SVsvix
Background Task

List Background Tasks

Changed on

List background tasks executed in the past 90 days.

get/api/v1/background-task

Request

  • Base URL
    https://api.eu.svix.com
  • URL
    https://api.eu.svix.com/api/v1/background-task
  • Auth
    HTTP bearer

Query parameters

status'running' | 'finished' | 'failed'

Filter the response based on the status.

task'endpoint.replay' | 'endpoint.recover' | 'application.stats' | 'message.broadcast' | 'sdk.generate' | 'event-type.aggregate' | 'application.purge_content' | 'endpoint.bulk-replay'

Filter the response based on the type.

limitinteger

Limit the number of returned items

iteratorstring nullable

The iterator returned from a prior invocation

Example:qtask_1srOrx2ZWZBpBUvZwXKQmoEYga2
order'ascending' | 'descending'

Defines the ordering in a listing of results.

The sorting order of the returned items

Response

doneboolean required
iteratorstring nullable required
prevIteratorstring nullable

Example response

{
  "data": [
    {
      "id": "qtask_1srOrx2ZWZBpBUvZwXKQmoEYga2"
    }
  ],
  "iterator": "iterator",
  "prevIterator": "-iterator"
}

Changes