Skip to main content
POST
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Headers

Idempotency-Key
string

Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.

Maximum string length: 255

Path Parameters

id
string
required

The resource ID (e.g., "prod_abc123") or slug (e.g., "my-product")

Response

The queued deployment

id
string
required
object
string
required
status
enum<string>
required
Available options:
pending,
building,
live,
failed,
superseded,
unpublished
commit_sha
string | null
required
is_live
boolean
required
url
string | null
required
triggered_by
string | null
required
error_message
string | null
required
db_bookmark
string | null
required
current_stage
string | null
required
stages
array
required
duration_seconds
number | null
required
elapsed_seconds
number | null
required
started_at
string | null
required
finished_at
string | null
required
created_at
string
required