Key Management
List all API Keys
Changed onList all API Keys for a Team.
get/2/teams/{teamSlug}/api-keys
Request
- Base URLhttps://api.honeycomb.io
- URLhttps://api.honeycomb.io/2/teams/{teamSlug}/api-keys
- AuthHTTP bearer
Query parameters
page[after]string
The string value of the next attribute from a previous result page. The cursor value must be empty or omitted for the first request of a cursor-paginated query.
page[size]number
The number of entries to include per response. Maximum value is 100.
filter[type]'configuration' | 'ingest'
Specifies the type of API key to return. This parameter accepts the following values:
- ingest: Returns only ingest API keys.
- configuration: Returns only configuration API keys.
The endpoint will default to fetching all API keys regardless of type if this filter is omitted.
Response
Success
Example response
{
"data": [
{
"id": "hcxik_12345678901234567890123456",
"attributes": {
"key_type": "ingest",
"name": "us-west-2 collectors key",
"description": "Used by the checkout service in prod. Rotate in AWS Secrets Manager.",
"timestamps": {
"created": "2022-09-22T17:32:11Z",
"updated": "2022-10-31T15:08:11Z"
}
},
"relationships": {
"environment": {
"data": {
"id": "hxenv_12345678901234567890123456"
}
},
"creator": {
"data": {
"id": "hcxus_01hzqr5g7jg9qz40xtgx7rjwj0"
}
},
"editor": {
"data": {
"id": "hcxus_01hzqr5g7jg9qz40xtgx7rjwj0"
}
}
},
"links": {
"self": "/2/teams/my-team/api-keys/hcxik_12345678901234567890123456"
}
}
],
"links": {
"next": "/2/teams/my-team/api-keys?page[after]=3025fa645ad1100d&page[size]=10"
}
}Changes
- info
added the optional property
/////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
/////to the response with the status - info
added
ingestconfigurationdiscriminator mapping keys to the//response property for the response status
- info