Server Blocklist

Add a server blocklist subscription

POST

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

curl -X POST 'https://peertube2.cpy.re/api/v1/server/blocklist/subscriptions' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "url": "https://example.com"
}'

const body = `{
  "url": "https://example.com"
}`;

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

const data = await response.text();

import requests

body = '''{
  "url": "https://example.com"
}'''

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

Request Body

{
  "url": "https://example.com"
}

200

{
  "id": 42,
  "name": "string",
  "url": "https://example.com",
  "mutedAccountsCount": 0,
  "mutedServersCount": 0,
  "lastSyncAt": "2024-01-15T09:30:00Z",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z"
}

Body

application/json

urlstring<url>required

Response

200OKBlocklistSubscription

successful operation

Response fields application/json

idid>= 1

Example

namestring

urlstring<url>

mutedAccountsCountinteger>= 0

mutedServersCountinteger>= 0

lastSyncAtstring<date-time>

createdAtstring<date-time>

updatedAtstring<date-time>

409Conflict

subscription already exists

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