Create an API key

POST/v1/api-keys

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Request body

requiredapplication/json

expires_atstring<date-time>

Expiration time

namestringrequired

Key name

min length 1

scopesany

Array of scope strings

Responses

201Created

created_atstringrequired

created_bystringrequired

expires_atstring | nullrequired

idstringrequired

is_activebooleanrequired

key_prefixstringrequired

namestringrequired

raw_keystringrequired

scopesanyrequired

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X POST "/v1/api-keys" \
  -H "Content-Type: application/json" \
  -d '{
  "expires_at": "2024-01-01T00:00:00Z",
  "name": "string",
  "scopes": "string"
}'

const response = await fetch("/v1/api-keys", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "expires_at": "2024-01-01T00:00:00Z",
  "name": "string",
  "scopes": "string"
})
});

import requests

response = requests.post(
    "/v1/api-keys",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "expires_at": "2024-01-01T00:00:00Z",
  "name": "string",
  "scopes": "string"
},
)

Response

{
  "created_at": "string",
  "created_by": "string",
  "expires_at": "string",
  "id": "string",
  "is_active": true,
  "key_prefix": "string",
  "name": "string",
  "raw_key": "string",
  "scopes": "string"
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}