Instance

Plugins

Managing plugins installed from a local path or from NPM, or search for new ones.

https://docs.joinpeertube.org/api/plugins

List plugins

GET

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

List plugins

curl -X GET 'https://peertube2.cpy.re/api/v1/plugins?count=15' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/plugins?count=15', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://peertube2.cpy.re/api/v1/plugins?count=15',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{
  "total": 1,
  "data": [
    {
      "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

pluginTypeintegerquery

uninstalledbooleanquery

startinteger>= 0query

Offset used to paginate results

countinteger[1, 100]15query

Number of items to return

sortstringquery

Sort column

Response

200OKPluginResponse

successful operation

Response fields application/json

totalinteger

Example

dataArray<Plugin>

Show child attributes

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>

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

List available plugins

GET

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

List available plugins

curl -X GET 'https://peertube2.cpy.re/api/v1/plugins/available?count=15' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/plugins/available?count=15', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://peertube2.cpy.re/api/v1/plugins/available?count=15',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{
  "total": 1,
  "data": [
    {
      "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

searchstringquery

pluginTypeintegerquery

currentPeerTubeEnginestringquery

startinteger>= 0query

Offset used to paginate results

countinteger[1, 100]15query

Number of items to return

sortstringquery

Sort column

Response

200OKPluginResponse

successful operation

Response fields application/json

totalinteger

Example

dataArray<Plugin>

Show child attributes

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>

503Service Unavailable

plugin index unavailable

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

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

Update a plugin

POST

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

Update a plugin

curl -X POST 'https://peertube2.cpy.re/api/v1/plugins/update' \
  -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/update', {
  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/update',
    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

404Not Found

existing plugin not found

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

Uninstall a plugin

POST

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

Uninstall a plugin

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

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

const response = await fetch('https://peertube2.cpy.re/api/v1/plugins/uninstall', {
  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"
}'''

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

Request Body

{
  "npmName": "peertube-plugin-auth-ldap"
}

Body

application/json

npmNamestringrequired

name of the plugin/theme in its package.json

Example

peertube-plugin-auth-ldap

Response

204No Content

successful operation

404Not Found

existing 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

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

Set a plugin's settings

PUT

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

Set a plugin's 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

Get a plugin's public settings

GET

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

Get a plugin's public settings

curl -X GET 'https://peertube2.cpy.re/api/v1/plugins/peertube-plugin-auth-ldap/public-settings'

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

const data = await response.text();

import requests

response = requests.get('https://peertube2.cpy.re/api/v1/plugins/peertube-plugin-auth-ldap/public-settings')
print(response.text)

200

{}

Parameters

npmNamestringrequiredpath

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

Response

200OKobject

successful operation

Response fields application/json

object

404Not Found

plugin not found

Get a plugin's registered settings

GET

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

Get a plugin's registered settings

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

const response = await fetch('https://peertube2.cpy.re/api/v1/plugins/peertube-plugin-auth-ldap/registered-settings', {
  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/registered-settings',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{}

Parameters

npmNamestringrequiredpath

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

Response

200OKobject

successful operation

Response fields application/json

object

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