Player Settings

Update channel player settings

PUT

https://peertube2.cpy.re/api/v1/player-settings/video-channels/{channelHandle}

Update default player settings for a video channel.

curl -X PUT 'https://peertube2.cpy.re/api/v1/player-settings/video-channels/my_username%20%7C%20my_username%40example.com' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "theme": "instance-default"
}'

const body = `{
  "theme": "instance-default"
}`;

const response = await fetch('https://peertube2.cpy.re/api/v1/player-settings/video-channels/my_username%20%7C%20my_username%40example.com', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "theme": "instance-default"
}'''

response = requests.put(
    'https://peertube2.cpy.re/api/v1/player-settings/video-channels/my_username%20%7C%20my_username%40example.com',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "theme": "instance-default"
}

200

{
  "theme": "instance-default"
}

Body

application/json

Player settings update for a channel

themePlayerThemeChannelSettinginstance-defaultgalaxyluciderequired

Player theme setting for a channel:

instance-default Use the instance default theme
galaxy Use the galaxy theme
lucide Use the lucide theme

Parameters

channelHandlestringrequiredpath

The video channel handle

Response

200OKPlayerChannelSettings

successful operation

Response fields application/json

Player settings for a channel

themePlayerThemeChannelSettinginstance-defaultgalaxylucide

Player theme setting for a channel:

instance-default Use the instance default theme
galaxy Use the galaxy theme
lucide Use the lucide theme

404Not Found

video channel 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.

Docs by Sourcey