Runner Jobs

List jobs

GET

https://peertube2.cpy.re/api/v1/runners/jobs

List jobs

curl -X GET 'https://peertube2.cpy.re/api/v1/runners/jobs?count=15' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/runners/jobs?count=15', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://peertube2.cpy.re/api/v1/runners/jobs?count=15',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{
  "total": 1,
  "data": [
    {
      "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
      "type": "vod-web-video-transcoding",
      "state": {
        "id": 1,
        "label": "Processing"
      },
      "payload": {
        "input": {
          "videoFileUrl": "string"
        },
        "output": {
          "resolution": 0,
          "fps": 0
        }
      },
      "failures": 0,
      "error": "string",
      "progress": 0,
      "priority": 0,
      "updatedAt": "2024-01-15T09:30:00Z",
      "createdAt": "2024-01-15T09:30:00Z",
      "startedAt": "2024-01-15T09:30:00Z",
      "finishedAt": "2024-01-15T09:30:00Z",
      "parent": {
        "type": "vod-web-video-transcoding",
        "state": {
          "id": 1,
          "label": "Processing"
        },
        "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d"
      },
      "runner": {
        "id": 0,
        "name": "string",
        "description": "string"
      },
      "privatePayload": {}
    }
  ]
}

Parameters

startinteger>= 0query

Offset used to paginate results

countinteger[1, 100]15query

Number of items to return

sortstringupdatedAtcreatedAtprioritystateprogressquery

Sort runner jobs by criteria

searchstringquery

Plain text search, applied to various parts of the model depending on endpoint

stateOneOfArray<RunnerJobState>12345678query

typeOneOfArray<RunnerJobType>vod-web-video-transcodingvod-hls-transcodingvod-audio-merge-transcodinglive-rtmp-hls-transcodingquery

Response

200OKobject

successful operation

Response fields application/json

totalinteger

Example

dataArray<RunnerJobAdmin>

Show child attributes

uuidUUIDv4<uuid>

Example

9c9de5e8-0a1e-484a-b099-e80766180a6d

typeRunnerJobTypevod-web-video-transcodingvod-hls-transcodingvod-audio-merge-transcodinglive-rtmp-hls-transcoding

stateRunnerJobStateConstant

Show child attributes

idRunnerJobState12345678

The runner job state:

1 Pending
2 Processing
3 Completed
4 Errored
5 Waiting for a parent job
6 Cancelled
7 Parent had an error
8 Parent has been cancelled

labelstring

Example

Processing

payloadobject

Show child attributes

Any of

inputobject

Show child attributes

videoFileUrlstring

outputobject

Show child attributes

resolutionnumber

fpsnumber

inputobject

Show child attributes

videoFileUrlstring

outputobject

Show child attributes

resolutionnumber

fpsnumber

inputobject

Show child attributes

audioFileUrlstring

previewFileUrlstring

outputobject

Show child attributes

resolutionnumber

fpsnumber

failuresinteger

Number of times a remote runner failed to process this job. After too many failures, the job in "error" state

errorstring | null

Error message if the job is errored

progressinteger

Percentage progress

priorityinteger

Job priority (less has more priority)

updatedAtstring<date-time>

createdAtstring<date-time>

startedAtstring<date-time>

finishedAtstring<date-time>

parentobject | null

If job has a parent job

Show child attributes

typeRunnerJobTypevod-web-video-transcodingvod-hls-transcodingvod-audio-merge-transcodinglive-rtmp-hls-transcoding

stateRunnerJobStateConstant

Show child attributes

idRunnerJobState12345678

The runner job state:

1 Pending
2 Processing
3 Completed
4 Errored
5 Waiting for a parent job
6 Cancelled
7 Parent had an error
8 Parent has been cancelled

labelstring

Example

Processing

uuidUUIDv4<uuid>

Example

9c9de5e8-0a1e-484a-b099-e80766180a6d

runnerany | null

If job is associated to a runner

Show child attributes

idnumber

namestring

descriptionstring

privatePayloadobject

Authorization

OAuth2oauth2

Authenticating via OAuth requires the following steps:

Have an activated account
Generate an access token for that account at /api/v1/users/token.
Make requests with the Authorization: Bearer <token> header
Profit, depending on the role assigned to the account

Note that the access token is valid for 1 day and is given along with a refresh token valid for 2 weeks.

Scopes: admin

Docs by Sourcey