Video Embed Privacy

Update video embed privacy

PUT

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

PeerTube >= 8.1

curl -X PUT 'https://peertube2.cpy.re/api/v1/videos/42/embed-privacy' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "policy": 1,
  "domains": [
    "example.com"
  ]
}'

const body = `{
  "policy": 1,
  "domains": [
    "example.com"
  ]
}`;

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

const data = await response.text();

import requests

body = '''{
  "policy": 1,
  "domains": [
    "example.com"
  ]
}'''

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

Request Body

{
  "policy": 1,
  "domains": [
    "example.com"
  ]
}

Body

application/json

policyVideoEmbedPrivacy1234

The video embed privacy level:

1 All allowed: anyone can embed the video
2 Allowlist: only the domains in the allowlist can embed the video
3 Remote restrictions: the remote instance has restrictions on where the video can be embedded
4 Nobody can embed this video

domainsArray<string>

Parameters

idid | UUIDv4 | shortUUIDrequiredpath

The object id, uuid or short uuid

Response

204No Content

successful operation

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