Dashboards

Update Dashboard

Changed on

Updates an existing dashboard.

Concurrency: This endpoint does not support optimistic concurrency control. Concurrent PUT requests for the same dashboard may silently overwrite each other, which can leave orphan tile-to-container references on layout-shape edits. Clients should serialize edits to a given dashboard.

put/api/v2/dashboards/{id}

Request

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

Path parameters

idstring required

Dashboard ID

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

Successfully updated dashboard

Changes

    • breaking

      added to the /////////////// response property oneOf list for the response status

    • breaking

      added to the /////////////// response property oneOf list for the response status

    • breaking

      added to the /////////////// response property oneOf list for the response status

    • breaking

      added to the /////////////// response property oneOf list for the response status

    • breaking

      added to the /////////////// response property oneOf list for the response status

    • breaking

      added to the /////////////// response property oneOf list for the response status

    • breaking

      added to the /////////////// response property oneOf list for the response status

    • breaking

      added to the /////////////// response property oneOf list for the response status

    • 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

    • info

      added discriminator to /////////////// response property for the response status

    • info

      added promql discriminator mapping keys to the /////////////// response property for the response status

    • info

      added promql discriminator mapping keys to the /////////////// response property for the response status

    • info

      added promql discriminator mapping keys to the /////////////// response property for the response status

    • info

      added promql discriminator mapping keys to the /////////////// response property for the response status

    • info

      added promql discriminator mapping keys to the /////////////// response property for the response status

    • info

      added promql discriminator mapping keys to the /////////////// response property for the response status

    • info

      added promql discriminator mapping keys to the /////////////// response property for the response status

    • 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 ////////////////

    • info

      added the optional property //////////////////// to the response with the status

    • info

      added the optional property ///////////////////// to the response with the status

    • info

      added the optional property //////////////////// to the response with the status

    • info

      added the optional property ///////////////////// to the response with the status