Abuses

Update an abuse

PUT

https://peertube2.cpy.re/api/v1/abuses/{abuseId}

Update an abuse

curl -X PUT 'https://peertube2.cpy.re/api/v1/abuses/42' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "state": 1,
  "moderationComment": "string"
}'

const body = `{
  "state": 1,
  "moderationComment": "string"
}`;

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

const data = await response.text();

import requests

body = '''{
  "state": 1,
  "moderationComment": "string"
}'''

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

Request Body

{
  "state": 1,
  "moderationComment": "string"
}

Body

application/json

stateAbuseStateSet123

The abuse state (Pending = 1, Rejected = 2, Accepted = 3)

moderationCommentstring

Update the report comment visible only to the moderation team

Parameters

abuseIdid>= 1requiredpath

Abuse id

Response

204No Content

successful operation

404Not Found

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

Docs by Sourcey