api-keys

Mint an organization API key for automation (e.g. Terraform). The plaintext token is returned once.

post/api-keys

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/api-keys
  • Auth: HTTP bearer

Request body

$schemastring uri

A URL to the JSON Schema for this object.

expires_in_daysinteger

Days until the key expires; omit or 0 for no expiry.

namestring required

Human label for the key.

Example request

{
  "$schema": "/api/v1/schemas/CreateAPIKeyInputBody.json"
}

Response

Created

$schemastring uri

A URL to the JSON Schema for this object.

tokenstring required

Plaintext API key — shown once, store it securely.

Example response

{
  "$schema": "/api/v1/schemas/CreateAPIKeyOutputBody.json"
}

Changes

No recorded changes to this operation across all 13 revisions of this API.