DocsICP FilingConsole
Documentation
Home Page Robotic Process Automation Developer Reference Service robot API reference Service bot StopRobots

StopRobots

Updated at:
Copy as MD
Product
My Favorites

Purpose: Stops one or more robots.

Path: rpa/openapi/raas/resource/StopRobots

Method: POST

Usage notes:

  • This operation stops a robot by shutting down its underlying cloud resource, which is currently an Elastic Desktop Service instance. This operation is only supported when the cloud resource is in the running state. If the cloud resource is already stopped or stopping, the service skips that robot to prevent redundant shutdowns.

  • We recommend stopping only one robot per call. If you stop multiple robots in a batch operation, you must ensure that all specified robot IDs are valid. Otherwise, the entire request fails.

  • This is an asynchronous operation. To verify the final result, check the status of the robot in the console or by calling the ListRobots API.

Limitations:

Important

For more information about API usage limits, see Usage limits.

Request parameters:

Parameter

Type

Required

Example

Description

RobotIds

Array of String, serialization: simple

Yes

["657963 ****** D178CAC2FCBD5BD0B4EC", "11DC81 ****** 4E463B1E538436035653"]

The IDs of the robots to stop. You can specify up to 50 robot IDs in a single call. To stop more than 50 robots, submit multiple requests. We recommend specifying only one robot ID per call.

Response parameters:

A Boolean value that indicates whether the request was accepted.

Previous：DeleteRobotsNext：GetAuthCode