Users

Block a user

POST

https://peertube2.cpy.re/api/v1/users/{id}/block

Prevent a user from logging in and interacting with the instance

Block a user

curl -X POST 'https://peertube2.cpy.re/api/v1/users/42/block' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "reason": "string"
}'

const body = `{
  "reason": "string"
}`;

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

const data = await response.text();

import requests

body = '''{
  "reason": "string"
}'''

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

Request Body

{
  "reason": "string"
}

Body

application/json

reasonstring

Optional reason for blocking the user

Parameters

idid>= 1requiredpath

Entity id

Response

204No Content

successful operation

400Bad Request

invalid user id

403Forbidden

insufficient permissions to block users

404Not Found

user not found

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