Update an app by ID or slug. You can change its name, slug, GitHub repository configuration, and delete protection. Omitted fields remain unchanged. A new slug must not collide with another app in the project.
Usage#
Flags#
Project ID or slug.
App ID or slug.
New human-readable name. Omit to leave unchanged.
New app slug. Omit to leave unchanged.
Connect or reconfigure a GitHub repository with repository and
defaultBranch fields. Set the value to null to disconnect the repository.
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#
See the API reference.