Retrieves a list of API keys associated with the authenticated user. Each API key is returned without the full key value for security reasons. This is a read-only GET operation. The output is a JSON array of API key objects.
Creates a new API key for the authenticated user. Requires a key name and scope in the request body. This is a POST operation that returns the created API key object in JSON format.
Body:
{ "key_name": "Backend API Key # Type: string", "key_scope": "READ,CREATE,UPDATE,DELETE,MANAGE # Type: array", "organization_id": "432 # Type: integer"}
| Name | Type | Required Field | Description |
|---|---|---|---|
| key_name | string | True | This is the name of the API_KEY, which helps the user(developer) identify the key |
| key_scope | array | True | This determines the range of action this API key is allowed to execute. Here are the key_scope options. "READ": This gives the access to execute reads with API requests "CREATE": This gives the access to create resources with API requests "UPDATE": This gives the access to execute updates with API requests "DELETE": This gives the access to execute deletes with API requests "MANAGE": This gives the access to manage accounts through API requests. ["READ", "CREATE", "UPDATE", "DELETE", "MANAGE"] |
| organization_id | integer | True | The numeric ID of the of the account |
Retrieves metadata for a specific API key by its ID. This call does not return the full key value. This is a GET operation. The JSON response representing the API key.
| Name | Type | Required Field | Description |
|---|---|---|---|
| key_id | integer | True | The ID of the API key. Type: integer (int64). Must be included in the URL path. Required. |
Deletes an API key identified by its ID. This is a DELETE operation. If successful, returns status 200 or 204 (No Content).
| Name | Type | Required Field | Description |
|---|---|---|---|
| key_id | integer | True | The ID of the API key. Type: integer (int64). Must be included in the URL path. Required. |