PeerTube

Get a plugin

Live Test Server (live data - latest nightly version)

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

GET

/plugins/{npmName}

Plugins

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://peertube2.cpy.re/api/v1/plugins/'

Response Example

200 - Example 1

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

Request

Path Params

npmName

string

required

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

Responses

🟢200successful operation

application/json

Body

createdAt

string <date-time>

optional

description

string

optional

enabled

boolean

optional

homepage

string <url>

optional

Example:

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

latestVersion

string

optional

Example:

0.0.3

name

string

optional

Example:

peertube-plugin-auth-ldap

peertubeEngine

string

optional

Example:

2.2.0

settings

object

optional

Additional properties

integer | number | string | boolean

optional

type

enum<integer>

optional

1: PLUGIN

2: THEME

Allowed values:

uninstalled

boolean

optional

updatedAt

string <date-time>

optional

version

string

optional

Example:

0.0.1

🟠404plugin not found

Modified at 2022-09-10 22:29:49

Update a plugin

Get a plugin's public settings