Skip to main content
Create a root key with the permissions listed on this page under Root Keys in the dashboard sidebar. CLI commands can instead use a session from unkey login with the required permissions. See Permission reference for every permission.
List deployments in the workspace, newest first. All filters are optional. With none set, every deployment in the workspace is returned. Filters nest: --app requires --project, and --environment requires both. When pagination.hasMore is true, pass pagination.cursor back with --cursor. --status takes a comma-separated list of statuses from pending, starting, building, deploying, network, finalizing, ready, failed, skipped, awaiting_approval, stopped, superseded, and cancelled.

Usage

Flags

string
App ID or slug to filter by. Requires --project.
string
Pagination cursor from a previous response.
string
Environment ID or slug to filter by. Requires --project and --app.
integer
Maximum deployments per page, between 1 and 100. The API uses 100 when the flag is omitted.
string
ID or slug to filter by.
string[]
Comma-separated lifecycle statuses to include.

Shared flags

Every resource command accepts these; CLI output and shared flags describes them in full.
string
A JSON document sent as the request body instead of building it from the flags above. It is mutually exclusive with the request-building flags, and unknown fields are rejected locally. See Send a raw body.
string
Root key used for the request. Falls back to UNKEY_ROOT_KEY, then stored credentials, including a CLI session. See CLI authentication for the full precedence order.
string
default:"https://api.unkey.com"
Base URL of the API. Falls back to UNKEY_API_BASE_URL. You don’t normally need to set it.
string
default:"~/.unkey/config.toml"
Path of the TOML config file. Falls back to UNKEY_CONFIG. An explicit --config takes precedence over a stored CLI session. Browser login stores a session, not a root key in this file. See CLI authentication.
enum
default:"human"
Use human (default) for name-first summary tables and single-response trees, or json for the unchanged full response envelope, including all fields and pagination. Trees wrap long values without truncation. Terminal tables use relative timestamps and may shorten display names and descriptions, but never identifiers, slugs, or credentials. Redirected human output keeps complete values and uses RFC3339 UTC timestamps. Falls back to UNKEY_OUTPUT; other values are rejected. --json also selects JSON output. Add --debug to print the request ID to stderr. See Output formats.
boolean
Print the successful response’s request ID to stderr, separate from stdout.
boolean
Print the full response as JSON. Takes precedence over a valid --output or UNKEY_OUTPUT value.

Required permissions

Your root key needs unkey:v1:<workspace_id>:projects/<project_id>/apps/<app_id>/environments/<environment_id>/deployments/*#read, with * for every level you don’t filter by. The permission must cover every deployment the filters select. A grant for one environment isn’t enough for a list that spans more environments. Without a matching permission the API answers 403 and the CLI prints Permission denied: followed by the detail. See Root key permissions for the full catalog.

Examples

Deployments of one environment:
Recent successes and failures across the workspace:

API endpoint

The command calls POST /v2/deployments.listDeployments and prints its response. The request fields carry the same names as the flags in camelCase, which is the shape --body expects.
Last modified on October 28, 2026