Dashboards

Validate Dashboard

Validates a dashboard body against the same schema and tile rules used by POST /api/v2/dashboards. The dashboard is never persisted. Use this endpoint at plan time (e.g. from a Terraform provider) to check that a dashboard configuration is valid before applying it.

post/api/v2/dashboards/validate

Request body

namestring required

Dashboard name.

tagsstring[]

Tags for organizing and filtering dashboards.

savedQuerystring nullable

Optional default dashboard query to persist on the dashboard.

savedQueryLanguage'sql' | 'lucene'

Query language for the where clause.

Response

Validation result. HTTP 200 is always returned for valid and invalid bodies — a non-200 response means the request itself failed (auth, server error, etc.).

validboolean required

True when the body passes all validation rules.

normalizedobject nullable required

The parsed dashboard body with defaults applied (no persistence, so no server-assigned tile IDs). Populated when valid is true, null when valid is false.

Changes

Changed in 10 of the 60 revisions of this API.2225

Aug 26, 20263399efdca551121See the full diff
- ▲
  the savedFilterValues/items/ request property type/format changed from object/ to /
  request-property-type-changed
- ●
  removed the request property savedFilterValues/items/condition
  request-property-removed
- ●
  removed the request property savedFilterValues/items/type
  request-property-removed
- ○
  added SqlSavedFilterValue VariableSavedFilterValue to the savedFilterValues/items/ request property oneOf list
  request-property-one-of-added
Aug 21, 2026657a080bc5477See the full diff
- ○
  added the new optional request property tiles/items/allOf[TileBase]/config/oneOf[BarChartConfig]/oneOf[BarBuilderChartConfig]/formulas
  new-optional-request-property
- ○
  added the new optional request property tiles/items/allOf[TileBase]/config/oneOf[BarChartConfig]/oneOf[BarBuilderChartConfig]/showOperandSeries
  new-optional-request-property
- ○
  added the new optional request property tiles/items/allOf[TileBase]/config/oneOf[LineChartConfig]/oneOf[LineBuilderChartConfig]/formulas
  new-optional-request-property
- ○
  added the new optional request property tiles/items/allOf[TileBase]/config/oneOf[LineChartConfig]/oneOf[LineBuilderChartConfig]/showOperandSeries
  new-optional-request-property
- ○
  added the new optional request property tiles/items/allOf[TileBase]/config/oneOf[NumberChartConfig]/oneOf[NumberBuilderChartConfig]/formulas
  new-optional-request-property
- ○
  added the new optional request property tiles/items/allOf[TileBase]/config/oneOf[TableChartConfig]/oneOf[TableBuilderChartConfig]/formulas
  new-optional-request-property
- ○
  added the new optional request property tiles/items/allOf[TileBase]/config/oneOf[TableChartConfig]/oneOf[TableBuilderChartConfig]/showOperandSeries
  new-optional-request-property
Aug 19, 2026f6841a440c383See the full diff
- ○
  added the new optional request property filters/items/isBroadcastEnabled
  new-optional-request-property
- ○
  added the new optional request property filters/items/isVariableEnabled
  new-optional-request-property
- ○
  added the new optional request property filters/items/variableName
  new-optional-request-property
Aug 7, 202619ec53ae02e04See the full diff
- ○
  the tiles/items/allOf[TileBase]/config/oneOf[BarChartConfig]/oneOf[BarBuilderChartConfig]/seriesLimit request property's min was decreased from 1.00 to 0.00
  request-property-min-decreased
- ○
  the tiles/items/allOf[TileBase]/config/oneOf[CategoricalBarChartConfig]/oneOf[CategoricalBarBuilderChartConfig]/limit request property's min was decreased from 1.00 to 0.00
  request-property-min-decreased
- ○
  the tiles/items/allOf[TileBase]/config/oneOf[LineChartConfig]/oneOf[LineBuilderChartConfig]/seriesLimit request property's min was decreased from 1.00 to 0.00
  request-property-min-decreased
- ○
  the tiles/items/allOf[TileBase]/config/oneOf[PieChartConfig]/oneOf[PieBuilderChartConfig]/limit request property's min was decreased from 1.00 to 0.00
  request-property-min-decreased
Aug 4, 202675cd108f32f72See the full diff
- ○
  added the new optional request property tiles/items/allOf[TileBase]/config/oneOf[BarChartConfig]/oneOf[BarBuilderChartConfig]/seriesLimit
  new-optional-request-property
- ○
  added the new optional request property tiles/items/allOf[TileBase]/config/oneOf[LineChartConfig]/oneOf[LineBuilderChartConfig]/seriesLimit
  new-optional-request-property
Jul 10, 2026b548b53bdc942See the full diff
- ○
  added the new optional request property tiles/items/allOf[TileBase]/config/oneOf[CategoricalBarChartConfig]/oneOf[CategoricalBarBuilderChartConfig]/orderBy
  new-optional-request-property
- ○
  added the new optional request property tiles/items/allOf[TileBase]/config/oneOf[PieChartConfig]/oneOf[PieBuilderChartConfig]/orderBy
  new-optional-request-property
Jul 9, 2026d3f0d5ec527e3See the full diff
- ○
  added the new optional request property tiles/items/allOf[TileBase]/config/oneOf[PieChartConfig]/oneOf[PieBuilderChartConfig]/limit
  new-optional-request-property
- ○
  added bar discriminator mapping keys to the tiles/items/allOf[TileBase]/config request property
  request-property-discriminator-mapping-added
- ○
  added CategoricalBarChartConfig to the tiles/items/allOf[TileBase]/config request property oneOf list
  request-property-one-of-added
Jul 8, 20263f2f1a8cf0bc2See the full diff
- ○
  added event_patterns discriminator mapping keys to the tiles/items/allOf[TileBase]/config request property
  request-property-discriminator-mapping-added
- ○
  added EventPatternsChartConfig to the tiles/items/allOf[TileBase]/config request property oneOf list
  request-property-one-of-added
Jul 1, 20265396afb666e31See the full diff
- ○
  endpoint added
  endpoint-added
Jan 30, 2026ed852374c4511See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 100 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history