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

Error

A valid request URL is required to generate request examples

200

valid

{
  "valid": true,
  "errors": [],
  "normalized": {
    "name": "My Dashboard",
    "tiles": []
  }
}

Autorizações

Authorization · string · header · obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Corpo

application/json

name · string · obrigatório

Dashboard name.

Maximum string length: 1024

Exemplo:

"New Dashboard"

tiles · object[] · obrigatório

List of tiles/charts to include in the dashboard.

Maximum array length: 500

Show child attributes

tags · string[]

Tags for organizing and filtering dashboards.

Maximum array length: 50

Maximum string length: 32

Exemplo:

["development"]

filters · object[]

Dashboard filter keys to add to the dashboard and apply across all tiles

Show child attributes

savedQuery · string | null

Optional default dashboard query to persist on the dashboard.

Exemplo:

"service.name = 'api'"

savedQueryLanguage · enum<string> | null · padrão: lucene

Query language used by savedQuery.

Opções disponíveis: sql, lucene

Exemplo:

"sql"

savedFilterValues · object[]

Optional default dashboard filter values to persist on the dashboard.

Show child attributes

containers · object[]

Optional grouping containers. Each tile may join a container via tile.containerId, and a tab inside it via tile.tabId.

Maximum array length: 50

Show child attributes

Resposta

200

application/json

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.).

valid · boolean · obrigatório

True when the body passes all validation rules.

errors · object[] · obrigatório

Validation errors. Empty when valid is true.

Show child attributes

normalized · object | null · obrigatório

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.