Abuses

Report an abuse

POST

https://peertube2.cpy.re/api/v1/abuses

You cannot report a video that you own or on which you are a collaborator (video channel editor).

Report an abuse

curl -X POST 'https://peertube2.cpy.re/api/v1/abuses' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "reason": "string",
  "predefinedReasons": [
    "violentOrAbusive"
  ],
  "video": {
    "startAt": 0,
    "endAt": 0
  },
  "comment": {},
  "account": {
    "id": 0
  }
}'

const body = `{
  "reason": "string",
  "predefinedReasons": [
    "violentOrAbusive"
  ],
  "video": {
    "startAt": 0,
    "endAt": 0
  },
  "comment": {},
  "account": {
    "id": 0
  }
}`;

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

const data = await response.text();

import requests

body = '''{
  "reason": "string",
  "predefinedReasons": [
    "violentOrAbusive"
  ],
  "video": {
    "startAt": 0,
    "endAt": 0
  },
  "comment": {},
  "account": {
    "id": 0
  }
}'''

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

Request Body

{
  "reason": "string",
  "predefinedReasons": [
    "violentOrAbusive"
  ],
  "video": {
    "startAt": 0,
    "endAt": 0
  },
  "comment": {},
  "account": {
    "id": 0
  }
}

200

{
  "abuse": {
    "id": 42
  }
}

Body

application/json

reasonstringrequired

Reason why the user reports this video

predefinedReasonsArray<string>violentOrAbusivehatefulOrAbusivespamOrMisleadingprivacyrightsserverRulesthumbnailscaptions

Reason categories that help triage reports

videoobject

Show child attributes

idid

Video id to report

Show child attributes

object id for the video

id>= 1

Example

startAtinteger<seconds>>= 0

Timestamp in the video that marks the beginning of the report

endAtinteger<seconds>>= 0

Timestamp in the video that marks the ending of the report

commentobject

Show child attributes

idid

Comment id to report

Show child attributes

id>= 1

Example

accountobject

Show child attributes

idinteger

Account id to report

Response

200OKobject

successful operation

Response fields application/json

abuseobject

Show child attributes

idid>= 1

Example

400Bad Request

incorrect request parameters

403Forbidden

cannot report a video you own or that you collaborate on

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.

Docs by Sourcey