How to rename a dashboard via Rest API ?

This article provides guidance on how to update the name of a dashboard for users with write access.

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>/v5.0/dashboard/rename/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.

4. 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/v5.0/dashboard/rename/dashboardId

Request Type

• PUT: This request type is used to update or modify the dashboard name.

Example Request

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

Request Body Schema

When making a request to create a new category, the following details must be included in the request body:

• DashboardName (required): A string representing the new name for the dashboard.

Example Request Body

{
  "DashboardName": "New Dashboard Name",
}

Responses

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

• 200: DashboardName has been updated successfully.

• 400: The content of the request body is missing or incomplete.
• 401: Access denied.
• 404: Item details not found.
• 405: Request type was not PUT.
• 406: The content of the request body is invalid.
• 409: Item name already exists.

Before Refreshing the page in application,

After refreshing the page in application, a new category will be created as shown below:

Additional References

To know more about Bold BI APIs