Sign in
API Keys

Generate a new API Key

Changed on

Returns the generated API Key for the requested account. Callers can create API keys with permissions as a subset of their current permissions.

post/v1/api-keys

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Request body

account_idstring uuid nullable

Owning account ID.

Account-scoped endpoints populate this with the authenticated account.

descriptionstring nullable

API key description

expiryinteger nullable

Expiration time in seconds

namestring required

API key name

permissionsPermission[] required

List of permissions for this API key

Response

API Key Created

account_idstring uuid required

Owning account ID

created_atstring date-time required

Date of creation in database

descriptionstring nullable

API key description

expires_atstring date-time nullable

Date of expiration

idstring uuid required

Internal ID

keystring nullable

API key (only returned once on creation, save it securely as it cannot be retrieved)

namestring required

API key name

permissionsPermission[] required

List of permissions for this API key

Changes

  • 1fe5c61520ccRevision changes
    • warning

      added the new read:account enum value to the / response property for the response status

    • warning

      added the new write:account enum value to the / response property for the response status

    • info

      added the new read:account enum value to the request property /

    • info

      added the new write:account enum value to the request property /

  • 2aba664778fbRevision changes
    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the required property to the response with the status