Videos

Video Mirroring

PeerTube instances can mirror videos from one another, and help distribute some videos.

For importing videos as your own, refer to video imports.

List videos being mirrored

GET

https://peertube2.cpy.re/api/v1/server/redundancy/videos

List videos being mirrored

curl -X GET 'https://peertube2.cpy.re/api/v1/server/redundancy/videos?target=my-videos&count=15' \
  -H 'Authorization: Bearer YOUR_TOKEN'

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

200

[
  {
    "id": 42,
    "name": "string",
    "url": "https://example.com",
    "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
    "redundancies": {
      "streamingPlaylists": [
        {
          "id": 42,
          "fileUrl": "https://example.com",
          "strategy": "manual",
          "size": 0,
          "createdAt": "2024-01-15T09:30:00Z",
          "updatedAt": "2024-01-15T09:30:00Z",
          "expiresOn": "2024-01-15T09:30:00Z"
        }
      ]
    }
  }
]

Parameters

targetstringmy-videosremote-videosrequiredquery

direction of the mirror

startinteger>= 0query

Offset used to paginate results

countinteger[1, 100]15query

Number of items to return

sortstringnamequery

Sort abuses by criteria

Response

200OKArray<VideoRedundancy>

successful operation

Response fields application/json

Array<VideoRedundancy>

Show child attributes

idid>= 1

Example

namestring

urlstring<url>

uuidUUIDv4<uuid>

Example

9c9de5e8-0a1e-484a-b099-e80766180a6d

redundanciesobject

Show child attributes

streamingPlaylistsArray<FileRedundancyInformation>

Show child attributes

idid>= 1

Example

fileUrlstring<url>

strategystringmanualmost-viewstrendingrecently-added

sizeinteger

createdAtstring<date-time>

updatedAtstring<date-time>

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

Mirror a video

POST

https://peertube2.cpy.re/api/v1/server/redundancy/videos

Mirror a video

curl -X POST 'https://peertube2.cpy.re/api/v1/server/redundancy/videos' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{}'

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

const data = await response.text();

import requests

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

Request Body

{}

Body

application/json

videoIdidrequired

object id for the video

Show child attributes

id>= 1

Example

Response

204No Content

successful operation

400Bad Request

cannot mirror a local video

404Not Found

video does not exist

409Conflict

video is already mirrored

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

Delete a mirror done on a video

DELETE

https://peertube2.cpy.re/api/v1/server/redundancy/videos/{redundancyId}

Delete a mirror done on a video

curl -X DELETE 'https://peertube2.cpy.re/api/v1/server/redundancy/videos/string' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/server/redundancy/videos/string', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.delete(
    'https://peertube2.cpy.re/api/v1/server/redundancy/videos/string',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

Parameters

redundancyIdstringrequiredpath

id of an existing redundancy on a video

Response

204No Content

successful operation

404Not Found

video redundancy not found

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