Skip to main content
POST
Create API Key
Creates a new API key for the organization. The full key value is returned only once in this response. Store it securely — it cannot be retrieved again.

Auth

Requires a valid Bearer token. User must be a member of the organization.

Path Parameters

string
required
Organization identifier.

Request Body

string
required
Descriptive name for the API key. Between 1 and 100 characters.
string[]
Array of permission scopes to restrict what the key can access. If omitted or empty, the key has full access to all organization resources.
number
Maximum requests per minute for this key. Minimum value of 1.
string
ISO 8601 date-time for when the key should expire. If omitted, the key does not expire.

Response

boolean
Always true on success.
object
string
Reminder to save the key.

Example