DeletePolarClawAgent
This operation removes an agent and its associated bindings from a specified PolarClaw.
Operation description
Usage notes
A successful operation returns the ID of the deleted agent and the number of removed bindings.
Ensure you provide the correct target
AgentId. An incorrect ID can cause the operation to fail or affect an unintended agent.
Try it now
Test
RAM authorization
Request syntax
POST HTTP/1.1
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ApplicationId |
string |
Yes |
The application ID. |
pa-************** |
| AgentId |
string |
Yes |
The ID of the agent to delete. This parameter cannot be set to |
work |
| DeleteFiles |
boolean |
No |
Specifies whether to delete the working directory and session files. Default value: |
true |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response schema. |
||
| RequestId |
string |
The request ID. |
2281C6C9-CBAB-1AFD-8400-670750CF6025_2212 |
| Message |
string |
The response message. |
successful |
| Code |
integer |
The status code. |
200 |
| ApplicationId |
string |
The application ID. |
pa-************** |
| AgentId |
string |
The ID of the deleted agent. |
work |
| RemovedBindings |
integer |
The number of automatically removed bindings. |
1 |
Examples
Success response
JSON format
{
"RequestId": "2281C6C9-CBAB-1AFD-8400-670750CF6025_2212",
"Message": "successful",
"Code": 200,
"ApplicationId": "pa-**************",
"AgentId": "work",
"RemovedBindings": 1
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.