API Key Management
List API Keys for your User
Example cURL Request
Endpoint Specification
Get your user
GET
/api/api-keys
Get all of the API keys for your user
Headers
Authorization*
string
Bearer ${API_KEY}
Create an API Key
Example cURL Request
Endpoint Specification
Create a new API key
POST
/api/api-keys
Create a new API key and optionally deactivate the API key used to authenticate this request
Headers
Authorization*
string
Bearer ${API_KEY}
Content-Type*
string
application/json
Request Body
name*
string
The name associated with the new API key.
deactivate_current*
boolean
Set to true if you wish to deactivate the key you use to authenticate this request.
422: Unprocessable Entity error
types
error
typesMAX_KEYS_REACHED
You have reached the maximum active API keys for your user. Maximum: 2
Deactivate an API Key
Example cURL Request
Endpoint Specification
Deactivate an API key
DELETE
/api/api-keys/${API_KEY_ID}
Deactivate an API key by its id
Path Parameters
API_KEY_ID*
string
The id of the API key you would like to deactivate.
Headers
Authorization*
string
Bearer ${API_KEY}
422: Unprocessable Entity error
types
error
typesAPI_KEY_NOT_EXISTS
Api key not found
Last updated