Config

Get instance "About" information

GET

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

Translatable information is returned in the language of the request, using the x-peertube-language header or the Accept-Language header. If the instance has no translation for this language, the default information is returned.

curl -X GET 'https://peertube2.cpy.re/api/v1/config/about'

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

const data = await response.text();

import requests

response = requests.get('https://peertube2.cpy.re/api/v1/config/about')
print(response.text)

200

{
  "instance": {
    "name": "PeerTube Nightly",
    "shortDescription": "PeerTube instance updated nightly",
    "description": "This instance is a test instance of the PeerTube project. It is updated to the latest commit in the develop branch every business day, 8pm CET.",
    "terms": "No terms for now. Being a closed test instance, no real terms of use beyond fair use are to be expected.",
    "codeOfConduct": "",
    "hardwareInformation": "",
    "creationReason": "",
    "moderationInformation": "This instance only allows...",
    "administrator": "",
    "maintenanceLifetime": "",
    "businessModel": "",
    "support": {
      "text": ""
    },
    "languages": [
      "fr"
    ],
    "categories": [
      16
    ],
    "banners": [
      {
        "height": 100,
        "width": 600,
        "path": "/lazy-static/banners/d853452c-f020-4c6f-a4ea-9fc582d68ff2.jpg",
        "fileUrl": "https://peertube2.cpy.re/lazy-static/banners/d853452c-f020-4c6f-a4ea-9fc582d68ff2.jpg",
        "createdAt": "2024-04-16T14:09:02.665Z",
        "updatedAt": "2024-04-16T14:09:02.665Z"
      },
      {
        "height": 317,
        "width": 1920,
        "path": "/lazy-static/banners/772ff0ae-6cb5-4d1c-b89b-ace85eece196.jpg",
        "fileUrl": "https://peertube2.cpy.re/lazy-static/banners/772ff0ae-6cb5-4d1c-b89b-ace85eece196.jpg",
        "createdAt": "2024-04-16T14:09:02.615Z",
        "updatedAt": "2024-04-16T14:09:02.615Z"
      }
    ],
    "avatars": [
      {
        "height": 1500,
        "width": 1500,
        "path": "/lazy-static/avatars/82936e50-9560-42e7-9e4b-d96309f5c9c9.png",
        "fileUrl": "https://peertube2.cpy.re/lazy-static/avatars/82936e50-9560-42e7-9e4b-d96309f5c9c9.png",
        "createdAt": "2024-05-15T09:12:38.684Z",
        "updatedAt": "2024-05-15T09:12:38.684Z"
      },
      {
        "height": 600,
        "width": 600,
        "path": "/lazy-static/avatars/177f70c4-ddef-4bb6-bc96-b00d5e2a0e05.png",
        "fileUrl": "https://peertube2.cpy.re/lazy-static/avatars/177f70c4-ddef-4bb6-bc96-b00d5e2a0e05.png",
        "createdAt": "2024-05-15T09:12:38.709Z",
        "updatedAt": "2024-05-15T09:12:38.709Z"
      },
      {
        "height": 120,
        "width": 120,
        "path": "/lazy-static/avatars/1163da44-0367-4df9-bf10-a1b0dc0e3fb9.png",
        "fileUrl": "https://peertube2.cpy.re/lazy-static/avatars/1163da44-0367-4df9-bf10-a1b0dc0e3fb9.png",
        "createdAt": "2024-05-15T09:12:38.719Z",
        "updatedAt": "2024-05-15T09:12:38.719Z"
      },
      {
        "height": 48,
        "width": 48,
        "path": "/lazy-static/avatars/abace30f-69ad-4ff2-a954-dea06c5db6eb.png",
        "fileUrl": "https://peertube2.cpy.re/lazy-static/avatars/abace30f-69ad-4ff2-a954-dea06c5db6eb.png",
        "createdAt": "2024-05-15T09:12:38.749Z",
        "updatedAt": "2024-05-15T09:12:38.749Z"
      }
    ]
  }
}

Parameters

Response

200OKServerConfigAbout

successful operation

Response fields application/json

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>

Docs by Sourcey