# PeerTube ## REST API - [PeerTube](https://sourcey-peertube.pages.dev/api-rest-reference.md): The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite HTTP/REST library for your programming language to use PeerTube. - [Get public Web Video file](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-static-web-videos-filename-get.md): PeerTube >= 6.0 - [Get private Web Video file](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-static-web-videos-private-filename-get.md): PeerTube >= 6.0 - [Get public HLS video file](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-static-streaming-playlists-hls-filename-get.md): GET /static/streaming-playlists/hls/{filename}. - [Get private HLS video file](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-static-streaming-playlists-hls-private-filename-get.md): GET /static/streaming-playlists/hls/private/{filename}. - [Download video file](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-download-videos-generate-videoidoruuid-get.md): Generate a mp4 container that contains at most 1 video stream and at most 1 audio stream. Mainly used to merge the HLS audio only video file and the HLS video only resolution file. - [Comments on videos feeds](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-feeds-video-comments-format-get.md): GET /feeds/video-comments.{format}: returns VideoCommentsForXML. - [Common videos feeds](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-feeds-videos-format-get.md): GET /feeds/videos.{format}: returns VideosForXML. - [Videos of subscriptions feeds](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-feeds-subscriptions-format-get.md): GET /feeds/subscriptions.{format}: returns VideosForXML. - [Videos podcast feed](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-feeds-podcast-videos-xml-get.md): GET /feeds/podcast/videos.xml. - [Video chapters of podcast feeds](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-feeds-podcast-video-chapters-json-get.md): PeerTube >= 9.0 Chapters of a video in the Podcasting 2.0 JSON format, referenced by the podcast:chapters tag of podcast feed items. See https://podcasting2.org/docs/podcast-namespace/tags/chapters - [Get an account](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-accounts-name-get.md): GET /api/v1/accounts/{name}: returns Account. - [List videos of an account](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-accounts-name-videos-get.md): GET /api/v1/accounts/{name}/videos: returns VideoListResponse. - [List followers of an account](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-accounts-name-followers-get.md): GET /api/v1/accounts/{name}/followers. - [List accounts](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-accounts-get.md): GET /api/v1/accounts. - [Get instance public configuration](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-config-get.md): GET /api/v1/config: returns ServerConfig. - [Get instance "About" information](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-config-about-get.md): Translatable information is returned in the language of the request, using the x-peertube-language header or the Accept-Language header. If the instance has no translation for this language, the default information is returned. - [Get instance runtime configuration](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-config-custom-get.md): GET /api/v1/config/custom: returns ServerConfigCustom. - [Set instance runtime configuration](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-config-custom-put.md): Changing instance.customizations.javascript or instance.customizations.css requires a password confirmation: set currentPassword at the root of the request body. - [Delete instance runtime configuration](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-config-custom-delete.md): DELETE /api/v1/config/custom. - [Update instance banner](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-config-instance-banner-pick-post.md): POST /api/v1/config/instance-banner/pick. - [Delete instance banner](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-config-instance-banner-delete.md): DELETE /api/v1/config/instance-banner. - [Update instance avatar](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-config-instance-avatar-pick-post.md): POST /api/v1/config/instance-avatar/pick. - [Delete instance avatar](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-config-instance-avatar-delete.md): DELETE /api/v1/config/instance-avatar. - [Update instance logo](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-config-instance-logo-logotype-pick-post.md): POST /api/v1/config/instance-logo/{logoType}/pick. - [Delete instance logo](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-config-instance-logo-logotype-delete.md): DELETE /api/v1/config/instance-logo/{logoType}. - [Get instance custom homepage](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-custom-pages-homepage-instance-get.md): GET /api/v1/custom-pages/homepage/instance: returns CustomHomepage. - [Set instance custom homepage](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-custom-pages-homepage-instance-put.md): PUT /api/v1/custom-pages/homepage/instance. - [Pause job queue](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-jobs-pause-post.md): POST /api/v1/jobs/pause. - [Resume job queue](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-jobs-resume-post.md): POST /api/v1/jobs/resume. - [List instance jobs](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-jobs-state-get.md): GET /api/v1/jobs/{state}. - [Cancel a job](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-jobs-jobtype-jobid-cancel-post.md): Abort a running job and its underlying ffmpeg/child process. Only active jobs that support cancellation can be cancelled. - [List instances following the server](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-server-followers-get.md): GET /api/v1/server/followers. - [Remove or reject a follower to your server](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-server-followers-handle-delete.md): DELETE /api/v1/server/followers/{handle}. - [Reject a pending follower to your server](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-server-followers-handle-reject-post.md): POST /api/v1/server/followers/{handle}/reject. - [Accept a pending follower to your server](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-server-followers-handle-accept-post.md): POST /api/v1/server/followers/{handle}/accept. - [List instances followed by the server](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-server-following-get.md): GET /api/v1/server/following. - [Follow a list of actors (PeerTube instance, channel or account)](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-server-following-post.md): POST /api/v1/server/following. - [Unfollow an actor (PeerTube instance, channel or account)](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-server-following-hostorhandle-delete.md): DELETE /api/v1/server/following/{hostOrHandle}. - [List users](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-get.md): GET /api/v1/users: returns a list of User. - [Create a user](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-post.md): POST /api/v1/users: takes AddUser, returns AddUserResponse. - [Get a user](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-id-get.md): GET /api/v1/users/{id}. - [Update a user](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-id-put.md): PUT /api/v1/users/{id}: takes UpdateUser. - [Delete a user](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-id-delete.md): DELETE /api/v1/users/{id}. - [Block a user](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-id-block-post.md): Prevent a user from logging in and interacting with the instance - [Unblock a user](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-id-unblock-post.md): Allow a previously blocked user to login and interact with the instance - [Login prerequisite](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-oauth-clients-local-get.md): You need to retrieve a client id and secret before logging in. - [Login](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-token-post.md): With your client id and secret, you can retrieve an access and refresh tokens. - [Logout](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-revoke-token-post.md): Revokes your access token and its associated refresh token, destroying your current session. - [List token sessions](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-id-token-sessions-get.md): GET /api/v1/users/{id}/token-sessions. - [List token sessions](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-id-token-sessions-tokensessionid-revoke-get.md): GET /api/v1/users/{id}/token-sessions/{tokenSessionId}/revoke. - [Resend user verification link](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-ask-send-verify-email-post.md): POST /api/v1/users/ask-send-verify-email. - [Resend verification link to registration request email](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-registrations-ask-send-verify-email-post.md): POST /api/v1/users/registrations/ask-send-verify-email. - [Verify a user](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-id-verify-email-post.md): Following a user registration, the new user will receive an email asking to click a link containing a secret. This endpoint can also be used to verify a new email set in the user account. - [Verify a registration email](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-registrations-registrationid-verify-email-post.md): Following a user registration request, the user will receive an email asking to click a link containing a secret. - [Ask to reset password](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-ask-reset-password-post.md): An email containing a reset password link - [Reset password](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-id-reset-password-post.md): POST /api/v1/users/{id}/reset-password. - [Request two factor auth](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-id-two-factor-request-post.md): Request two factor authentication for a user - [Confirm two factor auth](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-id-two-factor-confirm-request-post.md): Confirm a two factor authentication request - [Disable two factor auth](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-id-two-factor-disable-post.md): Disable two factor authentication of a user - [Initialize the resumable user import](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-userid-imports-import-resumable-post.md): PeerTube >= 6.1 Uses a resumable protocol to initialize the import of the archive - [Send chunk for the resumable user import](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-userid-imports-import-resumable-put.md): PeerTube >= 6.1 Uses a resumable protocol to continue, pause or resume the import of the archive - [Cancel the resumable user import](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-userid-imports-import-resumable-delete.md): PeerTube >= 6.1 Uses a resumable protocol to cancel the resumable user import - [Get latest user import](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-userid-imports-latest-get.md): PeerTube >= 6.1 - [Request user export](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-userid-exports-request-post.md): Request an archive of user data. An email is sent when the archive is ready. - [List user exports](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-userid-exports-get.md): PeerTube >= 6.1 - [Delete a user export](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-userid-exports-id-delete.md): PeerTube >= 6.1 - [Get my user information](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-me-get.md): GET /api/v1/users/me: returns a list of User. - [Update my user information](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-me-put.md): PUT /api/v1/users/me: takes UpdateMe. - [Delete my account](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-me-delete.md): Delete the authenticated user's account and all associated data - [List comments on user's videos](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-me-videos-comments-get.md): PeerTube >= 6.2 - [Get video imports of my user](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-me-videos-imports-get.md): GET /api/v1/users/me/videos/imports: returns VideoImportsList. - [Get my user used quota](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-me-video-quota-used-get.md): GET /api/v1/users/me/video-quota-used. - [Get rate of my user for a video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-me-videos-videoidoruuid-rating-get.md): GET /api/v1/users/me/videos/{videoIdOrUUID}/rating: returns GetMeVideoRating. - [List videos of my user](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-me-videos-get.md): GET /api/v1/users/me/videos: returns VideoListResponse. - [List my user subscriptions](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-me-subscriptions-get.md): GET /api/v1/users/me/subscriptions: returns VideoChannelList. - [Add subscription to my user](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-me-subscriptions-post.md): POST /api/v1/users/me/subscriptions. - [Get if subscriptions exist for my user](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-me-subscriptions-exist-get.md): GET /api/v1/users/me/subscriptions/exist. - [List videos of subscriptions of my user](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-me-subscriptions-videos-get.md): GET /api/v1/users/me/subscriptions/videos: returns VideoListResponse. - [Get subscription of my user](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-me-subscriptions-subscriptionhandle-get.md): GET /api/v1/users/me/subscriptions/{subscriptionHandle}: returns VideoChannel. - [Delete subscription of my user](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-me-subscriptions-subscriptionhandle-delete.md): DELETE /api/v1/users/me/subscriptions/{subscriptionHandle}. - [List my notifications](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-me-notifications-get.md): GET /api/v1/users/me/notifications: returns NotificationListResponse. - [Mark notifications as read by their id](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-me-notifications-read-post.md): POST /api/v1/users/me/notifications/read. - [Mark all my notification as read](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-me-notifications-read-all-post.md): POST /api/v1/users/me/notifications/read-all. - [Update my notification settings](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-me-notification-settings-put.md): PUT /api/v1/users/me/notification-settings: takes UserNotificationSettings. - [Mark feature info as read](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-me-new-feature-info-read-post.md): **PeerTube >= v8.0.0 - [List watched videos history](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-me-history-videos-get.md): GET /api/v1/users/me/history/videos: returns VideoListResponse. - [Delete history element](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-me-history-videos-videoidoruuid-delete.md): DELETE /api/v1/users/me/history/videos/{videoIdOrUUID}. - [Clear video history](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-me-history-videos-remove-post.md): POST /api/v1/users/me/history/videos/remove. - [Update my user avatar](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-me-avatar-pick-post.md): POST /api/v1/users/me/avatar/pick. - [Delete my avatar](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-me-avatar-delete.md): DELETE /api/v1/users/me/avatar. - [Register a user](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-register-post.md): Signup has to be enabled and signup approval is not required - [Request registration](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-registrations-request-post.md): Signup has to be enabled and require approval on the instance - [Accept registration](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-registrations-registrationid-accept-post.md): POST /api/v1/users/registrations/{registrationId}/accept: takes UserRegistrationAcceptOrReject. - [Reject registration](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-registrations-registrationid-reject-post.md): POST /api/v1/users/registrations/{registrationId}/reject: takes UserRegistrationAcceptOrReject. - [Delete registration](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-registrations-registrationid-delete.md): Delete the registration entry. It will not remove the user associated with this registration (if any) - [List registrations](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-registrations-get.md): GET /api/v1/users/registrations. - [List video ownership changes](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-ownership-get.md): List ownership change requests received by the authenticated user and requests sent by a channel managed by the authenticated user - [Accept ownership change request](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-ownership-id-accept-post.md): POST /api/v1/videos/ownership/{id}/accept. - [Refuse ownership change request](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-ownership-id-refuse-post.md): POST /api/v1/videos/ownership/{id}/refuse. - [Delete ownership change request](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-ownership-id-delete.md): Delete an ownership change request. Only users who can manage the video can delete the request. - [List ownership change requests for a video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-videoidoruuid-ownership-get.md): List all ownership change requests for a specific video. The authenticated user must be able to manage the video. - [Request ownership change](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-videoidoruuid-give-ownership-post.md): POST /api/v1/videos/{videoIdOrUUID}/give-ownership. - [List channel ownership changes](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-channels-ownership-get.md): List ownership change requests received by the authenticated user and requests sent by channels managed by the authenticated user - [Accept channel ownership change request](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-channels-ownership-id-accept-post.md): POST /api/v1/video-channels/ownership/{id}/accept. - [Refuse channel ownership change request](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-channels-ownership-id-refuse-post.md): POST /api/v1/video-channels/ownership/{id}/refuse. - [Delete channel ownership change request](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-channels-ownership-id-delete.md): Delete a channel ownership change request. Only channel owners can delete the request. - [List ownership change requests for a channel](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-channels-channelhandle-ownership-get.md): List all ownership change requests for a specific channel. The authenticated user must be able to manage the channel. - [Request channel ownership change](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-channels-channelhandle-give-ownership-post.md): POST /api/v1/video-channels/{channelHandle}/give-ownership. - [Request video token](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-token-post.md): Request special tokens that expire quickly to use them in some context (like accessing private static files) - [Create a studio task](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-studio-edit-post.md): Create a task to edit a video (cut, add intro/outro etc). By default the video is edited in place. Set saveAsNewVideo to keep it untouched and save the result in a new video. - [Duplicate a video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-duplicate-post.md): Create a copy of a local video, in the same channel. - [List videos](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-get.md): GET /api/v1/videos: returns VideoListResponse. - [List recommended videos](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-recommendations-videos-get.md): Return videos recommended next to a reference video (or general recommendations if no reference video is given). - [List available video categories](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-categories-get.md): GET /api/v1/videos/categories. - [List available video licences](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-licences-get.md): GET /api/v1/videos/licences. - [List available video languages](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-languages-get.md): GET /api/v1/videos/languages. - [List available video privacy policies](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-privacies-get.md): GET /api/v1/videos/privacies. - [Get a video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-get.md): GET /api/v1/videos/{id}: returns VideoDetails. - [Update a video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-put.md): PUT /api/v1/videos/{id}. - [Delete a video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-delete.md): DELETE /api/v1/videos/{id}. - [Notify user is watching a video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-views-post.md): Call this endpoint regularly (every 5-10 seconds for example) to notify the server the user is watching the video. After a while, PeerTube will increase video's viewers counter. If the user is authenticated, PeerTube will also store the current player time. - [Get overall stats of a video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-stats-overall-get.md): GET /api/v1/videos/{id}/stats/overall: returns VideoStatsOverall. - [Get user agent stats of a video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-stats-user-agent-get.md): GET /api/v1/videos/{id}/stats/user-agent: returns VideoStatsUserAgent. - [Get retention stats of a video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-stats-retention-get.md): GET /api/v1/videos/{id}/stats/retention: returns VideoStatsRetention. - [Get timeserie stats of a video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-stats-timeseries-metric-get.md): GET /api/v1/videos/{id}/stats/timeseries/{metric}: returns VideoStatsTimeserie. - [Upload a video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-upload-post.md): Uses a single request to upload a video. - [Initialize the resumable upload of a video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-upload-resumable-post.md): Uses a resumable protocol to initialize the upload of a video - [Send chunk for the resumable upload of a video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-upload-resumable-put.md): Uses a resumable protocol to continue, pause or resume the upload of a video - [Cancel the resumable upload of a video, deleting any data uploaded so far](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-upload-resumable-delete.md): Uses a resumable protocol to cancel the upload of a video - [Import a video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-imports-post.md): Import a torrent or magnetURI or HTTP resource (if enabled by the instance administrator) - [Cancel video import](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-imports-id-cancel-post.md): Cancel a pending video import - [Retry video import](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-imports-id-retry-post.md): PeerTube >= 8.0 Retry a failed or cancelled (PeerTube >= 8.3) video import. - [Retry the import of a video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-import-retry-post.md): PeerTube >= 9.0 Retry the failed or cancelled import of a video, without having to know the video import id. - [Delete video import](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-imports-id-delete.md): Delete ended video import - [Create a live](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-live-post.md): POST /api/v1/videos/live: returns VideoUploadResponse. - [Get information about a live](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-live-id-get.md): GET /api/v1/videos/live/{id}: returns LiveVideoResponse. - [Update information about a live](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-live-id-put.md): PUT /api/v1/videos/live/{id}: takes LiveVideoUpdate. - [List live sessions](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-live-id-sessions-get.md): List all sessions created in a particular live - [Get live session of a replay](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-live-session-get.md): If the video is a replay of a live, you can find the associated live session using this endpoint - [Get video source file metadata](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-source-get.md): Get metadata and download link of original video file - [Delete video source file](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-source-file-delete.md): DELETE /api/v1/videos/{id}/source/file. - [Initialize the resumable replacement of a video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-source-replace-resumable-post.md): PeerTube >= 6.0 Uses a resumable protocol to initialize the replacement of a video - [Send chunk for the resumable replacement of a video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-source-replace-resumable-put.md): PeerTube >= 6.0 Uses a resumable protocol to continue, pause or resume the replacement of a video - [Cancel the resumable replacement of a video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-source-replace-resumable-delete.md): PeerTube >= 6.0 Uses a resumable protocol to cancel the replacement of a video - [List my abuses](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-me-abuses-get.md): GET /api/v1/users/me/abuses. - [List abuses](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-abuses-get.md): GET /api/v1/abuses. - [Report an abuse](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-abuses-post.md): You cannot report a video that you own or on which you are a collaborator (video channel editor). - [Update an abuse](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-abuses-abuseid-put.md): PUT /api/v1/abuses/{abuseId}. - [Delete an abuse](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-abuses-abuseid-delete.md): DELETE /api/v1/abuses/{abuseId}. - [List messages of an abuse](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-abuses-abuseid-messages-get.md): GET /api/v1/abuses/{abuseId}/messages. - [Add message to an abuse](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-abuses-abuseid-messages-post.md): POST /api/v1/abuses/{abuseId}/messages. - [Delete an abuse message](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-abuses-abuseid-messages-abusemessageid-delete.md): DELETE /api/v1/abuses/{abuseId}/messages/{abuseMessageId}. - [Block a video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-blacklist-post.md): POST /api/v1/videos/{id}/blacklist: takes VideoBlacklistCreate. - [Update a video block](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-blacklist-put.md): PUT /api/v1/videos/{id}/blacklist: takes VideoBlacklistUpdate. - [Unblock a video by its id](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-blacklist-delete.md): DELETE /api/v1/videos/{id}/blacklist. - [List video blocks](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-blacklist-get.md): GET /api/v1/videos/blacklist. - [List storyboards of a video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-storyboards-get.md): PeerTube >= 6.0 - [List captions of a video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-captions-get.md): GET /api/v1/videos/{id}/captions. - [Generate a video caption](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-captions-generate-post.md): PeerTube >= 6.2 This feature has to be enabled by the administrator - [Add or replace a video caption](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-captions-captionlanguage-put.md): PUT /api/v1/videos/{id}/captions/{captionLanguage}. - [Delete a video caption](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-captions-captionlanguage-delete.md): DELETE /api/v1/videos/{id}/captions/{captionLanguage}. - [Get chapters of a video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-chapters-get.md): PeerTube >= 6.0 - [Replace video chapters](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-chapters-put.md): PeerTube >= 6.0 - [Get video embed privacy](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-embed-privacy-get.md): PeerTube >= 8.1 - [Update video embed privacy](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-embed-privacy-put.md): PeerTube >= 8.1 - [Check if embed is allowed](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-embed-privacy-allowed-get.md): PeerTube >= 8.1 Check if video embed is allowed on a specific domain according to the video embed privacy settings - [List video passwords](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-passwords-get.md): PeerTube >= 6.0 - [Add a video password](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-passwords-post.md): PeerTube >= 8.0 - [Update video passwords](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-passwords-put.md): PeerTube >= 6.0 - [Delete a video password](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-passwords-passwordid-delete.md): PeerTube >= 6.0 - [List video channels](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-channels-get.md): GET /api/v1/video-channels: returns VideoChannelList. - [Create a video channel](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-channels-post.md): POST /api/v1/video-channels: takes VideoChannelCreate. - [Get a video channel](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-channels-channelhandle-get.md): GET /api/v1/video-channels/{channelHandle}: returns VideoChannel. - [Update a video channel](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-channels-channelhandle-put.md): PUT /api/v1/video-channels/{channelHandle}: takes VideoChannelUpdate. - [Delete a video channel](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-channels-channelhandle-delete.md): DELETE /api/v1/video-channels/{channelHandle}. - [List videos of a video channel](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-channels-channelhandle-videos-get.md): GET /api/v1/video-channels/{channelHandle}/videos: returns VideoListResponse. - [List activities of a video channel](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-channels-channelhandle-activities-get.md): PeerTube >= 8.0 - [List playlists of a channel](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-channels-channelhandle-video-playlists-get.md): GET /api/v1/video-channels/{channelHandle}/video-playlists. - [Reorder channel playlists](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-channels-channelhandle-video-playlists-reorder-post.md): POST /api/v1/video-channels/{channelHandle}/video-playlists/reorder. - [List followers of a video channel](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-channels-channelhandle-followers-get.md): GET /api/v1/video-channels/{channelHandle}/followers. - [Update channel avatar](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-channels-channelhandle-avatar-pick-post.md): POST /api/v1/video-channels/{channelHandle}/avatar/pick. - [Delete channel avatar](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-channels-channelhandle-avatar-delete.md): DELETE /api/v1/video-channels/{channelHandle}/avatar. - [Update channel banner](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-channels-channelhandle-banner-pick-post.md): POST /api/v1/video-channels/{channelHandle}/banner/pick. - [Delete channel banner](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-channels-channelhandle-banner-delete.md): DELETE /api/v1/video-channels/{channelHandle}/banner. - [Import videos in channel](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-channels-channelhandle-import-videos-post.md): Import a remote channel/playlist videos into a channel - [Create a synchronization for a video channel](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-channel-syncs-post.md): POST /api/v1/video-channel-syncs: takes VideoChannelSyncCreate. - [Delete a video channel synchronization](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-channel-syncs-channelsyncid-delete.md): DELETE /api/v1/video-channel-syncs/{channelSyncId}. - [Triggers the channel synchronization job, fetching all the videos from the remote channel](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-channel-syncs-channelsyncid-sync-post.md): POST /api/v1/video-channel-syncs/{channelSyncId}/sync. - [Get video player settings](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-player-settings-videos-id-get.md): Get player settings for a specific video. Returns video-specific settings merged with channel player settings. - [Update video player settings](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-player-settings-videos-id-put.md): Update player settings for a specific video - [Get channel player settings](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-player-settings-video-channels-channelhandle-get.md): Get player settings for a video channel. - [Update channel player settings](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-player-settings-video-channels-channelhandle-put.md): Update default player settings for a video channel. - [List available playlist privacy policies](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-playlists-privacies-get.md): GET /api/v1/video-playlists/privacies. - [List video playlists](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-playlists-get.md): GET /api/v1/video-playlists. - [Create a video playlist](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-playlists-post.md): If the video playlist is set as public, videoChannelId is mandatory. - [Get a video playlist](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-playlists-playlistid-get.md): GET /api/v1/video-playlists/{playlistId}: returns VideoPlaylist. - [Update a video playlist](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-playlists-playlistid-put.md): If the video playlist is set as public, the playlist must have a assigned channel. - [Delete a video playlist](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-playlists-playlistid-delete.md): DELETE /api/v1/video-playlists/{playlistId}. - [List videos of a playlist](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-playlists-playlistid-videos-get.md): GET /api/v1/video-playlists/{playlistId}/videos. - [Add a video in a playlist](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-playlists-playlistid-videos-post.md): POST /api/v1/video-playlists/{playlistId}/videos. - [Reorder playlist elements](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-playlists-playlistid-videos-reorder-post.md): POST /api/v1/video-playlists/{playlistId}/videos/reorder. - [Update a playlist element](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-playlists-playlistid-videos-playlistelementid-put.md): PUT /api/v1/video-playlists/{playlistId}/videos/{playlistElementId}. - [Delete an element from a playlist](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-playlists-playlistid-videos-playlistelementid-delete.md): DELETE /api/v1/video-playlists/{playlistId}/videos/{playlistElementId}. - [Check video exists in my playlists](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-me-video-playlists-videos-exist-get.md): GET /api/v1/users/me/video-playlists/videos-exist. - [List playlists of an account](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-accounts-name-video-playlists-get.md): GET /api/v1/accounts/{name}/video-playlists. - [List video channels of an account](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-accounts-name-video-channels-get.md): GET /api/v1/accounts/{name}/video-channels: returns VideoChannelList. - [List the synchronizations of video channels of an account](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-accounts-name-video-channel-syncs-get.md): GET /api/v1/accounts/{name}/video-channel-syncs: returns VideoChannelSyncList. - [List ratings of an account](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-accounts-name-ratings-get.md): GET /api/v1/accounts/{name}/ratings: returns a list of VideoRating. - [List threads of a video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-comment-threads-get.md): GET /api/v1/videos/{id}/comment-threads: returns CommentThreadResponse. - [Create a thread](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-comment-threads-post.md): POST /api/v1/videos/{id}/comment-threads: returns CommentThreadPostResponse. - [Get a thread](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-comment-threads-threadid-get.md): Since PeerTube 8.3 the returned tree is truncated: only the first replies of each comment are included, and only down to maxDepth nesting levels. Use GET /api/v1/videos/{id}/comments/{commentId}/replies to fetch the replies that are missing, comparing children and totalChildren of each node of the tree. - [List replies of a comment](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-comments-commentid-replies-get.md): PeerTube >= 8.3 List the direct replies of a comment, each of them nested up to maxDepth levels. Used to unfold the parts of a thread that GET /api/v1/videos/{id}/comment-threads/{threadId} truncated. - [List instance comments](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-comments-get.md): GET /api/v1/videos/comments. - [Reply to a thread of a video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-comments-commentid-post.md): POST /api/v1/videos/{id}/comments/{commentId}: returns CommentThreadPostResponse. - [Delete a comment or a reply](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-comments-commentid-delete.md): DELETE /api/v1/videos/{id}/comments/{commentId}. - [Approve a comment](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-comments-commentid-approve-post.md): PeerTube >= 6.2 Approve a comment that requires a review - [Like/dislike a video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-rate-put.md): PUT /api/v1/videos/{id}/rate. - [Delete video HLS files](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-hls-delete.md): DELETE /api/v1/videos/{id}/hls. - [Delete video Web Video files](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-web-videos-delete.md): PeerTube >= 6.0 - [Create a transcoding job](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-videos-id-transcoding-post.md): POST /api/v1/videos/{id}/transcoding. - [Search videos](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-search-videos-get.md): GET /api/v1/search/videos: returns VideoListResponse. - [Search channels](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-search-video-channels-get.md): GET /api/v1/search/video-channels: returns VideoChannelList. - [Search playlists](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-search-video-playlists-get.md): GET /api/v1/search/video-playlists. - [Get block status of accounts/hosts](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-blocklist-status-get.md): GET /api/v1/blocklist/status: returns BlockStatus. - [List accounts blocked by my account](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-me-blocklist-accounts-get.md): Get the list of accounts that the authenticated user has blocked - [Block an account by my account](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-me-blocklist-accounts-post.md): Add an account to the authenticated user's blocklist - [Unblock an account by my account](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-me-blocklist-accounts-accountname-delete.md): Remove an account from the authenticated user's blocklist - [List servers blocked by my account](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-me-blocklist-servers-get.md): Get the list of servers that the authenticated user has blocked - [Block a server by my account](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-me-blocklist-servers-post.md): Add a server to the authenticated user's blocklist - [Unblock a server by my account](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-users-me-blocklist-servers-host-delete.md): Remove a server from the authenticated user's blocklist - [List blocked accounts by server](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-server-blocklist-accounts-get.md): GET /api/v1/server/blocklist/accounts. - [Block an account by server](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-server-blocklist-accounts-post.md): POST /api/v1/server/blocklist/accounts. - [Unblock an account by server](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-server-blocklist-accounts-accountname-delete.md): DELETE /api/v1/server/blocklist/accounts/{accountName}. - [List blocked servers by server](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-server-blocklist-servers-get.md): GET /api/v1/server/blocklist/servers. - [Block a server by server](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-server-blocklist-servers-post.md): POST /api/v1/server/blocklist/servers. - [Unblock a server by server](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-server-blocklist-servers-host-delete.md): DELETE /api/v1/server/blocklist/servers/{host}. - [List server blocklist subscriptions](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-server-blocklist-subscriptions-get.md): GET /api/v1/server/blocklist/subscriptions. - [Add a server blocklist subscription](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-server-blocklist-subscriptions-post.md): POST /api/v1/server/blocklist/subscriptions: returns BlocklistSubscription. - [Delete a server blocklist subscription](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-server-blocklist-subscriptions-id-delete.md): DELETE /api/v1/server/blocklist/subscriptions/{id}. - [List publicly shared server blocklist log entries](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-server-blocklist-public-log-get.md): GET /api/v1/server/blocklist/public-log: returns AutoMuteList. - [Update a server redundancy policy](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-server-redundancy-host-put.md): PUT /api/v1/server/redundancy/{host}. - [List videos being mirrored](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-server-redundancy-videos-get.md): GET /api/v1/server/redundancy/videos: returns a list of VideoRedundancy. - [Mirror a video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-server-redundancy-videos-post.md): POST /api/v1/server/redundancy/videos. - [Delete a mirror done on a video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-server-redundancy-videos-redundancyid-delete.md): DELETE /api/v1/server/redundancy/videos/{redundancyId}. - [Get instance stats](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-server-stats-get.md): Get instance public statistics. This endpoint is cached. - [Contact the instance administrators](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-server-contact-post.md): POST /api/v1/server/contact. - [Get debug information](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-server-debug-get.md): Retrieve internal debug information for administrators. - [Run a debug command](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-server-debug-run-command-post.md): Run an internal debug command as an administrator. - [Send client log](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-server-logs-client-post.md): POST /api/v1/server/logs/client: takes SendClientLog. - [Get instance logs](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-server-logs-get.md): GET /api/v1/server/logs. - [Get instance audit logs](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-server-audit-logs-get.md): User, administration and moderation actions recorded by all the PeerTube processes of the instance. - [List plugins](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-plugins-get.md): GET /api/v1/plugins: returns PluginResponse. - [List available plugins](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-plugins-available-get.md): GET /api/v1/plugins/available: returns PluginResponse. - [Install a plugin](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-plugins-install-post.md): POST /api/v1/plugins/install. - [Update a plugin](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-plugins-update-post.md): POST /api/v1/plugins/update. - [Uninstall a plugin](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-plugins-uninstall-post.md): POST /api/v1/plugins/uninstall. - [Get a plugin](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-plugins-npmname-get.md): GET /api/v1/plugins/{npmName}: returns Plugin. - [Set a plugin's settings](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-plugins-npmname-settings-put.md): PUT /api/v1/plugins/{npmName}/settings. - [Get a plugin's public settings](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-plugins-npmname-public-settings-get.md): GET /api/v1/plugins/{npmName}/public-settings. - [Get a plugin's registered settings](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-plugins-npmname-registered-settings-get.md): GET /api/v1/plugins/{npmName}/registered-settings. - [Create playback metrics](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-metrics-playback-post.md): These metrics are exposed by OpenTelemetry metrics exporter if enabled. - [Generate registration token](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-runners-registration-tokens-generate-post.md): Generate a new runner registration token - [Remove registration token](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-runners-registration-tokens-registrationtokenid-delete.md): Remove a registration token. Runners that used this token for their registration are automatically removed. - [List registration tokens](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-runners-registration-tokens-get.md): GET /api/v1/runners/registration-tokens. - [Register a new runner](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-runners-register-post.md): API used by PeerTube runners - [Unregister a runner](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-runners-unregister-post.md): API used by PeerTube runners - [Delete a runner](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-runners-runnerid-delete.md): DELETE /api/v1/runners/{runnerId}. - [List runners](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-runners-get.md): GET /api/v1/runners. - [Request a new job](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-runners-jobs-request-post.md): API used by PeerTube runners - [Accept job](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-runners-jobs-jobuuid-accept-post.md): API used by PeerTube runners - [Abort job](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-runners-jobs-jobuuid-abort-post.md): API used by PeerTube runners - [Update job](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-runners-jobs-jobuuid-update-post.md): API used by PeerTube runners - [Post job error](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-runners-jobs-jobuuid-error-post.md): API used by PeerTube runners - [Post job success](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-runners-jobs-jobuuid-success-post.md): API used by PeerTube runners - [Download the max-quality audio file for a job video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-runners-jobs-jobuuid-files-videos-videoidoruuid-max-quality-audio-post.md): API used by PeerTube runners. - [Download the max-quality video file for a job video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-runners-jobs-jobuuid-files-videos-videoidoruuid-max-quality-post.md): API used by PeerTube runners. - [Download the max-quality thumbnail for a job video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-runners-jobs-jobuuid-files-videos-videoidoruuid-thumbnails-max-quality-post.md): API used by PeerTube runners. - [Download the max-quality preview for a job video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-runners-jobs-jobuuid-files-videos-videoidoruuid-previews-max-quality-post.md): API used by PeerTube runners. - [Download a video studio task file for a job video](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-runners-jobs-jobuuid-files-videos-videoidoruuid-studio-task-files-filename-post.md): API used by PeerTube runners. - [Cancel a job](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-runners-jobs-jobuuid-cancel-post.md): POST /api/v1/runners/jobs/{jobUUID}/cancel. - [Delete a job](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-runners-jobs-jobuuid-delete.md): The endpoint will first cancel the job if needed, and then remove it from the database. Children jobs will also be removed - [List jobs](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-runners-jobs-get.md): GET /api/v1/runners/jobs. - [Get account auto tag policies on comments](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-automatic-tags-policies-accounts-accountname-comments-get.md): PeerTube >= 6.2 - [Update account auto tag policies on comments](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-automatic-tags-policies-accounts-accountname-comments-put.md): PeerTube >= 6.2 - [Get account available auto tags](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-automatic-tags-accounts-accountname-available-get.md): PeerTube >= 6.2 - [Get server available auto tags](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-automatic-tags-server-available-get.md): PeerTube >= 6.2 - [Get server auto tag policies for videos](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-automatic-tags-policies-server-videos-get.md): PeerTube >= 8.3 - [Update server auto tag policies for videos](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-automatic-tags-policies-server-videos-put.md): PeerTube >= 8.3 - [List account watched words](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-watched-words-accounts-accountname-lists-get.md): PeerTube >= 6.2 - [Add account watched words](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-watched-words-accounts-accountname-lists-post.md): PeerTube >= 6.2 - [Update account watched words](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-watched-words-accounts-accountname-lists-listid-put.md): PeerTube >= 6.2 - [Delete account watched words](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-watched-words-accounts-accountname-lists-listid-delete.md): PeerTube >= 6.2 - [List server watched words](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-watched-words-server-lists-get.md): PeerTube >= 6.2 - [Add server watched words](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-watched-words-server-lists-post.md): PeerTube >= 6.2 - [Update server watched words](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-watched-words-server-lists-listid-put.md): PeerTube >= 6.2 - [Delete server watched words](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-watched-words-server-lists-listid-delete.md): PeerTube >= 6.2 - [List account watched words subscriptions](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-watched-words-accounts-accountname-subscriptions-get.md): GET /api/v1/watched-words/accounts/{accountName}/subscriptions. - [Add account watched words subscription](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-watched-words-accounts-accountname-subscriptions-post.md): POST /api/v1/watched-words/accounts/{accountName}/subscriptions: returns WatchedWordsSubscription. - [Delete account watched words subscription](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-watched-words-accounts-accountname-subscriptions-id-delete.md): DELETE /api/v1/watched-words/accounts/{accountName}/subscriptions/{id}. - [List server watched words subscriptions](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-watched-words-server-subscriptions-get.md): GET /api/v1/watched-words/server/subscriptions. - [Add server watched words subscription](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-watched-words-server-subscriptions-post.md): POST /api/v1/watched-words/server/subscriptions: returns WatchedWordsSubscription. - [Delete server watched words subscription](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-watched-words-server-subscriptions-id-delete.md): DELETE /api/v1/watched-words/server/subscriptions/{id}. - [Update client language](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-client-config-update-language-post.md): Set a cookie so that the next time the client refreshes the HTML of the web interface, PeerTube uses the selected language. - [Update client language](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-client-config-update-interface-language-post.md): Set a cookie so that the next time the client refreshes the HTML of the web interface, PeerTube uses the selected language. - [List channel collaborators](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-channels-channelhandle-collaborators-get.md): PeerTube >= 8.0 - [Invite a collaborator](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-channels-channelhandle-collaborators-invite-post.md): PeerTube >= 8.0 Invite a local user to collaborate on the specified video channel. - [Accept a collaboration invitation](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-channels-channelhandle-collaborators-collaboratorid-accept-post.md): PeerTube >= 8.0 - [Reject a collaboration invitation](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-channels-channelhandle-collaborators-collaboratorid-reject-post.md): PeerTube >= 8.0 - [Remove a channel collaborator](https://sourcey-peertube.pages.dev/api-rest-reference/operations/operation-api-v1-video-channels-channelhandle-collaborators-collaboratorid-delete.md): PeerTube >= 8.0 Only the channel owner or the collaborator themselves can remove a collaborator from a channel - [id](https://sourcey-peertube.pages.dev/api-rest-reference/models/id.md): id - [UUIDv4](https://sourcey-peertube.pages.dev/api-rest-reference/models/uuidv4.md): UUIDv4 - [shortUUID](https://sourcey-peertube.pages.dev/api-rest-reference/models/shortuuid.md): translation of a uuid v4 with a bigger alphabet to have a shorter uuid - [username](https://sourcey-peertube.pages.dev/api-rest-reference/models/username.md): immutable name of the user, used to find or mention its actor - [usernameChannel](https://sourcey-peertube.pages.dev/api-rest-reference/models/usernamechannel.md): immutable name of the channel, used to interact with its actor - [password](https://sourcey-peertube.pages.dev/api-rest-reference/models/password.md): password - [currentPassword](https://sourcey-peertube.pages.dev/api-rest-reference/models/currentpassword.md): Password of the authenticated user, required if password confirmation is enabled - [VideoCategorySet](https://sourcey-peertube.pages.dev/api-rest-reference/models/videocategoryset.md): category id of the video (see /videos/categories) - [VideoConstantNumber-Category](https://sourcey-peertube.pages.dev/api-rest-reference/models/videoconstantnumber-category.md): Fields: id and label. - [VideoLicenceSet](https://sourcey-peertube.pages.dev/api-rest-reference/models/videolicenceset.md): licence id of the video (see /videos/licences) - [VideoConstantNumber-Licence](https://sourcey-peertube.pages.dev/api-rest-reference/models/videoconstantnumber-licence.md): Fields: id and label. - [VideoLanguageSet](https://sourcey-peertube.pages.dev/api-rest-reference/models/videolanguageset.md): language id of the video (see /videos/languages) - [VideoConstantString-Language](https://sourcey-peertube.pages.dev/api-rest-reference/models/videoconstantstring-language.md): Fields: id and label. - [VideoPlaylistPrivacySet](https://sourcey-peertube.pages.dev/api-rest-reference/models/videoplaylistprivacyset.md): Video playlist privacy policy (see /video-playlists/privacies) - [VideoPlaylistPrivacyConstant](https://sourcey-peertube.pages.dev/api-rest-reference/models/videoplaylistprivacyconstant.md): Fields: id and label. - [VideoPlaylistTypeSet](https://sourcey-peertube.pages.dev/api-rest-reference/models/videoplaylisttypeset.md): The video playlist type (Regular = 1, Watch Later = 2) - [VideoPlaylistTypeConstant](https://sourcey-peertube.pages.dev/api-rest-reference/models/videoplaylisttypeconstant.md): Fields: id and label. - [VideoPrivacySet](https://sourcey-peertube.pages.dev/api-rest-reference/models/videoprivacyset.md): privacy id of the video (see /videos/privacies) - [VideoPrivacyConstant](https://sourcey-peertube.pages.dev/api-rest-reference/models/videoprivacyconstant.md): Fields: id and label. - [VideoCommentsPolicySet](https://sourcey-peertube.pages.dev/api-rest-reference/models/videocommentspolicyset.md): Comments policy of the video (Enabled = 1, Disabled = 2, Requires Approval = 3) - [VideoCommentsPolicyConstant](https://sourcey-peertube.pages.dev/api-rest-reference/models/videocommentspolicyconstant.md): Fields: id and label. - [VideoRecommendationScopeSet](https://sourcey-peertube.pages.dev/api-rest-reference/models/videorecommendationscopeset.md): This is a preference of the video owner: applications displaying recommendations may not apply it - [VideoRecommendationScopeConstant](https://sourcey-peertube.pages.dev/api-rest-reference/models/videorecommendationscopeconstant.md): Fields: id and label. - [VideoAIUsageSet](https://sourcey-peertube.pages.dev/api-rest-reference/models/videoaiusageset.md): PeerTube >= 9.0 Use of AI in the video, declared by the video creator: - 1 Not specified - 2 No AI-generated content: nothing seen or heard in the video has been generated by AI - 3 Contains AI-generated content: some parts of the video have been generated by AI - 4 AI-generated: the whole video, or most of it, has… - [VideoAIUsageConstant](https://sourcey-peertube.pages.dev/api-rest-reference/models/videoaiusageconstant.md): Fields: id and label. - [VideoCommercialContentSet](https://sourcey-peertube.pages.dev/api-rest-reference/models/videocommercialcontentset.md): PeerTube >= 9.0 Commercial content in the video, declared by the video creator: - 1 None - 2 Promotional content: the creator promotes their own products, services or business - 3 Paid partnership: a third party paid, or provided goods or services, in exchange for the promotion - [VideoCommercialContentConstant](https://sourcey-peertube.pages.dev/api-rest-reference/models/videocommercialcontentconstant.md): Fields: id and label. - [BlockStatus](https://sourcey-peertube.pages.dev/api-rest-reference/models/blockstatus.md): Fields: accounts and hosts. - [NSFWPolicy](https://sourcey-peertube.pages.dev/api-rest-reference/models/nsfwpolicy.md): One of: display, warn and do_not_list. - [NSFWFlag](https://sourcey-peertube.pages.dev/api-rest-reference/models/nsfwflag.md): NSFW flags (can be combined using bitwise or operator) - [UserRole](https://sourcey-peertube.pages.dev/api-rest-reference/models/userrole.md): The user role (Admin = 0, Moderator = 1, User = 2) - [UserAdminFlags](https://sourcey-peertube.pages.dev/api-rest-reference/models/useradminflags.md): Admin flags for the user (None = 0, Bypass video blocklist = 1) - [LiveVideoLatencyMode](https://sourcey-peertube.pages.dev/api-rest-reference/models/livevideolatencymode.md): The live latency mode (Default = 1, High latency = 2, Small Latency = 3) - [LiveVideoReplaySettings](https://sourcey-peertube.pages.dev/api-rest-reference/models/livevideoreplaysettings.md): Field: privacy. - [VideoChannelActivityAction](https://sourcey-peertube.pages.dev/api-rest-reference/models/videochannelactivityaction.md): The activity action: - CREATE: 1 - UPDATE: 2 - DELETE: 3 - UPDATE_CAPTIONS: 4 - UPDATE_CHAPTERS: 5 - UPDATE_PASSWORDS: 6 - CREATE_STUDIO_TASKS: 7 - UPDATE_SOURCE_FILE: 8 - UPDATE_ELEMENTS: 9 - REMOVE_CHANNEL_OWNERSHIP: 10 - CREATE_CHANNEL_OWNERSHIP: 11 - [VideoChannelActivityTarget](https://sourcey-peertube.pages.dev/api-rest-reference/models/videochannelactivitytarget.md): The activity target: - VIDEO: 1, - PLAYLIST: 2, - CHANNEL: 3, - CHANNEL_SYNC: 4, - VIDEO_IMPORT: 5 - [VideoStateConstant](https://sourcey-peertube.pages.dev/api-rest-reference/models/videostateconstant.md): Fields: id and label. - [UserExportState](https://sourcey-peertube.pages.dev/api-rest-reference/models/userexportstate.md): The user export state: - 1: Pending - 2: Processing - 3: Completed - 4: Errored - [UserImportState](https://sourcey-peertube.pages.dev/api-rest-reference/models/userimportstate.md): The user import state: - 1: Pending - 2: Processing - 3: Completed - 4: Errored - [AbuseStateSet](https://sourcey-peertube.pages.dev/api-rest-reference/models/abusestateset.md): The abuse state (Pending = 1, Rejected = 2, Accepted = 3) - [AbuseStateConstant](https://sourcey-peertube.pages.dev/api-rest-reference/models/abusestateconstant.md): Fields: id and label. - [AbusePredefinedReasons](https://sourcey-peertube.pages.dev/api-rest-reference/models/abusepredefinedreasons.md): AbusePredefinedReasons - [VideoResolutionSet](https://sourcey-peertube.pages.dev/api-rest-reference/models/videoresolutionset.md): Video resolution (0, 240, 360, 720, 1080, 1440 or 2160) - [VideoResolutionConstant](https://sourcey-peertube.pages.dev/api-rest-reference/models/videoresolutionconstant.md): resolutions and their labels for the video - [VideoScheduledUpdate](https://sourcey-peertube.pages.dev/api-rest-reference/models/videoscheduledupdate.md): Fields: privacy and updateAt. - [AccountSummary](https://sourcey-peertube.pages.dev/api-rest-reference/models/accountsummary.md): Fields: id, name, displayName, url, host and avatars. - [VideoSummary](https://sourcey-peertube.pages.dev/api-rest-reference/models/videosummary.md): Fields: id, uuid, shortUUID, name, isLive, nsfw and 3 more. - [VideoChannelSummary](https://sourcey-peertube.pages.dev/api-rest-reference/models/videochannelsummary.md): Fields: id, name, displayName, url, host and avatars. - [PlaylistElement](https://sourcey-peertube.pages.dev/api-rest-reference/models/playlistelement.md): Fields: position, startTimestamp, stopTimestamp and video. - [Thumbnail](https://sourcey-peertube.pages.dev/api-rest-reference/models/thumbnail.md): Fields: fileUrl, width, height and aspectRatio. - [VideoFile](https://sourcey-peertube.pages.dev/api-rest-reference/models/videofile.md): Fields: id, magnetUri, resolution, size, torrentUrl, torrentDownloadUrl and 10 more. - [VideoStreamingPlaylists](https://sourcey-peertube.pages.dev/api-rest-reference/models/videostreamingplaylists.md): VideoStreamingPlaylists - [VideoStreamingPlaylists-HLS](https://sourcey-peertube.pages.dev/api-rest-reference/models/videostreamingplaylists-hls.md): Fields: playlistUrl, segmentsSha256Url, files and redundancies. - [VideoInfo](https://sourcey-peertube.pages.dev/api-rest-reference/models/videoinfo.md): Fields: id, uuid, name and state. - [Video](https://sourcey-peertube.pages.dev/api-rest-reference/models/video.md): Fields: id, uuid, shortUUID, isLive, liveSchedules, createdAt and 35 more. - [ServerError](https://sourcey-peertube.pages.dev/api-rest-reference/models/servererror.md): Fields: type, detail, status and code. - [VideoDetails](https://sourcey-peertube.pages.dev/api-rest-reference/models/videodetails.md): VideoDetails - [FileRedundancyInformation](https://sourcey-peertube.pages.dev/api-rest-reference/models/fileredundancyinformation.md): Fields: id, fileUrl, strategy, size, createdAt, updatedAt and expiresOn. - [VideoRedundancy](https://sourcey-peertube.pages.dev/api-rest-reference/models/videoredundancy.md): Fields: id, name, url, uuid and redundancies. - [AccountBlock](https://sourcey-peertube.pages.dev/api-rest-reference/models/accountblock.md): Fields: byAccount, blockedAccount, blocklistSubscription and createdAt. - [ServerBlock](https://sourcey-peertube.pages.dev/api-rest-reference/models/serverblock.md): Fields: byAccount, blockedServer, blocklistSubscription and createdAt. - [BlocklistSubscription](https://sourcey-peertube.pages.dev/api-rest-reference/models/blocklistsubscription.md): Fields: id, name, url, mutedAccountsCount, mutedServersCount, lastSyncAt and 2 more. - [BlocklistSubscriptionSummary](https://sourcey-peertube.pages.dev/api-rest-reference/models/blocklistsubscriptionsummary.md): Fields: id, name and url. - [BlocklistLog](https://sourcey-peertube.pages.dev/api-rest-reference/models/blocklistlog.md): Fields: id, action, target and createdAt. - [AutoMuteList](https://sourcey-peertube.pages.dev/api-rest-reference/models/automutelist.md): Fields: name and actions. - [CommentAutoTagPolicies](https://sourcey-peertube.pages.dev/api-rest-reference/models/commentautotagpolicies.md): Field: review. - [VideoAutoTagPolicies](https://sourcey-peertube.pages.dev/api-rest-reference/models/videoautotagpolicies.md): Field: autoBlock. - [AutomaticTagAvailable](https://sourcey-peertube.pages.dev/api-rest-reference/models/automatictagavailable.md): Field: available. - [VideoImportStateConstant](https://sourcey-peertube.pages.dev/api-rest-reference/models/videoimportstateconstant.md): Fields: id and label. - [VideoCreateImport](https://sourcey-peertube.pages.dev/api-rest-reference/models/videocreateimport.md): VideoCreateImport - [VideoImport](https://sourcey-peertube.pages.dev/api-rest-reference/models/videoimport.md): Fields: id, targetUrl, magnetUri, torrentfile, torrentName, state and 4 more. - [VideoImportsList](https://sourcey-peertube.pages.dev/api-rest-reference/models/videoimportslist.md): Fields: total and data. - [Abuse](https://sourcey-peertube.pages.dev/api-rest-reference/models/abuse.md): Fields: id, reason, predefinedReasons, reporterAccount, state, moderationComment and 2 more. - [AbuseMessage](https://sourcey-peertube.pages.dev/api-rest-reference/models/abusemessage.md): Fields: id, message, byModerator, createdAt and account. - [VideoBlacklist](https://sourcey-peertube.pages.dev/api-rest-reference/models/videoblacklist.md): Fields: id, reason, internalNote, unfederated, type, video and 2 more. - [VideoBlacklistCreate](https://sourcey-peertube.pages.dev/api-rest-reference/models/videoblacklistcreate.md): Fields: reason, unfederate and internalNote. - [VideoBlacklistUpdate](https://sourcey-peertube.pages.dev/api-rest-reference/models/videoblacklistupdate.md): Fields: reason and internalNote. - [ChangeOwnership](https://sourcey-peertube.pages.dev/api-rest-reference/models/changeownership.md): Representation of a ownership change - [VideoPlaylist](https://sourcey-peertube.pages.dev/api-rest-reference/models/videoplaylist.md): Fields: id, uuid, shortUUID, createdAt, updatedAt, description and 10 more. - [VideoComment](https://sourcey-peertube.pages.dev/api-rest-reference/models/videocomment.md): Fields: id, url, text, threadId, inReplyToCommentId, videoId and 8 more. - [VideoCommentThreadTree](https://sourcey-peertube.pages.dev/api-rest-reference/models/videocommentthreadtree.md): Fields: comment, children and totalChildren. - [VideoCommentForOwnerOrAdmin](https://sourcey-peertube.pages.dev/api-rest-reference/models/videocommentforowneroradmin.md): Fields: id, url, text, heldForReview, threadId, inReplyToCommentId and 5 more. - [Storyboard](https://sourcey-peertube.pages.dev/api-rest-reference/models/storyboard.md): Fields: storyboardPath, fileUrl, totalHeight, totalWidth, spriteHeight, spriteWidth and spriteDuration. - [VideoCaption](https://sourcey-peertube.pages.dev/api-rest-reference/models/videocaption.md): Fields: language, automaticallyGenerated, captionPath, fileUrl, m3u8Url and updatedAt. - [VideoChapters](https://sourcey-peertube.pages.dev/api-rest-reference/models/videochapters.md): Field: chapters. - [PodcastChapters](https://sourcey-peertube.pages.dev/api-rest-reference/models/podcastchapters.md): Podcasting 2.0 JSON chapters, see https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/examples/chapters/jsonChapters.md - [VideoSource](https://sourcey-peertube.pages.dev/api-rest-reference/models/videosource.md): Fields: inputFilename, fileDownloadUrl, resolution, size, fps, width and 2 more. - [ActorImage](https://sourcey-peertube.pages.dev/api-rest-reference/models/actorimage.md): Fields: path, fileUrl, width, height, createdAt and updatedAt. - [ActorInfo](https://sourcey-peertube.pages.dev/api-rest-reference/models/actorinfo.md): Fields: id, name, displayName, host and avatars. - [Actor](https://sourcey-peertube.pages.dev/api-rest-reference/models/actor.md): Fields: id, url, name, avatars, host, hostRedundancyAllowed and 4 more. - [Account](https://sourcey-peertube.pages.dev/api-rest-reference/models/account.md): Account - [UserViewingVideo](https://sourcey-peertube.pages.dev/api-rest-reference/models/userviewingvideo.md): Fields: currentTime, viewEvent, sessionId, client, device and operatingSystem. - [VideoStatsOverall](https://sourcey-peertube.pages.dev/api-rest-reference/models/videostatsoverall.md): Fields: averageWatchTime, totalWatchTime, viewersPeak, totalViewers, viewersPeakDate, countries and subdivisions. - [VideoStatsUserAgentDevice](https://sourcey-peertube.pages.dev/api-rest-reference/models/videostatsuseragentdevice.md): One of: console, embedded, mobile, smarttv, tablet, wearable and 2 more. - [VideoStatsUserAgent](https://sourcey-peertube.pages.dev/api-rest-reference/models/videostatsuseragent.md): Fields: clients, devices and operatingSystem. - [VideoStatsRetention](https://sourcey-peertube.pages.dev/api-rest-reference/models/videostatsretention.md): Field: data. - [VideoStatsTimeserie](https://sourcey-peertube.pages.dev/api-rest-reference/models/videostatstimeserie.md): Field: data. - [ServerConfig](https://sourcey-peertube.pages.dev/api-rest-reference/models/serverconfig.md): Fields: instance, search, plugin, theme, email, contactForm and 19 more. - [SendClientLog](https://sourcey-peertube.pages.dev/api-rest-reference/models/sendclientlog.md): Fields: message, url, level, stackTrace, userAgent and meta. - [ServerStats](https://sourcey-peertube.pages.dev/api-rest-reference/models/serverstats.md): Fields: totalUsers, totalDailyActiveUsers, totalWeeklyActiveUsers, totalMonthlyActiveUsers, totalModerators, totalAdmins and 26 more. - [ServerConfigAbout](https://sourcey-peertube.pages.dev/api-rest-reference/models/serverconfigabout.md): Field: instance. - [InstanceTranslation](https://sourcey-peertube.pages.dev/api-rest-reference/models/instancetranslation.md): Fields: language, shortDescription, description, terms, codeOfConduct, moderationInformation and 6 more. - [ServerConfigCustom](https://sourcey-peertube.pages.dev/api-rest-reference/models/serverconfigcustom.md): Fields: instance, theme, services, cache, signup, admin and 9 more. - [CustomHomepage](https://sourcey-peertube.pages.dev/api-rest-reference/models/customhomepage.md): Field: content. - [Follow](https://sourcey-peertube.pages.dev/api-rest-reference/models/follow.md): Fields: id, follower, following, score, state, createdAt and updatedAt. - [PredefinedAbuseReasons](https://sourcey-peertube.pages.dev/api-rest-reference/models/predefinedabusereasons.md): Reason categories that help triage reports - [JobType](https://sourcey-peertube.pages.dev/api-rest-reference/models/jobtype.md): One of: activitypub-cleaner, activitypub-follow, activitypub-http-broadcast, activitypub-http-broadcast-parallel, activitypub-http-fetcher, activitypub-http-unicast and 25 more. - [Job](https://sourcey-peertube.pages.dev/api-rest-reference/models/job.md): Fields: id, state, type, data, error, createdAt and 3 more. - [AddUserResponse](https://sourcey-peertube.pages.dev/api-rest-reference/models/adduserresponse.md): Field: user. - [VideoUploadRequestCommon](https://sourcey-peertube.pages.dev/api-rest-reference/models/videouploadrequestcommon.md): Fields: name, channelId, privacy, category, licence, language and 18 more. - [VideoUploadRequestLegacy](https://sourcey-peertube.pages.dev/api-rest-reference/models/videouploadrequestlegacy.md): VideoUploadRequestLegacy - [VideoUploadRequestResumable](https://sourcey-peertube.pages.dev/api-rest-reference/models/videouploadrequestresumable.md): VideoUploadRequestResumable - [VideoUploadResponse](https://sourcey-peertube.pages.dev/api-rest-reference/models/videouploadresponse.md): Field: video. - [VideoReplaceSourceRequestResumable](https://sourcey-peertube.pages.dev/api-rest-reference/models/videoreplacesourcerequestresumable.md): Field: filename. - [UserImportResumable](https://sourcey-peertube.pages.dev/api-rest-reference/models/userimportresumable.md): Field: filename. - [CommentThreadResponse](https://sourcey-peertube.pages.dev/api-rest-reference/models/commentthreadresponse.md): Fields: total, totalNotDeletedComments and data. - [CommentThreadPostResponse](https://sourcey-peertube.pages.dev/api-rest-reference/models/commentthreadpostresponse.md): Field: comment. - [VideoTokenResponse](https://sourcey-peertube.pages.dev/api-rest-reference/models/videotokenresponse.md): Field: files. - [VideoListResponse](https://sourcey-peertube.pages.dev/api-rest-reference/models/videolistresponse.md): Fields: total and data. - [ChannelActivityListResponse](https://sourcey-peertube.pages.dev/api-rest-reference/models/channelactivitylistresponse.md): Fields: total and data. - [UserNotificationSettings](https://sourcey-peertube.pages.dev/api-rest-reference/models/usernotificationsettings.md): Fields: abuseAsModerator, videoAutoBlacklistAsModerator, newUserRegistration, newVideoFromSubscription, blacklistOnMyVideo, myVideoPublished and 12 more. - [User](https://sourcey-peertube.pages.dev/api-rest-reference/models/user.md): Fields: id, username, email, emailVerified, nsfwPolicy, nsfwFlagsDisplayed and 31 more. - [UserWithStats](https://sourcey-peertube.pages.dev/api-rest-reference/models/userwithstats.md): UserWithStats - [AddUser](https://sourcey-peertube.pages.dev/api-rest-reference/models/adduser.md): Fields: username, password, email, videoQuota, videoQuotaDaily, channelName and 3 more. - [UpdateUser](https://sourcey-peertube.pages.dev/api-rest-reference/models/updateuser.md): Fields: email, emailVerified, videoQuota, videoQuotaDaily, pluginAuth, role and 3 more. - [UpdateMe](https://sourcey-peertube.pages.dev/api-rest-reference/models/updateme.md): Fields: password, currentPassword, email, displayName, nsfwPolicy, nsfwFlagsDisplayed and 17 more. - [GetMeVideoRating](https://sourcey-peertube.pages.dev/api-rest-reference/models/getmevideorating.md): Fields: id and rating. - [VideoRating](https://sourcey-peertube.pages.dev/api-rest-reference/models/videorating.md): Fields: video and rating. - [RegisterUser](https://sourcey-peertube.pages.dev/api-rest-reference/models/registeruser.md): Fields: username, password, email, displayName, channel and signupClient. - [UserRegistrationRequest](https://sourcey-peertube.pages.dev/api-rest-reference/models/userregistrationrequest.md): UserRegistrationRequest - [UserRegistrationAcceptOrReject](https://sourcey-peertube.pages.dev/api-rest-reference/models/userregistrationacceptorreject.md): Fields: moderationResponse and preventEmailDelivery. - [AuditLogAction](https://sourcey-peertube.pages.dev/api-rest-reference/models/auditlogaction.md): One of: create, update and delete. - [AuditLogEntityType](https://sourcey-peertube.pages.dev/api-rest-reference/models/auditlogentitytype.md): One of: video, video-import, video-live, video-source, video-file, video-caption and 49 more. - [AuditLog](https://sourcey-peertube.pages.dev/api-rest-reference/models/auditlog.md): Fields: id, action, entityType, entityId, user, ip and 6 more. - [UserRegistrationState](https://sourcey-peertube.pages.dev/api-rest-reference/models/userregistrationstate.md): The registration state (Pending = 1, Rejected = 2, Accepted = 3) - [ChangeOwnershipState](https://sourcey-peertube.pages.dev/api-rest-reference/models/changeownershipstate.md): The ownership change state (Pending = 1, Rejected = 2, Accepted = 3) - [UserRegistration](https://sourcey-peertube.pages.dev/api-rest-reference/models/userregistration.md): Fields: id, state, registrationReason, moderationResponse, username, email and 7 more. - [OAuthClient](https://sourcey-peertube.pages.dev/api-rest-reference/models/oauthclient.md): Fields: client_id and client_secret. - [OAuthToken-password](https://sourcey-peertube.pages.dev/api-rest-reference/models/oauthtoken-password.md): OAuthToken-password - [OAuthToken-refresh_token](https://sourcey-peertube.pages.dev/api-rest-reference/models/oauthtoken-refresh-token.md): OAuthToken-refresh_token - [VideoChannel](https://sourcey-peertube.pages.dev/api-rest-reference/models/videochannel.md): VideoChannel - [VideoChannelEdit](https://sourcey-peertube.pages.dev/api-rest-reference/models/videochanneledit.md): Fields: displayName, description, support and publicEmail. - [VideoChannelCreate](https://sourcey-peertube.pages.dev/api-rest-reference/models/videochannelcreate.md): VideoChannelCreate - [VideoChannelUpdate](https://sourcey-peertube.pages.dev/api-rest-reference/models/videochannelupdate.md): VideoChannelUpdate - [VideoChannelList](https://sourcey-peertube.pages.dev/api-rest-reference/models/videochannellist.md): Fields: total and data. - [ImportVideosInChannelCreate](https://sourcey-peertube.pages.dev/api-rest-reference/models/importvideosinchannelcreate.md): Fields: externalChannelUrl and videoChannelSyncId. - [VideoChannelSync](https://sourcey-peertube.pages.dev/api-rest-reference/models/videochannelsync.md): Fields: id, state, externalChannelUrl, createdAt, lastSyncAt, channel and videoPrivacy. - [VideoChannelSyncList](https://sourcey-peertube.pages.dev/api-rest-reference/models/videochannelsynclist.md): Fields: total and data. - [VideoChannelSyncCreate](https://sourcey-peertube.pages.dev/api-rest-reference/models/videochannelsynccreate.md): Fields: externalChannelUrl, videoChannelId and videoPrivacy. - [MRSSPeerLink](https://sourcey-peertube.pages.dev/api-rest-reference/models/mrsspeerlink.md): Fields: href and type. - [MRSSGroupContent](https://sourcey-peertube.pages.dev/api-rest-reference/models/mrssgroupcontent.md): Fields: url, fileSize, type, framerate, duration, height and lang. - [VideoCommentsForXML](https://sourcey-peertube.pages.dev/api-rest-reference/models/videocommentsforxml.md): VideoCommentsForXML - [VideosForXML](https://sourcey-peertube.pages.dev/api-rest-reference/models/videosforxml.md): VideosForXML - [NotificationSettingValue](https://sourcey-peertube.pages.dev/api-rest-reference/models/notificationsettingvalue.md): Notification type. One of the following values, or a sum of multiple values: - 0 NONE - 1 WEB - 2 EMAIL - [NotificationType](https://sourcey-peertube.pages.dev/api-rest-reference/models/notificationtype.md): Notification type. One of the following values: - 1 NEW_VIDEO_FROM_SUBSCRIPTION - 2 NEW_COMMENT_ON_MY_VIDEO - 3 NEW_ABUSE_FOR_MODERATORS - 4 BLACKLIST_ON_MY_VIDEO - 5 UNBLACKLIST_ON_MY_VIDEO - 6 MY_VIDEO_PUBLISHED - 7 MY_VIDEO_IMPORT_SUCCESS - 8 MY_VIDEO_IMPORT_ERROR - 9 NEW_USER_REGISTRATION - 10 NEW_FOLLOW - 11… - [NewFeatureInfoType](https://sourcey-peertube.pages.dev/api-rest-reference/models/newfeatureinfotype.md): Represent a new feature that can be displayed to inform users. One of the following values: - 1 CHANNEL_COLLABORATION - [Notification](https://sourcey-peertube.pages.dev/api-rest-reference/models/notification.md): Fields: id, type, read, video, videoImport, comment and 6 more. - [NotificationListResponse](https://sourcey-peertube.pages.dev/api-rest-reference/models/notificationlistresponse.md): Fields: total and data. - [Plugin](https://sourcey-peertube.pages.dev/api-rest-reference/models/plugin.md): Fields: name, type, latestVersion, version, enabled, uninstalled and 6 more. - [PluginResponse](https://sourcey-peertube.pages.dev/api-rest-reference/models/pluginresponse.md): Fields: total and data. - [LiveVideoUpdate](https://sourcey-peertube.pages.dev/api-rest-reference/models/livevideoupdate.md): Fields: saveReplay, replaySettings, permanentLive, latencyMode and schedules. - [LiveVideoResponse](https://sourcey-peertube.pages.dev/api-rest-reference/models/livevideoresponse.md): Fields: rtmpUrl, rtmpsUrl, streamKey, saveReplay, replaySettings, permanentLive and 2 more. - [LiveSchedule](https://sourcey-peertube.pages.dev/api-rest-reference/models/liveschedule.md): Field: startAt. - [TokenSession](https://sourcey-peertube.pages.dev/api-rest-reference/models/tokensession.md): Fields: id, currentSession, loginDevice, loginIP, loginDate, lastActivityDevice and 3 more. - [RequestTwoFactorResponse](https://sourcey-peertube.pages.dev/api-rest-reference/models/requesttwofactorresponse.md): Field: otpRequest. - [VideoStudioCreateTask](https://sourcey-peertube.pages.dev/api-rest-reference/models/videostudiocreatetask.md): VideoStudioCreateTask - [LiveVideoSessionResponse](https://sourcey-peertube.pages.dev/api-rest-reference/models/livevideosessionresponse.md): Fields: id, startDate, endDate, error and replayVideo. - [PlaybackMetricCreate](https://sourcey-peertube.pages.dev/api-rest-reference/models/playbackmetriccreate.md): Fields: playerMode, resolution, fps, p2pEnabled, p2pPeers, resolutionChanges and 6 more. - [RunnerRegistrationToken](https://sourcey-peertube.pages.dev/api-rest-reference/models/runnerregistrationtoken.md): Fields: id, registrationToken, createdAt, updatedAt and registeredRunnersCount. - [Runner](https://sourcey-peertube.pages.dev/api-rest-reference/models/runner.md): Fields: id, name, description, ip, updatedAt, createdAt and lastContact. - [RunnerJobType](https://sourcey-peertube.pages.dev/api-rest-reference/models/runnerjobtype.md): One of: vod-web-video-transcoding, vod-hls-transcoding, vod-audio-merge-transcoding and live-rtmp-hls-transcoding. - [RunnerJobState](https://sourcey-peertube.pages.dev/api-rest-reference/models/runnerjobstate.md): The runner job state: - 1 Pending - 2 Processing - 3 Completed - 4 Errored - 5 Waiting for a parent job - 6 Cancelled - 7 Parent had an error - 8 Parent has been cancelled - [RunnerJobStateConstant](https://sourcey-peertube.pages.dev/api-rest-reference/models/runnerjobstateconstant.md): Fields: id and label. - [RunnerJobPayload](https://sourcey-peertube.pages.dev/api-rest-reference/models/runnerjobpayload.md): RunnerJobPayload - [RunnerJob](https://sourcey-peertube.pages.dev/api-rest-reference/models/runnerjob.md): Fields: uuid, type, state, payload, failures, error and 8 more. - [RunnerJobAdmin](https://sourcey-peertube.pages.dev/api-rest-reference/models/runnerjobadmin.md): RunnerJobAdmin - [WatchedWordsLists](https://sourcey-peertube.pages.dev/api-rest-reference/models/watchedwordslists.md): Fields: id, listName, words, subscriptionUrl, updatedAt and createdAt. - [WatchedWordsSubscription](https://sourcey-peertube.pages.dev/api-rest-reference/models/watchedwordssubscription.md): Fields: id, name, url, importedWordsCount, lastSyncAt, state and 2 more. - [VideoPassword](https://sourcey-peertube.pages.dev/api-rest-reference/models/videopassword.md): Fields: id, password and videoId. - [VideoPasswordList](https://sourcey-peertube.pages.dev/api-rest-reference/models/videopasswordlist.md): Fields: total and data. - [AddVideoPasswords](https://sourcey-peertube.pages.dev/api-rest-reference/models/addvideopasswords.md): A list of password. - [VideoEmbedPrivacy](https://sourcey-peertube.pages.dev/api-rest-reference/models/videoembedprivacy.md): 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 - [PlayerTheme](https://sourcey-peertube.pages.dev/api-rest-reference/models/playertheme.md): The player theme to use - [PlayerThemeChannelSetting](https://sourcey-peertube.pages.dev/api-rest-reference/models/playerthemechannelsetting.md): Player theme setting for a channel: - instance-default Use the instance default theme - galaxy Use the galaxy theme - lucide Use the lucide theme - [PlayerThemeVideoSetting](https://sourcey-peertube.pages.dev/api-rest-reference/models/playerthemevideosetting.md): Player theme setting for a video: - channel-default Use the channel default theme - instance-default Use the instance default theme - galaxy Use the galaxy theme - lucide Use the lucide theme - [PlayerVideoSettings](https://sourcey-peertube.pages.dev/api-rest-reference/models/playervideosettings.md): Player settings for a video - [PlayerChannelSettings](https://sourcey-peertube.pages.dev/api-rest-reference/models/playerchannelsettings.md): Player settings for a channel - [PlayerVideoSettingsUpdate](https://sourcey-peertube.pages.dev/api-rest-reference/models/playervideosettingsupdate.md): Player settings update for a video - [PlayerChannelSettingsUpdate](https://sourcey-peertube.pages.dev/api-rest-reference/models/playerchannelsettingsupdate.md): Player settings update for a channel - [FileStorage](https://sourcey-peertube.pages.dev/api-rest-reference/models/filestorage.md): The file storage type: - 0 File system - 1 Object storage - [VideoChannelCollaborator](https://sourcey-peertube.pages.dev/api-rest-reference/models/videochannelcollaborator.md): Representation of a channel collaboration - [VideoChannelCollaboratorState](https://sourcey-peertube.pages.dev/api-rest-reference/models/videochannelcollaboratorstate.md): The user import state: - 1: Pending - 2: Accepted