Skip to main content

list-deployments

List deployments with the Unkey API CLI
1 min read

List deployments with optional resource and lifecycle status filters.

Usage#

Flags#

--projectstring#

Project identifier or slug.

--appstring#

Application identifier or slug.

--environmentstring#

Environment identifier or slug.

--statusstring[]#

Comma-separated lifecycle statuses. Valid choices are pending, starting, building, deploying, network, finalizing, ready, failed, skipped, awaiting_approval, stopped, superseded, and cancelled.

--limitinteger#

Maximum deployments to return per page. The default is 100.

--cursorstring#

Pagination cursor from a previous response.

Global Flags#

FlagTypeDescription
--root-keystringOverride root key ($UNKEY_ROOT_KEY)
--api-urlstringOverride API base URL (default: https://api.unkey.com)
--configstringPath to config file (default: ~/.unkey/config.toml)
--outputstringOutput format - use json for raw JSON
--bodystringSend this JSON string as the request body. You cannot combine it with request-building flags.

Examples#

See the List deployments API reference.