Accounts

Users

Using some features of PeerTube require authentication, for which User provide different levels of permission as well as associated user information. Each user has a corresponding local Account for federation.

List users

GET

https://peertube2.cpy.re/api/v1/users

List users

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

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

200

[
  {
    "id": 42,
    "username": "chocobozzz",
    "email": "user@example.com",
    "emailVerified": true,
    "nsfwPolicy": "display",
    "nsfwFlagsDisplayed": 0,
    "nsfwFlagsHidden": 0,
    "nsfwFlagsWarned": 0,
    "nsfwFlagsBlurred": 0,
    "aiUsagesHidden": [
      1
    ],
    "adminFlags": 1,
    "autoPlayNextVideo": true,
    "autoPlayNextVideoPlaylist": true,
    "autoPlayVideo": true,
    "p2pEnabled": true,
    "videosHistoryEnabled": true,
    "videoLanguages": [
      "string"
    ],
    "videoCategories": [
      0
    ],
    "videoLive": "true",
    "language": "string",
    "videoQuota": -1,
    "videoQuotaDaily": -1,
    "role": {
      "id": 2,
      "label": "User"
    },
    "theme": "string",
    "account": {
      "id": 42,
      "url": "https://example.com",
      "avatars": [
        {
          "path": "string",
          "fileUrl": "string",
          "width": 0,
          "height": 0,
          "createdAt": "2024-01-15T09:30:00Z",
          "updatedAt": "2024-01-15T09:30:00Z"
        }
      ],
      "host": "example.com",
      "hostRedundancyAllowed": true,
      "followingCount": 0,
      "followersCount": 0,
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "displayName": "string",
      "description": "string"
    },
    "notificationSettings": {
      "abuseAsModerator": 0,
      "videoAutoBlacklistAsModerator": 0,
      "newUserRegistration": 0,
      "newVideoFromSubscription": 0,
      "blacklistOnMyVideo": 0,
      "myVideoPublished": 0,
      "myVideoImportFinished": 0,
      "commentMention": 0,
      "newCommentOnMyVideo": 0,
      "newFollow": 0,
      "newInstanceFollower": 0,
      "autoInstanceFollowing": 0,
      "abuseStateChange": 0,
      "abuseNewMessage": 0,
      "newPeerTubeVersion": 0,
      "newPluginVersion": 0,
      "myVideoStudioEditionFinished": 0,
      "myVideoTranscriptionGenerated": 0
    },
    "videoChannels": [
      {
        "id": 42,
        "url": "https://example.com",
        "avatars": [
          {
            "path": "string",
            "fileUrl": "string",
            "width": 0,
            "height": 0,
            "createdAt": "2024-01-15T09:30:00Z",
            "updatedAt": "2024-01-15T09:30:00Z"
          }
        ],
        "host": "example.com",
        "hostRedundancyAllowed": true,
        "followingCount": 0,
        "followersCount": 0,
        "createdAt": "2024-01-15T09:30:00Z",
        "updatedAt": "2024-01-15T09:30:00Z",
        "displayName": "Videos of Framasoft",
        "description": "Videos made with <3 by Framasoft",
        "support": "Please support our work on https://soutenir.framasoft.org/en/ <3",
        "publicEmail": "user@example.com",
        "isLocal": true,
        "banners": [
          {
            "path": "string",
            "fileUrl": "string",
            "width": 0,
            "height": 0,
            "createdAt": "2024-01-15T09:30:00Z",
            "updatedAt": "2024-01-15T09:30:00Z"
          }
        ],
        "ownerAccount": {
          "id": 42,
          "url": "https://example.com",
          "avatars": [
            {
              "path": "string",
              "fileUrl": "string",
              "width": 0,
              "height": 0,
              "createdAt": "2024-01-15T09:30:00Z",
              "updatedAt": "2024-01-15T09:30:00Z"
            }
          ],
          "host": "example.com",
          "hostRedundancyAllowed": true,
          "followingCount": 0,
          "followersCount": 0,
          "createdAt": "2024-01-15T09:30:00Z",
          "updatedAt": "2024-01-15T09:30:00Z",
          "displayName": "string",
          "description": "string"
        },
        "videosCount": 0,
        "viewsPerDay": [
          {
            "date": "2024-01-15T09:30:00Z",
            "views": 0
          }
        ],
        "viewsGroupInterval": "day",
        "totalViews": 0
      }
    ],
    "blocked": true,
    "blockedReason": "string",
    "noInstanceConfigWarningModal": true,
    "noAccountSetupWarningModal": true,
    "noWelcomeModal": true,
    "createdAt": "string",
    "pluginAuth": "string",
    "lastLoginDate": "2024-01-15T09:30:00Z",
    "twoFactorEnabled": true,
    "newFeaturesInfoRead": 0
  }
]

Parameters

searchstringquery

Plain text search that will match with user usernames or emails

blockedbooleanquery

Filter results down to (un)banned users

roleUserRole012query

Filter results down to users with a specific role

startinteger>= 0query

Offset used to paginate results

countinteger[1, 100]15query

Number of items to return

sortstring-id-username-createdAtquery

Sort users by criteria

Response

200OKArray<User>

successful operation

Response fields application/json

Array<User>

Show child attributes

idid>= 1

Example

usernameusername

immutable name of the user, used to find or mention its actor

Example

chocobozzz

emailemail<email>

The user email

emailVerifiedboolean

Has the user confirmed their email address?

nsfwPolicyNSFWPolicydisplaywarndo_not_list

nsfwFlagsDisplayedNSFWFlag0124

NSFW flags (can be combined using bitwise or operator)

0 NONE
1 VIOLENT
2 EXPLICIT_SEX

nsfwFlagsHiddenNSFWFlag0124

NSFW flags (can be combined using bitwise or operator)

0 NONE
1 VIOLENT
2 EXPLICIT_SEX

nsfwFlagsWarnedNSFWFlag0124

NSFW flags (can be combined using bitwise or operator)

0 NONE
1 VIOLENT
2 EXPLICIT_SEX

nsfwFlagsBlurredNSFWFlag0124

NSFW flags (can be combined using bitwise or operator)

0 NONE
1 VIOLENT
2 EXPLICIT_SEX

aiUsagesHiddenArray<VideoAIUsageSet>1234

PeerTube >= 9.0 Videos with these AI usages are hidden from video lists

adminFlagsUserAdminFlags01

Admin flags for the user (None = 0, Bypass video blocklist = 1)

Example

autoPlayNextVideoboolean

Automatically start playing the upcoming video after the currently playing video

autoPlayNextVideoPlaylistboolean

Automatically start playing the video on the playlist after the currently playing video

autoPlayVideoboolean

Automatically start playing the video on the watch page

p2pEnabledboolean

whether to enable P2P in the player or not

videosHistoryEnabledboolean

whether to keep track of watched history or not

videoLanguagesArray<string>

list of languages to filter videos down to

videoCategoriesArray<integer> | null

list of categories to filter videos down to (null means all categories)

videoLivestringtruefalseboth

filter videos down to lives (true), VODs (false) or display both

languagestring

default language for this user

videoQuotainteger

The user video quota in bytes

Example

-1

videoQuotaDailyinteger

The user daily video quota in bytes

Example

-1

roleobject

Show child attributes

idUserRole012

The user role (Admin = 0, Moderator = 1, User = 2)

Example

labelstringUserModeratorAdministrator

themestring

Theme enabled by this user

accountActor & any

Show child attributes

idid>= 1

Example

urlstring<url>

nameusername

immutable name of the actor, used to find or mention it

Show child attributes

immutable name of the user, used to find or mention its actor

username

Example

chocobozzz

avatarsArray<ActorImage>

Show child attributes

pathstring | nulldeprecated

Deprecated in PeerTube v8.0, use fileUrl instead. Null if the file is stored in object storage: use the non-deprecated field instead.

fileUrlstring

PeerTube >= 7.1

widthinteger

heightinteger

PeerTube >= 7.3

createdAtstring<date-time>

updatedAtstring<date-time>

hoststring<hostname>

server on which the actor is resident

hostRedundancyAllowedboolean | null

whether this actor's host allows redundancy of its videos

followingCountinteger>= 0

number of actors subscribed to by this actor, as seen by this instance

followersCountinteger>= 0

number of followers of this actor, as seen by this instance

createdAtstring<date-time>

updatedAtstring<date-time>

userIdid | null

object id for the user tied to this account

Show child attributes

id>= 1

Example

displayNamestring

editable name of the account, displayed in its representations

descriptionstring | null

text or bio displayed on the account's profile

notificationSettingsUserNotificationSettings

Show child attributes

abuseAsModeratorNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

videoAutoBlacklistAsModeratorNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

newUserRegistrationNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

newVideoFromSubscriptionNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

blacklistOnMyVideoNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

myVideoPublishedNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

myVideoImportFinishedNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

commentMentionNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

newCommentOnMyVideoNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

newFollowNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

newInstanceFollowerNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

autoInstanceFollowingNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

abuseStateChangeNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

abuseNewMessageNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

newPeerTubeVersionNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

newPluginVersionNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

myVideoStudioEditionFinishedNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

myVideoTranscriptionGeneratedNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

videoChannelsArray<VideoChannel>

Show child attributes

idid>= 1

Example

Same fields as account.userId

urlstring<url>

nameusername

immutable name of the actor, used to find or mention it

Show child attributes

immutable name of the user, used to find or mention its actor

username

Example

chocobozzz

avatarsArray<ActorImage>

Show child attributes

pathstring | nulldeprecated

Deprecated in PeerTube v8.0, use fileUrl instead. Null if the file is stored in object storage: use the non-deprecated field instead.

fileUrlstring

PeerTube >= 7.1

widthinteger

heightinteger

PeerTube >= 7.3

createdAtstring<date-time>

updatedAtstring<date-time>

hoststring<hostname>

server on which the actor is resident

hostRedundancyAllowedboolean | null

whether this actor's host allows redundancy of its videos

followingCountinteger>= 0

number of actors subscribed to by this actor, as seen by this instance

followersCountinteger>= 0

number of followers of this actor, as seen by this instance

createdAtstring<date-time>

updatedAtstring<date-time>

displayNamestring

editable name of the channel, displayed in its representations

Example

Videos of Framasoft

descriptionstring | null

Example

Videos made with <3 by Framasoft

supportstring | null

text shown by default on all videos of this channel, to tell the audience how to support it

Example

Please support our work on https://soutenir.framasoft.org/en/ <3

publicEmailstring<email> | null

Public email visible in podcast RSS feeds

isLocalboolean

updatedAtstring<date-time>

bannersArray<ActorImage>

Show child attributes

pathstring | nulldeprecated

Deprecated in PeerTube v8.0, use fileUrl instead. Null if the file is stored in object storage: use the non-deprecated field instead.

fileUrlstring

PeerTube >= 7.1

widthinteger

heightinteger

PeerTube >= 7.3

createdAtstring<date-time>

updatedAtstring<date-time>

ownerAccountActor & any

Show child attributes

idid>= 1

Example

Same fields as account.userId

urlstring<url>

nameusername

immutable name of the actor, used to find or mention it

Show child attributes

immutable name of the user, used to find or mention its actor

username

Example

chocobozzz

avatarsArray<ActorImage>

Show child attributes

pathstring | nulldeprecated

Deprecated in PeerTube v8.0, use fileUrl instead. Null if the file is stored in object storage: use the non-deprecated field instead.

fileUrlstring

PeerTube >= 7.1

widthinteger

heightinteger

PeerTube >= 7.3

createdAtstring<date-time>

updatedAtstring<date-time>

hoststring<hostname>

server on which the actor is resident

hostRedundancyAllowedboolean | null

whether this actor's host allows redundancy of its videos

followingCountinteger>= 0

number of actors subscribed to by this actor, as seen by this instance

followersCountinteger>= 0

number of followers of this actor, as seen by this instance

createdAtstring<date-time>

updatedAtstring<date-time>

userIdid | null

object id for the user tied to this account

Show child attributes

id>= 1

Example

displayNamestring

editable name of the account, displayed in its representations

descriptionstring | null

text or bio displayed on the account's profile

videosCountinteger

only included when withStats is true

viewsPerDayArray<object>

only included when withStats is true. Chronologically ordered, spans the whole statsDays range. Each point aggregates viewsGroupInterval worth of views, starting at date

Show child attributes

datestring<date-time>

viewsinteger

viewsGroupIntervalstringdayweekmonth

bucket size of viewsPerDay, only included when withStats is true

totalViewsinteger

lifetime views of all the channel videos, only included when withStats is true

blockedboolean

blockedReasonstring

noInstanceConfigWarningModalboolean

noAccountSetupWarningModalboolean

noWelcomeModalboolean

createdAtstring

pluginAuthstring

Auth plugin to use to authenticate the user

lastLoginDatestring<date-time>

twoFactorEnabledboolean

Whether the user has enabled two-factor authentication or not

newFeaturesInfoReadnumber

New features information the user has read

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

Create a user

POST

https://peertube2.cpy.re/api/v1/users

Create a user

curl -X POST 'https://peertube2.cpy.re/api/v1/users' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "username": "chocobozzz",
  "password": "********",
  "email": "user@example.com",
  "videoQuota": -1,
  "videoQuotaDaily": -1,
  "channelName": "framasoft_videos",
  "role": 2,
  "adminFlags": 1
}'

const body = `{
  "username": "chocobozzz",
  "password": "********",
  "email": "user@example.com",
  "videoQuota": -1,
  "videoQuotaDaily": -1,
  "channelName": "framasoft_videos",
  "role": 2,
  "adminFlags": 1
}`;

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

const data = await response.text();

import requests

body = '''{
  "username": "chocobozzz",
  "password": "********",
  "email": "user@example.com",
  "videoQuota": -1,
  "videoQuotaDaily": -1,
  "channelName": "framasoft_videos",
  "role": 2,
  "adminFlags": 1
}'''

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

Request Body

{
  "username": "chocobozzz",
  "password": "********",
  "email": "user@example.com",
  "videoQuota": -1,
  "videoQuotaDaily": -1,
  "channelName": "framasoft_videos",
  "role": 2,
  "adminFlags": 1
}

200

{
  "user": {
    "id": 42,
    "account": {
      "id": 42
    }
  }
}

Body

application/json

If the smtp server is configured, you can leave the password empty and an email will be sent asking the user to set it first.

usernameusernamerequired

immutable name of the user, used to find or mention its actor

Example

chocobozzz

passwordpassword<password>required

emailstring<email>required

The user email

videoQuotainteger

The user video quota in bytes

Example

-1

videoQuotaDailyinteger

The user daily video quota in bytes

Example

-1

channelNameusernameChannel

immutable name of the channel, used to interact with its actor

Example

framasoft_videos

roleUserRole012required

The user role (Admin = 0, Moderator = 1, User = 2)

Example

adminFlagsUserAdminFlags01

Admin flags for the user (None = 0, Bypass video blocklist = 1)

Example

currentPasswordcurrentPassword

Required to create an administrator, see password confirmation

Show child attributes

Password of the authenticated user, required if password confirmation is enabled

currentPassword<password>

Response

200OKAddUserResponse

user created

Response fields application/json

userobject

Show child attributes

idid>= 1

Example

accountobject

Show child attributes

idid>= 1

Example

403Forbidden

insufficient authority to create an admin or moderator

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

Get a user

GET

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

Get a user

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

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

200

{
  "id": 42,
  "username": "chocobozzz",
  "email": "user@example.com",
  "emailVerified": true,
  "nsfwPolicy": "display",
  "nsfwFlagsDisplayed": 0,
  "nsfwFlagsHidden": 0,
  "nsfwFlagsWarned": 0,
  "nsfwFlagsBlurred": 0,
  "aiUsagesHidden": [
    1
  ],
  "adminFlags": 1,
  "autoPlayNextVideo": true,
  "autoPlayNextVideoPlaylist": true,
  "autoPlayVideo": true,
  "p2pEnabled": true,
  "videosHistoryEnabled": true,
  "videoLanguages": [
    "string"
  ],
  "videoCategories": [
    0
  ],
  "videoLive": "true",
  "language": "string",
  "videoQuota": -1,
  "videoQuotaDaily": -1,
  "role": {
    "id": 2,
    "label": "User"
  },
  "theme": "string",
  "account": {
    "id": 42,
    "url": "https://example.com",
    "avatars": [
      {
        "path": "string",
        "fileUrl": "string",
        "width": 0,
        "height": 0,
        "createdAt": "2024-01-15T09:30:00Z",
        "updatedAt": "2024-01-15T09:30:00Z"
      }
    ],
    "host": "example.com",
    "hostRedundancyAllowed": true,
    "followingCount": 0,
    "followersCount": 0,
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "displayName": "string",
    "description": "string"
  },
  "notificationSettings": {
    "abuseAsModerator": 0,
    "videoAutoBlacklistAsModerator": 0,
    "newUserRegistration": 0,
    "newVideoFromSubscription": 0,
    "blacklistOnMyVideo": 0,
    "myVideoPublished": 0,
    "myVideoImportFinished": 0,
    "commentMention": 0,
    "newCommentOnMyVideo": 0,
    "newFollow": 0,
    "newInstanceFollower": 0,
    "autoInstanceFollowing": 0,
    "abuseStateChange": 0,
    "abuseNewMessage": 0,
    "newPeerTubeVersion": 0,
    "newPluginVersion": 0,
    "myVideoStudioEditionFinished": 0,
    "myVideoTranscriptionGenerated": 0
  },
  "videoChannels": [
    {
      "id": 42,
      "url": "https://example.com",
      "avatars": [
        {
          "path": "string",
          "fileUrl": "string",
          "width": 0,
          "height": 0,
          "createdAt": "2024-01-15T09:30:00Z",
          "updatedAt": "2024-01-15T09:30:00Z"
        }
      ],
      "host": "example.com",
      "hostRedundancyAllowed": true,
      "followingCount": 0,
      "followersCount": 0,
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "displayName": "Videos of Framasoft",
      "description": "Videos made with <3 by Framasoft",
      "support": "Please support our work on https://soutenir.framasoft.org/en/ <3",
      "publicEmail": "user@example.com",
      "isLocal": true,
      "banners": [
        {
          "path": "string",
          "fileUrl": "string",
          "width": 0,
          "height": 0,
          "createdAt": "2024-01-15T09:30:00Z",
          "updatedAt": "2024-01-15T09:30:00Z"
        }
      ],
      "ownerAccount": {
        "id": 42,
        "url": "https://example.com",
        "avatars": [
          {
            "path": "string",
            "fileUrl": "string",
            "width": 0,
            "height": 0,
            "createdAt": "2024-01-15T09:30:00Z",
            "updatedAt": "2024-01-15T09:30:00Z"
          }
        ],
        "host": "example.com",
        "hostRedundancyAllowed": true,
        "followingCount": 0,
        "followersCount": 0,
        "createdAt": "2024-01-15T09:30:00Z",
        "updatedAt": "2024-01-15T09:30:00Z",
        "displayName": "string",
        "description": "string"
      },
      "videosCount": 0,
      "viewsPerDay": [
        {
          "date": "2024-01-15T09:30:00Z",
          "views": 0
        }
      ],
      "viewsGroupInterval": "day",
      "totalViews": 0
    }
  ],
  "blocked": true,
  "blockedReason": "string",
  "noInstanceConfigWarningModal": true,
  "noAccountSetupWarningModal": true,
  "noWelcomeModal": true,
  "createdAt": "string",
  "pluginAuth": "string",
  "lastLoginDate": "2024-01-15T09:30:00Z",
  "twoFactorEnabled": true,
  "newFeaturesInfoRead": 0
}

Parameters

idid>= 1requiredpath

Entity id

withStatsbooleanquery

include statistics about the user (only available as a moderator/admin)

Response

200OKUser | User & any

As an admin/moderator, you can request a response augmented with statistics about the user's moderation relations and videos usage, by using the withStats parameter.

Response fields application/json

One of

idid>= 1

Example

usernameusername

immutable name of the user, used to find or mention its actor

Example

chocobozzz

emailemail<email>

The user email

emailVerifiedboolean

Has the user confirmed their email address?

nsfwPolicyNSFWPolicydisplaywarndo_not_list

nsfwFlagsDisplayedNSFWFlag0124

NSFW flags (can be combined using bitwise or operator)

0 NONE
1 VIOLENT
2 EXPLICIT_SEX

nsfwFlagsHiddenNSFWFlag0124

NSFW flags (can be combined using bitwise or operator)

0 NONE
1 VIOLENT
2 EXPLICIT_SEX

nsfwFlagsWarnedNSFWFlag0124

NSFW flags (can be combined using bitwise or operator)

0 NONE
1 VIOLENT
2 EXPLICIT_SEX

nsfwFlagsBlurredNSFWFlag0124

NSFW flags (can be combined using bitwise or operator)

0 NONE
1 VIOLENT
2 EXPLICIT_SEX

aiUsagesHiddenArray<VideoAIUsageSet>1234

PeerTube >= 9.0 Videos with these AI usages are hidden from video lists

adminFlagsUserAdminFlags01

Admin flags for the user (None = 0, Bypass video blocklist = 1)

Example

autoPlayNextVideoboolean

Automatically start playing the upcoming video after the currently playing video

autoPlayNextVideoPlaylistboolean

Automatically start playing the video on the playlist after the currently playing video

autoPlayVideoboolean

Automatically start playing the video on the watch page

p2pEnabledboolean

whether to enable P2P in the player or not

videosHistoryEnabledboolean

whether to keep track of watched history or not

videoLanguagesArray<string>

list of languages to filter videos down to

videoCategoriesArray<integer> | null

list of categories to filter videos down to (null means all categories)

videoLivestringtruefalseboth

filter videos down to lives (true), VODs (false) or display both

languagestring

default language for this user

videoQuotainteger

The user video quota in bytes

Example

-1

videoQuotaDailyinteger

The user daily video quota in bytes

Example

-1

roleobject

Show child attributes

idUserRole012

The user role (Admin = 0, Moderator = 1, User = 2)

Example

labelstringUserModeratorAdministrator

themestring

Theme enabled by this user

accountActor & any

Show child attributes

idid>= 1

Example

urlstring<url>

nameusername

immutable name of the actor, used to find or mention it

Show child attributes

immutable name of the user, used to find or mention its actor

username

Example

chocobozzz

avatarsArray<ActorImage>

Show child attributes

pathstring | nulldeprecated

Deprecated in PeerTube v8.0, use fileUrl instead. Null if the file is stored in object storage: use the non-deprecated field instead.

fileUrlstring

PeerTube >= 7.1

widthinteger

heightinteger

PeerTube >= 7.3

createdAtstring<date-time>

updatedAtstring<date-time>

hoststring<hostname>

server on which the actor is resident

hostRedundancyAllowedboolean | null

whether this actor's host allows redundancy of its videos

followingCountinteger>= 0

number of actors subscribed to by this actor, as seen by this instance

followersCountinteger>= 0

number of followers of this actor, as seen by this instance

createdAtstring<date-time>

updatedAtstring<date-time>

userIdid | null

object id for the user tied to this account

Show child attributes

id>= 1

Example

displayNamestring

editable name of the account, displayed in its representations

descriptionstring | null

text or bio displayed on the account's profile

notificationSettingsUserNotificationSettings

Show child attributes

abuseAsModeratorNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

videoAutoBlacklistAsModeratorNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

newUserRegistrationNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

newVideoFromSubscriptionNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

blacklistOnMyVideoNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

myVideoPublishedNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

myVideoImportFinishedNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

commentMentionNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

newCommentOnMyVideoNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

newFollowNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

newInstanceFollowerNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

autoInstanceFollowingNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

abuseStateChangeNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

abuseNewMessageNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

newPeerTubeVersionNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

newPluginVersionNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

myVideoStudioEditionFinishedNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

myVideoTranscriptionGeneratedNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

videoChannelsArray<VideoChannel>

Show child attributes

idid>= 1

Example

Same fields as account.userId

urlstring<url>

nameusername

immutable name of the actor, used to find or mention it

Show child attributes

immutable name of the user, used to find or mention its actor

username

Example

chocobozzz

avatarsArray<ActorImage>

Show child attributes

pathstring | nulldeprecated

Deprecated in PeerTube v8.0, use fileUrl instead. Null if the file is stored in object storage: use the non-deprecated field instead.

fileUrlstring

PeerTube >= 7.1

widthinteger

heightinteger

PeerTube >= 7.3

createdAtstring<date-time>

updatedAtstring<date-time>

hoststring<hostname>

server on which the actor is resident

hostRedundancyAllowedboolean | null

whether this actor's host allows redundancy of its videos

followingCountinteger>= 0

number of actors subscribed to by this actor, as seen by this instance

followersCountinteger>= 0

number of followers of this actor, as seen by this instance

createdAtstring<date-time>

updatedAtstring<date-time>

displayNamestring

editable name of the channel, displayed in its representations

Example

Videos of Framasoft

descriptionstring | null

Example

Videos made with <3 by Framasoft

supportstring | null

text shown by default on all videos of this channel, to tell the audience how to support it

Example

Please support our work on https://soutenir.framasoft.org/en/ <3

publicEmailstring<email> | null

Public email visible in podcast RSS feeds

isLocalboolean

updatedAtstring<date-time>

bannersArray<ActorImage>

Show child attributes

pathstring | nulldeprecated

Deprecated in PeerTube v8.0, use fileUrl instead. Null if the file is stored in object storage: use the non-deprecated field instead.

fileUrlstring

PeerTube >= 7.1

widthinteger

heightinteger

PeerTube >= 7.3

createdAtstring<date-time>

updatedAtstring<date-time>

ownerAccountActor & any

Show child attributes

idid>= 1

Example

Same fields as account.userId

urlstring<url>

nameusername

immutable name of the actor, used to find or mention it

Show child attributes

immutable name of the user, used to find or mention its actor

username

Example

chocobozzz

avatarsArray<ActorImage>

Show child attributes

pathstring | nulldeprecated

Deprecated in PeerTube v8.0, use fileUrl instead. Null if the file is stored in object storage: use the non-deprecated field instead.

fileUrlstring

PeerTube >= 7.1

widthinteger

heightinteger

PeerTube >= 7.3

createdAtstring<date-time>

updatedAtstring<date-time>

hoststring<hostname>

server on which the actor is resident

hostRedundancyAllowedboolean | null

whether this actor's host allows redundancy of its videos

followingCountinteger>= 0

number of actors subscribed to by this actor, as seen by this instance

followersCountinteger>= 0

number of followers of this actor, as seen by this instance

createdAtstring<date-time>

updatedAtstring<date-time>

userIdid | null

object id for the user tied to this account

Show child attributes

id>= 1

Example

displayNamestring

editable name of the account, displayed in its representations

descriptionstring | null

text or bio displayed on the account's profile

videosCountinteger

only included when withStats is true

viewsPerDayArray<object>

only included when withStats is true. Chronologically ordered, spans the whole statsDays range. Each point aggregates viewsGroupInterval worth of views, starting at date

Show child attributes

datestring<date-time>

viewsinteger

viewsGroupIntervalstringdayweekmonth

bucket size of viewsPerDay, only included when withStats is true

totalViewsinteger

lifetime views of all the channel videos, only included when withStats is true

blockedboolean

blockedReasonstring

noInstanceConfigWarningModalboolean

noAccountSetupWarningModalboolean

noWelcomeModalboolean

createdAtstring

pluginAuthstring

Auth plugin to use to authenticate the user

lastLoginDatestring<date-time>

twoFactorEnabledboolean

Whether the user has enabled two-factor authentication or not

newFeaturesInfoReadnumber

New features information the user has read

idid>= 1

Example

usernameusername

immutable name of the user, used to find or mention its actor

Example

chocobozzz

emailemail<email>

The user email

emailVerifiedboolean

Has the user confirmed their email address?

nsfwPolicyNSFWPolicydisplaywarndo_not_list

nsfwFlagsDisplayedNSFWFlag0124

NSFW flags (can be combined using bitwise or operator)

0 NONE
1 VIOLENT
2 EXPLICIT_SEX

nsfwFlagsHiddenNSFWFlag0124

NSFW flags (can be combined using bitwise or operator)

0 NONE
1 VIOLENT
2 EXPLICIT_SEX

nsfwFlagsWarnedNSFWFlag0124

NSFW flags (can be combined using bitwise or operator)

0 NONE
1 VIOLENT
2 EXPLICIT_SEX

nsfwFlagsBlurredNSFWFlag0124

NSFW flags (can be combined using bitwise or operator)

0 NONE
1 VIOLENT
2 EXPLICIT_SEX

aiUsagesHiddenArray<VideoAIUsageSet>1234

PeerTube >= 9.0 Videos with these AI usages are hidden from video lists

adminFlagsUserAdminFlags01

Admin flags for the user (None = 0, Bypass video blocklist = 1)

Example

autoPlayNextVideoboolean

Automatically start playing the upcoming video after the currently playing video

autoPlayNextVideoPlaylistboolean

Automatically start playing the video on the playlist after the currently playing video

autoPlayVideoboolean

Automatically start playing the video on the watch page

p2pEnabledboolean

whether to enable P2P in the player or not

videosHistoryEnabledboolean

whether to keep track of watched history or not

videoLanguagesArray<string>

list of languages to filter videos down to

videoCategoriesArray<integer> | null

list of categories to filter videos down to (null means all categories)

videoLivestringtruefalseboth

filter videos down to lives (true), VODs (false) or display both

languagestring

default language for this user

videoQuotainteger

The user video quota in bytes

Example

-1

videoQuotaDailyinteger

The user daily video quota in bytes

Example

-1

roleobject

Show child attributes

idUserRole012

The user role (Admin = 0, Moderator = 1, User = 2)

Example

labelstringUserModeratorAdministrator

themestring

Theme enabled by this user

accountActor & any

Show child attributes

idid>= 1

Example

Same fields as account.userId

urlstring<url>

nameusername

immutable name of the actor, used to find or mention it

Show child attributes

immutable name of the user, used to find or mention its actor

username

Example

chocobozzz

avatarsArray<ActorImage>

Show child attributes

pathstring | nulldeprecated

Deprecated in PeerTube v8.0, use fileUrl instead. Null if the file is stored in object storage: use the non-deprecated field instead.

fileUrlstring

PeerTube >= 7.1

widthinteger

heightinteger

PeerTube >= 7.3

createdAtstring<date-time>

updatedAtstring<date-time>

hoststring<hostname>

server on which the actor is resident

hostRedundancyAllowedboolean | null

whether this actor's host allows redundancy of its videos

followingCountinteger>= 0

number of actors subscribed to by this actor, as seen by this instance

followersCountinteger>= 0

number of followers of this actor, as seen by this instance

createdAtstring<date-time>

updatedAtstring<date-time>

userIdid | null

object id for the user tied to this account

Show child attributes

id>= 1

Example

displayNamestring

editable name of the account, displayed in its representations

descriptionstring | null

text or bio displayed on the account's profile

notificationSettingsUserNotificationSettings

Show child attributes

abuseAsModeratorNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

videoAutoBlacklistAsModeratorNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

newUserRegistrationNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

newVideoFromSubscriptionNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

blacklistOnMyVideoNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

myVideoPublishedNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

myVideoImportFinishedNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

commentMentionNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

newCommentOnMyVideoNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

newFollowNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

newInstanceFollowerNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

autoInstanceFollowingNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

abuseStateChangeNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

abuseNewMessageNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

newPeerTubeVersionNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

newPluginVersionNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

myVideoStudioEditionFinishedNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

myVideoTranscriptionGeneratedNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

0 NONE
1 WEB
2 EMAIL

videoChannelsArray<VideoChannel>

Show child attributes

idid>= 1

Example

Same fields as account.userId

urlstring<url>

nameusername

immutable name of the actor, used to find or mention it

Show child attributes

immutable name of the user, used to find or mention its actor

username

Example

chocobozzz

avatarsArray<ActorImage>

Show child attributes

pathstring | nulldeprecated

Deprecated in PeerTube v8.0, use fileUrl instead. Null if the file is stored in object storage: use the non-deprecated field instead.

fileUrlstring

PeerTube >= 7.1

widthinteger

heightinteger

PeerTube >= 7.3

createdAtstring<date-time>

updatedAtstring<date-time>

hoststring<hostname>

server on which the actor is resident

hostRedundancyAllowedboolean | null

whether this actor's host allows redundancy of its videos

followingCountinteger>= 0

number of actors subscribed to by this actor, as seen by this instance

followersCountinteger>= 0

number of followers of this actor, as seen by this instance

createdAtstring<date-time>

updatedAtstring<date-time>

displayNamestring

editable name of the channel, displayed in its representations

Example

Videos of Framasoft

descriptionstring | null

Example

Videos made with <3 by Framasoft

supportstring | null

text shown by default on all videos of this channel, to tell the audience how to support it

Example

Please support our work on https://soutenir.framasoft.org/en/ <3

publicEmailstring<email> | null

Public email visible in podcast RSS feeds

isLocalboolean

updatedAtstring<date-time>

bannersArray<ActorImage>

Show child attributes

pathstring | nulldeprecated

Deprecated in PeerTube v8.0, use fileUrl instead. Null if the file is stored in object storage: use the non-deprecated field instead.

fileUrlstring

PeerTube >= 7.1

widthinteger

heightinteger

PeerTube >= 7.3

createdAtstring<date-time>

updatedAtstring<date-time>

ownerAccountActor & any

Show child attributes

idid>= 1

Example

Same fields as account.userId

urlstring<url>

nameusername

immutable name of the actor, used to find or mention it

Show child attributes

immutable name of the user, used to find or mention its actor

username

Example

chocobozzz

avatarsArray<ActorImage>

Show child attributes

pathstring | nulldeprecated

Deprecated in PeerTube v8.0, use fileUrl instead. Null if the file is stored in object storage: use the non-deprecated field instead.

fileUrlstring

PeerTube >= 7.1

widthinteger

heightinteger

PeerTube >= 7.3

createdAtstring<date-time>

updatedAtstring<date-time>

hoststring<hostname>

server on which the actor is resident

hostRedundancyAllowedboolean | null

whether this actor's host allows redundancy of its videos

followingCountinteger>= 0

number of actors subscribed to by this actor, as seen by this instance

followersCountinteger>= 0

number of followers of this actor, as seen by this instance

createdAtstring<date-time>

updatedAtstring<date-time>

userIdid | null

object id for the user tied to this account

Show child attributes

id>= 1

Example

displayNamestring

editable name of the account, displayed in its representations

descriptionstring | null

text or bio displayed on the account's profile

videosCountinteger

only included when withStats is true

viewsPerDayArray<object>

only included when withStats is true. Chronologically ordered, spans the whole statsDays range. Each point aggregates viewsGroupInterval worth of views, starting at date

Show child attributes

datestring<date-time>

viewsinteger

viewsGroupIntervalstringdayweekmonth

bucket size of viewsPerDay, only included when withStats is true

totalViewsinteger

lifetime views of all the channel videos, only included when withStats is true

blockedboolean

blockedReasonstring

noInstanceConfigWarningModalboolean

noAccountSetupWarningModalboolean

noWelcomeModalboolean

createdAtstring

pluginAuthstring

Auth plugin to use to authenticate the user

lastLoginDatestring<date-time>

twoFactorEnabledboolean

Whether the user has enabled two-factor authentication or not

newFeaturesInfoReadnumber

New features information the user has read

videosCountinteger

Count of videos published

abusesCountinteger

Count of reports/abuses of which the user is a target

abusesAcceptedCountinteger

Count of reports/abuses created by the user and accepted/acted upon by the moderation team

abusesCreatedCountinteger

Count of reports/abuses created by the user

videoCommentsCountinteger

Count of comments published

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.

Update a user

PUT

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

Update a user

curl -X PUT 'https://peertube2.cpy.re/api/v1/users/42' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "emailVerified": true,
  "videoQuota": 0,
  "videoQuotaDaily": 0,
  "pluginAuth": "peertube-plugin-auth-saml2",
  "role": 2,
  "adminFlags": 1,
  "password": "********"
}'

const body = `{
  "emailVerified": true,
  "videoQuota": 0,
  "videoQuotaDaily": 0,
  "pluginAuth": "peertube-plugin-auth-saml2",
  "role": 2,
  "adminFlags": 1,
  "password": "********"
}`;

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

const data = await response.text();

import requests

body = '''{
  "emailVerified": true,
  "videoQuota": 0,
  "videoQuotaDaily": 0,
  "pluginAuth": "peertube-plugin-auth-saml2",
  "role": 2,
  "adminFlags": 1,
  "password": "********"
}'''

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

Request Body

{
  "emailVerified": true,
  "videoQuota": 0,
  "videoQuotaDaily": 0,
  "pluginAuth": "peertube-plugin-auth-saml2",
  "role": 2,
  "adminFlags": 1,
  "password": "********"
}

Body

application/json

emailemail

The updated email of the user

Show child attributes

The user email

email<email>

emailVerifiedboolean

Set the email as verified

videoQuotainteger

The updated video quota of the user in bytes

videoQuotaDailyinteger

The updated daily video quota of the user in bytes

pluginAuthstring | null

The auth plugin to use to authenticate the user

Example

peertube-plugin-auth-saml2

roleUserRole012

The user role (Admin = 0, Moderator = 1, User = 2)

Example

adminFlagsUserAdminFlags01

Admin flags for the user (None = 0, Bypass video blocklist = 1)

Example

passwordpassword<password>

currentPasswordcurrentPassword

Required to give the administrator role, or to change the password, email or auth plugin of an administrator, see password confirmation

Show child attributes

Password of the authenticated user, required if password confirmation is enabled

currentPassword<password>

Parameters

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.

Delete a user

DELETE

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

Delete a user

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

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

Parameters

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.

Scopes: admin

Block a user

POST

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

Prevent a user from logging in and interacting with the instance

Block a user

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

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

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

const data = await response.text();

import requests

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

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

Request Body

{
  "reason": "string"
}

Body

application/json

reasonstring

Optional reason for blocking the user

Parameters

idid>= 1requiredpath

Entity id

Response

204No Content

successful operation

400Bad Request

invalid user id

403Forbidden

insufficient permissions to block users

404Not Found

user not found

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

Unblock a user

POST

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

Allow a previously blocked user to login and interact with the instance

Unblock a user

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

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

const data = await response.text();

import requests

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

Parameters

idid>= 1requiredpath

Entity id

Response

204No Content

successful operation

400Bad Request

invalid user id

403Forbidden

insufficient permissions to unblock users

404Not Found

user not found

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

Ask to reset password

POST

https://peertube2.cpy.re/api/v1/users/ask-reset-password

An email containing a reset password link

Ask to reset password

curl -X POST 'https://peertube2.cpy.re/api/v1/users/ask-reset-password' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "email": "string"
}'

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

const response = await fetch('https://peertube2.cpy.re/api/v1/users/ask-reset-password', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

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

response = requests.post(
    'https://peertube2.cpy.re/api/v1/users/ask-reset-password',
    data=body.encode('utf-8'),
    headers={
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "email": "string"
}

Body

application/json

emailstringrequired

User email

Response

204No Content

successful operation

Reset password

POST

https://peertube2.cpy.re/api/v1/users/{id}/reset-password

Reset password

curl -X POST 'https://peertube2.cpy.re/api/v1/users/42/reset-password' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "verificationString": "https://example.com",
  "password": "string"
}'

const body = `{
  "verificationString": "https://example.com",
  "password": "string"
}`;

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

const data = await response.text();

import requests

body = '''{
  "verificationString": "https://example.com",
  "password": "string"
}'''

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

Request Body

{
  "verificationString": "https://example.com",
  "password": "string"
}

Body

application/json

verificationStringstring<url>required

passwordstringrequired

Parameters

idid>= 1requiredpath

Entity id

Response

204No Content

successful operation

403Forbidden

invalid verification string

404Not Found

user not found

Request two factor auth

POST

https://peertube2.cpy.re/api/v1/users/{id}/two-factor/request

Request two factor authentication for a user

Request two factor auth

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

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

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

const data = await response.text();

import requests

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

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

Request Body

{
  "currentPassword": "string"
}

200

[
  {
    "otpRequest": {
      "requestToken": "string",
      "secret": "string",
      "uri": "string"
    }
  }
]

Body

application/json

currentPasswordstring

Password of the currently authenticated user

Parameters

idid>= 1requiredpath

Entity id

Response

200OKArray<RequestTwoFactorResponse>

successful operation

Response fields application/json

Array<RequestTwoFactorResponse>

Show child attributes

otpRequestobject

Show child attributes

requestTokenstring

The token to send to confirm this request

secretstring

The OTP secret

uristring

The OTP URI

403Forbidden

invalid password

404Not Found

user not found

429Too Many Requests

too many password checks for this user

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.

Confirm two factor auth

POST

https://peertube2.cpy.re/api/v1/users/{id}/two-factor/confirm-request

Confirm a two factor authentication request

Confirm two factor auth

curl -X POST 'https://peertube2.cpy.re/api/v1/users/42/two-factor/confirm-request' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "requestToken": "string",
  "otpToken": "string"
}'

const body = `{
  "requestToken": "string",
  "otpToken": "string"
}`;

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

const data = await response.text();

import requests

body = '''{
  "requestToken": "string",
  "otpToken": "string"
}'''

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

Request Body

{
  "requestToken": "string",
  "otpToken": "string"
}

Body

application/json

requestTokenstringrequired

Token to identify the two factor request

otpTokenstringrequired

OTP token generated by the app

Parameters

idid>= 1requiredpath

Entity id

Response

204No Content

successful operation

403Forbidden

invalid request token or OTP token

404Not Found

user not found

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.

Disable two factor auth

POST

https://peertube2.cpy.re/api/v1/users/{id}/two-factor/disable

Disable two factor authentication of a user

Disable two factor auth

curl -X POST 'https://peertube2.cpy.re/api/v1/users/42/two-factor/disable' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "currentPassword": "string"
}'

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

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

const data = await response.text();

import requests

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

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

Request Body

{
  "currentPassword": "string"
}

Body

application/json

currentPasswordstring

Password of the currently authenticated user. Users of an id and pass auth plugin must use the password they log in with

Parameters

idid>= 1requiredpath

Entity id

Response

204No Content

successful operation

403Forbidden

invalid password

404Not Found

user not found

429Too Many Requests

too many password checks for this user

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