How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Honeycomb Boards API

The Honeycomb Boards API allows developers to programmatically create and manage boards, which are collections of queries displayed together as a dashboard-like view. Boards provide a way to organize and share related queries for monitoring and debugging workflows. The API supports listing, creating, updating, and deleting boards, making it possible to automate the setup of observability dashboards across environments.

Honeycomb Boards API is one of 22 APIs that Honeycomb publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Dashboards, Observability, and Visualization. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, and 3 JSON Schemas.

This API exposes 10 operations across 4 paths, and defines 23 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.honeycomb.io, https://api.eu1.honeycomb.io.

10 operations 4 paths 23 schemas 2 DELETE4 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.honeycomb.io
Authentication
API Key, API Key, API Key, API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 5

Honeycomb Boards API declares 5 security schemes for authenticating requests. An API key is passed in the header as X-Honeycomb-Team (ApiKeyAuth). An API key is passed in the header as X-Honeycomb-Team (configuration_key). An API key is passed in the header as X-Honeycomb-Team (ingest_key). An API key is passed in the header as X-Amz-Firehose-Access-Key (firehose_access_key). It accepts HTTP bearer tokens (HONEYCOMB_KEY_ID:HONEYCOMB_KEY_SECRET) (bearerAuth).

  • ApiKeyAuth — Honeycomb Configuration API key. Must have appropriate permissions for the endpoint being called.
  • configuration_key — Authenticate using a Honeycomb Configuration Key. Pass the Token in the X-Honeycomb-Team header: http X-Honeycomb-Team: 1234567890123456789012 If you created y…
  • ingest_key — Authenticate using a Honeycomb Ingest Key. Pass the Ingest Key in the X-Honeycomb-Team header: http X-Honeycomb-Team: hc[x]ik1234567890123456789012345612345678…
  • firehose_access_key — We recommend using a Honeycomb Ingest Key to authenticate, though a Configuration Key will work. To learn more about authenticating requests, visit [API Authen…
  • bearerAuth — Authenticate using a Honeycomb Management Key. Pass the Management Key as a Bearer token in the Authorization header: http Authorization: Bearer hcxmk123456789…

Paths & Operations 10

Across 4 paths, the API surfaces 10 operations — 2 DELETE, 4 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Boards 10

Manage boards, which are collections of queries, SLO panels, and text panels displayed together.

GET
/1/boards
List all boards
listBoards → 200401
POST
/1/boards
Create a board
createBoard body → 201401
GET
/1/boards/{boardId}
Get a board
getBoard 2 params → 200401404
PUT
/1/boards/{boardId}
Update a board
updateBoard 2 params body → 200401404
DELETE
/1/boards/{boardId}
Delete a board
deleteBoard 2 params → 204401404
GET
/1/boards/{boardId}/views
List Board Views
listBoardViews 1 param → 200401403404429default
POST
/1/boards/{boardId}/views
Create a Board View
createBoardView 1 param body → 201400401404409422429default
GET
/1/boards/{boardId}/views/{viewId}
Get a Board View
getBoardView 2 params → 200401403404429default
DELETE
/1/boards/{boardId}/views/{viewId}
Delete a Board View
deleteBoardView 2 params → 204401403404429default
PUT
/1/boards/{boardId}/views/{viewId}
Update a Board View
updateBoardView 2 params body → 200400401404409422429default

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are Board (9 properties), Board_2 (9 properties), BoardQueryVisualizationSettings (6 properties), DetailedError (6 properties). Each schema is shown below with its type and property counts.

BoardQuery
object
6 properties
BoardUpdateRequest
object
5 properties
BoardCreateRequest
object
5 properties 1 required
Board
object
9 properties
SLOPanel
object
3 properties 2 required
BoardViewFilter
object
3 properties 2 required
DetailedError
object
An RFC7807 'Problem Detail' formatted error message.
6 properties 4 required
CreateBoardViewRequest
object
2 properties 2 required
Error
object
A legacy error, containing only a textual description.
1 property
UpdateBoardViewRequest
object
3 properties 2 required
BoardType
string
The type of the board. Only flexible boards are supported.
Board_2
object
9 properties 2 required
BoardQueryVisualizationSettings
object
A map of values to control the display settings for the Query on the Board. Unspecified boolean values are assumed to be false. Unspecified integers are assume…
6 properties
PresetFilter
object
2 properties 2 required
Tag
object
2 properties 2 required
TextPanel
object
3 properties 2 required
BoardViewResponse
object
3 properties
Threshold
object
A threshold line to display on a chart, with optional label and styling. Thresholds allow you to visualize important values or boundaries on your charts.
5 properties 4 required
JSONAPIError
object
A JSONAPI-formatted error message.
1 property
ValidationError
BoardPanelPosition
object
The position of the panel within the layout. When X and Y coordinates are not specified for any of the panels, the layout will be generated automatically.
4 properties
BoardPanel
object
QueryPanel
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

honeycomb-boards-api-openapi.yml Raw ↑

Other APIs Honeycomb publishes across the network.

Honeycomb Events API
Honeycomb Queries API
Honeycomb Datasets API
Honeycomb Markers API
Honeycomb Triggers API
Honeycomb Environments API
honeycomb Auth API
honeycomb Burn Alerts API
honeycomb Calculated Fields API
honeycomb Columns API
honeycomb Dataset Definitions API
honeycomb Key Management API
Where this information came from

This is an independent, third-party profile of Honeycomb Boards API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.