Skip to main content
Unkey Docs

create-deployment

Create deployment with the Unkey API CLI
1 min read

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

Usage#

Flags#

--projectstringrequired#

Project identifier or slug.

--appstringrequired#

Application identifier or slug.

--environmentstringrequired#

Environment identifier or slug.

--gitJSON string#
Git source with branch, commitSha, and repository.
Show JSON schema
The JSON object uses the properties and constraints listed above.
--imageJSON string#
Image source with dockerImage.
Show JSON schema
The JSON object uses the properties and constraints listed above.
--deploymentJSON string#
Existing source with deploymentId.
Show JSON schema
The JSON object uses the properties and constraints listed above.

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

update-settingsget-deployment