Modifying a Dashboard

Updated on 2025-02-27 GMT+08:00

View PDF

This API is used to modify a dashboard.

This API is not supported in the following five sites: CN East-Qingdao, LA-Mexico City1, TR-Istanbul, AP-Jakarta, and ME-Riyadh.

PUT /v2/{project_id}/dashboards/{dashboard_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant ID. Minimum: 1 Maximum: 64
dashboard_id	Yes	String	Dashboard ID, which starts with db and follows 22 letters and digits. Example: db16564943172807wjOmoLyn Array Length: 24 - 24 Regex Pattern: ^db([a-z]\|[A-Z]\|[0-9]){22}$

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	MIME type of the request body. Default value application/json is recommended. Default: application/json;charset=UTF-8 Minimum: 1 Maximum: 64
X-Auth-Token	Yes	String	User token. It is a response to the API used to obtain a user token. This API is the only one that does not require authentication. The value of X-Subject-Token in the response header is the token value. Minimum: 1 Maximum: 16000

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
dashboard_name	No	String	Custom name of the dashboard. Minimum: 1 Maximum: 128 Regex Pattern: ^([\u4E00-\u9FFF]\|[a-z]\|[A-Z]\|[0-9]\|_\|-)+$
is_favorite	No	Boolean	Whether a dashboard is added to favorites. The value can be true or false.
row_widget_num	No	Integer	How a graph is displayed. 0 indicates that you can customize top and left of the graph. 1 indicates one graph per row. Minimum: 0 Maximum: 3 Default: 3

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Status codes customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Request error message. Minimum: 0 Maximum: 256
request_id	String	Request ID. Minimum: 0 Maximum: 256

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Status codes customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Request error message. Minimum: 0 Maximum: 256
request_id	String	Request ID. Minimum: 0 Maximum: 256

Status code: 500

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Status codes customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Request error message. Minimum: 0 Maximum: 256
request_id	String	Request ID. Minimum: 0 Maximum: 256

{
  "dashboard_name" : "dashboard_name_new",
  "is_favorite" : true,
  "row_widget_num" : 0
}

None

Status Code	Description
204	No Content
400	The server failed to process the request.
401	Token authentication is required.
500	Failed to complete the request because of an internal server error.