Keys
Returns data about a key
POST
/
v1
/
keys.whoami
Changelog
| Date | Changes |
|---|---|
| Oct 07 2024 | Introduced endpoint |
You may not always have easy access to the keyId and therefore can’t use /v1/keys.getKey.
This offers an escape hatch to send us the real key instead.
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
key
string
requiredThe actual key to fetch
Response
200 - application/json
id
string
requiredThe ID of the key
name
string
The name of the key
remaining
integer
The remaining number of requests for the key
identity
object
The identity object associated with the key
meta
object
Metadata associated with the key
createdAt
integer
requiredThe timestamp in milliseconds when the key was created
enabled
boolean
requiredWhether the key is enabled
environment
string
The environment the key is associated with
Was this page helpful?