Delete Dashboard

Version 4.0.24.20 (latest)

Delete the dashboard with the specified id

Permanently deletes a dashboard. (The dashboard cannot be recovered after this operation.)

"Soft" delete or hide a dashboard by setting its deleted status to True with update_dashboard().

Note: When a dashboard is deleted in the UI, it is soft deleted. Use this API call to permanently remove it, if desired.

Request

DELETE /dashboards/{dashboard_id}
Datatype
Description
Request
HTTP Request
path
HTTP Path
Expand HTTP Path definition...
dashboard_id
string
Id of dashboard

Response

204: Successfully deleted.

Datatype
Description
(string)
string

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

405: Resource Can't Be Modified

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

429: Too Many Requests

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

Examples