On this page

Show all

Help Center/ KooPhone/ API Reference/ APIs/ Instance Management/ Resetting Instances in Batches

Resetting Instances in Batches

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

View PDF

Function

This API is used to reset instances in batches.

Before calling this API, ensure that the tenant has purchased a KooPhone cloud phone instance.

After this API is called, the current instances will be initialized.

URI

POST /v1/instances/batch-reset

Request Parameters

**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.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
error_code	String	Response code, which can be KOOPHONE.API.xxxx or common.00000xxx.
error_msg	String	Response description.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Response code, which can be KOOPHONE.API.xxxx or common.00000xxx.
error_msg	String	Response description.

Status code: 500

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Response code, which can be KOOPHONE.API.xxxx or common.00000xxx.
error_msg	String	Response description.

Example Requests

/v1/instances/batch-reset 

{
  "instance_ids" : [ "a44uhlf7", "efjy72gs" ]
}

Example Responses

Status code: 200

Normal response.

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

Status Codes

Status Code	Description
200	Normal response.
400	Bad Request
500	Internal Server Error

Error Codes

See Error Codes.

Parent topic: Instance Management

Previous topic: Querying Instance Status in Batches

Next topic: Obtaining device_token Before Streaming

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

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.

Chatbot