portal
Delete portal
Changed onDelete 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 URLhttps://api.unkey.com
- URLhttps://api.unkey.com/v2/portal.deletePortal
- AuthHTTP bearer
Request body
Example request
{
"portal": "proj_1234abcd"
}Response
Portal deleted and its sessions revoked.
Example response
{
"meta": {
"requestId": "req_123"
}
}Changes
- info
added the non-success response with the status
- info
- info
endpoint added
- info