Plugins

Install a plugin

POST

https://peertube2.cpy.re/api/v1/plugins/install

Install a plugin

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

const body = `{
  "npmName": "peertube-plugin-auth-ldap",
  "currentPassword": "********"
}`;

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

const data = await response.text();

import requests

body = '''{
  "npmName": "peertube-plugin-auth-ldap",
  "currentPassword": "********"
}'''

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

Request Body

{
  "npmName": "peertube-plugin-auth-ldap",
  "currentPassword": "********"
}

Body

application/json

One of

npmNamestringrequired

Example

peertube-plugin-auth-ldap

currentPasswordcurrentPassword<password>

Password of the authenticated user, required if password confirmation is enabled

pathstringrequired

currentPasswordcurrentPassword<password>

Password of the authenticated user, required if password confirmation is enabled

Response

204No Content

successful operation

400Bad Request

should have either npmName or path set, or 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