Skip to main content

Platform API Keys

Platform API keys provide Bearer token authentication for accessing the Unstract Platform API. Keys are managed through the Unstract UI by organization admins.

UI Only

Platform API key management (create, list, update, rotate, delete) is available exclusively through the Unstract UI under Platform > Platform API Keys. These operations are not exposed as Platform API endpoints.

Platform API Keys management UI

Key Management​

Organization admins can perform the following operations from the UI:

  • Create a new API key with a name, description, and permission level
  • List all API keys for the organization
  • Retrieve details of a specific key
  • Update a key's description, active status, or permission level (name is not updatable)
  • Delete a key and its associated service account
  • Rotate a key to generate a new secret (the old key is invalidated immediately)

Permission Enum​

ValueLabel
readRead
read_writeRead/Write

Input Validation​

The name and description fields are validated against the following pattern:

^[a-zA-Z0-9 \-_.,:()/]+$

Allowed characters: alphanumeric characters, spaces, hyphens, underscores, periods, commas, colons, parentheses, and forward slashes. HTML tags and angle brackets are rejected.