Skip to main content
POST
/
1
/
boards
curl --request POST \
  --url https://api.honeycomb.io/1/boards \
  --header 'Content-Type: application/json' \
  --header 'X-Honeycomb-Team: <api-key>' \
  --data '
{
  "name": "My API Board",
  "description": "A board created via the API with mixed panel types",
  "type": "flexible",
  "panels": [
    {
      "type": "query",
      "query_panel": {
        "query_id": "abc1234e",
        "query_annotation_id": "e4c24a35"
      },
      "position": {
        "x_coordinate": 0,
        "y_coordinate": 0,
        "height": 6,
        "width": 8
      }
    },
    {
      "type": "text",
      "text_panel": {
        "content": "# Welcome to our API Dashboard\n\nThis board shows key metrics for our services."
      },
      "position": {
        "x_coordinate": 8,
        "y_coordinate": 0,
        "height": 3,
        "width": 4
      }
    }
  ],
  "layout_generation": "manual",
  "tags": [
    {
      "key": "team",
      "value": "backend"
    },
    {
      "key": "environment",
      "value": "production"
    }
  ]
}
'
{
  "name": "My Board",
  "type": "flexible",
  "description": "A board created via the API",
  "links": {
    "board_url": "https://ui.honeycomb.io/myteam/environments/myenvironment/board/2NeeaE9bBLd"
  },
  "id": "2NeeaE9bBLd",
  "panels": [
    {
      "type": "<unknown>",
      "query_panel": {
        "query_id": "abc1234e",
        "query_annotation_id": "e4c24a35",
        "query_style": "graph",
        "dataset": "My Dataset",
        "visualization_settings": {
          "hide_compare": false,
          "hide_hovers": false,
          "hide_markers": false,
          "utc_xaxis": false,
          "overlaid_charts": false,
          "charts": [
            {
              "chart_index": 0,
              "chart_type": "default",
              "log_scale": false,
              "omit_missing_values": false
            }
          ]
        }
      },
      "position": {
        "x_coordinate": 1,
        "y_coordinate": 1,
        "height": 1,
        "width": 1
      }
    }
  ],
  "tags": [
    {
      "key": "team",
      "value": "blue"
    }
  ],
  "preset_filters": [
    {
      "column": "app.Service",
      "alias": "Service"
    }
  ]
}

Authorizations

​
X-Honeycomb-Team
string
header
required

A Honeycomb Configuration Key is required to use this API. A Configuration Key can be found in the API Keys section of the environment configuration, which can be found under Environment Settings -> API Keys -> Configuration tab. Check out our documentation to find your API Keys.

More information can be found in Manage Environments.

Body

application/json
​
name
string
required

The name of the Board.

Required string length: 1 - 255
Example:

"My Board"

​
type
enum<string>
required

The type of the board. Only flexible boards are supported.

Available options:
flexible
​
description
string

A description of the Board.

Maximum string length: 1024
Example:

"A board created via the API"

​
panels
(Query Panel · object | SLO Panel · object | Text Panel · object)[]
​
layout_generation
enum<string>
default:manual

The layout generation mode for the board. When set to "auto", the board will be automatically laid out based on the panels. When set to "manual", the board will be laid out manually by the user.

Available options:
auto,
manual
​
tags
object[]

A list of key-value pairs to help identify the Trigger.

Maximum array length: 10
Example:
[{ "key": "team", "value": "blue" }]
​
preset_filters
object[]

A list of preset filters to apply to the board. For backwards compatibility, if no preset filters are provided, the existing preset filters will be preserved. If an empty array is provided, all preset filters will be deleted. Note: Each board is limited to a maximum of 5 preset filters. Attempting to create or update a board with more than 5 preset filters will result in an error.

Maximum array length: 5
Example:
[
  {
    "column": "app.Service",
    "alias": "Service"
  }
]

Response

Created

​
name
string
required

The name of the Board.

Required string length: 1 - 255
Example:

"My Board"

​
type
enum<string>
required

The type of the board. Only flexible boards are supported.

Available options:
flexible
​
description
string

A description of the Board.

Maximum string length: 1024
Example:

"A board created via the API"

​
links
object
​
id
string

Unique identifier (ID), returned in response bodies.

Example:

"2NeeaE9bBLd"

​
panels
(Query Panel · object | SLO Panel · object | Text Panel · object)[]
​
tags
object[]

A list of key-value pairs to help identify the Trigger.

Maximum array length: 10
Example:
[{ "key": "team", "value": "blue" }]
​
preset_filters
object[]

A list of preset filters to apply to the board. For backwards compatibility, if no preset filters are provided, the existing preset filters will be preserved. If an empty array is provided, all preset filters will be deleted. Note: Each board is limited to a maximum of 5 preset filters. Attempting to create or update a board with more than 5 preset filters will result in an error.

Maximum array length: 5
Example:
[
  {
    "column": "app.Service",
    "alias": "Service"
  }
]