Skip to navigation

Read a variable

Reads an active cloud variable by name from the signed-in application. A paused or missing variable is rejected. Values become current when the app next fetches them; there is no unsolicited push.

Authentication

AuthorizationBearer
Opaque v3 session token returned by login, bound to its identity and installation.

Headers

X-AuthlyX-NoncestringRequiredformat: "^[a-f0-9]{32,128}$"
Fresh random hexadecimal nonce. Do not reuse.
X-AuthlyX-TimestampstringRequired

Server-aligned Unix time in milliseconds.

X-AuthlyX-SignaturestringRequired

Base64 Ed25519 installation signature over the exact request-proof payload.

Request

This endpoint expects an object.
namestringRequired
Cloud variable name.

Response

Successful
successboolean
codestring
messagestring
dataobject or null
requestIdstringformat: "uuid"
verificationobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
413
Content Too Large Error
415
Unsupported Media Type Error
429
Too Many Requests Error
503
Service Unavailable Error