Skip to content
GET /v1/config

Instance config

Try it live

10 free calls per day — no sign-up, no API key. Goes through the oanor gateway.

Custom headers (optional)
api.oanor.com/peertube-api

It works. Grab an API key and use it in your project.

Get an API key

Code snippets

curl "https://api.oanor.com/peertube-api/v1/config" \
  -H "x-oanor-key: oanor_test_..."
await fetch("https://api.oanor.com/peertube-api/v1/config", {
  headers: { "x-oanor-key": "oanor_test_..." }
});
$ch = curl_init("https://api.oanor.com/peertube-api/v1/config");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["x-oanor-key: oanor_test_..."]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$out = curl_exec($ch);
import requests
requests.get(
    "https://api.oanor.com/peertube-api/v1/config",
    headers={"x-oanor-key": "oanor_test_..."}
)

Example response

A real response from this endpoint, captured by the latest health check.

{
    "data": {
        "live": {
            "dvr": {
                "maxWindow": 3600
            },
            "rtmp": {
                "port": 1935
            },
            "enabled": true,
            "allowReplay": false,
            "maxDuration": -1,
            "transcoding": {
                "enabled": true,
                "profile": "default",
                "remoteRunners": {
                    "enabled": true
                },
                "availableProfiles": [
                    "default"
                ],
                "enabledResolutions": [
                    720
                ]
            },
            "maxUserLives": -1,
            "latencySetting": {
                "enabled": true
            },
            "maxInstanceLives": -1
        },
        "logo": {
            "file": {
                "size": {
                    "max": 8388608
                },
                "extensions": [
                    ".svg",
                    ".png",
                    ".jpeg",
                    ".jpg",
                    ".gif",
                    ".webp"
                ]
            }
        },
        "user": {
            "videoQuota": -1,
            "videoQuotaDaily": -1
        },
        "email": {
            "enabled": true
        },
        "theme": {
            "builtIn": [
                {
                    "name": "peertube-core-dark-brown"
                },
                {
                    "name": "peertube-core-light-beige"
                }
            ],
            "default": "framasoft",
            "registered": [
                {
                    "css": [
                        "assets/style.css"
                    ],
                    "name": "framasoft",
                    "npmName": "peertube-theme-framasoft",
                    "version": "1.0.2",
                    "description": "PeerTube Framasoft theme",
                    "clientScripts": []
                }
            ],
            "customization": {
                "primaryColor": null,
                "onPrimaryColor": null,
                "backgroundColor": null,
                "foregroundColor": null,
                "menuBorderRadius": null,
                "inputBorderRadius": null,
                "menuBackgroundColor": null,
                "menuForegroundColor": null,
                "headerBackgroundColor": null,
                "headerForegroundColor": null,
                "backgroundSecondaryColor": null
            }
        },
        "video": {
            "file": {
                "extensions": [
                    ".webm",
                    ".ogv",
                    ".ogg",
                    ".mp4",
                    ".mkv",
                    ".mov",
                    ".qt",
                    ".mqv",
                    ".m4v",
                    ".flv",
                    ".f4v",
                    ".wmv",
                    ".avi",
                    ".
…