Free cookie consent management tool by TermsFeed
View this page in the latest version of Appian.

Disconnect a Robot

The capabilities described on this page are included in Appian's standard capability tier. Usage limits may apply.

Tip:  Remember to include the appropriate authentication headers in your HTTP request message when using this method.

Disconnect a robot
Copy link to clipboard

POST: /node/disconnect

This method disconnects a single robot. When the robot is disconnected, the agent is still running but will no longer receive robotic task instructions.

Request body
Copy link to clipboard

Parameter Example Required? Description
nodeId 5da9a68106931e0e1d1246b6#1 Yes Unique ID of the robot

Example request body:

1
2
3

{
    "nodeId" : "5da9a68106931e0e1d1246b6#1"
}

Copy

Response
Copy link to clipboard

The call is successful if "invocationResult" = "OK".

This endpoint doesn't return any other data.

Example response body:

1
2
3
4
5
6
7
8

{
    "invocationResult": "OK",
    "result": {
        "lastUpdated": 1671122208677,
        "errorMessage": null
    },
    "exceptionThrownText": null
}

Copy

Troubleshooting
Copy link to clipboard

Possible reasons calls may be unsuccessful ("invocationResult" = "KO"):

  • The robot ID is null or invalid.
  • The requester doesn't have access to the robot.

Feedback
Copy link to clipboard