Accounts

User Exports

To create an archive of user data.

Request user export

POST

https://peertube2.cpy.re/api/v1/users/{userId}/exports/request

Request an archive of user data. An email is sent when the archive is ready.

Request user export

curl -X POST 'https://peertube2.cpy.re/api/v1/users/42/exports/request' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "withVideoFiles": true
}'

const body = `{
  "withVideoFiles": true
}`;

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

const data = await response.text();

import requests

body = '''{
  "withVideoFiles": true
}'''

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

Request Body

{
  "withVideoFiles": true
}

200

{
  "export": {
    "id": 0
  }
}

Body

application/json

withVideoFilesboolean

Whether to include video files in the archive

Parameters

userIdid>= 1requiredpath

User id

Response

200OKobject

successful operation

Response fields application/json

exportobject

Show child attributes

idinteger

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.

List user exports

GET

https://peertube2.cpy.re/api/v1/users/{userId}/exports

PeerTube >= 6.1

List user exports

curl -X GET 'https://peertube2.cpy.re/api/v1/users/42/exports' \
  -H 'Authorization: Bearer YOUR_TOKEN'

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

const data = await response.text();

import requests

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

200

{
  "id": 0,
  "state": {
    "id": 1,
    "label": "string"
  },
  "size": 0,
  "privateDownloadUrl": "string",
  "createdAt": "2024-01-15T09:30:00Z",
  "expiresOn": "2024-01-15T09:30:00Z"
}

Parameters

userIdid>= 1requiredpath

User id

Response

200OKobject

successful operation

Response fields application/json

idinteger

stateobject

Show child attributes

idUserExportState1234

The user export state:

1: Pending
2: Processing
3: Completed
4: Errored

labelstring

sizeinteger

Size of the archive file in bytes

privateDownloadUrlstring

This URL already contains the JWT token, so no additional authentication credentials are required

createdAtstring<date-time>

expiresOnstring<date-time>

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.

Delete a user export

DELETE

https://peertube2.cpy.re/api/v1/users/{userId}/exports/{id}

PeerTube >= 6.1

Delete a user export

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

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

const data = await response.text();

import requests

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

Parameters

userIdid>= 1requiredpath

User id

idid>= 1requiredpath

Entity id

Response

204No Content

successful operation

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