Updated on 2025-10-23 GMT+08:00

Deleting a Dashboard Group

Function

This API is used to delete a dashboard group.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    aom:view:delete

    Write

    -

    -

    -

    -

URI

DELETE /v2/{project_id}/aom/dashboards-folder/{folder_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which can be obtained from the console or by calling an API. For details, see Obtaining a Project ID.

folder_id

Yes

String

Dashboard group ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

delete_all

Yes

Boolean

Whether to delete dashboards in a dashboard group.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token obtained from IAM. For details, see Obtaining a Token.

Content-Type

Yes

String

Message body type or format. Content type, which is application/json.

Enterprise-Project-Id

No

String

Enterprise project ID. For details, see Obtaining an Enterprise Project ID.

  • To delete the instances in an enterprise project, enter the enterprise project ID.

  • If this parameter is not specified, the instances in enterprise project 0 are deleted by default.

Response Parameters

Status code: 200

OK: The request is successful.

None

Example Requests

Delete a dashboard group.

https://{Endpoint}/v2/{project_id}/aom/dashboards-folder/199dc141-****-****-****-fe706****3aa?delete_all=false

Example Responses

None

Status Codes

Status Code

Description

200

OK: The request is successful.

Error Codes

See Error Codes.