Update Dashboard

PUThttps://api.confident-ai.com/v1/dashboards/{dashboardId}

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

PUT/v1/dashboards/{dashboardId}

curl -X PUT "https://api.confident-ai.com/v1/dashboards/{dashboardId}" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Renamed Dashboard"
}'

200

{
  "success": true,
  "data": {
    "id": "DASHBOARD-ID"
  },
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Path parameters

dashboardIdstringRequired
The id of the dashboard.

Request body

namestring
The dashboard's new name.
descriptionstring
The dashboard's new description.
privateboolean
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.
Show 1 propertyHide 1 property
- idstring
  The id of the affected dashboard or widget.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI