api-keys

Create an API key

Changed on

Mints a fresh API key for the caller's organization. The plaintext key value is returned exactly once and never stored or returned again.

post/api-keys

Request

Request body

$schemastring uri

A URL to the JSON Schema for this object.

namestring required

Human-readable label for the API key.

Example request

{
  "$schema": "/api/v1/APIKeyCreateRequest.json"
}

Response

Created

$schemastring uri

A URL to the JSON Schema for this object.

created_atstring date-time required

Timestamp when the key was created.

idstring required

API key identifier.

key_valuestring required

Full plaintext key, shown only on creation.

namestring required

Human-readable label for the key.

Example response

{
  "$schema": "/api/v1/APIKeyCreateResponse.json"
}

Changes

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • breaking

      the request property's minLength was increased from 0 to 1

    • warning

      the request property's maxLength was set to 100

    • info

      the endpoint scheme security bearerAuth was removed from the API