Videos

Video Passwords

Operations on video passwords.

List video passwords

GET

https://peertube2.cpy.re/api/v1/videos/{id}/passwords

PeerTube >= 6.0

List video passwords

curl -X GET 'https://peertube2.cpy.re/api/v1/videos/42/passwords?count=15' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/videos/42/passwords?count=15', {
  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/passwords?count=15',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{
  "total": 1,
  "data": [
    {
      "id": 42,
      "password": "string",
      "videoId": 42
    }
  ]
}

Parameters

idid | UUIDv4 | shortUUIDrequiredpath

The object id, uuid or short uuid

startinteger>= 0query

Offset used to paginate results

countinteger[1, 100]15query

Number of items to return

sortstringquery

Sort column

Response

200OKVideoPasswordList

successful operation

Response fields application/json

totalinteger

Example

dataArray<VideoPassword>

Show child attributes

idid>= 1

Example

passwordpassword

videoIdid>= 1

Example

400Bad Request

video is not password protected

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

Add a video password

POST

https://peertube2.cpy.re/api/v1/videos/{id}/passwords

PeerTube >= 8.0

Add a video password

curl -X POST 'https://peertube2.cpy.re/api/v1/videos/42/passwords' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "password": "string"
}'

const body = `{
  "password": "string"
}`;

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

const data = await response.text();

import requests

body = '''{
  "password": "string"
}'''

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

Request Body

{
  "password": "string"
}

Body

application/json

passwordstring

Parameters

idid | UUIDv4 | shortUUIDrequiredpath

The object id, uuid or short uuid

Response

204No Content

successful operation

400Bad Request

video is not password protected

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

Update video passwords

PUT

https://peertube2.cpy.re/api/v1/videos/{id}/passwords

PeerTube >= 6.0

Update video passwords

curl -X PUT 'https://peertube2.cpy.re/api/v1/videos/42/passwords' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "passwords": [
    "string"
  ]
}'

const body = `{
  "passwords": [
    "string"
  ]
}`;

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

const data = await response.text();

import requests

body = '''{
  "passwords": [
    "string"
  ]
}'''

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

Request Body

{
  "passwords": [
    "string"
  ]
}

Body

application/json

passwordsArray<password>

Parameters

idid | UUIDv4 | shortUUIDrequiredpath

The object id, uuid or short uuid

Response

204No Content

successful operation

400Bad Request

video is not password protected

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

Delete a video password

DELETE

https://peertube2.cpy.re/api/v1/videos/{id}/passwords/{passwordId}

PeerTube >= 6.0

Delete a video password

curl -X DELETE 'https://peertube2.cpy.re/api/v1/videos/42/passwords/42' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/videos/42/passwords/42', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.delete(
    'https://peertube2.cpy.re/api/v1/videos/42/passwords/42',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

Parameters

idid | UUIDv4 | shortUUIDrequiredpath

The object id, uuid or short uuid

passwordIdid>= 1requiredpath

The video password id

Response

204No Content

successful operation

400Bad Request

video is not password protected

403Forbidden

cannot delete the last password of the protected video

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