openstead
APIEndpoint referenceDeployments

Get deployment progress

Request parameters, responses, and examples for get deployment progress.

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/{deploymentId}

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
deploymentId*string

Deployment UUID in this service.

Formatuuid

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/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Authorization: Bearer <OPENSTEAD_API_KEY>"
{  "deployment": {    "actor": "developer@example.com",    "blockedReason": "",    "branch": "main",    "canRollback": false,    "cancelRequested": false,    "commitMessage": "",    "commitSha": "",    "createdAt": "2026-09-25T12:00:00Z",    "error": "",    "finishedAt": null,    "id": "00000000-0000-4000-8000-000000000001",    "sourceDeploymentId": null,    "startedAt": null,    "status": "queued",    "steps": [],    "trigger": "manual"  }}
Need a hand? Contact Openstead support.

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.

Request deployment cancellation POST

Terminal deployments reject new cancellation requests. cancelRequested:true acknowledges the request; a running worker must still stop safely. Poll the deployment for its terminal state.