Plugins

Set a plugin's settings

PUT

https://peertube2.cpy.re/api/v1/plugins/{npmName}/settings

curl -X PUT 'https://peertube2.cpy.re/api/v1/plugins/peertube-plugin-auth-ldap/settings' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "settings": {}
}'

const body = `{
  "settings": {}
}`;

const response = await fetch('https://peertube2.cpy.re/api/v1/plugins/peertube-plugin-auth-ldap/settings', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "settings": {}
}'''

response = requests.put(
    'https://peertube2.cpy.re/api/v1/plugins/peertube-plugin-auth-ldap/settings',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "settings": {}
}

Body

application/json

settingsobject

Parameters

npmNamestringrequiredpath

name of the plugin/theme on npmjs.com or in its package.json

Response

204No Content

successful operation

404Not Found

plugin 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