v1

latestOpenAPI 3.0.0AGPLv3.02026-07-14186117194.3 KB
Job

List instance jobs

get/api/v1/jobs/{state}

Path parameters

state'' | 'active' | 'completed' | 'failed' | 'waiting' | 'delayed' required

The state of the job ('' for for no filter)

Query parameters

jobType'activitypub-follow' | 'activitypub-http-broadcast' | 'activitypub-http-fetcher' | 'activitypub-http-unicast' | 'email' | 'video-transcoding' | 'video-file-import' | 'video-import' | 'videos-views-stats' | 'activitypub-refresher' | 'video-redundancy' | 'video-live-ending' | 'video-channel-import'

job type

startinteger

Offset used to paginate results

countinteger

Number of items to return

sortstring
Example:-createdAt

Sort column

Response

successful operation

totalinteger

Example response

{
  "data": [
    {
      "id": 42
    }
  ],
  "total": 1
}