Deleting a Dashboard Group
Function
This API is used to delete a dashboard group.
Calling Method
For details, see Calling APIs.
URI
DELETE /v2/{project_id}/aom/dashboards-folder/{folder_id}
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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
delete_all |
Yes |
Boolean |
Whether to delete dashboards in a dashboard group. |
Request 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.
|
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.