Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Honeycomb Boards API

Boards are a place to pin and save useful queries/graphs, SLO panels, text panels, and views you want to retain for later reuse and reference.Boards can contain multiple panel types:- **Query panels**: Display saved queries/graphs- **SLO panels**: Monitor Service Level Objectives- **Text panels**: Add markdown-formatted text and documentation- **Views**: Filtered perspectives of board data (limited to 50 views per board)Boards also support preset filters (limited to 5 per board) to apply consistent filtering across the board.This API allows you to list, create, update, and delete boards, as well as manage board views.## AuthorizationThe API key must have the **Manage Public Boards** permission. Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/).

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

Tagged areas include Boards. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 10 operations across 4 paths, and defines 18 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

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

10 operations 4 paths 18 schemas 2 DELETE4 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.honeycomb.io
License
Resource Areas
1

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

Boards are a place to pin and save useful queries/graphs, SLO panels, text panels, and views you want to retain for later reuse and reference. Boards can contain multiple panel ty…

POST
/1/boards
Create a Board
createBoard body → 201400401403422429default
GET
/1/boards
List All Boards
listBoards → 200401429default
GET
/1/boards/{boardId}
Get a Board
getBoard 1 param → 200400401403404429default
PUT
/1/boards/{boardId}
Update a Board
updateBoard 1 param body → 200400401404422429default
DELETE
/1/boards/{boardId}
Delete a Board
deleteBoard 1 param → 204401404429default
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 18

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

Tag
object
2 properties 2 required
BoardViewResponse
object
3 properties
CreateBoardViewRequest
object
2 properties 2 required
BoardPanel
object
PresetFilter
object
2 properties 2 required
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
Error
object
A legacy error, containing only a textual description.
1 property
BoardType
string
The type of the board. Only flexible boards are supported.
BoardViewFilter
object
3 properties 2 required
ValidationError
Board
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
TextPanel
object
3 properties 2 required
SLOPanel
object
3 properties 2 required
UpdateBoardViewRequest
object
3 properties 2 required
QueryPanel
object
3 properties 2 required
DetailedError
object
An RFC7807 'Problem Detail' formatted error message.
6 properties 4 required
JSONAPIError
object
A JSONAPI-formatted error message.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

honeycomb-io-boards-api-openapi.yml Raw ↑

Other APIs Honeycomb publishes across the network.

Honeycomb Auth API
Honeycomb Burn Alerts API
Honeycomb Calculated Fields API
Honeycomb Columns API
Honeycomb Dataset Definitions API
Honeycomb Datasets API
Honeycomb Environments API
Honeycomb Events API
Honeycomb Key Management API
Honeycomb Kinesis Events API
Honeycomb Marker Settings API
Honeycomb Markers API