PeerTube
  1. Config
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
    • Get instance "About" information
      GET
    • Delete instance runtime configuration
      DELETE
    • Get instance runtime configuration
      GET
    • Set instance runtime configuration
      PUT
  • 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
    • List available plugins
    • Install a plugin
    • Uninstall a plugin
    • Update a plugin
    • Get a plugin
    • Get a plugin's public settings
    • Get a plugin's registered settings
    • Set a plugin's settings
  • 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. Config

Get instance public configuration

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
/config
Config
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://peertube2.cpy.re/api/v1/config'
Response Response Example
{
    "autoBlacklist": {
        "videos": {
            "ofUsers": {
                "enabled": true
            }
        }
    },
    "avatar": {
        "extensions": [
            "string"
        ],
        "file": {
            "size": {
                "max": 0
            }
        }
    },
    "contactForm": {
        "enabled": true
    },
    "email": {
        "enabled": true
    },
    "followings": {
        "instance": {
            "autoFollowIndex": {
                "indexUrl": "string"
            }
        }
    },
    "homepage": {
        "enabled": true
    },
    "import": {
        "videos": {
            "http": {
                "enabled": true
            },
            "torrent": {
                "enabled": true
            }
        }
    },
    "instance": {
        "customizations": {
            "css": "string",
            "javascript": "string"
        },
        "defaultClientRoute": "string",
        "defaultNSFWPolicy": "string",
        "isNSFW": true,
        "name": "string",
        "shortDescription": "string"
    },
    "plugin": {
        "registered": [
            "string"
        ]
    },
    "search": {
        "remoteUri": {
            "anonymous": true,
            "users": true
        }
    },
    "serverCommit": "string",
    "serverVersion": "string",
    "signup": {
        "allowed": true,
        "allowedForCurrentIP": true,
        "requiresEmailVerification": true
    },
    "theme": {
        "registered": [
            "string"
        ]
    },
    "tracker": {
        "enabled": true
    },
    "transcoding": {
        "enabledResolutions": [
            240
        ],
        "hls": {
            "enabled": true
        },
        "webtorrent": {
            "enabled": true
        }
    },
    "trending": {
        "videos": {
            "intervalDays": 0
        }
    },
    "user": {
        "videoQuota": 16810141515,
        "videoQuotaDaily": 1681014151
    },
    "video": {
        "file": {
            "extensions": [
                "string"
            ]
        },
        "image": {
            "extensions": [
                "string"
            ],
            "size": {
                "max": 0
            }
        }
    },
    "videoCaption": {
        "file": {
            "extensions": [
                "string"
            ],
            "size": {
                "max": 0
            }
        }
    }
}

Request

None

Responses

🟢200successful operation
application/json
Body
autoBlacklist
object 
optional
videos
object 
optional
avatar
object 
optional
extensions
array[string]
optional
file
object 
optional
contactForm
object 
optional
enabled
boolean 
optional
email
object 
optional
enabled
boolean 
optional
followings
object 
optional
instance
object 
optional
homepage
object 
optional
enabled
boolean 
optional
import
object 
optional
videos
object 
optional
instance
object 
optional
customizations
object 
optional
defaultClientRoute
string 
optional
defaultNSFWPolicy
string 
optional
isNSFW
boolean 
optional
name
string 
optional
shortDescription
string 
optional
plugin
object 
optional
registered
array[string]
optional
search
object 
optional
remoteUri
object 
optional
serverCommit
string 
optional
serverVersion
string 
optional
signup
object 
optional
allowed
boolean 
optional
allowedForCurrentIP
boolean 
optional
requiresEmailVerification
boolean 
optional
theme
object 
optional
registered
array[string]
optional
tracker
object 
optional
enabled
boolean 
optional
transcoding
object 
optional
enabledResolutions
array[integer]
optional
hls
object 
optional
webtorrent
object 
optional
trending
object 
optional
videos
object 
optional
user
object 
optional
videoQuota
integer 
optional
Example:
16810141515
videoQuotaDaily
integer 
optional
Example:
1681014151
video
object 
optional
file
object 
optional
image
object 
optional
videoCaption
object 
optional
file
object 
optional
Modified at 2022-09-10 22:29:49
Previous
Update channel banner
Next
Get instance "About" information
Built with