Skip to main content
GET
TypeScript

Authorizations

Authorization
string
header
required

Use your project-specific Secret API key. Will start with tr_dev_, tr_prod, tr_stg, etc.

You can find your Secret API key in the API Keys section of your Trigger.dev project dashboard.

Our TypeScript SDK will default to using the value of the TRIGGER_SECRET_KEY environment variable if it is set. If you are using the SDK in a different environment, you can set the key using the configure function.

Path Parameters

deploymentId
string
required

The deployment ID.

Response

Successful request

id
string

The deployment ID

status
enum<string>

The current status of the deployment

Available options:
PENDING,
INSTALLING,
BUILDING,
DEPLOYING,
DEPLOYED,
FAILED,
CANCELED,
TIMED_OUT
contentHash
string

Hash of the deployment content

shortCode
string

The short code for the deployment

version
string

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

imageReference
string | null

Reference to the deployment image

imagePlatform
string

Platform of the deployment image

externalBuildData
object | null

External build data if applicable

errorData
object | null

Error data if the deployment failed

worker
object | null

Worker information if available