Skip to main content
ZStack
Monitoring & Collection/Grafana Dashboards

ValidateDashboardPanels

Validate that a set of panels fits within canvas bounds and has no overlaps

POST/api/v1/monitoring/dashboards/validate

Operation ID

ValidateDashboardPanels

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • panels
    ListRequired

    Panels for this resource

    Example: (nested array)

    • panelId
      String

      Unique identifier of the panel within the dashboard

      Example: panel-cpu-001

    • x
      Integer

      Horizontal grid position of the panel

      Example: 20

    • y
      Integer

      Vertical grid position of the panel

      Example: 20

    • w
      Integer

      Width of the panel in grid units

      Example: 12

    • h
      Integer

      Height of the panel in grid units

      Example: 8

  • maxPanelOverride
    IntegerRequired

    Override max panel count for this validation request

    Example: 20

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • valid
    Boolean

    Whether the panel layout passed validation

    Example: true

  • errorCode
    String

    Machine-readable error code if validation failed

    Example: INVALID_CONFIG

  • conflicts
    List

    Conflicts for this resource

    Example: (nested array)

    • panelAId
      String

      ID of the first panel in the overlap

      Example: panel-cpu-001

    • panelBId
      String

      ID of the second panel in the overlap

      Example: panel-mem-002

    • overlapX
      Integer

      X coordinate of the overlap region

      Example: 6

    • overlapY
      Integer

      Y coordinate of the overlap region

      Example: 20

    • overlapW
      Integer

      Width of the overlap region

      Example: 2

    • overlapH
      Integer

      Height of the overlap region

      Example: 4

  • boundErrors
    List

    Bound errors

    Example: (nested array)

    • panelId
      String

      ID of the panel that exceeds canvas bounds

      Example: panel-cpu-001

    • field
      String

      Name of the field that caused the bound error (e.g. x, w, h)

      Example: w

    • value
      Integer

      Value that exceeded the bound

      Example: 25

    • message
      String

      Human-readable bound error description

      Example: panel width 25 exceeds canvas width 24

  • panelCount
    Integer

    Number of panels in the layout

    Example: 6

  • maxPanels
    Integer

    Maximum allowed panels for this dashboard

    Example: 20

  • suggestion
    String

    Suggestion for resolving validation issues

    Example: consider increasing the threshold