List deployments

Retrieve a paginated list of deployments within a workspace, newest first.

Filter by project, app, environment, and lifecycle status. All filters are optional; with none set, every deployment in the workspace is returned. Filters nest: app requires project, and environment requires both project and app. Results are paginated; when hasMore is true, pass the returned cursor to fetch the next page.

Required Permissions

Your root key must have the environment.*.read_deployment permission. Listing spans environments, so a grant on a single environment is not sufficient.

POST

deployments.listDeployments

Python (SDK)

from unkey.py import Unkey, models


with Unkey(
    root_key="<YOUR_BEARER_TOKEN_HERE>",
) as unkey:

    res = unkey.deployments.list_deployments(project="payments-service", app="payments-api", environment="production", status=[
        models.DeploymentStatus.READY,
        models.DeploymentStatus.FAILED,
    ], limit=100)

    while res is not None:
        # Handle items

        res = res.next()

import { Unkey } from "@unkey/api";

const unkey = new Unkey({
  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
});

async function run() {
  const result = await unkey.deployments.listDeployments({
    project: "payments-service",
    app: "payments-api",
    environment: "production",
  });

  for await (const page of result) {
    console.log(page);
  }
}

run();

package main

import(
	"context"
	"os"
	unkey "github.com/unkeyed/sdks/api/go/v2"
	"github.com/unkeyed/sdks/api/go/v2/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := unkey.New(
        unkey.WithSecurity(os.Getenv("UNKEY_ROOT_KEY")),
    )

    res, err := s.Deployments.ListDeployments(ctx, components.V2DeploymentsListDeploymentsRequestBody{
        Project: unkey.Pointer("payments-service"),
        App: unkey.Pointer("payments-api"),
        Environment: unkey.Pointer("production"),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V2DeploymentsListDeploymentsResponseBody != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

curl --request POST \
  --url https://api.unkey.com/v2/deployments.listDeployments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "app": "payments-api",
  "environment": "production",
  "project": "payments-service"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({app: 'payments-api', environment: 'production', project: 'payments-service'})
};

fetch('https://api.unkey.com/v2/deployments.listDeployments', 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.unkey.com/v2/deployments.listDeployments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'app' => 'payments-api',
    'environment' => 'production',
    'project' => 'payments-service'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

HttpResponse<String> response = Unirest.post("https://api.unkey.com/v2/deployments.listDeployments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"app\": \"payments-api\",\n  \"environment\": \"production\",\n  \"project\": \"payments-service\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.unkey.com/v2/deployments.listDeployments")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"app\": \"payments-api\",\n  \"environment\": \"production\",\n  \"project\": \"payments-service\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "createdAt": 1704153600000,
      "id": "dep_1234abcd",
      "runtime": {
        "command": [
          "node",
          "server.js"
        ],
        "cpuMillicores": 250,
        "memoryMib": 256,
        "port": 8080,
        "shutdownSignal": "SIGTERM",
        "storageMib": 0,
        "upstreamProtocol": "http1"
      },
      "status": "ready"
    },
    {
      "createdAt": 1704067200000,
      "id": "dep_5678efgh",
      "runtime": {
        "command": [],
        "cpuMillicores": 250,
        "memoryMib": 256,
        "port": 8080,
        "shutdownSignal": "SIGTERM",
        "storageMib": 0,
        "upstreamProtocol": "http1"
      },
      "status": "failed"
    }
  ],
  "meta": {
    "requestId": "req_1234abcd"
  },
  "pagination": {
    "hasMore": false
  }
}

{
  "error": {
    "detail": "The 'environment' filter requires both 'project' and 'app' to be set.",
    "status": 400,
    "title": "Bad Request",
    "type": "validation-error"
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}

{
  "error": {
    "detail": "Your root key requires the 'environment.*.read_deployment' permission to perform this operation",
    "status": 403,
    "title": "Forbidden",
    "type": "forbidden"
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}

{
  "error": {
    "detail": "The requested project does not exist.",
    "status": 404,
    "title": "Not Found",
    "type": "not-found"
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}

Authorizations

Authorization

string

header

required

Unkey uses bearer tokens for authentication. Public integrations use root keys, while the dashboard proxy uses short-lived JWTs. To authenticate, include the token in the Authorization header of each request:

Authorization: Bearer unkey_123

Root keys have specific permissions attached to them, controlling what operations they can perform. Legacy permissions use tuple strings like api.*.create_key; resource permissions use Unkey Resource Names plus actions, like unkey:v1:ws_123:keyspaces/*#create_key. Security best practices:

Keep root keys secure and never expose them in client-side code
Use different root keys for different environments
Rotate keys periodically, especially after team member departures
Create keys with minimal necessary permissions following least privilege principle
Monitor key usage with audit logs.

Body

application/json

Filter deployments within a workspace. All filters are optional; with none set, every deployment in the workspace is returned, newest first.

project

string

Restrict results to a single project, identified by its ID or slug. Required when filtering by app or environment.

Required string length: 3 - 255

Pattern: ^[a-zA-Z0-9_-]+$

Example:

"proj_1234abcd"

app

string

Restrict results to a single app, identified by its ID or slug. Requires project to also be set.

Required string length: 3 - 255

Pattern: ^[a-zA-Z0-9_-]+$

Example:

"proj_1234abcd"

environment

string

Restrict results to a single environment, identified by its ID or slug. Requires project and app to also be set.

Required string length: 3 - 255

Pattern: ^[a-zA-Z0-9_-]+$

Example:

"proj_1234abcd"

status

enum<string>[]

Restrict results to deployments in any of the given lifecycle statuses. Omit to return deployments in every status.

Maximum array length: 13

Current lifecycle status of the deployment. Poll until it reaches a terminal state: ready (serving), failed, skipped, superseded, stopped, or cancelled.

Available options:

pending,

starting,

building,

deploying,

network,

finalizing,

ready,

failed,

skipped,

awaiting_approval,

stopped,

superseded,

cancelled

Example:

["ready", "failed"]

limit

integer

default:100

Maximum number of deployments to return per request. Balance between response size and number of pagination calls needed.

Required range: 1 <= x <= 100

cursor

string

Pagination cursor from a previous response to fetch the next page. Use when hasMore: true in the previous response.

Response

Successfully retrieved a paginated list of deployments. Use the pagination cursor for additional results when hasMore: true.

meta

object

required

Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The requestId is particularly important when troubleshooting issues with the Unkey support team.

Show child attributes

data

object[]

required

Array of deployments, ordered newest first.

Maximum array length: 100

Show child attributes

pagination

object

required

Pagination metadata for list endpoints. Provides information necessary to traverse through large result sets efficiently using cursor-based pagination.

Show child attributes

Last modified on July 22, 2026

Promote deploymentPromote a deployment to become the current deployment for its environment. All sticky domains are reassigned from the current deployment to the promoted one, and the previous deployment is scheduled for standby. The deployment must be ready, not already shutting down, belong to the production environment, and its app must already have a current deployment. Promoting the deployment that is already current fails, unless the app is in a rolled-back state, in which case promoting the current deployment confirms the rollback and re-enables automatic promotion of future deployments. Promotion runs as a durable workflow: this endpoint returns once the promotion is accepted. Poll `getDeployment` or `listDeployments` to observe the result. **Required Permissions** Your root key must have one of the following permissions: - `environment.*.promote_deployment` (to promote deployments in any environment) - `environment.<environment_id>.promote_deployment` (to promote deployments in a specific environment)

⌘I

Python (SDK)

from unkey.py import Unkey, models


with Unkey(
    root_key="<YOUR_BEARER_TOKEN_HERE>",
) as unkey:

    res = unkey.deployments.list_deployments(project="payments-service", app="payments-api", environment="production", status=[
        models.DeploymentStatus.READY,
        models.DeploymentStatus.FAILED,
    ], limit=100)

    while res is not None:
        # Handle items

        res = res.next()

import { Unkey } from "@unkey/api";

const unkey = new Unkey({
  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
});

async function run() {
  const result = await unkey.deployments.listDeployments({
    project: "payments-service",
    app: "payments-api",
    environment: "production",
  });

  for await (const page of result) {
    console.log(page);
  }
}

run();

package main

import(
	"context"
	"os"
	unkey "github.com/unkeyed/sdks/api/go/v2"
	"github.com/unkeyed/sdks/api/go/v2/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := unkey.New(
        unkey.WithSecurity(os.Getenv("UNKEY_ROOT_KEY")),
    )

    res, err := s.Deployments.ListDeployments(ctx, components.V2DeploymentsListDeploymentsRequestBody{
        Project: unkey.Pointer("payments-service"),
        App: unkey.Pointer("payments-api"),
        Environment: unkey.Pointer("production"),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V2DeploymentsListDeploymentsResponseBody != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

curl --request POST \
  --url https://api.unkey.com/v2/deployments.listDeployments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "app": "payments-api",
  "environment": "production",
  "project": "payments-service"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({app: 'payments-api', environment: 'production', project: 'payments-service'})
};

fetch('https://api.unkey.com/v2/deployments.listDeployments', 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.unkey.com/v2/deployments.listDeployments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'app' => 'payments-api',
    'environment' => 'production',
    'project' => 'payments-service'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

HttpResponse<String> response = Unirest.post("https://api.unkey.com/v2/deployments.listDeployments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"app\": \"payments-api\",\n  \"environment\": \"production\",\n  \"project\": \"payments-service\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.unkey.com/v2/deployments.listDeployments")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"app\": \"payments-api\",\n  \"environment\": \"production\",\n  \"project\": \"payments-service\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "createdAt": 1704153600000,
      "id": "dep_1234abcd",
      "runtime": {
        "command": [
          "node",
          "server.js"
        ],
        "cpuMillicores": 250,
        "memoryMib": 256,
        "port": 8080,
        "shutdownSignal": "SIGTERM",
        "storageMib": 0,
        "upstreamProtocol": "http1"
      },
      "status": "ready"
    },
    {
      "createdAt": 1704067200000,
      "id": "dep_5678efgh",
      "runtime": {
        "command": [],
        "cpuMillicores": 250,
        "memoryMib": 256,
        "port": 8080,
        "shutdownSignal": "SIGTERM",
        "storageMib": 0,
        "upstreamProtocol": "http1"
      },
      "status": "failed"
    }
  ],
  "meta": {
    "requestId": "req_1234abcd"
  },
  "pagination": {
    "hasMore": false
  }
}

{
  "error": {
    "detail": "The 'environment' filter requires both 'project' and 'app' to be set.",
    "status": 400,
    "title": "Bad Request",
    "type": "validation-error"
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}

{
  "error": {
    "detail": "Your root key requires the 'environment.*.read_deployment' permission to perform this operation",
    "status": 403,
    "title": "Forbidden",
    "type": "forbidden"
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}

{
  "error": {
    "detail": "The requested project does not exist.",
    "status": 404,
    "title": "Not Found",
    "type": "not-found"
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}