deployments

Retrieve information about a specific deployment by its ID.

get/api/v1/deployments/{deploymentId}

Request

Response

Successful request

idstring

The deployment ID

status'PENDING' | 'INSTALLING' | 'BUILDING' | 'DEPLOYING' | 'DEPLOYED' | 'FAILED' | 'CANCELED' | 'TIMED_OUT'

The current status of the deployment

contentHashstring

Hash of the deployment content

shortCodestring

The short code for the deployment

versionstring

The deployment version (e.g., "20250228.1")

imageReferencestring nullable

Reference to the deployment image

imagePlatformstring

Platform of the deployment image

externalIdstring

The external deployment id this deployment was deployed under (--external-id), used by version skew protection to pin runs. Absent if the deployment was deployed without one

externalBuildDataobject nullable

External build data if applicable

errorDataobject nullable

Error data if the deployment failed

Changes