Get Agent Operation Status

Get Agent Operation Status

The response contains information about the bootstrap action status by the given taskId.

Request
URI
GET
https://{api_host}/suite-api/api/applications/agents/{taskId}/status
COPY
Path Parameters
string
taskId
Required

Action identifier (result of the action: POST /api/actions/{id})


Authentication
This operation uses the following authentication methods.
Responses
200

The populated action information

Returns bootstrap-status of type(s) application/json
"{\n  \"taskId\" : \"e17cf1dc-cadf-412e-80df-5ef7e8d36c9f\",\n  \"name\" : \"Bootstrap virtual machines\",\n  \"startDate\" : \"2020-02-10T14:05:28.202Z\",\n  \"bootstrapObjectStatuses\" : [ {\n    \"id\" : \"24236b3c-fd84-4688-8c3f-ad1621c0e462\",\n    \"stage\" : \"INSTALLING\",\n    \"state\" : \"COMPLETED_SUCCESSFULLY\",\n    \"creationDate\" : \"2020-02-10T14:05:28.202Z\",\n    \"messages\" : [ {\n      \"message\" : \"Install operation task failed\",\n      \"level\" : \"ERROR\",\n      \"timestamp\" : \"2020-02-10T14:05:38.202Z\"\n    }, {\n      \"message\" : \"The operation is not allowed in current state\",\n      \"level\" : \"WARN\",\n      \"timestamp\" : \"2020-02-10T14:05:38.202Z\"\n    }, {\n      \"message\" : \"Successfully Dispatched Action: BOOTSTRAPVM\",\n      \"level\" : \"INFO\",\n      \"timestamp\" : \"2020-02-10T14:05:38.202Z\"\n    } ]\n  } ]\n}"
string
taskId
Required

The id of the action result

string
name
Optional

The name of the action

string
startDate
Optional

The start date of the action

array of object
bootstrapObjectStatuses
Optional

Collection of bootstrap object statuses


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/applications/agents/{taskId}/status