api-keys

Updates the display name and enabled checks of an API key.

patch/api/keys/{uuid}

Request

  • Base URL: https://api.pricklymails.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.pricklymails.com/api/keys/{uuid}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

uuidstring required

Public UUID of the API key.

Request body

enabled_checksstring[] nullable

New set of enabled checks, with the same values as on creation. Left unchanged when absent.

namestring nullable

New display name. Left unchanged when absent.

Response

The updated API key.

created_atstring required

RFC 3339 creation timestamp.

enabled_checksstring[] required

Verification checks enabled for the key.

environmentstring required

Environment of the key: "live" or "test".

expires_atstring nullable

RFC 3339 expiry timestamp, or null when the key does not expire.

is_activeboolean required

Whether the key can currently authenticate (not revoked and not expired).

last_used_atstring nullable

RFC 3339 timestamp of the last request made with the key, or null when it was never used.

namestring required

Display name of the key.

prefixstring required

Visible prefix of the key (for example pm_live_abc12345).

request_countinteger required

Total number of requests made with the key.

revoked_atstring nullable

RFC 3339 timestamp of the revocation, or null when the key is not revoked.

scopesstring[] required

Scopes granted to the key.

uuidstring required

Public UUID of the key.

Changes

No recorded changes to this operation across all 1 revision of this API.