Skip to main content
GET
/
api
/
v1
/
deployments
/
{deploymentId}
TypeScript
const response = await fetch(
  `https://api.trigger.dev/api/v1/deployments/${deploymentId}`,
  {
    method: "GET",
    headers: {
      "Authorization": `Bearer ${secretKey}`,
    },
  }
);
const deployment = await response.json();
{
  "id": "<string>",
  "status": "PENDING",
  "contentHash": "<string>",
  "shortCode": "<string>",
  "version": "<string>",
  "imageReference": "<string>",
  "imagePlatform": "<string>",
  "externalBuildData": {},
  "errorData": {},
  "worker": {
    "id": "<string>",
    "version": "<string>",
    "tasks": [
      {
        "id": "<string>",
        "slug": "<string>",
        "filePath": "<string>",
        "exportName": "<string>"
      }
    ]
  }
}

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.

import { configure } from "@trigger.dev/sdk";

configure({ accessToken: "tr_dev_1234" });

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

External build data if applicable

​
errorData
object

Error data if the deployment failed

​
worker
object

Worker information if available