Watched Words

Add server watched words subscription

POST

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

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

Docs by Sourcey