Project data modelsDashboards

Update Dashboard

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

Path parameters

dashboardIdstringRequired
The id of the dashboard.

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Request

The dashboard metadata fields to update.
namestringOptional
The dashboard's new name.
descriptionstring or nullOptional
The dashboard's new description.
privatebooleanOptional
Whether the dashboard is private to its creator.

Response

The id of the updated dashboard.
successboolean
Indicates if the request was successful.
dataobject
The id of the affected dashboard or widget.
deprecatedboolean
Indicates if this endpoint is deprecated.