Authentication
API Keys
Manage api keys within the Authentication API. This section covers endpoints for working with api keys including retrieval, creation, and management operations.
Update key
PATCH/accounts/{account_id}/api_keys/update
Update an existing API key
Path Parameters
account_id*number (double)
Query Parameters
update_by*enum
update_param*string
Request Body
RequiredThe new configuration for the key
name*string
Responses
200Ok
Response Attributes
code*number (double)
messagestring
configobject
Get key
GET/accounts/{account_id}/api_keys/retrieve
Retrieve an API key by its key value, name, or ID
Path Parameters
account_id*number (double)
Query Parameters
retrieve_byenum=
"value"retrieve_param*string
Responses
200Ok
Response Attributes
code*number (double)
messagestring
keyobject
List keys
GET/accounts/{account_id}/api_keys/list
Retrieve an API key by its key value, name, or ID
Path Parameters
account_id*number (double)
Responses
200Ok
Response Attributes
code*number (double)
messagestring
keysobject[]
Delete key
DEL/accounts/{account_id}/api_keys/delete
Delete an API key by its key value, name, or ID
Path Parameters
account_id*number (double)
Query Parameters
delete_by*enum
delete_param*string
Responses
200Ok
Response Attributes
code*number (double)
messagestring
Create key
PUT/accounts/{account_id}/api_keys/create
Create a new API key
Path Parameters
account_id*number (double)
Request Body
RequiredThe configuration for the new key
name*string
Responses
200Ok
Response Attributes
code*number (double)
messagestring
keyobject