Skip to main content

    idstringrequired

    The UUID of the API key. Is unique.

    Format: string<uuid>
    Example: 00000000-0000-0000-0000-000000000000

    handlestringrequired

    The handle of the API key. Is unique.

    Format: string<handle>
    Example: key-a

    aliasstring | nullrequired

    The alias of the API key.

    Format: string,null<alias>
    Example: Key A

    suffixstringrequired

    Last 4 characters of the API key token used for identification.

    Possible values: <= 4 characters

    Example: cWTk

    tokenstringrequired

    The token of the API key. Is unique.

    Example: 53y9g8ZNronem8Mv4Aw0h0oxiUWqysmZzKX8cWTk

    createdAtstringrequired

    The date and time when the API key was created.

    Format: string<date-time>
    Example: 2023-01-01T00:00:00.000000Z
KeyCreate
{
"id": "00000000-0000-0000-0000-000000000000",
"handle": "key-a",
"alias": "Key A",
"suffix": "cWTk",
"token": "53y9g8ZNronem8Mv4Aw0h0oxiUWqysmZzKX8cWTk",
"createdAt": "2023-01-01T00:00:00.000000Z"
}