HYhyperdxio
Dashboards

Validate Dashboard

Changed on

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

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v2/dashboards/validate
  • Auth
    HTTP bearer

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

  • b755030b0f33Revision changes
    • info

      added discriminator to ////////// request property

    • info

      added promql discriminator mapping keys to the ////////// request property

    • info

      added promql discriminator mapping keys to the ////////// request property

    • info

      added promql discriminator mapping keys to the ////////// request property

    • info

      added promql discriminator mapping keys to the ////////// request property

    • info

      added promql discriminator mapping keys to the ////////// request property

    • info

      added promql discriminator mapping keys to the ////////// request property

    • info

      added promql discriminator mapping keys to the ////////// request property

    • info

      added to the ////////// request property oneOf list

    • info

      added to the ////////// request property oneOf list

    • info

      added to the ////////// request property oneOf list

    • info

      added to the ////////// request property oneOf list

    • info

      added to the ////////// request property oneOf list

    • info

      added to the ////////// request property oneOf list

    • info

      added to the ////////// request property oneOf list

    • info

      added to the ////////// request property oneOf list

  • b55e9818c8cfRevision changes
    • info

      added the new optional request property ///////////////

    • info

      added the new optional request property ////////////////

    • info

      added the new optional request property ///////////////

    • info

      added the new optional request property ////////////////