Get API key

GET {{baseUrl}}/api/v2/api_keys/:api_key_id

Get an API key.

Request Params

KeyDatatypeRequiredDescription
includestringComma separated list of resource paths for related resources to include in the response. Supported resource paths are created_by and modified_by.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"data":{"attributes":{"category":"labore in consequat","created_at":"2020-11-23T10:00:00.000Z","key":"eu quis ullamco","last4":"abcd","modified_at":"2020-11-23T10:00:00.000Z","name":"API Key for submitting metrics","remote_config_read_enabled":false},"id":"pariatur elit aute fugiat","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":"1954-02-08T22:21:36.630Z","disabled":true,"email":"sunt in","handle":"voluptate nisi reprehenderit enim","icon":"incididunt ut eiusmod","modified_at":"1985-04-07T13:40:41.162Z","name":"mollit","service_account":false,"status":"adipisicing irure nisi","title":"officia do","verified":true},"id":"id anim incididunt ullamco dolor","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":"1971-04-19T13:50:39.290Z","disabled":false,"email":"commodo eiusmod adipisicing pariatur","handle":"sit ipsum Lorem","icon":"ut consectetur laborum","modified_at":"1968-01-08T09:10:30.083Z","name":"quis laboris","service_account":true,"status":"pariatur fugiat ut ex labore","title":"in cillum laboris officia voluptate","verified":true},"id":"nulla ea","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"}]}