Boards

Boards are a place to pin and save useful queries and graphs you want to retain for later reuse and reference.

This API allows you to list, create, update, and delete Boards.

Authorization

The API key must have the Manage Public Boards permission. Learn more about API keys here.

Create a Board

Create a Board comprised of one or more Queries.

Securityconfiguration_key

Request

Request Body schema: application/json
required

name required	string [ 1 .. 255 ] characters The name of the Board.
description	string [ 0 .. 1024 ] characters A description of the Board.
style	string Deprecated Default: "visual" All boards are displayed visually in the UI. The field can still be sent, but it will have no functional effect in the UI.
column_layout	string Default: "multi" The number of columns to layout on the board. Enum: "multi" "single"
	Array of objects (BoardQuery)
slos	Array of strings A list of SLO IDs to add to the board

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

422

Validation Failed

default

Error

post/1/boards

Request samples

Payload
curl

application/json

{"name": "My Board",
"description": "A board created via the API",
"style": "visual",
"column_layout": "multi",
"queries": [{"caption": "context for this query",
"graph_settings": {"hide_markers": false,
"log_scale": false,
"omit_missing_values": false,
"stacked_graphs": false,
"utc_xaxis": false,
"overlaid_charts": false
},
"query_style": "graph",
"dataset": "My Dataset",
"query_id": "abc1234e",
"query": null,
"query_annotation_id": "e4c24a35"
}
],
"slos": ["BGfyxhFto",
"dF1URaPGL",
"oSxbG7eiA"
]
}

Response samples

application/json

{"name": "My Board",
"description": "A board created via the API",
"style": "visual",
"column_layout": "multi",
"queries": [{"caption": "context for this query",
"graph_settings": {"hide_markers": false,
"log_scale": false,
"omit_missing_values": false,
"stacked_graphs": false,
"utc_xaxis": false,
"overlaid_charts": false
},
"query_style": "graph",
"dataset": "My Dataset",
"query_id": "abc1234e",
"query_annotation_id": "e4c24a35"
}
],
"slos": ["BGfyxhFto",
"dF1URaPGL",
"oSxbG7eiA"
],
"links": {"board_url": "https://ui.honeycomb.io/myteam/environments/myenvironment/board/2NeeaE9bBLd"
},
"id": "2NeeaE9bBLd"
}

List All Boards

Retrieves a list of all non-secret Boards within an environment. Note: For Honeycomb Classic users, all boards within Classic will be returned.

Securityconfiguration_key

Responses

200

Success

401

Unauthorized

default

Error

get/1/boards

Request samples

curl

Response samples

200
401
default

application/json

[{"name": "My Board",
"description": "A board created via the API",
"style": "visual",
"column_layout": "multi",
"queries": [{"caption": "context for this query",
"graph_settings": {"hide_markers": false,
"log_scale": false,
"omit_missing_values": false,
"stacked_graphs": false,
"utc_xaxis": false,
"overlaid_charts": false
},
"query_style": "graph",
"dataset": "My Dataset",
"query_id": "abc1234e",
"query_annotation_id": "e4c24a35"
}
],
"slos": ["BGfyxhFto",
"dF1URaPGL",
"oSxbG7eiA"
],
"links": {"board_url": "https://ui.honeycomb.io/myteam/environments/myenvironment/board/2NeeaE9bBLd"
},
"id": "2NeeaE9bBLd"
}
]

Get a Board

Get a single Board by ID.

Securityconfiguration_key

Request

path Parameters

boardId

required

string

The unique identifier (ID) of a Board.

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

default

Error

get/1/boards/{boardId}

Request samples

curl

Response samples

application/json

{"name": "My Board",
"description": "A board created via the API",
"style": "visual",
"column_layout": "multi",
"queries": [{"caption": "context for this query",
"graph_settings": {"hide_markers": false,
"log_scale": false,
"omit_missing_values": false,
"stacked_graphs": false,
"utc_xaxis": false,
"overlaid_charts": false
},
"query_style": "graph",
"dataset": "My Dataset",
"query_id": "abc1234e",
"query_annotation_id": "e4c24a35"
}
],
"slos": ["BGfyxhFto",
"dF1URaPGL",
"oSxbG7eiA"
],
"links": {"board_url": "https://ui.honeycomb.io/myteam/environments/myenvironment/board/2NeeaE9bBLd"
},
"id": "2NeeaE9bBLd"
}

Update a Board

Update a Board by specifying its ID and full details.

Note: Queries can be added to, removed from, and re-ordered by updating the board itself. It is not possible to reference individual queries via the API.

Securityconfiguration_key

Request

path Parameters

boardId

required

string

The unique identifier (ID) of a Board.

Request Body schema: application/json
required

name required	string [ 1 .. 255 ] characters The name of the Board.
description	string [ 0 .. 1024 ] characters A description of the Board.
style	string Deprecated Default: "visual" All boards are displayed visually in the UI. The field can still be sent, but it will have no functional effect in the UI.
column_layout	string Default: "multi" The number of columns to layout on the board. Enum: "multi" "single"
	Array of objects (BoardQuery)
slos	Array of strings A list of SLO IDs to add to the board

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

422

Validation Failed

default

Error

put/1/boards/{boardId}

Request samples

Payload
curl

application/json

{"name": "My Board",
"description": "A board created via the API",
"style": "visual",
"column_layout": "multi",
"queries": [{"caption": "context for this query",
"graph_settings": {"hide_markers": false,
"log_scale": false,
"omit_missing_values": false,
"stacked_graphs": false,
"utc_xaxis": false,
"overlaid_charts": false
},
"query_style": "graph",
"dataset": "My Dataset",
"query_id": "abc1234e",
"query": null,
"query_annotation_id": "e4c24a35"
}
],
"slos": ["BGfyxhFto",
"dF1URaPGL",
"oSxbG7eiA"
]
}

Response samples

application/json

{"name": "My Board",
"description": "A board created via the API",
"style": "visual",
"column_layout": "multi",
"queries": [{"caption": "context for this query",
"graph_settings": {"hide_markers": false,
"log_scale": false,
"omit_missing_values": false,
"stacked_graphs": false,
"utc_xaxis": false,
"overlaid_charts": false
},
"query_style": "graph",
"dataset": "My Dataset",
"query_id": "abc1234e",
"query_annotation_id": "e4c24a35"
}
],
"slos": ["BGfyxhFto",
"dF1URaPGL",
"oSxbG7eiA"
],
"links": {"board_url": "https://ui.honeycomb.io/myteam/environments/myenvironment/board/2NeeaE9bBLd"
},
"id": "2NeeaE9bBLd"
}

Delete a Board

Delete a public Board by specifying its ID.

Securityconfiguration_key

Request

path Parameters

boardId

required

string

The unique identifier (ID) of a Board.

Responses

204

Success - no Content

401

Unauthorized

404

Not Found

default

Error

delete/1/boards/{boardId}

Request samples

curl

Response samples

401
404
default

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

➔ Next to Burn Alerts

Boards

Authorization

Create a Board

Request Body schema: application/jsonrequired

List All Boards

Get a Board

path Parameters

Update a Board

path Parameters

Request Body schema: application/jsonrequired

Delete a Board

path Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required