How to delete a dashboard via REST API ?

This article offers comprehensive guidelines for users with delete permissions on how to remove a dashboard using the REST API.

Authorization

To execute this action, please ensure that a access token is included in your request header. For details on obtaining the access token, please refer to the relevant documentation here.

Authorization: bearer <token>

Self-Hosted Server

For self-hosted instances, use the following endpoint:

https://{yourdomain}/bi/api/site/<site_identifier>/v4.0/dashboards/dashboardId

Steps to Get the Dashboard ID

1. Access the Dashboard: Navigate to the dashboard you wish to retrieve the ID for.
2. Open the Options Menu: Click on the three dots (ellipsis) located in the right corner of the dashboard.
3. Select the Info Icon: From the dropdown menu, click on the info icon.

5. Locate the Dashboard Id: The displayed item ID in the subsequent window is the Dashboard Id you are looking for.

By following these steps, you can easily find the Dashboard ID for your needs.

Bold BI Cloud Server

For Bold BI Cloud instances, the endpoint is:

https://{yourdomain}/bi/api/v4.0/dashboards/dashboardId

Request Type

• DELETE: This request type is used to delete a dashboard.

Example Request

Here is an example of how to structure your DELETE request:

Responses

The API will return different responses based on the outcome of the request:

• 204 No Content: The item was successfully deleted.

• 400 Bad Request: The item ID is empty. Ensure that the dashboard ID is provided in the request.
• 401 Unauthorized: Access denied. Verify that you have the necessary permissions to delete the item.
• 404 Not Found: Item details not found. Check that the provided dashboard ID is correct.
• 405 Method Not Allowed: The request type was not DELETE. Ensure that you are using the correct HTTP method.
• 417 Expectation Failed: The deletion of the item failed. Check for any additional error messages that may provide more context.

Additional References

To know more about Bold BI APIs