Tasks

Get background task status

Return the live status for a background task started by list operations Use the task_id returned by the create endpoint.

Usage Poll this endpoint every 1s until completed=true. If the task is unknown or expired, the service returns completed=true with no totals, which can be treated as finished.

get/tasks/{task_id}

Path parameters

task_idstring required

Background task id returned by the create endpoint.

Response

Task status returned successfully.

task_idstring required

runningboolean required

completedboolean required

totalinteger nullable

updatedinteger nullable

version_conflictsinteger nullable

Example response

{
  "completed": true,
  "running": false,
  "task_id": "a1b2c3:UNLOCK",
  "total": 100,
  "updated": 100,
  "version_conflicts": 0
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.