Get task

Gets the task with the given ID.

When the wait parameter is set then the request will not return a response until:

  • The task reaches the desired state (and optionally client action), or
  • The specified number of seconds is reached, or
  • The task completes, fails, times-out or is canceled

You must check the state property of the returned task to determine whether it reached the desired state.

Path Params
string
required

The unique identifier of the task

Query Params
int32

A number of seconds (between 1 and 30) to wait for the task to reach the state, and optionally client action, defined in the desired_state and desired_client_action parameters. The task is not guaranteed to be in the specified state when the request returns so you must check the state yourself and repeat the request if necessary.

string

A state to wait for the task to reach, if the wait parameter is set.

string

A client action to wait for the task to reach, if the wait parameter is set.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
LoadingLoading…
Response
Choose an example:
application/json