Skip to main content
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. Your root key must have portal.*.create_portal. A grant scoped to a specific portal ID does not authorize creation because the ID doesn’t exist yet.

Usage

Flags

string
required
URL-safe handle unique within your workspace. Use 3-64 lowercase alphanumeric characters and single hyphens. Don’t start or end it with a hyphen.
string
required
Human-readable name shown in the portal header and page titles.
string
ID of the keyspace this portal serves. You must set exactly one of --keyspace-id or --app-id.
string
ID of the app this portal serves. You must set exactly one of --app-id or --keyspace-id.
bool
default:"true"
Whether sessions can be minted for this portal.
string
Absolute https:// URL of the logo shown in the portal header.
string
Six-digit hex colour used for primary actions and accents.

Global Flags

Examples

See the API reference.
Last modified on September 18, 2026