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. Note: Each board is limited to a maximum of 5 preset filters. Attempting to update a board with more than 5 preset filters will result in an error.

Request body

namestring required

The name of the Board.

descriptionstring

A description of the Board.

type'flexible' required

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

idstring

Unique identifier (ID), returned in response bodies.

layout_generation'auto' | '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.

Example request

{
  "name": "My Board",
  "description": "A board created via the API",
  "links": {
    "board_url": "https://ui.honeycomb.io/myteam/environments/myenvironment/board/2NeeaE9bBLd"
  },
  "id": "2NeeaE9bBLd",
  "panels": [
    {
      "query_panel": {
        "query_id": "abc1234e",
        "query_annotation_id": "e4c24a35",
        "dataset": "My Dataset",
        "visualization_settings": {
          "charts": [
            {
              "thresholds": [
                {
                  "value": 100,
                  "label": "Critical",
                  "color": "red",
                  "operation": "gt",
                  "line_style": "filled-solid"
                }
              ]
            }
          ]
        }
      }
    }
  ],
  "tags": [
    {
      "key": "team",
      "value": "blue"
    }
  ],
  "preset_filters": [
    {
      "column": "app.Service",
      "alias": "Service"
    }
  ]
}

Response

Success