You need a root key with the permissions listed on this page. Create one in the dashboard under Settings > Root Keys. See Permission reference for every permission.
delete-project 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
Everyunkey api 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 for the request. Falls back to
UNKEY_ROOT_KEY, then to the config file written by unkey auth login. See CLI authentication.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 file that
unkey auth login writes. Falls back to UNKEY_CONFIG.string
Output format. Falls back to
UNKEY_OUTPUT. Set json to print the full response envelope (meta and data) for piping; any other value prints the request ID followed by data.Required permissions
Your root key needs one of:project.*.update_project(any project)project.<project_id>.update_project(a specific project)
Permission denied: followed by the detail. See Root key permissions for the full catalog.
Examples
Rename a project:API endpoint
The command callsPOST /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.