Skip to main content

API Key Update Expiration

POST 
/api/v1/apikey/:apikey_id/update

Update the expiration date of a specific API key.

Request​

Path Parameters

    apikey_id stringrequired

    The UUID4 identifier associated with this API Key.

Body

required
    date_expires date-timenullablerequired

    The new expiration date for the API key. Set to null to remove expiration. The date should be in ISO8601 format.

Responses​

OK
Schema
    api_key Api Key (string)nullablerequired

    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-timenullablerequired

    The date that the API key will automatically expire.

    date_last_used date-timenullablerequired

    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...