Sign in
api-keys

Create My Api Key

Issue the caller a key. Plaintext is in this response and nowhere else.

user_id and created_by are both the caller, which is the whole difference from the admin route — every limit underneath (one live key, the maximum lifetime, tenant membership) is the same code.

post/api/v1/api-keys

Headers

authorizationstring nullable
X-API-Keystring nullable

Request body

namestring required
expires_atstring date-time nullable

Response

Successful Response

idinteger required
namestring required
user_idinteger required
user_namestring nullable
user_emailstring nullable
key_prefixstring required
expires_atstring date-time required
last_used_atstring date-time nullable
revoked_atstring date-time nullable
status'active' | 'revoked' | 'expired' required
created_byinteger nullable
created_atstring date-time required
api_keystring required

Changes

Changed in 1 of the 5 revisions of this API.1