update-app

Update an app by ID or slug. You can change its name, slug, source configuration, and delete protection. Omitted fields remain unchanged. A new slug must not collide with another app in the project.

Usage

unkey api apps update-app [flags]

Flags

string

required

Project ID or slug.

string

required

App ID or slug.

string

New human-readable name. Omit to leave unchanged.

string

New app slug. Omit to leave unchanged.

JSON string

Connect or reconfigure a GitHub repository with repository and defaultBranch fields. Set the value to null to disconnect the repository.

JSON string

Change the default image reference for an OCI-sourced app. The JSON object must contain image with an explicit tag or digest. This doesn’t create a deployment or switch the app’s source.

bool

Enable or disable delete protection. Omit to leave unchanged.

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 apps update-app --project=payments --app=app_1234abcd \
  --git='{"repository":"unkeyed/api","defaultBranch":"main"}'

OCI image

unkey api apps update-app --project=payments --app=app_1234abcd \
  --oci='{"image":"ghcr.io/acme/payments:v2"}'

See the 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