Stop Agent

Stop Agent

Stop agent on the specified resources

Request
URI
PUT
https://{api_host}/suite-api/api/applications/agents/stop
COPY
Request Body

IDs of resources

resource-parameters of type(s) application/json
Required

Show optional properties

{
    "contextResourceIDs": [
        {}
    ]
}
"{\n  \"contextResourceIDs\" : [ \"c1a8f642-e585-422d-9882-ac33570b0bd9\", \"ed757041-34da-4921-804b-4c0a0e9b05e4\" ]\n}"
array of string
contextResourceIDs
Required

Collection of resource IDs

Authentication
This operation uses the following authentication methods.
Responses
200

The result of task status

Returns agent-task-statuses of type(s) application/json
"{\n  \"taskStatuses\" : [ {\n    \"taskID\" : \"task_id_1\",\n    \"resources\" : [ \"vm_id_1\", \"vm_id_2\" ]\n  }, {\n    \"taskID\" : \"task_id_2\",\n    \"resources\" : [ \"vm_id_3\", \"vm_id_4\" ]\n  } ]\n}"
array of object
taskStatuses
Required

Collection of agent task statuses


Code Samples
COPY
                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"contextResourceIDs":["string"]}' https://{api_host}/suite-api/api/applications/agents/stop