Job

Cancel a job

POST

https://peertube2.cpy.re/api/v1/jobs/{jobType}/{jobId}/cancel

Abort a running job and its underlying ffmpeg/child process. Only active jobs that support cancellation can be cancelled.

Cancel a job

curl -X POST 'https://peertube2.cpy.re/api/v1/jobs/activitypub-cleaner/string/cancel' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/jobs/activitypub-cleaner/string/cancel', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.post(
    'https://peertube2.cpy.re/api/v1/jobs/activitypub-cleaner/string/cancel',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

Parameters

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-statsrequiredpath

The type of the job to cancel

jobIdstringrequiredpath

The id of the job to cancel

Response

204No Content

successful operation

404Not Found

job not found

409Conflict

job cannot be cancelled (not active or not cancellable)

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