Monitoring & Tasks API (REST)

Ingestion, collection changes, and package operations can return a taskId. Keep that value exactly as returned and use it to monitor the asynchronous operation.

Endpoints

Method	Path	Result	Rights
GET	/task	Array of task responses	Read or Admin
GET	/task/{taskId}	One task response	Read or Admin

A successful lookup returns HTTP 200. A missing task returns 404. Task identifiers belong to the authenticated subscription.

Response

{
  "id": "TASK_ID_FROM_THE_OPERATION_RESPONSE",
  "data": {
    "state": "Succeed",
    "date": "2026-09-08T09:00:00+00:00",
    "events": [
      {
        "action": "Operation completed",
        "date": "2026-09-08T09:00:00+00:00"
      }
    ],
    "component": "PublicApi",
    "version": "One"
  }
}

Download the response example.

The top-level properties are id and data. Read the lifecycle state from data.state. The data also includes date, events, component, and version. Event entries contain an action and date; the response has no percentage-progress or errorMessage field.

State	Meaning	Client action
Pending	Queued	Continue polling.
Processing	Running	Continue polling.
Succeed	Completed successfully	Stop polling and continue the workflow.
Failed	Operation failed	Stop polling and inspect the event history.

Use Succeed exactly as spelled. Job scheduler states use a separate contract.

curl --fail-with-body "$BLUECURVE_API_URL/task/$TASK_ID" \
  -H "x-api-key: $BLUECURVE_API_KEY" \
  -H 'api-version: 1.0'

Use a bounded polling interval and an overall deadline in your client. A 404 means no task record was returned; it is not a successful terminal state.

Next: Referential Data API