Get all API keys
GET {{baseUrl}}/api/v2/api_keys
List all API keys available for your account.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page[size] | number | Size for a given page. The maximum allowed value is 100. | |
page[number] | number | Specific page number to return. | |
sort | string | API key attribute used to sort results. Sort order is ascending | |
| by default. In order to specify a descending sort, prefix the | |||
| attribute with a minus sign. | |||
filter | string | Filter API keys by the specified string. | |
filter[created_at][start] | string | Only include API keys created on or after the specified date. | |
filter[created_at][end] | string | Only include API keys created on or before the specified date. | |
filter[modified_at][start] | string | Only include API keys modified on or after the specified date. | |
filter[modified_at][end] | string | Only include API keys modified on or before the specified date. | |
include | string | Comma separated list of resource paths for related resources to include in the response. Supported resource paths are created_by and modified_by. | |
filter[remote_config_read_enabled] | boolean | Filter API keys by remote config read enabled status. | |
filter[category] | string | Filter API keys by category. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"attributes":{"category":"exercitation Excepteur","created_at":"2020-11-23T10:00:00.000Z","last4":"abcd","modified_at":"2020-11-23T10:00:00.000Z","name":"API Key for submitting metrics","remote_config_read_enabled":false},"id":"voluptate cupidatat esse","relationships":{"created_by":{"data":{"id":"00000000-0000-0000-2345-000000000000","type":"users"}},"modified_by":{"data":{"id":"00000000-0000-0000-2345-000000000000","type":"users"}}},"type":"api_keys"},{"attributes":{"category":"dolore veniam","created_at":"2020-11-23T10:00:00.000Z","last4":"abcd","modified_at":"2020-11-23T10:00:00.000Z","name":"API Key for submitting metrics","remote_config_read_enabled":true},"id":"exercitation do quis officia","relationships":{"created_by":{"data":{"id":"00000000-0000-0000-2345-000000000000","type":"users"}},"modified_by":{"data":{"id":"00000000-0000-0000-2345-000000000000","type":"users"}}},"type":"api_keys"}],"included":[{"attributes":{"created_at":"1984-12-17T07:04:27.304Z","disabled":false,"email":"tempor aliqua","handle":"eu elit Ut amet","icon":"labore l","modified_at":"1990-02-12T03:44:40.115Z","name":"nostrud deserunt tempor proident","service_account":false,"status":"commodo consequat","title":"in sit Ut ad dolor","verified":true},"id":"dolore","relationships":{"org":{"data":{"id":"00000000-0000-beef-0000-000000000000","type":"orgs"}},"other_orgs":{"data":[]},"other_users":{"data":[]},"roles":{"data":[{"id":"3653d3c6-0c75-11ea-ad28-fb5701eabc7d","type":"roles"},{"id":"3653d3c6-0c75-11ea-ad28-fb5701eabc7d","type":"roles"}]}},"type":"users"},{"attributes":{"created_at":"2005-11-27T22:13:29.945Z","disabled":false,"email":"aute nisi ipsum","handle":"dolor eu voluptate occaecat","icon":"sunt ullamco do velit","modified_at":"2009-04-15T14:52:08.249Z","name":"quis Lorem","service_account":false,"status":"fugiat deserunt commodo quis","title":"labore","verified":true},"id":"aute sunt sed sint","relationships":{"org":{"data":{"id":"00000000-0000-beef-0000-000000000000","type":"orgs"}},"other_orgs":{"data":[]},"other_users":{"data":[]},"roles":{"data":[{"id":"3653d3c6-0c75-11ea-ad28-fb5701eabc7d","type":"roles"},{"id":"3653d3c6-0c75-11ea-ad28-fb5701eabc7d","type":"roles"}]}},"type":"users"}],"meta":{"max_allowed":-83556793,"page":{"total_filtered_count":59250628}}}