openstead
APIEndpoint referenceDeployments

List deployments, newest first

Bounded by default to 100; maximum limit 200. Follow page.nextCursor for older deployments. Hosting disabled with no runtime returns available:false and empty items.

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}/deploys

Bounded by default to 100; maximum limit 200. Follow page.nextCursor for older deployments. Hosting disabled with no runtime returns available:false and empty items.

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/deploys" \  -H "Authorization: Bearer <OPENSTEAD_API_KEY>"
{  "available": true,  "items": [    {      "actor": "string",      "blockedReason": "string",      "branch": "string",      "canRollback": true,      "cancelRequested": true,      "commitMessage": "string",      "commitSha": "string",      "createdAt": "2019-08-24T14:15:22Z",      "error": "string",      "finishedAt": "2019-08-24T14:15:22Z",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "sourceDeploymentId": "eaf2fa77-0ea5-41d6-b608-637bf5e31d4e",      "startedAt": "2019-08-24T14:15:22Z",      "status": "queued",      "steps": [        {          "finishedAt": "2019-08-24T14:15:22Z",          "name": "queued",          "startedAt": "2019-08-24T14:15:22Z"        }      ],      "trigger": "string"    }  ],  "page": {    "hasMore": true,    "limit": 1,    "nextCursor": "string"  },  "reason": "string"}
Need a hand? Contact Openstead support.

Restore archived service configuration POST

Sets archived:false; does not automatically deploy or resume infrastructure.

Queue a deployment POST

Creates a durable deployment/job when hosting is enabled, subject to capacity, billing and source validation. The initial status is queued. Poll getDeployment for progress; use getService for the serving release. A replay returns the original successful response, not the latest status.