API Keys
API keys authenticate your requests, see Authentication. This endpoint lets you see which keys exist and what roles they have. The key secret itself is never returned.
Keys with the Read Only or Admin role can call it. The list is small and not paginated. An account can have up to 10 keys.
List API Keys
Section titled “List API Keys”GET /account/{accountId}/apikey
| Required role |
|---|
| Admin or Read Only |
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
accountId | number | Yes | Your account ID. |
Response
Status 200.
| Name | Type | Description |
|---|---|---|
items | array | The account’s API keys, described below. |
| Name | Type | Description |
|---|---|---|
accountId | number | The account ID. |
id | number | The key ID. This is not the secret. |
name | string | The key name. |
roles | array of strings | The key’s roles: admin, read-only, alert-push. |
Notes
- Write actions taken with a key (anything that creates, changes, or deletes) appear in the audit log with the key ID and name as the actor.
- After you revoke a key or change its roles, it can take a few minutes to take effect.