Help Center/ CloudDevice/ API Reference/ APIs/ Instance Management/ Restarting Instances

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

View PDF

Restarting Instances

This API is used to restart cloud phone instances in batches.

POST /v1/instances/reboot

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
x-request-id	Yes	String	Unique ID of a request.
X-Auth-Token	Yes	String	Tenant-level token.

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
instance_ids	Yes	Array of strings	Instance list. The value can contain a maximum of 100 columns.

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
error_code	String	Response code. The error code specification is KooPhone.API.1001, and the number increases in ascending order.
error_msg	String	Error description.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	0: successful. KOOPHONE.API.1000: The request parameter is incorrect. KOOPHONE.API.1001: Insufficient instance permissions. KOOPHONE.API.5005: Not all instances are running. KOOPHONE.API.9999: Internal service error.
error_msg	String	Error message.

Status code: 500

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	0: successful. KOOPHONE.API.1000: The request parameter is incorrect. KOOPHONE.API.1001: Insufficient instance permissions. KOOPHONE.API.5005: Not all instances are running. KOOPHONE.API.9999: Internal service error.
error_msg	String	Error message.

/v1/instances/reboot

{
  "instance_ids" : [ "a44uhlf7" ]
}

Status code: 200

Response to the request for restarting an instance.

{
  "error_code" : "0",
  "error_msg" : "OK"
}

Status Code	Description
200	Response to the request for restarting an instance.
400	Request error.
500	Internal error.

Parent topic: Instance Management

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.