API keys of the project
GET /api_keys
Never the key value; the prefix identifies a key to the person who holds it.
Parameters
| Name | In | Type | Required | Description |
|---|
page | query | integer | No | (minimum 1, default 1) |
per_page | query | integer | No | (minimum 1, maximum 100, default 25) |
name | query | string | No | Exact name (maximum length 64) |
sort | query | string | No | <field>:asc|desc; fields id, name, created; default created:desc (pattern ^(id|name|created):(asc|desc)$) |
Responses
| Status | Description |
|---|
200 | Keys, newest first by default |
401 | No valid API key |
403 | The key's scope or the organization's subscription does not allow the request (forbidden), or a quota is exhausted (resource_limit_exceeded) |
422 | A field is missing or malformed (invalid_input, details.fields) or an Idempotency-Key was reused with a different request (idempotency_key_mismatch) |
429 | The key's allowance is used up |
Response body
| Field | Type | Required | Description |
|---|
api_keys | array of ApiKey | Yes | |
meta | Meta | Yes | |
One API key
GET /api_keys/{id}
Parameters
| Name | In | Type | Required | Description |
|---|
id | path | string (uuid) | Yes | |
Responses
| Status | Description |
|---|
200 | The key |
401 | No valid API key |
403 | The key's scope or the organization's subscription does not allow the request (forbidden), or a quota is exhausted (resource_limit_exceeded) |
404 | No such resource in this project |
429 | The key's allowance is used up |
Response body
| Field | Type | Required | Description |
|---|
api_key | ApiKey | Yes | |