Skip to main content

Delete dashboards

Camunda 7 only

The dashboards deletion API allows you to delete dashboards by ID from Optimize.

Heads up!

The deletion of a dashboard does not affect the referenced reports.

Method & HTTP target resource​

DELETE /api/public/dashboard/{dashboard-ID}

Where dashboard-ID is the ID of the dashboard you wish to delete.

Request headers​

The following request headers have to be provided with every delete request:

HeaderConstraintsValue
AuthorizationREQUIREDSee Authorization

Query parameters​

No query parameters available.

Request body​

No request body is required.

Result​

No response body.

Response codes​

Possible HTTP Response status codes:

CodeDescription
204Request successful.
401Secret incorrect or missing in HTTP Header. See Authorization on how to authenticate.
404The requested dashboard was not found, please check the provided dashboard-ID.
500Some error occurred while processing the request, best check the Optimize log.

Example​

Delete a dashboard​

Let's assume you want to delete a dashboard with the ID e6c5abb1-6a18-44e7-8480-d562d511ba62, this is what it would look like:

DELETE /api/public/dashboard/e6c5aaa1-6a18-44e7-8480-d562d511ba62

Request header​

Authorization: Bearer mySecret

Response​

Status 204.