Sign in
Tenants

Create a new API key

Generate a new API key with specified scopes. The full key is returned only once in the response — store it securely.

post/api/tenants/me/api-keys

Request body

namestring required
scopesstring[] required
expiresAtstring

Example request

{
  "name": "Production API Key",
  "scopes": [
    "read",
    "write"
  ]
}

Response

API key created. The key value is shown only once.

idstring required
keystring required
namestring required
scopesstring[] required
lastUsedstring
expiresAtstring
createdAtstring required

Example response

{
  "id": "clx1234567890",
  "key": "sk_live_abc123...",
  "name": "Production API Key",
  "scopes": [
    "read",
    "write"
  ]
}

Changes

Changed in 1 of the 2 revisions of this API.7

  • 0e449a4e0dc87See the full diff
    • ○

      added the optional property expiresAt to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property lastUsed to the response with the 201 status

      response-optional-property-added

    • ○

      the response property id became required for the status 201

      response-property-became-required

    • ○

      the response property key became required for the status 201

      response-property-became-required

    • ○

      the response property name became required for the status 201

      response-property-became-required

    • ○

      the response property scopes became required for the status 201

      response-property-became-required

    • ○

      added the required property createdAt to the response with the 201 status

      response-required-property-added