Help Center/Cloud Eye/API Reference/API V2/Dashboards/Creating or Copying a Dashboard
Updated on 2025-12-02 GMT+08:00
View PDF

Creating or Copying a Dashboard

Function

This API is used to create or copy a dashboard.

Constraints

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

URI

POST /v2/{project_id}/dashboards

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. It is used to specify the project that an asset belongs to. You can query the assets of a project by project ID. You can obtain the project ID from the API or console. For details, see Obtaining a Project ID.

Constraints

N/A

Range

1 to 64 characters

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

No

String

Definition

MIME type of the request body.

Constraints:

None

Value range:

The value can contain 1 to 64 characters.

Default value:

The default type is application/json; charset=UTF-8.

X-Auth-Token

No

String

Definition

User token.

Constraints:

None

Value range:

The value can contain 1 to 16,384 characters.

Default value:

None

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

dashboard_name

Yes

String

Description

Custom dashboard name.

Constraints

N/A

Range

The value allows 1 to 128 characters and can only contain letters, digits, underscores (_), and hyphens (-).

Default Value

N/A

enterprise_id

No

String

Definition

Enterprise project ID.

Constraints

N/A

Range

The value allows 36 characters. It can only contain lowercase letters, digits, hyphens (-), and underscores (_). You can customize an enterprise project ID. It can also be 0 (default enterprise project ID).

Default Value

N/A

dashboard_id

No

String

Description

Dashboard ID.

Constraints

N/A

Range

The value starts with db and is followed by 22 characters of letters, digits, or a combination of both. The total length is 24 characters.

Default Value

N/A

row_widget_num

No

Integer

Description

How a graph is displayed.

Constraints

N/A

Range

  • 0: You can customize top and left of the graph.

  • 1: one graph per row

  • 2: two graphs per row

  • 3: three graphs per row

Default Value

3

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

dashboard_id

String

Description

Dashboard ID.

Range

The value starts with db and is followed by 22 characters of letters, digits, or a combination of both. The total length is 24 characters.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Status codes customized by each cloud service when a request error occurs.

error_msg

String

Request error message.

request_id

String

Request ID.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Status codes customized by each cloud service when a request error occurs.

error_msg

String

Request error message.

request_id

String

Request ID.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Status codes customized by each cloud service when a request error occurs.

error_msg

String

Request error message.

request_id

String

Request ID.

Example Requests

{
  "dashboard_name" : "dashboard_name",
  "enterprise_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "dashboard_id" : "dbxxxxxxxxxxxxxxxxxxxxxx",
  "row_widget_num" : 3
}

Example Responses

Status code: 201

OK

{
  "dashboard_id" : "dbxxxxxxxxx"
}

Status Codes

Status Code

Description

201

OK

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.

Error Codes

See Error Codes.

Parent topic:Dashboards