Skip to main content
Create a root key with the permissions listed on this page under Root Keys in the dashboard sidebar. CLI commands can instead use a session from unkey login with the required permissions. See Permission reference for every permission.
Update a ’s name, slug, or delete protection. Flags you omit leave the stored value unchanged. Changing the slug changes the hostnames of the project’s deployments, which breaks anything that uses the old ones. Delete protection blocks unkey projects delete until you turn it off again; see Delete protection.

Usage

Flags

boolean
Enable (--delete-protection) or disable (--delete-protection=false) delete protection. Omit the flag to leave the current setting unchanged.
string
New human-readable name, 1 to 256 characters.
string
required
Project ID or slug. Both forms resolve to the same project.
string
New project slug. Must stay unique in the workspace, and must be 3 to 255 characters matching ^[a-zA-Z0-9_-]+$.

Shared flags

Every resource command accepts these; CLI output and shared flags describes them in full.
string
A JSON document sent as the request body instead of building it from the flags above. It is mutually exclusive with the request-building flags, and unknown fields are rejected locally. See Send a raw body.
string
Root key used for the request. Falls back to UNKEY_ROOT_KEY, then stored credentials, including a CLI session. See CLI authentication for the full precedence order.
string
default:"https://api.unkey.com"
Base URL of the API. Falls back to UNKEY_API_BASE_URL. You don’t normally need to set it.
string
default:"~/.unkey/config.toml"
Path of the TOML config file. Falls back to UNKEY_CONFIG. An explicit --config takes precedence over a stored CLI session. Browser login stores a session, not a root key in this file. See CLI authentication.
enum
default:"human"
Use human (default) for name-first summary tables and single-response trees, or json for the unchanged full response envelope, including all fields and pagination. Trees wrap long values without truncation. Terminal tables use relative timestamps and may shorten display names and descriptions, but never identifiers, slugs, or credentials. Redirected human output keeps complete values and uses RFC3339 UTC timestamps. Falls back to UNKEY_OUTPUT; other values are rejected. --json also selects JSON output. Add --debug to print the request ID to stderr. See Output formats.
boolean
Print the successful response’s request ID to stderr, separate from stdout.
boolean
Print the full response as JSON. Takes precedence over a valid --output or UNKEY_OUTPUT value.

Required permissions

Your root key needs one of:
  • unkey:v1:<workspace_id>:projects/*#write (any project in the workspace)
  • unkey:v1:<workspace_id>:projects/<project_id>#write (a specific project)
Without a matching permission the API answers 403 and the CLI prints Permission denied: followed by the detail. See Root key permissions for the full catalog.

Examples

Rename a project:
Protect a project from deletion:
Send the request body as JSON:

API endpoint

The command calls POST /v2/projects.updateProject and prints its response. The request fields carry the same names as the flags in camelCase, which is the shape --body expects.
Last modified on November 11, 2026