Job

Pause job queue

POST

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

Pause job queue

curl -X POST 'https://peertube2.cpy.re/api/v1/jobs/pause' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "processRoles": [
    "primary"
  ]
}'

const body = `{
  "processRoles": [
    "primary"
  ]
}`;

const response = await fetch('https://peertube2.cpy.re/api/v1/jobs/pause', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "processRoles": [
    "primary"
  ]
}'''

response = requests.post(
    'https://peertube2.cpy.re/api/v1/jobs/pause',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "processRoles": [
    "primary"
  ]
}

Body

application/json

processRolesArray<string>primarysecondary

Roles of the PeerTube processes that must pause their job queue. Defaults to all the roles. Other processes are notified asynchronously.

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