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.
Change one or more fields on a portal. Only the flags you pass change. For the two branding fields, null clears the value. Calls POST /v2/portal.updatePortal. Two changes affect your end users right away:
  • Pointing the portal at a different keyspace or app signs out every current session. Sending the same keyspace or app it already has changes nothing. The new one must be in the same as the old one, or the call fails with 412. Keyspaces are in the workspace’s default project and apps are in the project you created them in, so moving between a keyspace and an app often hits this. Create a new portal instead.
  • Disabling the portal stops new sessions and ends the current ones. Re-enabling it does not bring them back. To also free the slug, use portals delete.

Usage

Flags

string
required
Portal id or slug to update.
string
New portal handle, unique in the workspace. A slug another portal has returns 409 err:unkey:data:portal_already_exists. Update any calls that use the old slug.
string
New name shown to end users.
string
Keyspace the portal should serve instead. Mutually exclusive with --app-id.
string
App the portal should serve instead. Mutually exclusive with --keyspace-id.
boolean
Whether you can create new sessions. Leave it off to keep the current state.
string
New absolute HTTPS logo URL, or null to remove the logo.
string
New six-digit hex color, or null to fall back to the default styling.

Shared flags

Every resource command takes these. See CLI output and shared flags.
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.
string
Send this JSON as the whole request body instead of using the command’s flags. You can’t combine it with them.

Required permissions

Your root key must have write permission on unkey:v1:<workspace_id>:projects/<project_id>/portals/<portal_id>. A broader grant, such as unkey:v1:<workspace_id>:**#write, also permits updates. Without portal read access, you get a 404, as if the portal didn’t exist. If your key can read the portal but lacks write permission, you get a 403 that names the missing permission instead. Pointing the portal at a new resource also requires read permission on the target:
  • unkey:v1:<workspace_id>:projects/<project_id>/keyspaces/<keyspace_id>#read for a keyspace.
  • unkey:v1:<workspace_id>:projects/<project_id>/apps/<app_id>#read for an app.
Without target read permission, the call fails with 403 and “You do not have permission to point a portal at that resource.” See Root key permissions.

Examples

Rename
Re-point and disable
Clear branding
Or send the whole request as JSON:
Raw body
Last modified on November 12, 2026