List API keys
GET/v1/api-keys
Parameters
| Field | Type | Required |
|---|---|---|
cursorquery | string | no |
limitquery | integer | no |
Responses
200KeyList400401403404409412413415422428429503
API reference
API keys
Issuing, suspending and revoking keys.
Create an API key
POST/v1/api-keys
Request bodyKeyCreate
| Field | Type | Required |
|---|---|---|
name | string | yes |
scopes | array of string | yes |
expires_at | string (date-time) | yes |
environment | enum: test, live | yes |
Responses
201KeyIssued400401403404409412413415422428429503
Revoke an API key
POST/v1/api-keys/{key_id}/revoke
Parameters
| Field | Type | Required |
|---|---|---|
key_idpath | string (uuid) | yes |
Request bodyReasonAction
| Field | Type | Required |
|---|---|---|
reason_code | string | yes |
note | string | no |
Responses
200Key400401403404409412413415422428429503
Suspend an API key
POST/v1/api-keys/{key_id}/suspend
Temporary containment: the key stops authenticating (403 credential_suspended) until resumed. Evidence and history are kept.
Parameters
| Field | Type | Required |
|---|---|---|
key_idpath | string (uuid) | yes |
Request bodyReasonAction
| Field | Type | Required |
|---|---|---|
reason_code | string | yes |
note | string | no |
Responses
200Key400401403404409412413415422428429503
Resume an API key
POST/v1/api-keys/{key_id}/resume
Restores a suspended key. Revoked or expired keys cannot be resumed.
Parameters
| Field | Type | Required |
|---|---|---|
key_idpath | string (uuid) | yes |
Request bodyReasonAction
| Field | Type | Required |
|---|---|---|
reason_code | string | yes |
note | string | no |
Responses
200Key400401403404409412413415422428429503