Skip to main content
POST
workflow.deployment.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
deploymentId
string

Record identifier in your connected account.

Required string length: 1 - 256
Pattern: ^[A-Za-z0-9_.:-]+$
select
enum<string>

Latest may be a failed build; current is the promoted deployment.

Available options:
latest,
current

Response

The result

deploymentId
string
required

Record identifier in your connected account.

Required string length: 1 - 256
Pattern: ^[A-Za-z0-9_.:-]+$
state
enum<string>
required

Deployment state.

Available options:
pending,
installing,
building,
deploying,
deployed,
failed,
canceled,
timed_out
versionId
string
required

Account-owned label.

Required string length: 1 - 256
createdAt
string<date-time>

Creation time in UTC.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
tasks
object[]

Workflow definitions in this deployment.

Maximum array length: 1000