openstead
APIEndpoint referenceVariables

List masked variable metadata

Values are always null. Legacy requests without limit/cursor return all variables.

Suggest a change

Kept in memory for this page. Requests go through this documentation site to the live Openstead API and can change your workspace. Use a read-only key to explore read operations.

GET
/workspaces/{workspaceId}/services/{serviceId}/variables

Values are always null. Legacy requests without limit/cursor return all variables.

Authorization

AuthorizationBearer <token>

Workspace-scoped rnv_ API key. Read scope allows GET; write scope is additionally constrained by current membership, role, email verification, expiry and workspace MFA policy.

In: header

Path Parameters

workspaceId*string

Workspace UUID; it must match the bearer key scope.

Formatuuid
serviceId*string

Service UUID in this workspace.

Formatuuid

Query Parameters

limit?integer

Page size. Supplying limit or cursor enables pagination for legacy unbounded lists.

Range1 <= value <= 200
Default100
cursor?string

Opaque nextCursor returned by the previous page. Reuse with the same endpoint and query; do not parse or construct it.

Header Parameters

X-Request-ID?string

Optional correlation identifier; invalid values are replaced. The accepted/generated value is returned in X-Request-ID and error body requestId. This is not an idempotency key.

Match^[A-Za-z0-9][A-Za-z0-9._-]*$
Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.openstead.tech/api/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/variables" \  -H "Authorization: Bearer <OPENSTEAD_API_KEY>"
{  "page": {    "hasMore": true,    "limit": 1,    "nextCursor": "string"  },  "variables": [    {      "configured": true,      "createdAt": "2019-08-24T14:15:22Z",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "key": "string",      "kind": "variable",      "updatedAt": "2019-08-24T14:15:22Z",      "value": null    }  ]}
Need a hand? Contact Openstead support.

Read or tail service logs GET

Without after returns the newest retained batch in ascending numeric ID order. With after returns later lines in ascending ID order. Continue with response cursor; this is not opaque collection pagination. Retention depends on the plan, and search is limited to 200 characters.

Create an encrypted variable POST

The stored value is encrypted. The response contains only masked metadata.