Get portal
Read one portal, by its id or slug, or by the resource it serves.
Unreleased and subject to change without notice.
Send exactly one of portal, keyspaceId, or appId. Sending more than one
is a 400.
Required Permissions
Your root key must have one of:
portal.*.read_portal(to read any portal in the workspace)portal.<portal_id>.read_portal(to read a specific portal)
Without the permission this returns 404, not 403.
Authorizations
Unkey uses bearer tokens for authentication. Public integrations use root keys, while the dashboard proxy uses short-lived JWTs. To authenticate, include the token in the Authorization header of each request:
Root keys have specific permissions attached to them, controlling what operations they can perform. Legacy permissions use tuple strings like api.*.create_key; resource permissions use Unkey Resource Names plus actions, like unkey:v1:ws_123:keyspaces/*#create_key.
Security best practices:
- Keep root keys secure and never expose them in client-side code
- Use different root keys for different environments
- Rotate keys periodically, especially after team member departures
- Create keys with minimal necessary permissions following least privilege principle
- Monitor key usage with audit logs.
Body
- Option 1
- Option 2
- Option 3
Name the portal directly with portal, or name the resource it serves with
keyspaceId or appId. Exactly one of the three is required; sending more
than one is a bad request.
Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
3 - 255^[a-zA-Z0-9_-]+$"proj_1234abcd"
The id of the keyspace this portal serves keys for. Must belong to your workspace.
A portal serves exactly one resource, so keyspaceId and appId are
mutually exclusive.
1 - 255^[a-zA-Z0-9_-]+$"ks_1234abcd"
The id of the app this portal serves keys for. Must belong to your workspace.
A portal serves exactly one resource, so appId and keyspaceId are mutually
exclusive.
1 - 255^[a-zA-Z0-9_-]+$"app_1234abcd"
Response
The portal.
Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The requestId is particularly important when troubleshooting issues with the Unkey support team.
A portal you expose to your end users so they can manage their own keys.
Exactly one of keyspaceId or appId is present, naming the single resource
the portal serves. Neither is in the required list because which one appears
depends on the portal, so a reader checks for the one it cares about.