Dashboards

Update Dashboard

Changed on

Updates a dashboard's metadata and returns the id of the updated dashboard. Only the provided fields are changed.

put/v1/dashboards/{dashboardId}

Request

Path parameters

dashboardIdstring required

The id of the dashboard.

Request body

namestring

The dashboard's new name.

descriptionstring nullable

The dashboard's new description.

privateboolean

Whether the dashboard is private to its creator.

Response

The id of the updated dashboard.

successboolean required

Indicates if the request was successful.

deprecatedboolean required

Indicates if this endpoint is deprecated.

Changes