Plugins

Get a plugin

GET

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

Get a plugin

curl -X GET 'https://peertube2.cpy.re/api/v1/plugins/peertube-plugin-auth-ldap' \
  -H 'Authorization: Bearer YOUR_TOKEN'

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

const data = await response.text();

import requests

response = requests.get(
    'https://peertube2.cpy.re/api/v1/plugins/peertube-plugin-auth-ldap',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{
  "name": "peertube-plugin-auth-ldap",
  "type": 1,
  "latestVersion": "0.0.3",
  "version": "0.0.1",
  "enabled": true,
  "uninstalled": true,
  "peertubeEngine": "2.2.0",
  "description": "string",
  "homepage": "https://framagit.org/framasoft/peertube/official-plugins/tree/master/peertube-plugin-auth-ldap",
  "settings": {},
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z"
}

Parameters

npmNamestringrequiredpath

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

Response

200OKPlugin

successful operation

Response fields application/json

namestring

Example

peertube-plugin-auth-ldap

typeinteger12

1: PLUGIN
2: THEME

latestVersionstring

Example

0.0.3

versionstring

Example

0.0.1

enabledboolean

uninstalledboolean

peertubeEnginestring

Example

2.2.0

descriptionstring

homepagestring<url>

Example

https://framagit.org/framasoft/peertube/official-plugins/tree/master/peertube-plugin-auth-ldap

settingsobject

createdAtstring<date-time>

updatedAtstring<date-time>

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