How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

PeerTube Config API

Each server exposes public information regarding supported videos and options.

PeerTube Config API is one of 54 APIs that PeerTube publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Config. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and rate-limit docs.

This API exposes 11 operations across 9 paths, and defines 8 schemas. It is described by OpenAPI 3.0.3, at version 8.1.0.

Requests are made against 3 base URLs: https://peertube2.cpy.re, https://peertube3.cpy.re, https://peertube.cpy.re.

11 operations 9 paths 8 schemas 4 DELETE3 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
8.1.0
Base URL
https://{instance}/api/v1
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

PeerTube Config API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the password flow, exposing 3 scopes.

  • OAuth2 — Authenticating via OAuth requires the following steps: - Have an activated account - [Generate] an access token for that account at /api/v1/users/token. - Make…

Paths & Operations 11

Across 9 paths, the API surfaces 11 operations — 4 DELETE, 3 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Config 11

Each server exposes public information regarding supported videos and options.

GET
/api/v1/config
Get instance public configuration
getConfig → 200
GET
/api/v1/config/about
Get instance "About" information
getAbout → 200
GET
/api/v1/config/custom
Get instance runtime configuration
getCustomConfig → 200
PUT
/api/v1/config/custom
Set instance runtime configuration
putCustomConfig → 200400
DELETE
/api/v1/config/custom
Delete instance runtime configuration
delCustomConfig → 200
POST
/api/v1/config/instance-banner/pick
Update instance banner
body → 204413
DELETE
/api/v1/config/instance-banner
Delete instance banner
→ 204
POST
/api/v1/config/instance-avatar/pick
Update instance avatar
body → 204413
DELETE
/api/v1/config/instance-avatar
Delete instance avatar
→ 204
POST
/api/v1/config/instance-logo/{logoType}/pick
Update instance logo
1 param body → 204413
DELETE
/api/v1/config/instance-logo/{logoType}
Delete instance logo
1 param → 204

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are ServerConfig (24 properties), ServerConfigCustom (14 properties), ActorImage (6 properties), ServerConfigAbout (1 property). Each schema is shown below with its type and property counts.

VideoCommentsPolicySet
integer
Comments policy of the video (Enabled = 1, Disabled = 2, Requires Approval = 3)
VideoPrivacySet
integer
privacy id of the video (see [/videos/privacies](operation/getVideoPrivacyPolicies))
ServerConfigCustom
object
14 properties
ServerConfigAbout
object
1 property
ServerConfig
object
24 properties
ActorImage
object
6 properties
VideoResolutionSet
integer
Video resolution (0, 240, 360, 720, 1080, 1440 or 2160) 0 is used as a special value for stillimage videos dedicated to audio, a.k.a. audio-only videos.
VideoLicenceSet
integer
licence id of the video (see [/videos/licences](operation/getLicences))

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

peertube-config-api-openapi.yml Raw ↑

Other APIs PeerTube publishes across the network.

PeerTube Abuses API
PeerTube Account Blocklist API
PeerTube Accounts API
PeerTube Automatic Tags API
PeerTube Channels Sync API
PeerTube Client Config API
PeerTube Contact API
PeerTube Debug API
PeerTube Homepage API
PeerTube Instance Follows API
PeerTube Instance Redundancy API
PeerTube Job API
Where this information came from

This is an independent, third-party profile of PeerTube Config API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.