create-deployment

Create a deployment for an app in a project. Omit the source to use the app’s configured default. A Git app builds its default branch. An OCI app deploys its default image. Optionally provide one source override:

oci: deploy a prebuilt OCI image without a build. Mutable tags are resolved to immutable digests before rollout.
git: build and deploy from the app’s connected GitHub repository, a branch, a specific commit, or a fork commit. Requires the app to have a repository connected.
deployment: re-run an existing deployment by its id. Git deployments rebuild from the recorded commit. OCI deployments reuse the recorded resolved image.

The command returns immediately with a deploymentId. The build and rollout run asynchronously. Poll deployments.getDeployment to watch status until it is ready. Authentication requires a root key with permission to create deployments.

Usage

unkey api deployments create-deployment [flags]

Flags

string

required

Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as proj_ or app_) or a slug.

string

required

Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as proj_ or app_) or a slug.

string

required

Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as proj_ or app_) or a slug.

JSON string

Build from the app’s connected GitHub repository. Provide the source as a JSON object.

Show JSON schema

string

Branch to build (its HEAD). Omit branch and commitSha to use the app’s default branch.

string

Commit to build (full or abbreviated SHA). Takes precedence over branch.

string

Build from a fork instead of the app’s connected repository, as owner/repo. Requires commitSha.

JSON string

Deploy a prebuilt OCI image without a build. Provide the source as a JSON object.

Show JSON schema

string

required

OCI image to deploy. Mutable tags are resolved to immutable digests before rollout.

JSON string

Re-run an existing deployment. Provide the source as a JSON object.

Show JSON schema

string

required

Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as proj_ or app_) or a slug.

You can provide at most one of --git, --oci, or --deployment.

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

unkey api deployments create-deployment \
  --project=payments \
  --app=payments-api \
  --environment=production

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

unkey api deployments create-deployment \
  --project=payments \
  --app=payments-api \
  --environment=production \
  --oci='{"image":"ghcr.io/acme/payments:v1.2.3"}'

unkey api deployments create-deployment \
  --project=payments \
  --app=payments-api \
  --environment=production \
  --deployment='{"deploymentId":"d_abc123xyz"}'

See the Create deployment API reference.

Getting Started

Platform

Build & Deploy

Networking

Observability

CLI

Security

Keyspaces

AI Code Gen

Audit Logs

Log Drains

CLI

Errors

Usage

Flags

Global Flags

Examples

​Usage

​Flags

​Global Flags

​Examples

Usage

Flags

Global Flags

Examples