Config

Get instance runtime configuration

GET

https://peertube2.cpy.re/api/v1/config/custom

curl -X GET 'https://peertube2.cpy.re/api/v1/config/custom' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/config/custom', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://peertube2.cpy.re/api/v1/config/custom',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{
  "instance": {
    "name": "string",
    "shortDescription": "string",
    "description": "string",
    "terms": "string",
    "codeOfConduct": "string",
    "creationReason": "string",
    "moderationInformation": "string",
    "administrator": "string",
    "maintenanceLifetime": "string",
    "businessModel": "string",
    "hardwareInformation": "string",
    "translations": [
      {
        "language": "fr-FR",
        "shortDescription": "string",
        "description": "string",
        "terms": "string",
        "codeOfConduct": "string",
        "moderationInformation": "string",
        "administrator": "string",
        "creationReason": "string",
        "maintenanceLifetime": "string",
        "businessModel": "string",
        "hardwareInformation": "string",
        "supportText": "string"
      }
    ],
    "languages": [
      "string"
    ],
    "categories": [
      0
    ],
    "isNSFW": true,
    "defaultNSFWPolicy": "string",
    "serverCountry": "string",
    "support": {
      "text": "string"
    },
    "social": {
      "externalLink": "string",
      "mastodonLink": "string",
      "blueskyLink": "string",
      "xLink": "string"
    },
    "defaultClientRoute": "string",
    "customizations": {
      "javascript": "string",
      "css": "string"
    }
  },
  "theme": {
    "default": "string"
  },
  "services": {
    "twitter": {
      "username": "string"
    }
  },
  "cache": {
    "previews": {
      "size": 0
    },
    "captions": {
      "size": 0
    }
  },
  "signup": {
    "enabled": true,
    "limit": 0,
    "requiresEmailVerification": true
  },
  "admin": {
    "email": "user@example.com"
  },
  "contactForm": {
    "enabled": true
  },
  "user": {
    "videoQuota": 16810141515,
    "videoQuotaDaily": 1681014151
  },
  "transcoding": {
    "enabled": true,
    "originalFile": {
      "keep": true
    },
    "allowAdditionalExtensions": true,
    "allowAudioFiles": true,
    "threads": 0,
    "concurrency": 0,
    "profile": "default",
    "resolutions": {
      "0p": true,
      "144p": true,
      "240p": true,
      "360p": true,
      "480p": true,
      "720p": true,
      "1080p": true,
      "1440p": true,
      "2160p": true
    },
    "web_videos": {
      "enabled": true
    },
    "hls": {
      "enabled": true,
      "splitAudioAndVideo": true
    }
  },
  "import": {
    "videos": {
      "http": {
        "enabled": true
      },
      "torrent": {
        "enabled": true
      }
    },
    "video_channel_synchronization": {
      "enabled": true
    }
  },
  "autoBlacklist": {
    "videos": {
      "ofUsers": {
        "enabled": true
      }
    }
  },
  "blocklist": {
    "publicLog": {
      "enabled": true
    }
  },
  "followers": {
    "instance": {
      "enabled": true,
      "manualApproval": true
    }
  },
  "storyboard": {
    "enabled": true
  },
  "defaults": {
    "publish": {
      "downloadEnabled": true,
      "commentsPolicy": 1,
      "recommendationScope": 1,
      "privacy": 1,
      "licence": 2
    },
    "p2p": {
      "webapp": {
        "enabled": true
      },
      "embed": {
        "enabled": true
      }
    },
    "player": {
      "autoPlay": true
    }
  }
}

Response

200OKServerConfigCustom

successful operation

Response fields application/json

instanceobject

Show child attributes

namestring

shortDescriptionstring

descriptionstring

termsstring

codeOfConductstring

creationReasonstring

moderationInformationstring

administratorstring

maintenanceLifetimestring

businessModelstring

hardwareInformationstring

translationsArray<InstanceTranslation>

Translations of the instance information. Empty fields fall back to the default instance information

Show child attributes

languagestring

Locale of the web interface

Example

fr-FR

shortDescriptionstring

descriptionstring

termsstring

codeOfConductstring

moderationInformationstring

administratorstring

creationReasonstring

maintenanceLifetimestring

businessModelstring

hardwareInformationstring

supportTextstring

languagesArray<string>

categoriesArray<number>

isNSFWboolean

defaultNSFWPolicystring

serverCountrystring

supportobject

Show child attributes

textstring

defaultClientRoutestring

customizationsobject

Show child attributes

javascriptstring

cssstring

themeobject

Show child attributes

defaultstring

servicesobject

Show child attributes

twitterobject

Show child attributes

usernamestring

cacheobject

Show child attributes

previewsobject

Show child attributes

sizeinteger

captionsobject

Show child attributes

sizeinteger

adminobject

Show child attributes

emailstring<email>

contactFormobject

Show child attributes

enabledboolean

userobject

Settings that apply to new users, if registration is enabled

Show child attributes

videoQuotainteger

Example

16810141515

videoQuotaDailyinteger

Example

1681014151

transcodingobject

Settings pertaining to transcoding jobs

Show child attributes

enabledboolean

originalFileobject

Show child attributes

keepboolean

allowAdditionalExtensionsboolean

Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos

allowAudioFilesboolean

If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file

threadsinteger

Amount of threads used by ffmpeg for 1 transcoding job

concurrencynumber

Amount of transcoding jobs to execute in parallel

profilestringdefault

New profiles can be added by plugins ; available in core PeerTube: 'default'.

resolutionsobject

Resolutions to transcode new videos to

Show child attributes

0pboolean

144pboolean

240pboolean

360pboolean

480pboolean

720pboolean

1080pboolean

1440pboolean

2160pboolean

web_videosobject

Web Video specific settings

Show child attributes

enabledboolean

hlsobject

HLS specific settings

Show child attributes

enabledboolean

splitAudioAndVideoboolean

importobject

Show child attributes

videosobject

Show child attributes

httpobject

Show child attributes

enabledboolean

torrentobject

Show child attributes

enabledboolean

video_channel_synchronizationobject

Show child attributes

enabledboolean

autoBlacklistobject

Show child attributes

videosobject

Show child attributes

ofUsersobject

Show child attributes

enabledboolean

blocklistobject

Show child attributes

publicLogobject

Show child attributes

enabledboolean

followersobject

Show child attributes

instanceobject

Show child attributes

enabledboolean

manualApprovalboolean

storyboardobject

Show child attributes

enabledboolean

defaultsobject

Show child attributes

publishobject

Show child attributes

downloadEnabledboolean

commentsPolicyVideoCommentsPolicySet123

Comments policy of the video (Enabled = 1, Disabled = 2, Requires Approval = 3)

recommendationScopeVideoRecommendationScopeSet1234

Videos that can be recommended next to a video:

1 All videos
2 Only videos of the platform that owns the reference video (or of the current platform if no video is given)
3 Only videos of the account that owns the reference video
4 Only videos of the channel of the reference video

This is a preference of the video owner: applications displaying recommendations may not apply it

privacyVideoPrivacySet12345

privacy id of the video (see /videos/privacies)

licenceVideoLicenceSet

licence id of the video (see /videos/licences)

Example

p2pobject

Show child attributes

webappobject

Show child attributes

enabledboolean

embedobject

Show child attributes

enabledboolean

playerobject

Show child attributes

autoPlayboolean

Authorization

OAuth2oauth2

Authenticating via OAuth requires the following steps:

Have an activated account
Generate an access token for that account at /api/v1/users/token.
Make requests with the Authorization: Bearer <token> header
Profit, depending on the role assigned to the account

Note that the access token is valid for 1 day and is given along with a refresh token valid for 2 weeks.

Scopes: admin

Docs by Sourcey