Video Embed Privacy

Check if embed is allowed

GET

https://peertube2.cpy.re/api/v1/videos/{id}/embed-privacy/allowed

PeerTube >= 8.1 Check if video embed is allowed on a specific domain according to the video embed privacy settings

curl -X GET 'https://peertube2.cpy.re/api/v1/videos/42/embed-privacy/allowed?domain=string' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/videos/42/embed-privacy/allowed?domain=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://peertube2.cpy.re/api/v1/videos/42/embed-privacy/allowed?domain=string',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{
  "domainAllowed": true,
  "userBypassAllowed": true
}

Parameters

idid | UUIDv4 | shortUUIDrequiredpath

The object id, uuid or short uuid

domainstringrequiredquery

The domain to check if embed is allowed

Response

200OKobject

successful operation

Response fields application/json

domainAllowedboolean

userBypassAllowedboolean | null

Whether the user can bypass embed restrictions for this video, either because they are the owner/editor of the video or because they have a moderator or admin role

400Bad Request

invalid request

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: user

Docs by Sourcey