Skip to main content
You need a root key with the permissions listed on this page. Create one in the dashboard under Settings > Root Keys, and pass it as Authorization: Bearer <root key>. See Permission reference for every permission.
Delete a portal and sign out all of its users. Most sessions stop working within about 10 seconds, but some can keep working for up to 5 minutes. The keyspace or app behind the portal isn’t touched, its keys keep working, and the slug is free to reuse. Calls POST /v2/portal.deletePortal. The portal management commands are unreleased and may change without notice. To stop new sessions without cutting off the users who already have one, disable the portal with update-portal instead.

​
Usage

​
Flags

​
string
required
Portal id or slug.

​
Shared flags

Every unkey api command takes these. See CLI output and shared flags.
​
string
Root key used for the request. Falls back to UNKEY_ROOT_KEY, then to the key stored by unkey auth login.
​
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 config file written by unkey auth login. Falls back to UNKEY_CONFIG.
​
string
Output format. Falls back to UNKEY_OUTPUT. json prints the full response. Any other value prints the request ID and data.
​
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

portal.*.delete_portal or portal.<portalId>.delete_portal. Without it you get a 404, as if the portal didn’t exist. See Root key permissions.

​
Examples

Delete
Or send the whole request as JSON:
Raw body
Last modified on September 29, 2026