Get progress or status of async operations in subscriptions

get/subscriptions/v1beta1/async-operations/{id}

Use this API to find the status of the asynchronous Add and update subscriptions API.

An asynchronous resource is generated to track the status of an asynchronous operation. An asynchronous resource that has reached a terminal state (SUCCEEDED, FAILED, TIMEOUT) will no longer be accessible 24 hours after reaching the terminal state.

An asynchronous resource is set to the TIMEOUT state if the resource has been in an INITIALIZED or RUNNING state for a period greater than the timeout set. If an asynchronous operation resource coming from an asynchronous request consists of multiple subscriptions, a breakdown of succeeded subscriptions and failed subscriptions, if there are any, is returned as the response. In this case, the subscription key identifies each subscription.

Note: You need view permissions for the Devices and Subscription service to invoke this API.

Rate limits are enforced on this API. Five requests per minute is supported per workspace. API will result in 429 if this threshold is breached.

SecurityBearer
Request
path Parameters
id
required
string

The unique identifier returned by an asynchronous API operation.

Responses
200

Successful response

400

Bad request

401

Unauthorized request

403

The operation is forbidden

404

Not found

429

Too many requests

500

Internal server error

Request samples 
Response samples 
application/json
{
  • "status": "INITIALIZED",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "endedAt": "2019-08-24T14:15:22Z",
  • "progressPercent": 0,
  • "suggestedPollingIntervalSeconds": 0,
  • "timeoutMinutes": 0,
  • "result": { },
  • "resultType": "string",
  • "id": "3292c36d-30ef-4£26-823b-76b5d213b670",
  • "type": "subscriptions/asyncOperation"
}