portal

Delete a portal and revoke the sessions it minted.

Unreleased and subject to change without notice.

Its end users lose access rather than keeping it until their tokens expire. Revocation is not instantaneous: session lookups are cached briefly, so a request already in flight may still succeed.

The app or keyspace it served is untouched, and its slug becomes free for a new portal.

Required Permissions

Your root key must have one of:

  • portal.*.delete_portal (to delete any portal in the workspace)
  • portal.<portal_id>.delete_portal (to delete a specific portal)

A root key that cannot read the portal gets 404. One that can read it but lacks the permission gets 403.

post/v2/portal.deletePortal

Request

  • Base URL
    https://api.unkey.com
  • URL
    https://api.unkey.com/v2/portal.deletePortal
  • Auth
    HTTP bearer

Request body

portalstring required

Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.

Example request

{
  "portal": "proj_1234abcd"
}

Response

Portal deleted and its sessions revoked.

dataEmptyResponse required

Empty response object by design. A successful response indicates this operation was successfully executed.

Example response

{
  "meta": {
    "requestId": "req_123"
  }
}

Changes