Server Blocklist

Block an account by server

POST

https://peertube2.cpy.re/api/v1/server/blocklist/accounts

curl -X POST 'https://peertube2.cpy.re/api/v1/server/blocklist/accounts' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "accountName": "chocobozzz@example.org"
}'

const body = `{
  "accountName": "chocobozzz@example.org"
}`;

const response = await fetch('https://peertube2.cpy.re/api/v1/server/blocklist/accounts', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "accountName": "chocobozzz@example.org"
}'''

response = requests.post(
    'https://peertube2.cpy.re/api/v1/server/blocklist/accounts',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "accountName": "chocobozzz@example.org"
}

Body

application/json

accountNamestringrequired

account to block, in the form username@domain

Example

chocobozzz@example.org

Response

200OK

successful operation

409Conflict

self-blocking forbidden

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