The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with [openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO) which generates
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://peertube2.cpy.re https://peertube3.cpy.re https://peertube.cpy.re
auth: o a u t h 2
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with [openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO) which generates a client SDK in the language of your choice - we generate some client SDKs automatically: - [Pytho
| method | path | what the vendor says it does |
|---|---|---|
GET | /api/v1/abuses | List abuses Abuses |
POST | /api/v1/abuses | Report an abuse Abuses |
PUT | /api/v1/abuses/{abuseId} | Update an abuse Abuses |
DELETE | /api/v1/abuses/{abuseId} | Delete an abuse Abuses |
GET | /api/v1/abuses/{abuseId}/messages | List messages of an abuse Abuses |
POST | /api/v1/abuses/{abuseId}/messages | Add message to an abuse Abuses |
DELETE | /api/v1/abuses/{abuseId}/messages/{abuseMessageId} | Delete an abuse message Abuses |
GET | /api/v1/accounts | List accounts Accounts |
GET | /api/v1/accounts/{name} | Get an account Accounts |
GET | /api/v1/accounts/{name}/followers | List followers of an account Accounts |
GET | /api/v1/accounts/{name}/ratings | List ratings of an account Accounts |
GET | /api/v1/accounts/{name}/video-channel-syncs | List the synchronizations of video channels of an account Video Channels Channels Sync Accounts |
GET | /api/v1/accounts/{name}/video-channels | List video channels of an account Video Channels Accounts |
GET | /api/v1/accounts/{name}/video-playlists | List playlists of an account Video Playlists Accounts |
GET | /api/v1/accounts/{name}/videos | List videos of an account Accounts Video |
GET | /api/v1/blocklist/status | Get block status of accounts/hosts Account Blocks Server Blocks |
GET | /api/v1/config | Get instance public configuration Config |
GET | /api/v1/config/about | Get instance "About" information Config |
GET | /api/v1/config/custom | Get instance runtime configuration Config |
PUT | /api/v1/config/custom | Set instance runtime configuration Config |
DELETE | /api/v1/config/custom | Delete instance runtime configuration Config |
GET | /api/v1/custom-pages/homepage/instance | Get instance custom homepage Homepage |
PUT | /api/v1/custom-pages/homepage/instance | Set instance custom homepage Homepage |
POST | /api/v1/jobs/pause | Pause job queue Job |
POST | /api/v1/jobs/resume | Resume job queue Job |
GET | /api/v1/jobs/{state} | List instance jobs Job |
POST | /api/v1/metrics/playback | Create playback metrics These metrics are exposed by OpenTelemetry metrics exporter if enabled. Stats |
GET | /api/v1/oauth-clients/local | Login prerequisite You need to retrieve a client id and secret before [logging in](#operation/getOAuthToken). |
GET | /api/v1/plugins | List plugins Plugins |
GET | /api/v1/plugins/available | List available plugins Plugins |
POST | /api/v1/plugins/install | Install a plugin Plugins |
POST | /api/v1/plugins/uninstall | Uninstall a plugin Plugins |
POST | /api/v1/plugins/update | Update a plugin Plugins |
GET | /api/v1/plugins/{npmName} | Get a plugin Plugins |
GET | /api/v1/plugins/{npmName}/public-settings | Get a plugin's public settings Plugins |
GET | /api/v1/plugins/{npmName}/registered-settings | Get a plugin's registered settings Plugins |
PUT | /api/v1/plugins/{npmName}/settings | Set a plugin's settings Plugins |
GET | /api/v1/search/video-channels | Search channels Search |
GET | /api/v1/search/video-playlists | Search playlists Search |
GET | /api/v1/search/videos | Search videos Search |
and 146 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/Chocobozzz/PeerTube/develop/support/doc/api/openapi.yaml
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.