Key Management

This API allows you to list, create, update, and delete API Keys for a Team.

List all API Keys

SecuritybearerAuth

Request

path Parameters

teamSlug

required

string

The slug of the Team

query Parameters

page[next]	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. Example: page[next]=eyxJjcmAVhdGVkX
page[size]	number [ 1 .. 100 ] Default: 20 The number of entries to include per response. Maximum Example: page[size]=10

Responses

200

Success

401

Unauthorized

403

Forbidden

404

Not Found

422

Validation Failed

429

RateLimited

500

InternalError

get/2/teams/{teamSlug}/api-keys

Request samples

curl

Response samples

application/vnd.api+json

{"data": [{"id": "hcxik_12345678901234567890123456",
"type": "api-keys",
"attributes": {"key_type": "ingest",
"name": "us-west-2 collectors key",
"disabled": false,
"permissions": {"create_datasets": false
},
"timestamps": {"created": "2022-09-22T17:32:11Z",
"updated": "2022-10-31T15:08:11Z"
}
},
"relationships": {"environment": {"data": {"id": "hxenv_12345678901234567890123456",
"type": "environments"
}
},
"creator": {"data": {"id": "hcxus_01hzqr5g7jg9qz40xtgx7rjwj0",
"type": "users"
}
},
"editor": {"data": {"id": "hcxus_01hzqr5g7jg9qz40xtgx7rjwj0",
"type": "users"
}
}
},
"links": {"self": "/2/teams/my-team/api-keys/hcxik_12345678901234567890123456"
}
}
],
"links": {"next": "/2/teams/my-team/api-keys?page[after]=3025fa645ad1100d&page[size]=10"
}
}

Create an API Key

This creates an API Key, which will return the API Key components in the response. The Key ID will be found at data.relationships.environment.data.id and the Key Secret will be found at data.attributes.secret. For security reasons the Key Secret will only be available during creation so make sure to save it.

To use a newly-created Ingest Key it should be passed in the X-Honeycomb-Team header with the API Key's ID and secret concatenated (and with no separator). For example, X-Honeycomb-Team: hcxik_1234567890123456789012345612345678901234567890123456789012

Check out our best practices for API Keys.

SecuritybearerAuth

Request

path Parameters

teamSlug

required

string

The slug of the Team

Request Body schema: application/vnd.api+json
required

required

object

Responses

201

Created

400

The provided request body was invalid. Most APIs will return a DetailedError for this condition, explaining what went wrong, but some older APIs only return a GenericError.

401

Unauthorized

403

Forbidden

404

Not Found

413

The provided request body was over the maximum allowed size.

415

The provided request body had an invalid Content-Type.

422

Validation Failed

429

RateLimited

500

InternalError

post/2/teams/{teamSlug}/api-keys

Request samples

Payload
curl

application/vnd.api+json

{"data": {"type": "api-keys",
"attributes": {"name": "my ingest key",
"key_type": "ingest",
"permissions": {"create_datasets": true
}
},
"relationships": {"environment": {"data": {"id": "hcxen_12345678901234567890123456",
"type": "environments"
}
}
}
}
}

Response samples

application/vnd.api+json

{"data": {"id": "hcxik_12345678901234567890123456",
"type": "api-keys",
"attributes": {"key_type": "ingest",
"name": "us-west-2 collectors key",
"disabled": false,
"permissions": {"create_datasets": false
},
"timestamps": {"created": "2022-09-22T17:32:11Z",
"updated": "2022-10-31T15:08:11Z"
},
"secret": "12345678901234567890123456789"
},
"relationships": {"environment": {"data": {"id": "hxenv_12345678901234567890123456",
"type": "environments"
}
},
"creator": {"data": {"id": "hcxus_01hzqr5g7jg9qz40xtgx7rjwj0",
"type": "users"
}
},
"editor": {"data": {"id": "hcxus_01hzqr5g7jg9qz40xtgx7rjwj0",
"type": "users"
}
}
},
"links": {"self": "/2/teams/my-team/api-keys/hcxik_12345678901234567890123456"
}
}
}

Get an API Key

SecuritybearerAuth

Request

path Parameters

teamSlug required	string The slug of the Team
ID required	string A unique identifier

Responses

200

Success

400

The provided request body was invalid. Most APIs will return a DetailedError for this condition, explaining what went wrong, but some older APIs only return a GenericError.

401

Unauthorized

404

Not Found

429

RateLimited

500

InternalError

get/2/teams/{teamSlug}/api-keys/{ID}

Request samples

curl

Response samples

application/vnd.api+json

{"data": {"id": "hcxik_12345678901234567890123456",
"type": "api-keys",
"attributes": {"key_type": "ingest",
"name": "us-west-2 collectors key",
"disabled": false,
"permissions": {"create_datasets": false
},
"timestamps": {"created": "2022-09-22T17:32:11Z",
"updated": "2022-10-31T15:08:11Z"
}
},
"relationships": {"environment": {"data": {"id": "hxenv_12345678901234567890123456",
"type": "environments"
}
},
"creator": {"data": {"id": "hcxus_01hzqr5g7jg9qz40xtgx7rjwj0",
"type": "users"
}
},
"editor": {"data": {"id": "hcxus_01hzqr5g7jg9qz40xtgx7rjwj0",
"type": "users"
}
}
},
"links": {"self": "/2/teams/my-team/api-keys/hcxik_12345678901234567890123456"
}
}
}

Update an API Key

SecuritybearerAuth

Request

path Parameters

teamSlug required	string The slug of the Team
ID required	string A unique identifier

Request Body schema: application/vnd.api+json
required

required

object

Responses

200

Success

400

The provided request body was invalid. Most APIs will return a DetailedError for this condition, explaining what went wrong, but some older APIs only return a GenericError.

401

Unauthorized

403

Forbidden

404

Not Found

413

The provided request body was over the maximum allowed size.

415

The provided request body had an invalid Content-Type.

422

Validation Failed

429

RateLimited

500

InternalError

patch/2/teams/{teamSlug}/api-keys/{ID}

Request samples

Payload
curl

application/vnd.api+json

{"data": {"id": "hcxik_12345678901234567890123456",
"type": "api-keys",
"attributes": {"name": "updated key name",
"enabled": false
}
}
}

Response samples

application/vnd.api+json

{"data": {"id": "hcxik_12345678901234567890123456",
"type": "api-keys",
"attributes": {"key_type": "ingest",
"name": "us-west-2 collectors key",
"disabled": false,
"permissions": {"create_datasets": false
},
"timestamps": {"created": "2022-09-22T17:32:11Z",
"updated": "2022-10-31T15:08:11Z"
}
},
"relationships": {"environment": {"data": {"id": "hxenv_12345678901234567890123456",
"type": "environments"
}
},
"creator": {"data": {"id": "hcxus_01hzqr5g7jg9qz40xtgx7rjwj0",
"type": "users"
}
},
"editor": {"data": {"id": "hcxus_01hzqr5g7jg9qz40xtgx7rjwj0",
"type": "users"
}
}
},
"links": {"self": "/2/teams/my-team/api-keys/hcxik_12345678901234567890123456"
}
}
}

Delete an API Key

This deletes and immediately deactivates the API Key. This is an irreversible operation.

SecuritybearerAuth

Request

path Parameters

teamSlug required	string The slug of the Team
ID required	string A unique identifier

Responses

204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

429

RateLimited

500

InternalError

delete/2/teams/{teamSlug}/api-keys/{ID}

Request samples

curl

Response samples

{"error": "unknown API key - check your credentials"
}

➔ Next to Kinesis Events

Key Management

List all API Keys

path Parameters

query Parameters

Create an API Key

path Parameters

Request Body schema: application/vnd.api+jsonrequired

Get an API Key

path Parameters

Update an API Key

path Parameters

Request Body schema: application/vnd.api+jsonrequired

Delete an API Key

path Parameters

Request Body schema: application/vnd.api+json
required

Request Body schema: application/vnd.api+json
required