PeerTube
  1. Plugins
PeerTube
  • Abuses
    • List abuses
      GET
    • Report an abuse
      POST
    • Delete an abuse
      DELETE
    • Update an abuse
      PUT
    • List messages of an abuse
      GET
    • Add message to an abuse
      POST
    • Delete an abuse message
      DELETE
    • List my abuses
      GET
  • Accounts
    • List accounts
      GET
    • Get an account
      GET
    • List ratings of an account
      GET
    • List videos of an account
      GET
  • Video Channels
    • List video channels of an account
      GET
    • List video channels
      GET
    • Create a video channel
      POST
    • Delete a video channel
      DELETE
    • Get a video channel
      GET
    • Update a video channel
      PUT
    • Delete channel avatar
      DELETE
    • Update channel avatar
      POST
    • Delete channel banner
      DELETE
    • Update channel banner
      POST
  • Config
    • Get instance public configuration
    • Get instance "About" information
    • Delete instance runtime configuration
    • Get instance runtime configuration
    • Set instance runtime configuration
  • Homepage
    • Get instance custom homepage
    • Set instance custom homepage
  • Feeds
    • List videos of subscriptions tied to a token
    • List comments on videos
    • List videos
  • Job
    • List instance jobs
  • Session
    • Login prerequisite
    • Logout
    • Login
  • Plugins
    • List plugins
      GET
    • List available plugins
      GET
    • Install a plugin
      POST
    • Uninstall a plugin
      POST
    • Update a plugin
      POST
    • Get a plugin
      GET
    • Get a plugin's public settings
      GET
    • Get a plugin's registered settings
      GET
    • Set a plugin's settings
      PUT
  • Search
    • Search channels
    • Search playlists
    • Search videos
  • Account Blocks
    • List account blocks
    • Block an account
    • Unblock an account by its handle
  • Server Blocks
    • List server blocks
    • Block a server
    • Unblock a server by its domain
  • Instance Follows
    • List instances following the server
    • Remove or reject a follower to your server
    • Accept a pending follower to your server
    • Reject a pending follower to your server
    • List instances followed by the server
    • Follow a list of actors (PeerTube instance, channel or account)
    • Unfollow an actor (PeerTube instance, channel or account)
  • Video Mirroring
    • List videos being mirrored
    • Mirror a video
    • Delete a mirror done on a video
  • Instance Redundancy
    • Update a server redundancy policy
  • Users
    • List users
    • Create a user
    • Resend user verification link
    • Register a user
    • Delete a user
    • Get a user
    • Update a user
    • Verify a user
  • My User
    • Get my user information
    • Update my user information
    • Delete my avatar
    • Update my user avatar
    • Get my user used quota
    • Get videos of my user
    • Get rate of my user for a video
  • My History
    • List watched videos history
    • Clear video history
  • My Notifications
    • Update my notification settings
    • List my notifications
    • Mark notifications as read by their id
    • Mark all my notification as read
  • My Subscriptions
    • Get my user subscriptions
    • Add subscription to my user
    • Get if subscriptions exist for my user
    • List videos of subscriptions of my user
    • Delete subscription of my user
    • Get subscription of my user
  • Video Playlists
    • Check video exists in my playlists
    • List video playlists
    • Create a video playlist
    • List available playlist privacy policies
    • Delete a video playlist
    • Get a video playlist
    • Update a video playlist
    • Reorder a playlist
    • Delete an element from a playlist
    • Update a playlist element
  • Videos
    • Get video imports of my user
    • List videos of a playlist
    • Add a video in a playlist
  • Video
    • List videos of a video channel
    • List videos
    • List available video categories
    • Import a video
    • List available video languages
    • List available video licences
    • List available video privacy policies
    • Upload a video
    • Cancel the resumable upload of a video, deleting any data uploaded so far
    • Initialize the resumable upload of a video
    • Send chunk for the resumable upload of a video
    • Delete a video
    • Get a video
    • Update a video
    • Get complete video description
    • Add a view to a video
    • Set watching progress of a video
  • Video Blocks
    • List video blocks
    • Unblock a video by its id
    • Block a video
  • Live Videos
    • Create a live
    • Get information about a live
    • Update information about a live
  • Video Ownership Change
    • List video ownership changes
    • Accept ownership change request
    • Refuse ownership change request
    • Request ownership change
  • Video Captions
    • List captions of a video
    • Delete a video caption
    • Add or replace a video caption
  • Video Comments
    • List threads of a video
    • Create a thread
    • Get a thread
    • Delete a comment or a reply
    • Reply to a thread of a video
  • Video Rates
    • Like/dislike a video
  1. Plugins

List available plugins

Live Test Server (live data - latest nightly version)
https://peertube2.cpy.re/api/v1
Live Test Server (live data - latest nightly version)
https://peertube2.cpy.re/api/v1
GET
/plugins/available
Plugins
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://peertube2.cpy.re/api/v1/plugins/available'
Response Response Example
200 - Example 1
{
    "data": [
        {
            "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"
        }
    ],
    "total": 1
}

Request

Query Params
search
string 
optional
pluginType
integer 
optional
currentPeerTubeEngine
string 
optional
start
integer 
optional
Offset used to paginate results
count
integer 
optional
Number of items to return
sort
string 
optional
Sort column

Responses

🟢200successful operation
application/json
Body
data
array[object (Plugin) {12}] 
optional
<= 100 items
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
type
enum<integer> 
optional
1: PLUGIN
2: THEME
Allowed values:
12
uninstalled
boolean 
optional
updatedAt
string <date-time>
optional
version
string 
optional
Example:
0.0.1
total
integer 
optional
Example:
1
🔴503plugin index unavailable
Modified at 2022-09-10 22:29:49
Previous
List plugins
Next
Install a plugin
Built with