Runners

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