Sign in
latestOpenAPI 3.1.02026-08-211286041.7 MB

b0c8a1820333

Background Task

Get Background Task

Get a background task by ID.

get/api/v1/background-task/{task_id}

Path parameters

task_idstring required

The QueueBackgroundTask's ID.

Example:qtask_1srOrx2ZWZBpBUvZwXKQmoEYga2

The QueueBackgroundTask's ID.

Response

dataobject required
idstring required

The QueueBackgroundTask's ID.

status'running' | 'finished' | 'failed' required
task'endpoint.replay' | 'endpoint.recover' | 'application.stats' | 'message.broadcast' | 'sdk.generate' | 'event-type.aggregate' | 'application.purge_content' | 'endpoint.bulk-replay' required
updatedAtstring date-time required

Example response

{
  "id": "qtask_1srOrx2ZWZBpBUvZwXKQmoEYga2"
}