Runner Jobs

Delete a job

DELETE

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

The endpoint will first cancel the job if needed, and then remove it from the database. Children jobs will also be removed

Delete a job

curl -X DELETE 'https://peertube2.cpy.re/api/v1/runners/jobs/9c9de5e8-0a1e-484a-b099-e80766180a6d' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/runners/jobs/9c9de5e8-0a1e-484a-b099-e80766180a6d', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.delete(
    'https://peertube2.cpy.re/api/v1/runners/jobs/9c9de5e8-0a1e-484a-b099-e80766180a6d',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

Parameters

jobUUIDUUIDv4<uuid>requiredpath

Response

204No Content

successful operation

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