Config

Set instance runtime configuration

PUT

https://peertube2.cpy.re/api/v1/config/custom

Changing instance.customizations.javascript or instance.customizations.css requires a password confirmation: set currentPassword at the root of the request body.

curl -X PUT 'https://peertube2.cpy.re/api/v1/config/custom' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/config/custom', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.put(
    'https://peertube2.cpy.re/api/v1/config/custom',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

Response

200OK

successful operation

400Bad Request

Arises when:

the emailer is disabled and the instance is open to registrations
web videos and hls are disabled with transcoding enabled - you need at least one enabled
the custom JavaScript or CSS changed and currentPassword is missing

403Forbidden

invalid currentPassword, or password confirmation unavailable for this user

429Too Many Requests

too many failed password confirmations

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