Remote Jobs

Runners

Register a new runner

POST

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

API used by PeerTube runners

curl -X POST 'https://peertube2.cpy.re/api/v1/runners/register' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "registrationToken": "string",
  "name": "string",
  "description": "string"
}'

const body = `{
  "registrationToken": "string",
  "name": "string",
  "description": "string"
}`;

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

const data = await response.text();

import requests

body = '''{
  "registrationToken": "string",
  "name": "string",
  "description": "string"
}'''

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

Request Body

{
  "registrationToken": "string",
  "name": "string",
  "description": "string"
}

200

{
  "id": 0,
  "runnerToken": "string"
}

Body

application/json

registrationTokenstringrequired

namestringrequired

descriptionstring

Response

200OKobject

successful operation

Response fields application/json

idinteger

Runner id

runnerTokenstring

Unregister a runner

POST

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

API used by PeerTube runners

Unregister a runner

curl -X POST 'https://peertube2.cpy.re/api/v1/runners/unregister' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "runnerToken": "string"
}'

const body = `{
  "runnerToken": "string"
}`;

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

const data = await response.text();

import requests

body = '''{
  "runnerToken": "string"
}'''

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

Request Body

{
  "runnerToken": "string"
}

Body

application/json

runnerTokenstringrequired

Response

204No Content

successful operation

Delete a runner

DELETE

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

Delete a runner

curl -X DELETE 'https://peertube2.cpy.re/api/v1/runners/0' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "runnerToken": "string"
}'

const body = `{
  "runnerToken": "string"
}`;

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

const data = await response.text();

import requests

body = '''{
  "runnerToken": "string"
}'''

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

Request Body

{
  "runnerToken": "string"
}

Body

application/json

runnerTokenstringrequired

Parameters

runnerIdintegerrequiredpath

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

List runners

GET

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

List runners

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

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

200

{
  "total": 1,
  "data": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "ip": "string",
      "updatedAt": "2024-01-15T09:30:00Z",
      "createdAt": "2024-01-15T09:30:00Z",
      "lastContact": "2024-01-15T09:30:00Z"
    }
  ]
}

Parameters

startinteger>= 0query

Offset used to paginate results

countinteger[1, 100]15query

Number of items to return

sortstringcreatedAtquery

Sort runners by criteria

Response

200OKobject

successful operation

Response fields application/json

totalinteger

Example

dataArray<Runner>

Show child attributes

idinteger

namestring

descriptionstring

ipstring

updatedAtstring<date-time>

createdAtstring<date-time>

lastContactstring<date-time>

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