Models

ServerConfig

object

instanceobject

Show child attributes

namestring

shortDescriptionstring

defaultClientRoutestring

isNSFWboolean

defaultNSFWPolicystring

serverCountrystring

defaultLanguagestring

supportobject

Show child attributes

textstring

customizationsobject

Show child attributes

javascriptstring

cssstring

avatarsArray<ActorImage>

Show child attributes

pathstring | nulldeprecated

Deprecated in PeerTube v8.0, use fileUrl instead. Null if the file is stored in object storage: use the non-deprecated field instead.

fileUrlstring

PeerTube >= 7.1

widthinteger

heightinteger

PeerTube >= 7.3

createdAtstring<date-time>

updatedAtstring<date-time>

bannersArray<ActorImage>

Show child attributes

pathstring | nulldeprecated

Deprecated in PeerTube v8.0, use fileUrl instead. Null if the file is stored in object storage: use the non-deprecated field instead.

fileUrlstring

PeerTube >= 7.1

widthinteger

heightinteger

PeerTube >= 7.3

createdAtstring<date-time>

updatedAtstring<date-time>

searchobject

Show child attributes

remoteUriobject

Show child attributes

usersboolean

anonymousboolean

pluginobject

Show child attributes

registeredArray<string>

themeobject

Show child attributes

registeredArray<string>

emailobject

Show child attributes

enabledboolean

contactFormobject

Show child attributes

enabledboolean

serverVersionstring

serverCommitstring

transcodingobject

Show child attributes

hlsobject

Show child attributes

enabledboolean

web_videosobject

Show child attributes

enabledboolean

enabledResolutionsArray<VideoResolutionSet>

importobject

Show child attributes

videosobject

Show child attributes

httpobject

Show child attributes

enabledboolean

torrentobject

Show child attributes

enabledboolean

videoChannelSynchronizationobject

Show child attributes

enabledboolean

usersobject

Show child attributes

enabledboolean

resumableUploadobject

Show child attributes

minChunkSizenumber

In bytes. Minimum size of a user archive import chunk (except the last one), 0 if there is no minimum

exportobject

Show child attributes

usersobject

Show child attributes

enabledboolean

exportExpirationnumber

In milliseconds

maxUserVideoQuotanumber

In bytes

autoBlacklistobject

Show child attributes

videosobject

Show child attributes

ofUsersobject

Show child attributes

enabledboolean

blocklistobject

Show child attributes

publicLogobject

Show child attributes

enabledboolean

avatarobject

Show child attributes

fileobject

Show child attributes

sizeobject

Show child attributes

maxinteger

extensionsArray<string>

videoobject

Show child attributes

imageobject

Show child attributes

extensionsArray<string>

sizeobject

Show child attributes

maxinteger

fileobject

Show child attributes

extensionsArray<string>

videoCaptionobject

Show child attributes

fileobject

Show child attributes

sizeobject

Show child attributes

maxinteger

extensionsArray<string>

userobject

Show child attributes

videoQuotainteger

In bytes

Example

16810141515

videoQuotaDailyinteger

In bytes

Example

1681014151

trackerobject

Show child attributes

enabledboolean

followingsobject

Show child attributes

instanceobject

Show child attributes

autoFollowIndexobject

Show child attributes

indexUrlstring<url>

federationobject

Show child attributes

enabledboolean

homepageobject

Show child attributes

enabledboolean

openTelemetryobject

PeerTube >= 6.1

Show child attributes

metricsobject

Show child attributes

enabledboolean

playbackStatsIntervalnumber

Milliseconds

viewsobject

PeerTube >= 6.1

Show child attributes

videosobject

Show child attributes

countViewAfternumber

Milliseconds

watchingIntervalobject

Show child attributes

anonymousnumber

Milliseconds

usersnumber

Milliseconds

Example

{
  "instance": {
    "name": "string",
    "shortDescription": "string",
    "defaultClientRoute": "string",
    "isNSFW": true,
    "defaultNSFWPolicy": "string",
    "serverCountry": "string",
    "defaultLanguage": "string",
    "support": {
      "text": "string"
    },
    "social": {
      "externalLink": "string",
      "mastodonLink": "string",
      "blueskyLink": "string",
      "xLink": "string"
    },
    "customizations": {
      "javascript": "string",
      "css": "string"
    },
    "avatars": [
      {
        "path": "string",
        "fileUrl": "string",
        "width": 0,
        "height": 0,
        "createdAt": "2024-01-15T09:30:00Z",
        "updatedAt": "2024-01-15T09:30:00Z"
      }
    ],
    "banners": [
      {
        "path": "string",
        "fileUrl": "string",
        "width": 0,
        "height": 0,
        "createdAt": "2024-01-15T09:30:00Z",
        "updatedAt": "2024-01-15T09:30:00Z"
      }
    ]
  },
  "search": {
    "remoteUri": {
      "users": true,
      "anonymous": true
    }
  },
  "plugin": {
    "registered": [
      "string"
    ]
  },
  "theme": {
    "registered": [
      "string"
    ]
  },
  "email": {
    "enabled": true
  },
  "contactForm": {
    "enabled": true
  },
  "serverVersion": "string",
  "serverCommit": "string",
  "signup": {
    "allowed": true,
    "allowedForCurrentIP": true,
    "requiresEmailVerification": true
  },
  "transcoding": {
    "hls": {
      "enabled": true
    },
    "web_videos": {
      "enabled": true
    },
    "enabledResolutions": [
      240
    ]
  },
  "import": {
    "videos": {
      "http": {
        "enabled": true
      },
      "torrent": {
        "enabled": true
      }
    },
    "videoChannelSynchronization": {
      "enabled": true
    },
    "users": {
      "enabled": true,
      "resumableUpload": {
        "minChunkSize": 0
      }
    }
  },
  "export": {
    "users": {
      "enabled": true,
      "exportExpiration": 0,
      "maxUserVideoQuota": 0
    }
  },
  "autoBlacklist": {
    "videos": {
      "ofUsers": {
        "enabled": true
      }
    }
  },
  "blocklist": {
    "publicLog": {
      "enabled": true
    }
  },
  "avatar": {
    "file": {
      "size": {
        "max": 0
      }
    },
    "extensions": [
      "string"
    ]
  },
  "video": {
    "image": {
      "extensions": [
        "string"
      ],
      "size": {
        "max": 0
      }
    },
    "file": {
      "extensions": [
        "string"
      ]
    }
  },
  "videoCaption": {
    "file": {
      "size": {
        "max": 0
      },
      "extensions": [
        "string"
      ]
    }
  },
  "user": {
    "videoQuota": 16810141515,
    "videoQuotaDaily": 1681014151
  },
  "trending": {
    "videos": {
      "intervalDays": 0
    }
  },
  "tracker": {
    "enabled": true
  },
  "followings": {
    "instance": {
      "autoFollowIndex": {
        "indexUrl": "https://example.com"
      }
    }
  },
  "federation": {
    "enabled": true
  },
  "homepage": {
    "enabled": true
  },
  "openTelemetry": {
    "metrics": {
      "enabled": true,
      "playbackStatsInterval": 0
    }
  },
  "views": {
    "videos": {
      "countViewAfter": 0,
      "watchingInterval": {
        "anonymous": 0,
        "users": 0
      }
    }
  }
}

Docs by Sourcey