v1

latestOpenAPI 3.1.0Apache 2.02026-07-2685126228.9 KB

Boards

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.

get/1/boards

Response

Success

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 response

[
  {
    "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"
      }
    ]
  }
]