Job

List instance jobs

GET

https://peertube2.cpy.re/api/v1/jobs/{state}

List instance jobs

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

const response = await fetch('https://peertube2.cpy.re/api/v1/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/jobs/?count=15',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{
  "total": 1,
  "data": [
    {
      "id": 42,
      "state": "active",
      "type": "activitypub-cleaner",
      "data": {},
      "error": {},
      "createdAt": "2024-01-15T09:30:00Z",
      "finishedOn": "2024-01-15T09:30:00Z",
      "processedOn": "2024-01-15T09:30:00Z",
      "canCancel": true
    }
  ]
}

Parameters

statestringactivecompletedfailedwaitingdelayedrequiredpath

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

jobTypeJobTypeactivitypub-cleaneractivitypub-followactivitypub-http-broadcastactivitypub-http-broadcast-parallelactivitypub-http-fetcheractivitypub-http-unicastactivitypub-refresheractor-keysafter-video-channel-importbuild-automatic-tagsbuild-object-automatic-tagscreate-user-exportemailfederate-videogenerate-video-storyboardimport-user-archivemanage-video-torrentmove-to-file-systemmove-to-object-storagenotifytranscoding-job-buildervideo-channel-importvideo-file-importvideo-files-lifecyclevideo-importvideo-live-endingvideo-redundancyvideo-studio-editionvideo-transcodingvideo-transcriptionvideos-statsquery

job type

startinteger>= 0query

Offset used to paginate results

countinteger[1, 100]15query

Number of items to return

sortstringquery

Sort column

Response

200OKobject

successful operation

Response fields application/json

totalinteger

Example

dataArray<Job>

Show child attributes

idid>= 1

Example

statestringactivecompletedfailedwaitingdelayed

typeJobTypeactivitypub-cleaneractivitypub-followactivitypub-http-broadcastactivitypub-http-broadcast-parallelactivitypub-http-fetcheractivitypub-http-unicastactivitypub-refresheractor-keysafter-video-channel-importbuild-automatic-tagsbuild-object-automatic-tagscreate-user-exportemailfederate-videogenerate-video-storyboardimport-user-archivemanage-video-torrentmove-to-file-systemmove-to-object-storagenotifytranscoding-job-buildervideo-channel-importvideo-file-importvideo-files-lifecyclevideo-importvideo-live-endingvideo-redundancyvideo-studio-editionvideo-transcodingvideo-transcriptionvideos-stats

dataobject

errorobject

createdAtstring<date-time>

finishedOnstring<date-time>

processedOnstring<date-time>

canCancelboolean

Whether this job is currently running and supports cancellation

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