Skip to main content

get-deployment

Get deployment with the Unkey API CLI
1 min read

Retrieve a deployment and its current lifecycle status by ID.

Usage#

Flags#

--deployment-idstringrequired#

Unique deployment identifier.

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 Get deployment API reference.