Moderation

Watched Words

Manage list of watched words to detect patterns on objects (like comments of videos)

List account watched words

GET

https://peertube2.cpy.re/api/v1/watched-words/accounts/{accountName}/lists

PeerTube >= 6.2

List account watched words

curl -X GET 'https://peertube2.cpy.re/api/v1/watched-words/accounts/string/lists' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/watched-words/accounts/string/lists', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://peertube2.cpy.re/api/v1/watched-words/accounts/string/lists',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{
  "total": 1,
  "data": [
    {
      "id": 42,
      "listName": "string",
      "words": [
        "string"
      ],
      "subscriptionUrl": "https://example.com",
      "updatedAt": "2021-05-04T08:01:01.502Z",
      "createdAt": "2021-05-04T08:01:01.502Z"
    }
  ]
}

Parameters

accountNamestringrequiredpath

account name to list watched words

Response

200OKany

successful operation

Response fields application/json

totalinteger

Example

dataArray<WatchedWordsLists>

Show child attributes

idid>= 1

Example

listNamestring

wordsArray<string>

subscriptionUrlstring<url> | null

updatedAtstring<date-time>

Example

2021-05-04T08:01:01.502Z

createdAtstring<date-time>

Example

2021-05-04T08:01:01.502Z

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.

Add account watched words

POST

https://peertube2.cpy.re/api/v1/watched-words/accounts/{accountName}/lists

PeerTube >= 6.2

Add account watched words

curl -X POST 'https://peertube2.cpy.re/api/v1/watched-words/accounts/string/lists' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "listName": "string",
  "words": [
    "string"
  ]
}'

const body = `{
  "listName": "string",
  "words": [
    "string"
  ]
}`;

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

const data = await response.text();

import requests

body = '''{
  "listName": "string",
  "words": [
    "string"
  ]
}'''

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

Request Body

{
  "listName": "string",
  "words": [
    "string"
  ]
}

200

{
  "watchedWordsList": {
    "id": 0
  }
}

Body

application/json

listNamestring

wordsArray<string>

Parameters

accountNamestringrequiredpath

Response

200OKobject

successful operation

Response fields application/json

watchedWordsListobject

Show child attributes

idinteger

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.

Update account watched words

PUT

https://peertube2.cpy.re/api/v1/watched-words/accounts/{accountName}/lists/{listId}

PeerTube >= 6.2

Update account watched words

curl -X PUT 'https://peertube2.cpy.re/api/v1/watched-words/accounts/string/lists/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "listName": "string",
  "words": [
    "string"
  ]
}'

const body = `{
  "listName": "string",
  "words": [
    "string"
  ]
}`;

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

const data = await response.text();

import requests

body = '''{
  "listName": "string",
  "words": [
    "string"
  ]
}'''

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

Request Body

{
  "listName": "string",
  "words": [
    "string"
  ]
}

Body

application/json

listNamestring

wordsArray<string>

Parameters

accountNamestringrequiredpath

listIdstringrequiredpath

list of watched words to update

Response

204No Content

successful operation

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.

Delete account watched words

DELETE

https://peertube2.cpy.re/api/v1/watched-words/accounts/{accountName}/lists/{listId}

PeerTube >= 6.2

Delete account watched words

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

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

const data = await response.text();

import requests

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

Parameters

accountNamestringrequiredpath

listIdstringrequiredpath

list of watched words to delete

Response

204No Content

successful operation

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.

List server watched words

GET

https://peertube2.cpy.re/api/v1/watched-words/server/lists

PeerTube >= 6.2

List server watched words

curl -X GET 'https://peertube2.cpy.re/api/v1/watched-words/server/lists' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/watched-words/server/lists', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://peertube2.cpy.re/api/v1/watched-words/server/lists',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{
  "total": 1,
  "data": [
    {
      "id": 42,
      "listName": "string",
      "words": [
        "string"
      ],
      "subscriptionUrl": "https://example.com",
      "updatedAt": "2021-05-04T08:01:01.502Z",
      "createdAt": "2021-05-04T08:01:01.502Z"
    }
  ]
}

Response

200OKany

successful operation

Response fields application/json

totalinteger

Example

dataArray<WatchedWordsLists>

Show child attributes

idid>= 1

Example

listNamestring

wordsArray<string>

subscriptionUrlstring<url> | null

updatedAtstring<date-time>

Example

2021-05-04T08:01:01.502Z

createdAtstring<date-time>

Example

2021-05-04T08:01:01.502Z

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, moderator

Add server watched words

POST

https://peertube2.cpy.re/api/v1/watched-words/server/lists

PeerTube >= 6.2

Add server watched words

curl -X POST 'https://peertube2.cpy.re/api/v1/watched-words/server/lists' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "listName": "string",
  "words": [
    "string"
  ]
}'

const body = `{
  "listName": "string",
  "words": [
    "string"
  ]
}`;

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

const data = await response.text();

import requests

body = '''{
  "listName": "string",
  "words": [
    "string"
  ]
}'''

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

Request Body

{
  "listName": "string",
  "words": [
    "string"
  ]
}

200

{
  "watchedWordsList": {
    "id": 0
  }
}

Body

application/json

listNamestring

wordsArray<string>

Response

200OKobject

successful operation

Response fields application/json

watchedWordsListobject

Show child attributes

idinteger

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, moderator

Update server watched words

PUT

https://peertube2.cpy.re/api/v1/watched-words/server/lists/{listId}

PeerTube >= 6.2

Update server watched words

curl -X PUT 'https://peertube2.cpy.re/api/v1/watched-words/server/lists/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "listName": "string",
  "words": [
    "string"
  ]
}'

const body = `{
  "listName": "string",
  "words": [
    "string"
  ]
}`;

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

const data = await response.text();

import requests

body = '''{
  "listName": "string",
  "words": [
    "string"
  ]
}'''

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

Request Body

{
  "listName": "string",
  "words": [
    "string"
  ]
}

Body

application/json

listNamestring

wordsArray<string>

Parameters

listIdstringrequiredpath

list of watched words to update

Response

204No Content

successful operation

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, moderator

Delete server watched words

DELETE

https://peertube2.cpy.re/api/v1/watched-words/server/lists/{listId}

PeerTube >= 6.2

Delete server watched words

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

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

const data = await response.text();

import requests

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

Parameters

listIdstringrequiredpath

list of watched words to delete

Response

204No Content

successful operation

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, moderator

List account watched words subscriptions

GET

https://peertube2.cpy.re/api/v1/watched-words/accounts/{accountName}/subscriptions

List account watched words subscriptions

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

const response = await fetch('https://peertube2.cpy.re/api/v1/watched-words/accounts/string/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/watched-words/accounts/string/subscriptions?count=15',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{
  "total": 1,
  "data": [
    {
      "id": 42,
      "name": "string",
      "url": "https://example.com",
      "importedWordsCount": 0,
      "lastSyncAt": "2021-05-04T08:01:01.502Z",
      "state": {
        "id": 1,
        "label": "string"
      },
      "updatedAt": "2021-05-04T08:01:01.502Z",
      "createdAt": "2021-05-04T08:01:01.502Z"
    }
  ]
}

Parameters

accountNamestringrequiredpath

account name to list watched words subscriptions

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<WatchedWordsSubscription>

Show child attributes

idid>= 1

Example

namestring

urlstring<url>

importedWordsCountinteger>= 0

lastSyncAtstring<date-time> | null

Example

2021-05-04T08:01:01.502Z

stateobject

Show child attributes

idinteger1234

labelstring

updatedAtstring<date-time>

Example

2021-05-04T08:01:01.502Z

createdAtstring<date-time>

Example

2021-05-04T08:01:01.502Z

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.

Add account watched words subscription

POST

https://peertube2.cpy.re/api/v1/watched-words/accounts/{accountName}/subscriptions

Add account watched words subscription

curl -X POST 'https://peertube2.cpy.re/api/v1/watched-words/accounts/string/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/watched-words/accounts/string/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/watched-words/accounts/string/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",
  "importedWordsCount": 0,
  "lastSyncAt": "2021-05-04T08:01:01.502Z",
  "state": {
    "id": 1,
    "label": "string"
  },
  "updatedAt": "2021-05-04T08:01:01.502Z",
  "createdAt": "2021-05-04T08:01:01.502Z"
}

Body

application/json

urlstring<url>required

Parameters

accountNamestringrequiredpath

Response

200OKWatchedWordsSubscription

successful operation

Response fields application/json

idid>= 1

Example

namestring

urlstring<url>

importedWordsCountinteger>= 0

lastSyncAtstring<date-time> | null

Example

2021-05-04T08:01:01.502Z

stateobject

Show child attributes

idinteger1234

labelstring

updatedAtstring<date-time>

Example

2021-05-04T08:01:01.502Z

createdAtstring<date-time>

Example

2021-05-04T08:01:01.502Z

400Bad Request

cannot fetch or parse watched words URL

409Conflict

subscription already exists or watched words list with fetched name 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.

Delete account watched words subscription

DELETE

https://peertube2.cpy.re/api/v1/watched-words/accounts/{accountName}/subscriptions/{id}

Delete account watched words subscription

curl -X DELETE 'https://peertube2.cpy.re/api/v1/watched-words/accounts/string/subscriptions/0' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/watched-words/accounts/string/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/watched-words/accounts/string/subscriptions/0',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

Parameters

accountNamestringrequiredpath

idintegerrequiredpath

Response

204No Content

successful operation

404Not Found

watched words 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.

List server watched words subscriptions

GET

https://peertube2.cpy.re/api/v1/watched-words/server/subscriptions

List server watched words subscriptions

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

const response = await fetch('https://peertube2.cpy.re/api/v1/watched-words/server/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/watched-words/server/subscriptions?count=15',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{
  "total": 1,
  "data": [
    {
      "id": 42,
      "name": "string",
      "url": "https://example.com",
      "importedWordsCount": 0,
      "lastSyncAt": "2021-05-04T08:01:01.502Z",
      "state": {
        "id": 1,
        "label": "string"
      },
      "updatedAt": "2021-05-04T08:01:01.502Z",
      "createdAt": "2021-05-04T08:01:01.502Z"
    }
  ]
}

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<WatchedWordsSubscription>

Show child attributes

idid>= 1

Example

namestring

urlstring<url>

importedWordsCountinteger>= 0

lastSyncAtstring<date-time> | null

Example

2021-05-04T08:01:01.502Z

stateobject

Show child attributes

idinteger1234

labelstring

updatedAtstring<date-time>

Example

2021-05-04T08:01:01.502Z

createdAtstring<date-time>

Example

2021-05-04T08:01:01.502Z

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, moderator

Add server watched words subscription

POST

https://peertube2.cpy.re/api/v1/watched-words/server/subscriptions

Add server watched words subscription

curl -X POST 'https://peertube2.cpy.re/api/v1/watched-words/server/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/watched-words/server/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/watched-words/server/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",
  "importedWordsCount": 0,
  "lastSyncAt": "2021-05-04T08:01:01.502Z",
  "state": {
    "id": 1,
    "label": "string"
  },
  "updatedAt": "2021-05-04T08:01:01.502Z",
  "createdAt": "2021-05-04T08:01:01.502Z"
}

Body

application/json

urlstring<url>required

Response

200OKWatchedWordsSubscription

successful operation

Response fields application/json

idid>= 1

Example

namestring

urlstring<url>

importedWordsCountinteger>= 0

lastSyncAtstring<date-time> | null

Example

2021-05-04T08:01:01.502Z

stateobject

Show child attributes

idinteger1234

labelstring

updatedAtstring<date-time>

Example

2021-05-04T08:01:01.502Z

createdAtstring<date-time>

Example

2021-05-04T08:01:01.502Z

400Bad Request

cannot fetch or parse watched words URL

409Conflict

subscription already exists or watched words list with fetched name 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, moderator

Delete server watched words subscription

DELETE

https://peertube2.cpy.re/api/v1/watched-words/server/subscriptions/{id}

Delete server watched words subscription

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

const response = await fetch('https://peertube2.cpy.re/api/v1/watched-words/server/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/watched-words/server/subscriptions/0',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

Parameters

idintegerrequiredpath

Response

204No Content

successful operation

404Not Found

watched words 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, moderator

Docs by Sourcey