Help Center/ Cloud Eye/ API Reference/ API V2/ Dashboards/ Deleting Dashboards in Batches
Updated on 2025-08-27 GMT+08:00

Deleting Dashboards in Batches

Function

This API is used to delete dashboards in batches.

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.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

POST /v2/{project_id}/dashboards/batch-delete

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Tenant ID.

Constraints:

None

Value range:

Project ID, 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 by calling an API or on the console. For details, see Obtaining a Project ID. The value must contain of 1 to 64 characters.

Default value:

None

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.

Default value:

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_ids

No

Array of strings

Dashboard ID list.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

dashboards

Array of BatchDeleteDashboardRespInfo objects

Response body for deleting dashboards in batches.

Table 5 BatchDeleteDashboardRespInfo

Parameter

Type

Description

dashboard_id

String

Dashboard ID.

Regex Pattern: ^db([a-z]|[A-Z]|[0-9]){22}

ret_status

String

Operation result. The value can be successful or error.

Enumeration values:

  • successful

  • error

error_msg

String

Error message.

Status code: 400

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: 401

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.

Status code: 500

Table 8 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_ids" : [ "dbxxxxxxxxxxxxxxxxxxxxxx", "dbXXXXXXXXXXXXXXXXXXXXXX" ]
}

Example Responses

Status code: 200

OK

{
  "dashboards" : [ {
    "dashboard_id" : "dbxxxxxxxxxxxxxxxxxxxxxx",
    "ret_status" : "successful"
  }, {
    "dashboard_id" : "dbXXXXXXXXXXXXXXXXXXXXXX",
    "ret_status" : "error",
    "error_msg" : "record not found"
  } ]
}

Status Codes

Status Code

Description

200

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.