Skip to main content
GET
Get deployment status

Authorizations

Authorization
string
header
required

WorkOS access JWT or a user-owned WorkOS API key. User keys are bound to one organization and restricted to their enabled product permissions. Session-only onboarding and session revocation require an interactive access JWT. No cookie session is assumed.

Headers

X-Request-Id
string

Optional caller-provided correlation identifier.

Required string length: 1 - 128

Path Parameters

project_id
string
required

Project identifier.

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
deployment_id
string
required

Deployment identifier.

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Response

The deployment and its current status.

id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
project_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
operation_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
commit_sha
string
required

Exact full Git commit object identifier; abbreviated or branch references are forbidden.

Pattern: ^[0-9a-f]{40}$
source_digest
string
required
Pattern: ^sha256:[0-9a-f]{64}$
build_plan_digest
string
required
Pattern: ^sha256:[0-9a-f]{64}$
status
enum<string>
required
Available options:
queued,
building,
publishing,
active,
failed,
rolled_back,
deleting,
deleted,
reconciliation_required
created_at
string<date-time>
required
updated_at
string<date-time>
required
artifact_digest
string
Pattern: ^sha256:[0-9a-f]{64}$
url
string<uri>

Project-isolated public gateway URL for the observed deployment.

Pattern: ^https://