Help Center/ DataArts Insight/ API Reference/ Dashboard/ Batch Taking Dashboards Offline

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

CLI Examples

View PDF

Batch Taking Dashboards Offline

This API is used to take dashboards offline in batches.

POST /v1/{project_id}/dashboards/batch-offline

**Table 1** URI parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For how to obtain the project ID, see Obtaining a Project ID.

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Workspace-Id	Yes	String	Workspace ID. For how to obtain it, see Obtaining a Workspace ID.
X-Auth-Token	Yes	String	User token. Obtain a user token by calling IAM's "Obtaining a User Token" API. X-Subject-Token in the response header is the desired user token.

**Table 3** Request body parameter
Parameter	Mandatory	Type	Description
ids	Yes	Array of strings	List of IDs of dashboards to be batch taken offline.

Status code: 200

**Table 4** Response body parameter
Parameter	Type	Description
data	Boolean	Whether the request is successful. The options include true and false.

Take dashboards offline in batches.

https://{endpoint}/v1/{project_id}/dashboards/batch-offline
{
  "ids" : [ "009b3d3e-xxxx-4cc3-xxxx-dc54cd42xxxx" ]
}

Status code: 200

Dashboards are successfully taken offline in batches.

{
  "data" : true
}

Status Code	Description
200	Dashboards are successfully taken offline in batches.

Parent topic: Dashboard

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.