Config

Update instance banner

POST

https://peertube2.cpy.re/api/v1/config/instance-banner/pick

curl -X POST 'https://peertube2.cpy.re/api/v1/config/instance-banner/pick' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const form = new FormData();
const response = await fetch('https://peertube2.cpy.re/api/v1/config/instance-banner/pick', {
  method: 'POST',
  headers: {"Authorization":"Bearer YOUR_TOKEN"},
  body: form,
});
console.log(await response.text());

import requests
from contextlib import ExitStack

with ExitStack() as stack:
    files = [
    ]
    response = requests.request('POST', 'https://peertube2.cpy.re/api/v1/config/instance-banner/pick', headers={"Authorization":"Bearer YOUR_TOKEN"}, files=files)
    print(response.text)

Request Body

{
  "bannerfile": "<binary>"
}

Body

multipart/form-data

multipart/form-dataobject

Encoding

bannerfileimage/png, image/jpeg

bannerfilestring<binary>

The file to upload.

Response

204No Content

successful operation

413Payload Too Large

image file too large

Response headers

X-File-Maximum-Sizestring<Nginx size>header

Maximum file size for the banner

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