Skip to main content

Generate API Key

POST 

/api/apikey/generate

Generates a long-term API Key from your account's username and password.

Request

Body

required
    username Username (string)required

    Your account username.

    password Password (string)required

    Your account password.

    name Name/Tag (string)

    A human readable name for your API key used to identify it when managing keys.

Responses

OK
Schema
    api_key Api Key (string)

    The API key. Will be null unless the key was created during the request. Keys are not stored in plaintext and can not be recovered after creation time.

    date_created date-timerequired

    The date that the API key was created.

    date_expires date-time

    The date that the API key will automatically expire.

    date_last_used date-time

    The last time that the API key was used to authenticate with the API.

    id uuid4required

    The database ID for the API key. Used when deleting keys.

    name Name (string)required

    The human-readable name for the API key used for managing keys.

    prefix Prefix (string)required

    The non-secret key prefix.

    suffix Suffix (string)required

    The non-secret key suffix. Helpful for identifying keys if a name wasn't specified at creation time.

Loading...