create-deployment

Create deployment with the Unkey API CLI

Create a deployment from a Git branch, container image, or existing deployment.

Usage

unkey api deployments create-deployment [flags]

Flags

--project · string · required

Project identifier or slug.

--app · string · required

Application identifier or slug.

--environment · string · required

Environment identifier or slug.

--git · JSON string

Git source with branch, commitSha, and repository.

--image · JSON string

Image source with dockerImage.

--deployment · JSON string

Existing source with deploymentId.

Global Flags

Flag	Type	Description
--root-key	string	Override root key ($UNKEY_ROOT_KEY)
--api-url	string	Override API base URL (default: https://api.unkey.com)
--config	string	Path to config file (default: ~/.unkey/config.toml)
--output	string	Output format - use json for raw JSON
--body	string	Send this JSON string as the request body. You cannot combine it with request-building flags.

Examples

Basic

unkey api deployments create-deployment --project=payments --app=payments-api \
  --environment=production --git='{"branch":"main"}'

See the Create deployment API reference.