Skip to main content

API keys

API keys belong to users and provide long-lived bearer tokens, which in turn can be used to authenticate API requests.

To learn how to use the token of an API key to authenticate your API requests, read the bearer tokens page.

Access: Only you can manage your API keys.

 

Fields​

    idstringrequired

    The UUID of the API key. Is unique.

    Format: uuid
    Example: 00000000-0000-0000-0000-000000000000
    handlestringrequired

    The handle of the API key. Is unique.

    Example: key-a
    aliasstring | nullrequired

    The alias of the API key.

    Example: Key A
    tokenstringrequired

    The Base64-encoded bearer token of the API key. Is unique.

    Format: byte
    Example: 2lMFEf/TgA4ydxf6ugnvYjtk4Cv9rTzs5ZyLnchZetc=
    createdAtstringrequired

    The date and time when the API key was created.

    Format: date-time
    Example: 2023-01-01T00:00:00.000000Z
Key
{
  "id": "00000000-0000-0000-0000-000000000000",
  "handle": "key-a",
  "alias": "Key A",
  "token": "2lMFEf/TgA4ydxf6ugnvYjtk4Cv9rTzs5ZyLnchZetc=",
  "createdAt": "2023-01-01T00:00:00.000000Z"
}