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();
curl -X GET "https://api.trigger.dev/api/v1/deployments/deployment_1234" \
  -H "Authorization: Bearer tr_dev_1234"
import requests

url = "https://api.trigger.dev/api/v1/deployments/{deploymentId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.trigger.dev/api/v1/deployments/{deploymentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.trigger.dev/api/v1/deployments/{deploymentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.trigger.dev/api/v1/deployments/{deploymentId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.trigger.dev/api/v1/deployments/{deploymentId}")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.trigger.dev/api/v1/deployments/{deploymentId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "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 | null

External build data if applicable

​
errorData
object | null

Error data if the deployment failed

​
worker
object | null

Worker information if available