Moderation

Server Blocklist

GETGet block status of accounts/hosts

List blocked accounts by server

GET

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

List blocked accounts by server

curl -X GET 'https://peertube2.cpy.re/api/v1/server/blocklist/accounts?count=15' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/server/blocklist/accounts?count=15', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://peertube2.cpy.re/api/v1/server/blocklist/accounts?count=15',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{
  "total": 1,
  "data": [
    {
      "byAccount": {
        "id": 42,
        "url": "https://example.com",
        "avatars": [
          {
            "path": "string",
            "fileUrl": "string",
            "width": 0,
            "height": 0,
            "createdAt": "2024-01-15T09:30:00Z",
            "updatedAt": "2024-01-15T09:30:00Z"
          }
        ],
        "host": "example.com",
        "hostRedundancyAllowed": true,
        "followingCount": 0,
        "followersCount": 0,
        "createdAt": "2024-01-15T09:30:00Z",
        "updatedAt": "2024-01-15T09:30:00Z",
        "displayName": "string",
        "description": "string"
      },
      "blockedAccount": {
        "id": 42,
        "url": "https://example.com",
        "avatars": [
          {
            "path": "string",
            "fileUrl": "string",
            "width": 0,
            "height": 0,
            "createdAt": "2024-01-15T09:30:00Z",
            "updatedAt": "2024-01-15T09:30:00Z"
          }
        ],
        "host": "example.com",
        "hostRedundancyAllowed": true,
        "followingCount": 0,
        "followersCount": 0,
        "createdAt": "2024-01-15T09:30:00Z",
        "updatedAt": "2024-01-15T09:30:00Z",
        "displayName": "string",
        "description": "string"
      },
      "blocklistSubscription": {
        "id": 42,
        "name": "string",
        "url": "https://example.com"
      },
      "createdAt": "2024-01-15T09:30:00Z"
    }
  ]
}

Parameters

startinteger>= 0query

Offset used to paginate results

countinteger[1, 100]15query

Number of items to return

sortstringquery

Sort column

subscriptionNamestringquery

Response

200OKobject

successful operation

Response fields application/json

totalinteger

Example

dataArray<AccountBlock>

Show child attributes

byAccountActor & any

Show child attributes

idid>= 1

Example

urlstring<url>

nameusername

immutable name of the actor, used to find or mention it

Show child attributes

immutable name of the user, used to find or mention its actor

username

Example

chocobozzz

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>

hoststring<hostname>

server on which the actor is resident

hostRedundancyAllowedboolean | null

whether this actor's host allows redundancy of its videos

followingCountinteger>= 0

number of actors subscribed to by this actor, as seen by this instance

followersCountinteger>= 0

number of followers of this actor, as seen by this instance

createdAtstring<date-time>

updatedAtstring<date-time>

userIdid | null

object id for the user tied to this account

Show child attributes

id>= 1

Example

displayNamestring

editable name of the account, displayed in its representations

descriptionstring | null

text or bio displayed on the account's profile

blockedAccountActor & any

Show child attributes

idid>= 1

Example

Same fields as data.byAccount.userId

urlstring<url>

nameusername

immutable name of the actor, used to find or mention it

Show child attributes

immutable name of the user, used to find or mention its actor

username

Example

chocobozzz

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>

hoststring<hostname>

server on which the actor is resident

hostRedundancyAllowedboolean | null

whether this actor's host allows redundancy of its videos

followingCountinteger>= 0

number of actors subscribed to by this actor, as seen by this instance

followersCountinteger>= 0

number of followers of this actor, as seen by this instance

createdAtstring<date-time>

updatedAtstring<date-time>

userIdid | null

object id for the user tied to this account

Show child attributes

id>= 1

Example

displayNamestring

editable name of the account, displayed in its representations

descriptionstring | null

text or bio displayed on the account's profile

blocklistSubscriptionBlocklistSubscriptionSummary | null

Show child attributes

idid>= 1

Example

Same fields as data.byAccount.userId

namestring

urlstring<url>

createdAtstring<date-time>

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

Block an account by server

POST

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

Block an account by server

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

Unblock an account by server

DELETE

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

Unblock an account by server

curl -X DELETE 'https://peertube2.cpy.re/api/v1/server/blocklist/accounts/string' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/server/blocklist/accounts/string', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.delete(
    'https://peertube2.cpy.re/api/v1/server/blocklist/accounts/string',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

Parameters

accountNamestringrequiredpath

account to unblock, in the form username@domain

Response

201Created

successful operation

404Not Found

account or account block does not exist

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

List blocked servers by server

GET

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

List blocked servers by server

curl -X GET 'https://peertube2.cpy.re/api/v1/server/blocklist/servers?count=15' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/server/blocklist/servers?count=15', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://peertube2.cpy.re/api/v1/server/blocklist/servers?count=15',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{
  "total": 1,
  "data": [
    {
      "byAccount": {
        "id": 42,
        "url": "https://example.com",
        "avatars": [
          {
            "path": "string",
            "fileUrl": "string",
            "width": 0,
            "height": 0,
            "createdAt": "2024-01-15T09:30:00Z",
            "updatedAt": "2024-01-15T09:30:00Z"
          }
        ],
        "host": "example.com",
        "hostRedundancyAllowed": true,
        "followingCount": 0,
        "followersCount": 0,
        "createdAt": "2024-01-15T09:30:00Z",
        "updatedAt": "2024-01-15T09:30:00Z",
        "displayName": "string",
        "description": "string"
      },
      "blockedServer": {
        "host": "example.com"
      },
      "blocklistSubscription": {
        "id": 42,
        "name": "string",
        "url": "https://example.com"
      },
      "createdAt": "2024-01-15T09:30:00Z"
    }
  ]
}

Parameters

startinteger>= 0query

Offset used to paginate results

countinteger[1, 100]15query

Number of items to return

sortstringquery

Sort column

subscriptionNamestringquery

Response

200OKobject

successful operation

Response fields application/json

totalinteger

Example

dataArray<ServerBlock>

Show child attributes

byAccountActor & any

Show child attributes

idid>= 1

Example

urlstring<url>

nameusername

immutable name of the actor, used to find or mention it

Show child attributes

immutable name of the user, used to find or mention its actor

username

Example

chocobozzz

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>

hoststring<hostname>

server on which the actor is resident

hostRedundancyAllowedboolean | null

whether this actor's host allows redundancy of its videos

followingCountinteger>= 0

number of actors subscribed to by this actor, as seen by this instance

followersCountinteger>= 0

number of followers of this actor, as seen by this instance

createdAtstring<date-time>

updatedAtstring<date-time>

userIdid | null

object id for the user tied to this account

Show child attributes

id>= 1

Example

displayNamestring

editable name of the account, displayed in its representations

descriptionstring | null

text or bio displayed on the account's profile

blockedServerobject

Show child attributes

hoststring<hostname>

blocklistSubscriptionBlocklistSubscriptionSummary | null

Show child attributes

idid>= 1

Example

Same fields as data.byAccount.userId

namestring

urlstring<url>

createdAtstring<date-time>

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

Block a server by server

POST

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

Block a server by server

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

const body = `{
  "host": "example.com"
}`;

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

const data = await response.text();

import requests

body = '''{
  "host": "example.com"
}'''

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

Request Body

{
  "host": "example.com"
}

Body

application/json

hoststring<hostname>required

server domain to block

Response

204No Content

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

Unblock a server by server

DELETE

https://peertube2.cpy.re/api/v1/server/blocklist/servers/{host}

Unblock a server by server

curl -X DELETE 'https://peertube2.cpy.re/api/v1/server/blocklist/servers/example.com' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/server/blocklist/servers/example.com', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.delete(
    'https://peertube2.cpy.re/api/v1/server/blocklist/servers/example.com',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

Parameters

hoststring<hostname>requiredpath

server domain to unblock

Response

204No Content

successful operation

404Not Found

server block does not exist

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

List server blocklist subscriptions

GET

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

List server blocklist subscriptions

curl -X GET 'https://peertube2.cpy.re/api/v1/server/blocklist/subscriptions?count=15' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/server/blocklist/subscriptions?count=15', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://peertube2.cpy.re/api/v1/server/blocklist/subscriptions?count=15',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{
  "total": 1,
  "data": [
    {
      "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"
    }
  ]
}

Parameters

startinteger>= 0query

Offset used to paginate results

countinteger[1, 100]15query

Number of items to return

sortstringquery

Sort column

searchstringquery

Plain text search, applied to various parts of the model depending on endpoint

Response

200OKobject

successful operation

Response fields application/json

totalinteger

Example

dataArray<BlocklistSubscription>

Show child attributes

idid>= 1

Example

namestring

urlstring<url>

mutedAccountsCountinteger>= 0

mutedServersCountinteger>= 0

lastSyncAtstring<date-time>

createdAtstring<date-time>

updatedAtstring<date-time>

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

Add a server blocklist subscription

POST

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

Add a server blocklist subscription

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

Delete a server blocklist subscription

DELETE

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

Delete a server blocklist subscription

curl -X DELETE 'https://peertube2.cpy.re/api/v1/server/blocklist/subscriptions/0' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/server/blocklist/subscriptions/0', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.delete(
    'https://peertube2.cpy.re/api/v1/server/blocklist/subscriptions/0',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

Parameters

idintegerrequiredpath

Response

204No Content

successful operation

404Not Found

subscription does not exist

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

List publicly shared server blocklist log entries

GET

https://peertube2.cpy.re/api/v1/server/blocklist/public-log

List publicly shared server blocklist log entries

curl -X GET 'https://peertube2.cpy.re/api/v1/server/blocklist/public-log?startDate=2024-01-15T09%3A30%3A00Z'

const response = await fetch('https://peertube2.cpy.re/api/v1/server/blocklist/public-log?startDate=2024-01-15T09%3A30%3A00Z', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('https://peertube2.cpy.re/api/v1/server/blocklist/public-log?startDate=2024-01-15T09%3A30%3A00Z')
print(response.text)

200

{
  "name": "string",
  "actions": [
    {
      "type": "block",
      "target": "string",
      "createdAt": "2024-01-15T09:30:00Z"
    }
  ]
}

Parameters

startDatestring<date-time>requiredquery

Response

200OKAutoMuteList

successful operation

Response fields application/json

namestring

actionsArray<object>

Show child attributes

typestringblockunblock

targetstring

createdAtstring<date-time>

403Forbidden

public log is disabled

Docs by Sourcey