Query Task Status

Query Task Status

The response code corresponds to the task being successfully retrieved, and not to the asynchoronous operation itself. The status of the asynchronous operation can be viewed in the response body.

Tasks are per cell and remain in memory till the respective appliance nodes is rebooted. This means that tasks that were triggered prior to reboot are lost upon reboot.

Request
URI
GET
https://{api_host}/api/1.0.0/tasks/{task-id}
COPY
Path Parameters
string
task-id
Required

ID of task to return

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns Task of type(s) application/json 
{
    "id": "string",
    "result": {
        "message": "string",
        "result": [
            "string"
        ]
    },
    "startedAt": "string",
    "status": "string",
    "stoppedAt": "string",
    "url": "string"
}
string
id
Optional

36 character UUID generated for each task.

object
result
Optional

result

string
startedAt
Optional

date-time with timezone in ISO-8601 format. For example, 2021-06-08T18:27:30-04:00.

string
status
Optional

Status of requested action. The values are:

  • running
  • failed
  • stopped
string
stoppedAt
Optional

date-time with timezone in ISO-8601 format. null while task is still in progress. Once completed, same format as startedAt field.

string
url
Optional

URL of request, which includes action.


404

404 NOT FOUND

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/1.0.0/tasks/{task-id}
Availability
Added in 36
On This Page
Task Status Operations
GET
Get Task Status
Deprecated
GET
Query Task Status