UNunkeyed
portal

Create portal

Changed on

Create a portal for one app or keyspace in your workspace.

Unreleased and subject to change without notice.

Send exactly one of keyspaceId or appId. That resource must belong to your workspace, and it can back only one portal, so a second portal for the same resource is a 409.

displayName is what your end users see. It is yours to set and change independently of the resource the portal serves.

Required Permissions

Your root key must have portal.*.create_portal. A grant scoped to a specific portal id does not authorize creation, because the id does not exist yet.

post/v2/portal.createPortal

Request

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

Request body

OR

Example request

{
  "slug": "acme-portal",
  "displayName": "Acme",
  "keyspaceId": "ks_1234abcd",
  "appId": "app_1234abcd",
  "enabled": true,
  "logoUrl": "https://cdn.example.com/logo.svg",
  "primaryColor": "#6366f1"
}

Response

Portal created successfully.

Example response

{
  "meta": {
    "requestId": "req_123"
  },
  "data": {
    "portalId": "prt_1234abcd"
  }
}

Changes