Models

ServerConfigAbout

object

instanceobject

Show child attributes

namestring

shortDescriptionstring

descriptionstring

termsstring

codeOfConductstring

hardwareInformationstring

creationReasonstring

moderationInformationstring

administratorstring

maintenanceLifetimestring

businessModelstring

supportobject

Show child attributes

textstring

languagesArray<string>

categoriesArray<integer>

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>

Example

{
  "instance": {
    "name": "string",
    "shortDescription": "string",
    "description": "string",
    "terms": "string",
    "codeOfConduct": "string",
    "hardwareInformation": "string",
    "creationReason": "string",
    "moderationInformation": "string",
    "administrator": "string",
    "maintenanceLifetime": "string",
    "businessModel": "string",
    "support": {
      "text": "string"
    },
    "languages": [
      "string"
    ],
    "categories": [
      0
    ],
    "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"
      }
    ]
  }
}

Docs by Sourcey