User Imports

Initialize the resumable user import

POST

https://peertube2.cpy.re/api/v1/users/{userId}/imports/import-resumable

PeerTube >= 6.1 Uses a resumable protocol to initialize the import of the archive

curl -X POST 'https://peertube2.cpy.re/api/v1/users/42/imports/import-resumable' \
  -H 'X-Upload-Content-Length: 2469036' \
  -H 'X-Upload-Content-Type: video/mp4' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "filename": "user-export-6-2024-02-09T10_12_11.682Z"
}'

const body = `{
  "filename": "user-export-6-2024-02-09T10_12_11.682Z"
}`;

const response = await fetch('https://peertube2.cpy.re/api/v1/users/42/imports/import-resumable', {
  method: 'POST',
  headers: {
    'X-Upload-Content-Length': '2469036',
    'X-Upload-Content-Type': 'video/mp4',
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "filename": "user-export-6-2024-02-09T10_12_11.682Z"
}'''

response = requests.post(
    'https://peertube2.cpy.re/api/v1/users/42/imports/import-resumable',
    data=body.encode('utf-8'),
    headers={
        'X-Upload-Content-Length': '2469036',
        'X-Upload-Content-Type': 'video/mp4',
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "filename": "user-export-6-2024-02-09T10_12_11.682Z"
}

Body

application/json

filenamestring<filename>

Archive filename including extension

Example

user-export-6-2024-02-09T10_12_11.682Z

Parameters

userIdid>= 1requiredpath

User id

X-Upload-Content-Lengthnumberrequiredheader

Number of bytes that will be uploaded in subsequent requests. Set this value to the size of the file you are uploading.

X-Upload-Content-Typestring<mimetype>requiredheader

MIME type of the file that you are uploading. Depending on your instance settings, acceptable values might vary.

Response

201Created

created

Response headers

Locationstring<url>header

Content-Lengthnumberheader

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