openapi: 3.0.0
info:
title: PeerTube
- version: 2.1.0-rc.1
+ version: 2.2.0
contact:
name: PeerTube Community
url: 'https://joinpeertube.org'
altText: PeerTube Project Homepage
description: |
# Introduction
- The PeerTube API is built on HTTP(S). Our API is RESTful. It has predictable
- resource URLs. It returns HTTP response codes to indicate errors. It also
- accepts and returns JSON in the HTTP body. You can use your favorite
- HTTP/REST library for your programming language to use PeerTube. No official
- SDK is currently provided, but the spec API is fully compatible with
+
+ 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. The spec API is fully compatible with
[openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO)
- which generates a client SDK in the language of your choice.
+ which generates a client SDK in the language of your choice - we generate some client SDKs automatically:
+
+ - [Python](https://framagit.org/framasoft/peertube/clients/python)
+ - [Go](https://framagit.org/framasoft/peertube/clients/go)
+ - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin)
+
+ See the [Quick Start guide](https://docs.joinpeertube.org/#/api-rest-getting-started) so you can play with the PeerTube API.
# Authentication
+
When you sign up for an account, you are given the possibility to generate
sessions, and authenticate using this session token. One session token can
currently be used at a time.
# Errors
+
The API uses standard HTTP status codes to indicate the success or failure
of the API call. The body of the response will be JSON in the following
format.
description: >
Jobs are long-running tasks enqueued and processed by the instance
itself. No additional worker registration is currently available.
- - name: Server Following
+ - name: Instance Follows
description: >
Managing servers which the instance interacts with is crucial to the
concept of federation in PeerTube and external video indexation. The PeerTube
server then deals with inter-server ActivityPub operations and propagates
information across its social graph by posting activities to actors' inbox
endpoints.
- - name: Video Abuse
+ - name: Video Abuses
description: |
Video abuses deal with reports of local or remote videos alike.
- name: Video
Operations dealing with listing, uploading, fetching or modifying videos.
- name: Search
description: |
- The search helps to find _videos_ from within the instance and beyond.
+ The search helps to find _videos_ or _channels_ from within the instance and beyond.
Videos from other instances federated by the instance (that is, instances
followed by the instance) can be found via keywords and other criteria of
the advanced search.
- - name: Video Comment
+
+ Administrators can also enable the use of a remote search system, indexing
+ videos and channels not could be not federated by the instance.
+ - name: Video Comments
description: >
Operations dealing with comments to a video. Comments are organized in
threads.
- - name: Video Playlist
+ - name: Video Playlists
description: >
Operations dealing with playlists of videos. Playlists are bound to users
and/or channels.
- - name: Video Channel
+ - name: Video Channels
description: >
- Operations dealing with creation, modification and video listing of a
- user's channels.
- - name: Video Blacklist
+ Operations dealing with the creation, modification and listing of videos within a channel.
+ - name: Video Blocks
description: >
- Operations dealing with blacklisting videos (removing them from view and
+ Operations dealing with blocking videos (removing them from view and
preventing interactions).
- - name: Video Rate
+ - name: Video Rates
description: >
- Voting for a video.
+ Like/dislike a video.
+ - name: Feeds
+ description: >
+ Server syndication feeds
x-tagGroups:
- name: Accounts
tags:
- Accounts
- - User
+ - Users
- My User
+ - My Subscriptions
+ - My Notifications
- name: Videos
tags:
- Video
- Video Caption
- - Video Channel
- - Video Comment
- - Video Following
- - Video Rate
+ - Video Channels
+ - Video Comments
+ - Video Rates
+ - Video Playlists
+ - Video Ownership Change
+ - Feeds
+ - name: Search
+ tags:
+ - Search
- name: Moderation
tags:
- - Video Abuse
- - Video Blacklist
+ - Video Abuses
+ - Video Blocks
+ - Account Blocks
+ - Server Blocks
- name: Instance Configuration
tags:
- Config
- - Server Following
+ - Instance Follows
- name: Jobs
tags:
- Job
- - name: Search
- tags:
- - Search
paths:
'/accounts/{name}':
get:
tags:
- Accounts
- summary: Get the account by name
+ summary: Get an account
parameters:
- $ref: '#/components/parameters/name'
responses:
application/json:
schema:
$ref: '#/components/schemas/Account'
+ '404':
+ description: account not found
'/accounts/{name}/videos':
get:
tags:
- Accounts
- Video
- summary: 'Get videos for an account, provided the name of that account'
+ summary: 'List videos of an account'
parameters:
- $ref: '#/components/parameters/name'
+ - $ref: '#/components/parameters/categoryOneOf'
+ - $ref: '#/components/parameters/tagsOneOf'
+ - $ref: '#/components/parameters/tagsAllOf'
+ - $ref: '#/components/parameters/licenceOneOf'
+ - $ref: '#/components/parameters/languageOneOf'
+ - $ref: '#/components/parameters/nsfw'
+ - $ref: '#/components/parameters/filter'
+ - $ref: '#/components/parameters/skipCount'
+ - $ref: '#/components/parameters/start'
+ - $ref: '#/components/parameters/count'
+ - $ref: '#/components/parameters/videosSort'
responses:
'200':
description: successful operation
get:
tags:
- Accounts
- summary: Get all accounts
+ summary: List accounts
parameters:
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
get:
tags:
- Config
- summary: Get the public configuration of the server
+ summary: Get instance public configuration
responses:
'200':
description: successful operation
$ref: '#/components/schemas/ServerConfig'
/config/about:
get:
- summary: Get the instance about page content
+ summary: Get instance "About" information
tags:
- Config
responses:
$ref: '#/components/schemas/ServerConfigAbout'
/config/custom:
get:
- summary: Get the runtime configuration of the server
+ summary: Get instance runtime configuration
tags:
- Config
security:
schema:
$ref: '#/components/schemas/ServerConfigCustom'
put:
- summary: Set the runtime configuration of the server
+ summary: Set instance runtime configuration
tags:
- Config
security:
'200':
description: successful operation
delete:
- summary: Delete the runtime configuration of the server
+ summary: Delete instance runtime configuration
tags:
- Config
security:
description: successful operation
/jobs/{state}:
get:
- summary: Get list of jobs
+ summary: List instance jobs
security:
- OAuth2:
- admin
delete:
security:
- OAuth2:
- - admin
+ - admin
tags:
- - Server Following
- summary: Unfollow a server by hostname
+ - Instance Follows
+ summary: Unfollow a server
parameters:
- name: host
in: path
/server/followers:
get:
tags:
- - Server Following
- summary: Get followers of the server
+ - Instance Follows
+ summary: List instance followers
parameters:
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
/server/following:
get:
tags:
- - Server Following
- summary: Get servers followed by the server
+ - Instance Follows
+ summary: List instances followed by the server
parameters:
+ - name: state
+ in: query
+ schema:
+ type: string
+ enum:
+ - pending
+ - accepted
+ - name: actorType
+ in: query
+ schema:
+ type: string
+ enum:
+ - Person
+ - Application
+ - Group
+ - Service
+ - Organization
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/sort'
- OAuth2:
- admin
tags:
- - Server Following
+ - Instance Follows
summary: Follow a server
responses:
'204':
- $ref: '#/paths/~1users~1me/put/responses/204'
+ description: successful operation
+ '500':
+ description: cannot follow a non-HTTPS server
requestBody:
content:
application/json:
schema:
- $ref: '#/components/schemas/Follow'
+ type: object
+ properties:
+ hosts:
+ type: array
+ items:
+ type: string
+ uniqueItems: true
/users:
post:
- summary: Creates user
+ summary: Create a user
security:
- OAuth2:
- admin
tags:
- - User
+ - Users
responses:
'200':
description: successful operation
description: User to create
required: true
get:
- summary: Get a list of users
+ summary: List users
security:
- OAuth2: []
tags:
- - User
+ - Users
parameters:
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
$ref: '#/components/schemas/User'
'/users/{id}':
delete:
- summary: Delete a user by its id
+ summary: Delete a user
security:
- OAuth2:
- admin
tags:
- - User
+ - Users
parameters:
- $ref: '#/components/parameters/id'
responses:
'204':
- $ref: '#/paths/~1users~1me/put/responses/204'
+ description: successful operation
get:
- summary: Get user by its id
+ summary: Get a user
security:
- OAuth2: []
tags:
- - User
+ - Users
parameters:
- $ref: '#/components/parameters/id'
responses:
schema:
$ref: '#/components/schemas/User'
put:
- summary: Update user profile by its id
+ summary: Update a user
security:
- OAuth2: []
tags:
- - User
+ - Users
parameters:
- $ref: '#/components/parameters/id'
responses:
'204':
- $ref: '#/paths/~1users~1me/put/responses/204'
+ description: successful operation
requestBody:
content:
application/json:
post:
summary: Register a user
tags:
- - User
+ - Users
responses:
'204':
- $ref: '#/paths/~1users~1me/put/responses/204'
+ description: successful operation
requestBody:
content:
application/json:
required: true
/users/me:
get:
- summary: Get current user information
+ summary: Get my user information
security:
- OAuth2:
- user
items:
$ref: '#/components/schemas/User'
put:
- summary: Update current user information
+ summary: Update my user information
security:
- OAuth2:
- user
required: true
/users/me/videos/imports:
get:
- summary: Get video imports of current user
+ summary: Get video imports of my user
security:
- OAuth2:
- user
tags:
+ - Videos
- My User
parameters:
- $ref: '#/components/parameters/start'
$ref: '#/components/schemas/VideoImport'
/users/me/video-quota-used:
get:
- summary: Get current user used quota
+ summary: Get my user used quota
security:
- OAuth2:
- user
type: number
'/users/me/videos/{videoId}/rating':
get:
- summary: 'Get rating of video by its id, among those of the current user'
+ summary: Get rate of my user for a video
security:
- OAuth2: []
tags:
- My User
+ - Video Rates
parameters:
- name: videoId
in: path
$ref: '#/components/schemas/GetMeVideoRating'
/users/me/videos:
get:
- summary: Get videos of the current user
+ summary: Get videos of my user
security:
- OAuth2:
- user
tags:
- My User
+ - Videos
parameters:
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
$ref: '#/components/schemas/VideoListResponse'
/users/me/subscriptions:
get:
- summary: Get subscriptions of the current user
+ summary: Get my user subscriptions
security:
- OAuth2:
- user
tags:
- - My User
+ - My Subscriptions
parameters:
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
'200':
description: successful operation
post:
- summary: Add subscription to the current user
+ summary: Add subscription to my user
security:
- OAuth2:
- user
tags:
- - My User
+ - My Subscriptions
responses:
'200':
description: successful operation
/users/me/subscriptions/exist:
get:
- summary: Get if subscriptions exist for the current user
+ summary: Get if subscriptions exist for my user
security:
- OAuth2:
- user
tags:
- - My User
+ - My Subscriptions
parameters:
- $ref: '#/components/parameters/subscriptionsUris'
responses:
type: object
/users/me/subscriptions/videos:
get:
- summary: Get videos of subscriptions of the current user
+ summary: List videos of subscriptions of my user
security:
- OAuth2:
- user
tags:
- - My User
+ - My Subscriptions
+ - Videos
parameters:
+ - $ref: '#/components/parameters/categoryOneOf'
+ - $ref: '#/components/parameters/tagsOneOf'
+ - $ref: '#/components/parameters/tagsAllOf'
+ - $ref: '#/components/parameters/licenceOneOf'
+ - $ref: '#/components/parameters/languageOneOf'
+ - $ref: '#/components/parameters/nsfw'
+ - $ref: '#/components/parameters/filter'
+ - $ref: '#/components/parameters/skipCount'
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
- - $ref: '#/components/parameters/sort'
+ - $ref: '#/components/parameters/videosSort'
responses:
'200':
description: successful operation
$ref: '#/components/schemas/VideoListResponse'
'/users/me/subscriptions/{subscriptionHandle}':
get:
- summary: Get subscription of the current user for a given uri
+ summary: Get subscription of my user
security:
- OAuth2:
- user
tags:
- - My User
+ - My Subscriptions
parameters:
- $ref: '#/components/parameters/subscriptionHandle'
responses:
schema:
$ref: '#/components/schemas/VideoChannel'
delete:
- summary: Delete subscription of the current user for a given uri
+ summary: Delete subscription of my user
security:
- OAuth2:
- user
tags:
- - My User
+ - My Subscriptions
parameters:
- $ref: '#/components/parameters/subscriptionHandle'
responses:
'200':
description: successful operation
+ /users/me/notifications:
+ get:
+ summary: List my notifications
+ security:
+ - OAuth2: []
+ tags:
+ - My Notifications
+ parameters:
+ - name: unread
+ in: query
+ description: only list unread notifications
+ schema:
+ type: boolean
+ - $ref: '#/components/parameters/start'
+ - $ref: '#/components/parameters/count'
+ - $ref: '#/components/parameters/sort'
+ responses:
+ '200':
+ description: successful operation
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NotificationListResponse'
+ /users/me/notifications/read:
+ post:
+ summary: Mark notifications as read by their id
+ security:
+ - OAuth2: []
+ tags:
+ - My Notifications
+ requestBody:
+ content:
+ multipart/form-data:
+ schema:
+ type: object
+ properties:
+ ids:
+ type: array
+ description: ids of the notifications to mark as read
+ items:
+ type: integer
+ required:
+ - ids
+ responses:
+ '204':
+ description: successful operation
+ /users/me/notifications/read-all:
+ post:
+ summary: Mark all my notification as read
+ security:
+ - OAuth2: []
+ tags:
+ - My Notifications
+ responses:
+ '204':
+ description: successful operation
+ /users/me/notification-settings:
+ put:
+ summary: Update my notification settings
+ security:
+ - OAuth2: []
+ tags:
+ - My Notifications
+ requestBody:
+ content:
+ multipart/form-data:
+ schema:
+ type: object
+ properties:
+ newVideoFromSubscription:
+ $ref: '#/components/schemas/NotificationSettingValue'
+ newCommentOnMyVideo:
+ $ref: '#/components/schemas/NotificationSettingValue'
+ videoAbuseAsModerator:
+ $ref: '#/components/schemas/NotificationSettingValue'
+ videoAutoBlacklistAsModerator:
+ $ref: '#/components/schemas/NotificationSettingValue'
+ blacklistOnMyVideo:
+ $ref: '#/components/schemas/NotificationSettingValue'
+ myVideoPublished:
+ $ref: '#/components/schemas/NotificationSettingValue'
+ myVideoImportFinished:
+ $ref: '#/components/schemas/NotificationSettingValue'
+ newFollow:
+ $ref: '#/components/schemas/NotificationSettingValue'
+ newUserRegistration:
+ $ref: '#/components/schemas/NotificationSettingValue'
+ commentMention:
+ $ref: '#/components/schemas/NotificationSettingValue'
+ newInstanceFollower:
+ $ref: '#/components/schemas/NotificationSettingValue'
+ autoInstanceFollowing:
+ $ref: '#/components/schemas/NotificationSettingValue'
+ responses:
+ '204':
+ description: successful operation
/users/me/avatar/pick:
post:
- summary: Update current user avatar
+ summary: Update my user avatar
security:
- OAuth2: []
tags:
encoding:
avatarfile:
contentType: image/png, image/jpeg
+ /videos/ownership:
+ get:
+ summary: List video ownership changes
+ tags:
+ - Video Ownership Change
+ security:
+ - OAuth2: []
+ responses:
+ '200':
+ description: successful operation
+ '/videos/ownership/{id}/accept':
+ post:
+ summary: Accept ownership change request
+ tags:
+ - Video Ownership Change
+ security:
+ - OAuth2: []
+ parameters:
+ - $ref: '#/components/parameters/idOrUUID'
+ responses:
+ '204':
+ description: successful operation
+ '403':
+ description: cannot terminate an ownership change of another user
+ '404':
+ description: video owneship change not found
+ '/videos/ownership/{id}/refuse':
+ post:
+ summary: Refuse ownership change request
+ tags:
+ - Video Ownership Change
+ security:
+ - OAuth2: []
+ parameters:
+ - $ref: '#/components/parameters/idOrUUID'
+ responses:
+ '204':
+ description: successful operation
+ '403':
+ description: cannot terminate an ownership change of another user
+ '404':
+ description: video owneship change not found
+ '/videos/{id}/give-ownership':
+ post:
+ summary: Request ownership change
+ tags:
+ - Video Ownership Change
+ security:
+ - OAuth2: []
+ parameters:
+ - $ref: '#/components/parameters/idOrUUID'
+ requestBody:
+ required: true
+ content:
+ application/x-www-form-urlencoded:
+ schema:
+ type: object
+ properties:
+ username:
+ type: string
+ required:
+ - username
+ responses:
+ '204':
+ description: successful operation
+ '400':
+ description: changing video ownership to a remote account is not supported yet
+ '404':
+ description: video not found
/videos:
get:
- summary: Get list of videos
+ summary: List videos
tags:
- Video
parameters:
- $ref: '#/components/parameters/languageOneOf'
- $ref: '#/components/parameters/nsfw'
- $ref: '#/components/parameters/filter'
+ - $ref: '#/components/parameters/skipCount'
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/videosSort'
$ref: '#/components/schemas/VideoListResponse'
/videos/categories:
get:
- summary: Get list of video categories known by the server
+ summary: List available video categories
tags:
- Video
responses:
type: string
/videos/licences:
get:
- summary: Get list of video licences known by the server
+ summary: List available video licences
tags:
- Video
responses:
type: string
/videos/languages:
get:
- summary: Get list of languages known by the server
+ summary: List available video languages
tags:
- Video
responses:
type: string
/videos/privacies:
get:
- summary: Get list of privacy policies supported by the server
+ summary: List available video privacies
tags:
- Video
responses:
type: string
'/videos/{id}':
put:
- summary: Update metadata for a video by its id
+ summary: Update a video
security:
- OAuth2: []
tags:
language:
description: Video language
type: string
+ privacy:
+ $ref: '#/components/schemas/VideoPrivacySet'
description:
description: Video description
type: string
previewfile:
contentType: image/jpeg
get:
- summary: Get a video by its id
+ summary: Get a video
tags:
- Video
parameters:
schema:
$ref: '#/components/schemas/VideoDetails'
delete:
- summary: Delete a video by its id
+ summary: Delete a video
security:
- OAuth2: []
tags:
- $ref: '#/components/parameters/idOrUUID'
responses:
'204':
- $ref: '#/paths/~1users~1me/put/responses/204'
+ description: successful operation
'/videos/{id}/description':
get:
- summary: Get a video description by its id
+ summary: Get complete video description
tags:
- Video
parameters:
type: string
'/videos/{id}/views':
post:
- summary: Add a view to the video by its id
+ summary: Add a view to a video
tags:
- Video
parameters:
- $ref: '#/components/parameters/idOrUUID'
responses:
'204':
- $ref: '#/paths/~1users~1me/put/responses/204'
+ description: successful operation
'/videos/{id}/watching':
put:
- summary: Set watching progress of a video by its id for a user
+ summary: Set watching progress of a video
tags:
- Video
security:
required: true
responses:
'204':
- $ref: '#/paths/~1users~1me/put/responses/204'
- /videos/ownership:
- get:
- summary: Get list of video ownership changes requests
- tags:
- - Video
- security:
- - OAuth2: []
- responses:
- '200':
description: successful operation
- '/videos/ownership/{id}/accept':
- post:
- summary: Refuse ownership change request for video by its id
- tags:
- - Video
- security:
- - OAuth2: []
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- responses:
- '204':
- $ref: '#/paths/~1users~1me/put/responses/204'
- '/videos/ownership/{id}/refuse':
- post:
- summary: Accept ownership change request for video by its id
- tags:
- - Video
- security:
- - OAuth2: []
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- responses:
- '204':
- $ref: '#/paths/~1users~1me/put/responses/204'
- '/videos/{id}/give-ownership':
- post:
- summary: Request change of ownership for a video you own, by its id
- tags:
- - Video
- security:
- - OAuth2: []
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- requestBody:
- required: true
- content:
- application/x-www-form-urlencoded:
- schema:
- type: object
- properties:
- username:
- type: string
- required:
- - username
- responses:
- '204':
- $ref: '#/paths/~1users~1me/put/responses/204'
- '400':
- description: 'Changing video ownership to a remote account is not supported yet'
/videos/upload:
post:
- summary: Upload a video file with its metadata
+ summary: Upload a video
security:
- OAuth2: []
tags:
format: binary
channelId:
description: Channel id that will contain this video
- type: number
+ type: integer
thumbnailfile:
description: Video thumbnail file
type: string
type: array
minItems: 1
maxItems: 5
+ uniqueItems: true
items:
type: string
minLength: 2
"Authorization:Bearer $token"
/videos/imports:
post:
- summary: Import a torrent or magnetURI or HTTP resource (if enabled by the instance administrator)
+ summary: Import a video
+ description: Import a torrent or magnetURI or HTTP resource (if enabled by the instance administrator)
security:
- OAuth2: []
tags:
- Video
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/VideoUploadResponse'
requestBody:
content:
multipart/form-data:
type: string
channelId:
description: Channel id that will contain this video
- type: number
+ type: integer
thumbnailfile:
description: Video thumbnail file
type: string
contentType: image/jpeg
previewfile:
contentType: image/jpeg
+ responses:
+ '200':
+ description: successful operation
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/VideoUploadResponse'
+ '409':
+ description: HTTP or Torrent/magnetURI import not enabled
+ '400':
+ description: '`magnetUri` or `targetUrl` or a torrent file missing'
/videos/abuse:
get:
- summary: Get list of reported video abuses
+ summary: List video abuses
security:
- - OAuth2: []
+ - OAuth2:
+ - admin
+ - moderator
tags:
- - Video Abuse
+ - Video Abuses
parameters:
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
$ref: '#/components/schemas/VideoAbuse'
'/videos/{id}/abuse':
post:
- summary: 'Report an abuse, on a video by its id'
+ summary: Report an abuse
security:
- OAuth2: []
tags:
- - Video Abuse
+ - Video Abuses
+ - Videos
parameters:
- $ref: '#/components/parameters/idOrUUID'
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ reason:
+ description: Reason why the user reports this video
+ type: string
+ predefinedReasons:
+ description: Reason categories that help triage reports
+ type: array
+ items:
+ type: string
+ enum:
+ - violentOrAbusive
+ - hatefulOrAbusive
+ - spamOrMisleading
+ - privacy
+ - rights
+ - serverRules
+ - thumbnails
+ - captions
+ startAt:
+ type: integer
+ description: Timestamp in the video that marks the beginning of the report
+ endAt:
+ type: integer
+ description: Timestamp in the video that marks the ending of the report
+ required:
+ - reason
responses:
'204':
- $ref: '#/paths/~1users~1me/put/responses/204'
- '/videos/{id}/blacklist':
- post:
- summary: Put on blacklist a video by its id
+ description: successful operation
+ '/videos/{id}/abuse/{abuseId}':
+ put:
+ summary: Update an abuse
security:
- OAuth2:
- - admin
- - moderator
+ - admin
+ - moderator
tags:
- - Video Blacklist
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
+ - Video Abuses
responses:
'204':
- $ref: '#/paths/~1users~1me/put/responses/204'
- delete:
- summary: Delete an entry of the blacklist of a video by its id
- security:
- - OAuth2:
+ description: successful operation
+ '404':
+ description: video abuse not found
+ parameters:
+ - $ref: '#/components/parameters/idOrUUID'
+ - $ref: '#/components/parameters/abuseId'
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ state:
+ $ref: '#/components/schemas/VideoAbuseStateSet'
+ moderationComment:
+ type: string
+ description: 'Update the comment of the video abuse for other admin/moderators'
+ delete:
+ summary: Delete an abuse
+ security:
+ - OAuth2:
+ - admin
+ - moderator
+ tags:
+ - Video Abuses
+ responses:
+ '204':
+ description: successful operation
+ '404':
+ description: block not found
+ parameters:
+ - $ref: '#/components/parameters/idOrUUID'
+ - $ref: '#/components/parameters/abuseId'
+
+ '/videos/{id}/blacklist':
+ post:
+ summary: Block a video
+ security:
+ - OAuth2:
- admin
- moderator
tags:
- - Video Blacklist
+ - Video Blocks
parameters:
- $ref: '#/components/parameters/idOrUUID'
responses:
'204':
- $ref: '#/paths/~1users~1me/put/responses/204'
+ description: successful operation
+ delete:
+ summary: Unblock a video by its id
+ security:
+ - OAuth2:
+ - admin
+ - moderator
+ tags:
+ - Video Blocks
+ parameters:
+ - $ref: '#/components/parameters/idOrUUID'
+ responses:
+ '204':
+ description: successful operation
+ '404':
+ description: block not found
/videos/blacklist:
get:
- summary: Get list of videos on blacklist
+ tags:
+ - Video Blocks
+ summary: List video blocks
security:
- OAuth2:
- admin
- moderator
- tags:
- - Video Blacklist
parameters:
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
$ref: '#/components/schemas/VideoBlacklist'
/videos/{id}/captions:
get:
- summary: Get list of video's captions
+ summary: List captions of a video
tags:
- Video Caption
parameters:
contentType: text/vtt, application/x-subrip, text/plain
responses:
'204':
- $ref: '#/paths/~1users~1me/put/responses/204'
+ description: successful operation
+ '404':
+ description: video or language not found
delete:
summary: Delete a video caption
tags:
- $ref: '#/components/parameters/captionLanguage'
responses:
'204':
- $ref: '#/paths/~1users~1me/put/responses/204'
+ description: successful operation
+ '404':
+ description: video or language or caption for that language not found
/video-channels:
get:
- summary: Get list of video channels
+ summary: List video channels
tags:
- - Video Channel
+ - Video Channels
parameters:
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
items:
$ref: '#/components/schemas/VideoChannel'
post:
- summary: Creates a video channel for the current user
+ summary: Create a video channel
security:
- OAuth2: []
tags:
- - Video Channel
+ - Video Channels
responses:
'204':
- $ref: '#/paths/~1users~1me/put/responses/204'
+ description: successful operation
requestBody:
content:
application/json:
$ref: '#/components/schemas/VideoChannelCreate'
'/video-channels/{channelHandle}':
get:
- summary: Get a video channel by its id
+ summary: Get a video channel
tags:
- - Video Channel
+ - Video Channels
parameters:
- $ref: '#/components/parameters/channelHandle'
responses:
schema:
$ref: '#/components/schemas/VideoChannel'
put:
- summary: Update a video channel by its id
+ summary: Update a video channel
security:
- OAuth2: []
tags:
- - Video Channel
+ - Video Channels
parameters:
- $ref: '#/components/parameters/channelHandle'
responses:
'204':
- $ref: '#/paths/~1users~1me/put/responses/204'
+ description: successful operation
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VideoChannelUpdate'
delete:
- summary: Delete a video channel by its id
+ summary: Delete a video channel
security:
- OAuth2: []
tags:
- - Video Channel
+ - Video Channels
parameters:
- $ref: '#/components/parameters/channelHandle'
responses:
'204':
- $ref: '#/paths/~1users~1me/put/responses/204'
+ description: successful operation
'/video-channels/{channelHandle}/videos':
get:
- summary: Get videos of a video channel by its id
+ summary: List videos of a video channel
tags:
- Video
- - Video Channel
+ - Video Channels
parameters:
- $ref: '#/components/parameters/channelHandle'
+ - $ref: '#/components/parameters/categoryOneOf'
+ - $ref: '#/components/parameters/tagsOneOf'
+ - $ref: '#/components/parameters/tagsAllOf'
+ - $ref: '#/components/parameters/licenceOneOf'
+ - $ref: '#/components/parameters/languageOneOf'
+ - $ref: '#/components/parameters/nsfw'
+ - $ref: '#/components/parameters/filter'
+ - $ref: '#/components/parameters/skipCount'
+ - $ref: '#/components/parameters/start'
+ - $ref: '#/components/parameters/count'
+ - $ref: '#/components/parameters/videosSort'
responses:
'200':
description: successful operation
application/json:
schema:
$ref: '#/components/schemas/VideoListResponse'
+
+ /video-playlists/privacies:
+ get:
+ summary: List available playlist privacies
+ tags:
+ - Video Playlists
+ responses:
+ '200':
+ description: successful operation
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ type: string
+
/video-playlists:
get:
- summary: Get list of video playlists
+ summary: List video playlists
tags:
- - Video Playlist
+ - Video Playlists
parameters:
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
type: array
items:
$ref: '#/components/schemas/VideoPlaylist'
+ post:
+ summary: Create a video playlist
+ description: 'If the video playlist is set as public, the videoChannelId is mandatory.'
+ security:
+ - OAuth2: []
+ tags:
+ - Video Playlists
+ responses:
+ '200':
+ description: successful operation
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ videoPlaylist:
+ type: object
+ properties:
+ id:
+ type: integer
+ uuid:
+ type: string
+ requestBody:
+ content:
+ multipart/form-data:
+ schema:
+ type: object
+ properties:
+ displayName:
+ description: Video playlist display name
+ type: string
+ thumbnailfile:
+ description: Video playlist thumbnail file
+ type: string
+ format: binary
+ privacy:
+ $ref: '#/components/schemas/VideoPlaylistPrivacySet'
+ description:
+ description: Video playlist description
+ type: string
+ videoChannelId:
+ description: Video channel in which the playlist will be published
+ type: integer
+ required:
+ - displayName
+
+ /video-playlists/{id}:
+ get:
+ summary: Get a video playlist
+ tags:
+ - Video Playlists
+ parameters:
+ - $ref: '#/components/parameters/idOrUUID'
+ responses:
+ '200':
+ description: successful operation
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/VideoPlaylist'
+ put:
+ summary: Update a video playlist
+ description: 'If the video playlist is set as public, the playlist must have a assigned channel.'
+ security:
+ - OAuth2: []
+ tags:
+ - Video Playlists
+ responses:
+ '204':
+ description: successful operation
+ parameters:
+ - $ref: '#/components/parameters/idOrUUID'
+ requestBody:
+ content:
+ multipart/form-data:
+ schema:
+ type: object
+ properties:
+ displayName:
+ description: Video playlist display name
+ type: string
+ thumbnailfile:
+ description: Video playlist thumbnail file
+ type: string
+ format: binary
+ privacy:
+ $ref: '#/components/schemas/VideoPlaylistPrivacySet'
+ description:
+ description: Video playlist description
+ type: string
+ videoChannelId:
+ description: Video channel in which the playlist will be published
+ type: integer
+ delete:
+ summary: Delete a video playlist
+ security:
+ - OAuth2: []
+ tags:
+ - Video Playlists
+ parameters:
+ - $ref: '#/components/parameters/idOrUUID'
+ responses:
+ '204':
+ description: successful operation
+
+ /video-playlists/{id}/videos:
+ get:
+ summary: 'List videos of a playlist'
+ tags:
+ - Videos
+ - Video Playlists
+ parameters:
+ - $ref: '#/components/parameters/idOrUUID'
+ responses:
+ '200':
+ description: successful operation
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/VideoListResponse'
+ post:
+ summary: 'Add a video in a playlist'
+ security:
+ - OAuth2: []
+ tags:
+ - Videos
+ - Video Playlists
+ parameters:
+ - $ref: '#/components/parameters/idOrUUID'
+ responses:
+ '200':
+ description: successful operation
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ videoPlaylistElement:
+ type: object
+ properties:
+ id:
+ type: integer
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ videoId:
+ type: integer
+ description: 'Video to add in the playlist'
+ startTimestamp:
+ type: integer
+ description: 'Start the video at this specific timestamp (in seconds)'
+ stopTimestamp:
+ type: integer
+ description: 'Stop the video at this specific timestamp (in seconds)'
+ required:
+ - videoId
+
+ /video-playlists/{id}/videos/reorder:
+ post:
+ summary: 'Reorder a playlist'
+ security:
+ - OAuth2: []
+ tags:
+ - Video Playlists
+ parameters:
+ - $ref: '#/components/parameters/idOrUUID'
+ responses:
+ '204':
+ description: successful operation
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ startPosition:
+ type: integer
+ description: 'Start position of the element to reorder'
+ minimum: 1
+ insertAfterPosition:
+ type: integer
+ description: 'New position for the block to reorder, to add the block before the first element'
+ minimum: 0
+ reorderLength:
+ type: integer
+ description: 'How many element from `startPosition` to reorder'
+ minimum: 1
+ required:
+ - startPosition
+ - insertAfterPosition
+
+ /video-playlists/{id}/videos/{playlistElementId}:
+ put:
+ summary: 'Update a playlist element'
+ security:
+ - OAuth2: []
+ tags:
+ - Video Playlists
+ parameters:
+ - $ref: '#/components/parameters/idOrUUID'
+ - $ref: '#/components/parameters/playlistElementId'
+ responses:
+ '204':
+ description: successful operation
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ startTimestamp:
+ type: integer
+ description: 'Start the video at this specific timestamp (in seconds)'
+ stopTimestamp:
+ type: integer
+ description: 'Stop the video at this specific timestamp (in seconds)'
+ delete:
+ summary: 'Delete an element from a playlist'
+ security:
+ - OAuth2: []
+ tags:
+ - Video Playlists
+ parameters:
+ - $ref: '#/components/parameters/idOrUUID'
+ - $ref: '#/components/parameters/playlistElementId'
+ responses:
+ '204':
+ description: successful operation
+
+ '/users/me/video-playlists/videos-exist':
+ get:
+ summary: 'Check video exists in my playlists'
+ security:
+ - OAuth2: []
+ tags:
+ - Video Playlists
+ parameters:
+ - name: videoIds
+ in: query
+ required: true
+ description: The video ids to check
+ schema:
+ type: array
+ items:
+ type: integer
+ responses:
+ '200':
+ description: successful operation
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ videoId:
+ type: array
+ items:
+ type: object
+ properties:
+ playlistElementId:
+ type: integer
+ playlistId:
+ type: integer
+ startTimestamp:
+ type: integer
+ stopTimestamp:
+ type: integer
+
'/accounts/{name}/video-channels':
get:
- summary: Get video channels of an account by its name
+ summary: List video channels of an account
tags:
- - Video Channel
+ - Video Channels
+ - Accounts
parameters:
- $ref: '#/components/parameters/name'
responses:
$ref: '#/components/schemas/VideoChannel'
'/accounts/{name}/ratings':
get:
- summary: Get ratings of an account by its name
- security:
- - OAuth2: []
+ summary: List ratings of an account
+ security:
+ - OAuth2: []
+ tags:
+ - Accounts
+ parameters:
+ - $ref: '#/components/parameters/name'
+ - $ref: '#/components/parameters/start'
+ - $ref: '#/components/parameters/count'
+ - $ref: '#/components/parameters/sort'
+ - name: rating
+ in: query
+ required: false
+ description: Optionally filter which ratings to retrieve
+ schema:
+ type: string
+ enum:
+ - like
+ - dislike
+ responses:
+ '200':
+ description: successful operation
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/VideoRating'
+ '/videos/{id}/comment-threads':
+ get:
+ summary: List threads of a video
+ tags:
+ - Video Comments
+ parameters:
+ - $ref: '#/components/parameters/idOrUUID'
+ - $ref: '#/components/parameters/start'
+ - $ref: '#/components/parameters/count'
+ - $ref: '#/components/parameters/commentsSort'
+ responses:
+ '200':
+ description: successful operation
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CommentThreadResponse'
+ post:
+ summary: Create a thread
+ security:
+ - OAuth2: []
+ tags:
+ - Video Comments
+ parameters:
+ - $ref: '#/components/parameters/idOrUUID'
+ responses:
+ '200':
+ description: successful operation
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CommentThreadPostResponse'
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ text:
+ type: string
+ description: 'Text comment'
+ required:
+ - text
+
+ '/videos/{id}/comment-threads/{threadId}':
+ get:
+ summary: Get a thread
+ tags:
+ - Video Comments
+ parameters:
+ - $ref: '#/components/parameters/idOrUUID'
+ - $ref: '#/components/parameters/threadId'
+ responses:
+ '200':
+ description: successful operation
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/VideoCommentThreadTree'
+ '/videos/{id}/comments/{commentId}':
+ post:
+ summary: Reply to a thread of a video
+ security:
+ - OAuth2: []
+ tags:
+ - Video Comments
+ parameters:
+ - $ref: '#/components/parameters/idOrUUID'
+ - $ref: '#/components/parameters/commentId'
+ responses:
+ '200':
+ description: successful operation
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CommentThreadPostResponse'
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ text:
+ type: string
+ description: 'Text comment'
+ required:
+ - text
+
+ delete:
+ summary: Delete a comment or a reply
+ security:
+ - OAuth2: []
+ tags:
+ - Video Comments
+ parameters:
+ - $ref: '#/components/parameters/idOrUUID'
+ - $ref: '#/components/parameters/commentId'
+ responses:
+ '204':
+ description: successful operation
+ '/videos/{id}/rate':
+ put:
+ summary: Like/dislike a video
+ security:
+ - OAuth2: []
+ tags:
+ - Video Rates
+ parameters:
+ - $ref: '#/components/parameters/idOrUUID'
+ responses:
+ '204':
+ description: successful operation
+ /search/videos:
+ get:
+ tags:
+ - Search
+ summary: Search videos
+ parameters:
+ - $ref: '#/components/parameters/categoryOneOf'
+ - $ref: '#/components/parameters/tagsOneOf'
+ - $ref: '#/components/parameters/tagsAllOf'
+ - $ref: '#/components/parameters/licenceOneOf'
+ - $ref: '#/components/parameters/languageOneOf'
+ - $ref: '#/components/parameters/nsfw'
+ - $ref: '#/components/parameters/filter'
+ - $ref: '#/components/parameters/skipCount'
+ - $ref: '#/components/parameters/start'
+ - $ref: '#/components/parameters/count'
+ - $ref: '#/components/parameters/searchTarget'
+ - $ref: '#/components/parameters/videosSearchSort'
+ - name: search
+ in: query
+ required: true
+ description: >
+ String to search. If the user can make a remote URI search, and the string is an URI then the
+ PeerTube instance will fetch the remote object and add it to its database. Then,
+ you can use the REST API to fetch the complete video information and interact with it.
+ schema:
+ type: string
+ - name: startDate
+ in: query
+ required: true
+ description: Get videos that are published after this date
+ schema:
+ type: string
+ format: date-time
+ - name: endDate
+ in: query
+ required: true
+ description: Get videos that are published before this date
+ schema:
+ type: string
+ format: date-time
+ - name: originallyPublishedStartDate
+ in: query
+ required: true
+ description: Get videos that are originally published after this date
+ schema:
+ type: string
+ format: date-time
+ - name: originallyPublishedEndDate
+ in: query
+ required: true
+ description: Get videos that are originally published before this date
+ schema:
+ type: string
+ format: date-time
+ - name: durationMin
+ in: query
+ required: true
+ description: Get videos that have this minimum duration
+ schema:
+ type: integer
+ - name: durationMax
+ in: query
+ required: true
+ description: Get videos that have this maximum duration
+ schema:
+ type: integer
+ responses:
+ '200':
+ description: successful operation
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/VideoListResponse'
+ /search/video-channels:
+ get:
tags:
- - User
+ - Search
+ summary: Search channels
parameters:
- - $ref: '#/components/parameters/name'
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
+ - $ref: '#/components/parameters/searchTarget'
- $ref: '#/components/parameters/sort'
- - name: rating
+ - name: search
in: query
- required: false
- description: Optionally filter which ratings to retrieve
+ required: true
+ description: >
+ String to search. If the user can make a remote URI search, and the string is an URI then the
+ PeerTube instance will fetch the remote object and add it to its database. Then,
+ you can use the REST API to fetch the complete channel information and interact with it.
schema:
type: string
- enum:
- - like
- - dislike
responses:
'200':
description: successful operation
schema:
type: array
items:
- $ref: '#/components/schemas/VideoRating'
- '/videos/{id}/comment-threads':
+ $ref: '#/components/schemas/VideoChannel'
+ /blocklist/accounts:
get:
- summary: Get the comment threads of a video by its id
tags:
- - Video Comment
+ - Account Blocks
+ summary: List account blocks
+ security:
+ - OAuth2:
+ - admin
parameters:
- - $ref: '#/components/parameters/idOrUUID'
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
- - $ref: '#/components/parameters/commentsSort'
+ - $ref: '#/components/parameters/sort'
responses:
'200':
description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CommentThreadResponse'
post:
- summary: 'Creates a comment thread, on a video by its id'
+ tags:
+ - Account Blocks
+ summary: Block an account
security:
- - OAuth2: []
+ - OAuth2:
+ - admin
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ accountName:
+ type: string
+ description: account to block, in the form `username@domain`
+ required:
+ - accountName
+ responses:
+ '200':
+ description: successful operation
+ '409':
+ description: self-blocking forbidden
+ '/blocklist/accounts/{accountName}':
+ delete:
tags:
- - Video Comment
+ - Account Blocks
+ summary: Unblock an account by its handle
+ security:
+ - OAuth2:
+ - admin
parameters:
- - $ref: '#/components/parameters/idOrUUID'
+ - name: accountName
+ in: path
+ required: true
+ description: account to unblock, in the form `username@domain`
+ schema:
+ type: string
responses:
- '200':
+ '201':
description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CommentThreadPostResponse'
- '/videos/{id}/comment-threads/{threadId}':
+ '404':
+ description: account or account block does not exist
+ /blocklist/servers:
get:
- summary: 'Get the comment thread by its id, of a video by its id'
tags:
- - Video Comment
+ - Server Blocks
+ summary: List server blocks
+ security:
+ - OAuth2:
+ - admin
parameters:
- - $ref: '#/components/parameters/idOrUUID'
- - $ref: '#/components/parameters/threadId'
+ - $ref: '#/components/parameters/start'
+ - $ref: '#/components/parameters/count'
+ - $ref: '#/components/parameters/sort'
responses:
'200':
description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/VideoCommentThreadTree'
- '/videos/{id}/comments/{commentId}':
post:
- summary: 'Creates a comment in a comment thread by its id, of a video by its id'
- security:
- - OAuth2: []
tags:
- - Video Comment
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- - $ref: '#/components/parameters/commentId'
+ - Server Blocks
+ summary: Block a server
+ security:
+ - OAuth2:
+ - admin
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ accountName:
+ type: string
+ description: server domain to block
+ required:
+ - accountName
responses:
'200':
description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CommentThreadPostResponse'
+ '409':
+ description: self-blocking forbidden
+ '/blocklist/servers/{host}':
delete:
- summary: 'Delete a comment in a comment thread by its id, of a video by its id'
- security:
- - OAuth2: []
tags:
- - Video Comment
+ - Server Blocks
+ summary: Unblock a server by its domain
+ security:
+ - OAuth2:
+ - admin
parameters:
- - $ref: '#/components/parameters/idOrUUID'
- - $ref: '#/components/parameters/commentId'
+ - name: host
+ in: path
+ required: true
+ description: server domain to unblock
+ schema:
+ type: string
responses:
- '204':
- $ref: '#/paths/~1users~1me/put/responses/204'
- '/videos/{id}/rate':
- put:
- summary: Vote for a video by its id
- security:
- - OAuth2: []
+ '201':
+ description: successful operation
+ '404':
+ description: account block does not exist
+ '/feeds/video-comments.{format}':
+ get:
tags:
- - Video Rate
+ - Feeds
+ summary: List comments on videos
+ servers:
+ - url: 'https://peertube2.cpy.re'
+ description: Live Test Server (live data - latest nightly version)
+ - url: 'https://peertube3.cpy.re'
+ description: Live Test Server (live data - latest RC version)
+ - url: 'https://peertube.cpy.re'
+ description: Live Test Server (live data - stable version)
parameters:
- - $ref: '#/components/parameters/idOrUUID'
+ - name: format
+ in: path
+ required: true
+ description: 'format expected (we focus on making `rss` the most featureful ; it serves Media RSS)'
+ schema:
+ type: string
+ enum:
+ - xml
+ - rss
+ - rss2
+ - atom
+ - atom1
+ - json
+ - json1
+ - name: videoId
+ in: query
+ description: 'limit listing to a specific video'
+ schema:
+ type: string
responses:
'204':
- $ref: '#/paths/~1users~1me/put/responses/204'
- /search/videos:
+ description: successful operation
+ headers:
+ Cache-Control:
+ schema:
+ type: string
+ default: 'max-age=900' # 15 min cache
+ content:
+ application/xml:
+ schema:
+ $ref: '#/components/schemas/VideoCommentsForXML'
+ application/rss+xml:
+ schema:
+ $ref: '#/components/schemas/VideoCommentsForXML'
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/VideoCommentsForXML'
+ application/atom+xml:
+ schema:
+ $ref: '#/components/schemas/VideoCommentsForXML'
+ application/json:
+ schema:
+ type: object
+ '406':
+ description: accept header unsupported
+ '/feeds/videos.{format}':
get:
tags:
- - Search
- summary: Get the videos corresponding to a given query
+ - Feeds
+ summary: List videos
+ servers:
+ - url: 'https://peertube2.cpy.re'
+ description: Live Test Server (live data - latest nightly version)
+ - url: 'https://peertube3.cpy.re'
+ description: Live Test Server (live data - latest RC version)
+ - url: 'https://peertube.cpy.re'
+ description: Live Test Server (live data - stable version)
parameters:
- - $ref: '#/components/parameters/start'
- - $ref: '#/components/parameters/count'
- - $ref: '#/components/parameters/videosSearchSort'
- - name: search
- in: query
+ - name: format
+ in: path
required: true
- description: String to search
+ description: 'format expected (we focus on making `rss` the most featureful ; it serves Media RSS)'
+ schema:
+ type: string
+ enum:
+ - xml
+ - rss
+ - rss2
+ - atom
+ - atom1
+ - json
+ - json1
+ - name: accountId
+ in: query
+ description: 'limit listing to a specific account'
+ schema:
+ type: string
+ - name: accountName
+ in: query
+ description: 'limit listing to a specific account'
+ schema:
+ type: string
+ - name: videoChannelId
+ in: query
+ description: 'limit listing to a specific video channel'
+ schema:
+ type: string
+ - name: videoChannelName
+ in: query
+ description: 'limit listing to a specific video channel'
schema:
type: string
responses:
- '200':
+ '204':
description: successful operation
+ headers:
+ Cache-Control:
+ schema:
+ type: string
+ default: 'max-age=900' # 15 min cache
content:
+ application/xml:
+ schema:
+ $ref: '#/components/schemas/VideosForXML'
+ application/rss+xml:
+ schema:
+ $ref: '#/components/schemas/VideosForXML'
+ text/xml:
+ schema:
+ $ref: '#/components/schemas/VideosForXML'
+ application/atom+xml:
+ schema:
+ $ref: '#/components/schemas/VideosForXML'
application/json:
schema:
- $ref: '#/components/schemas/VideoListResponse'
+ type: object
+ '406':
+ description: accept header unsupported
servers:
- - url: 'https://peertube.cpy.re/api/v1'
- description: Live Test Server (live data - stable version)
- url: 'https://peertube2.cpy.re/api/v1'
- description: Live Test Server (live data - bleeding edge version)
+ description: Live Test Server (live data - latest nightly version)
- url: 'https://peertube3.cpy.re/api/v1'
- description: Live Test Server (live data - bleeding edge version)
+ description: Live Test Server (live data - latest RC version)
+ - url: 'https://peertube.cpy.re/api/v1'
+ description: Live Test Server (live data - stable version)
components:
parameters:
start:
name: start
in: query
required: false
- description: Offset
+ description: Offset used to paginate results
schema:
- type: number
+ type: integer
count:
name: count
in: query
required: false
- description: Number of items
+ description: "Number of items to return"
schema:
- type: number
+ type: integer
+ maximum: 100
+ minimum: 1
sort:
name: sort
in: query
required: false
- description: Sort column (-createdAt for example)
+ description: Sort column (`-createdAt` for example)
schema:
type: string
+ searchTarget:
+ name: searchTarget
+ in: query
+ required: false
+ description: >
+ If the administrator enabled search index support, you can override the default search target.
+
+
+ **Warning**: If you choose to make an index search, PeerTube will get results from a third party service.
+ It means the instance may not know the objects you fetched. If you want to load video/channel information:
+ * If the current user has the ability to make a remote URI search (this information is available in the config endpoint),
+ then reuse the search API to make a search using the object URI so PeerTube instance fetches the remote object and fill its database.
+ After that, you can use the classic REST API endpoints to fetch the complete object or interact with it
+ * If the current user has not the ability to make a remote URI search, then redirect the user on the origin instance or fetch
+ the data from the origin instance API
+ schema:
+ type: string
+ enum:
+ - 'local'
+ - 'search-index'
videosSort:
name: sort
in: query
in: path
required: true
description: >-
- The name of the account (chocobozzz or chocobozzz@peertube.cpy.re for
+ The name of the account (`chocobozzz` or `chocobozzz@example.org` for
example)
schema:
type: string
required: true
description: The user id
schema:
- type: number
+ type: integer
idOrUUID:
name: id
in: path
required: true
- description: The video id or uuid
+ description: The object id or uuid
schema:
type: string
+ playlistElementId:
+ name: playlistElementId
+ in: path
+ required: true
+ description: Playlist element id
+ schema:
+ type: integer
+ abuseId:
+ name: abuseId
+ in: path
+ required: true
+ description: Video abuse id
+ schema:
+ type: integer
captionLanguage:
name: captionLanguage
in: path
required: true
description: The thread id (root comment id)
schema:
- type: number
+ type: integer
commentId:
name: commentId
in: path
required: true
description: The comment id
schema:
- type: number
+ type: integer
categoryOneOf:
name: categoryOneOf
in: query
required: false
- description: category id of the video
+ description: category id of the video (see /videos/categories)
schema:
oneOf:
- - type: number
+ - type: integer
- type: array
items:
- type: number
+ type: integer
style: form
explode: false
tagsOneOf:
name: languageOneOf
in: query
required: false
- description: language id of the video
+ description: language id of the video (see /videos/languages). Use `_unknown` to filter on videos that don't have a video language
schema:
oneOf:
- type: string
name: licenceOneOf
in: query
required: false
- description: licence id of the video
+ description: licence id of the video (see /videos/licences)
schema:
oneOf:
- - type: number
+ - type: integer
- type: array
items:
- type: number
+ type: integer
style: form
explode: false
+ skipCount:
+ name: skipCount
+ in: query
+ required: false
+ description: if you don't need the `total` in the response
+ schema:
+ type: string
+ enum:
+ - 'true'
+ - 'false'
+ default: 'false'
nsfw:
name: nsfw
in: query
VideoConstantNumber:
properties:
id:
- type: number
+ type: integer
label:
type: string
VideoConstantString:
type: string
label:
type: string
+
+ VideoPlaylistPrivacySet:
+ type: integer
+ enum:
+ - 1
+ - 2
+ - 3
+ description: 'The video playlist privacy (Public = `1`, Unlisted = `2`, Private = `3`)'
+ VideoPlaylistPrivacyConstant:
+ properties:
+ id:
+ $ref: '#/components/schemas/VideoPlaylistPrivacySet'
+ label:
+ type: string
+
+ VideoPlaylistTypeSet:
+ type: integer
+ enum:
+ - 1
+ - 2
+ description: 'The video playlist type (Regular = `1`, Watch Later = `2`)'
+ VideoPlaylistTypeConstant:
+ properties:
+ id:
+ $ref: '#/components/schemas/VideoPlaylistTypeSet'
+ label:
+ type: string
+
VideoPrivacySet:
type: integer
enum:
- 1
- 2
- 3
- description: 'The video privacy (Public = 1, Unlisted = 2, Private = 3)'
+ - 4
+ description: 'The video privacy (Public = `1`, Unlisted = `2`, Private = `3`, Internal = `4`)'
VideoPrivacyConstant:
properties:
id:
- type: integer
- enum:
- - 1
- - 2
- - 3
+ $ref: '#/components/schemas/VideoPrivacySet'
label:
type: string
+
+ NSFWPolicy:
+ type: string
+ enum:
+ - display
+ - blur
+ - do_not_list
+
+ UserRole:
+ type: integer
+ enum:
+ - 0
+ - 1
+ - 2
+ description: 'The user role (Admin = `0`, Moderator = `1`, User = `2`)'
+
VideoStateConstant:
properties:
id:
- 1
- 2
- 3
- description: 'The video state (Published = 1, to transcode = 2, to import = 3)'
+ description: 'The video state (Published = `1`, to transcode = `2`, to import = `3`)'
+ label:
+ type: string
+
+ VideoAbuseStateSet:
+ type: integer
+ enum:
+ - 1
+ - 2
+ - 3
+ description: 'The video playlist privacy (Pending = `1`, Rejected = `2`, Accepted = `3`)'
+ VideoAbuseStateConstant:
+ properties:
+ id:
+ $ref: '#/components/schemas/VideoAbuseStateSet'
label:
type: string
+ VideoAbusePredefinedReasons:
+ type: array
+ items:
+ type: string
+ enum:
+ - violentOrAbusive
+ - hatefulOrAbusive
+ - spamOrMisleading
+ - privacy
+ - rights
+ - serverRules
+ - thumbnails
+ - captions
+
VideoResolutionConstant:
properties:
id:
properties:
privacy:
$ref: '#/components/schemas/VideoPrivacySet'
- description: Video privacy target
updateAt:
type: string
format: date
description: When to update the video
required:
- updateAt
- VideoAccountSummary:
+ AccountSummary:
properties:
id:
- type: number
+ type: integer
name:
type: string
displayName:
type: string
avatar:
nullable: true
- $ref: '#/components/schemas/Avatar'
+ allOf:
+ - $ref: '#/components/schemas/Avatar'
VideoChannelSummary:
properties:
id:
- type: number
+ type: integer
name:
type: string
displayName:
type: string
avatar:
nullable: true
- $ref: '#/components/schemas/Avatar'
+ allOf:
+ - $ref: '#/components/schemas/Avatar'
PlaylistElement:
properties:
position:
- type: number
+ type: integer
startTimestamp:
- type: number
+ type: integer
stopTimestamp:
- type: number
+ type: integer
video:
nullable: true
- $ref: '#/components/schemas/Video'
+ allOf:
+ - $ref: '#/components/schemas/Video'
VideoFile:
properties:
magnetUri:
resolution:
$ref: '#/components/schemas/VideoResolutionConstant'
size:
- type: number
+ type: integer
description: 'Video file size in bytes'
torrentUrl:
type: string
type: string
fps:
type: number
+ metadataUrl:
+ type: string
VideoStreamingPlaylists:
properties:
id:
- type: number
+ type: integer
type:
- type: number
+ type: integer
enum:
- 1
- description: 'Playlist type (HLS = 1)'
+ description: 'Playlist type (HLS = `1`)'
playlistUrl:
type: string
segmentsSha256Url:
type: string
+ files:
+ type: array
+ items:
+ $ref: '#/components/schemas/VideoFile'
redundancies:
type: array
items:
properties:
baseUrl:
type: string
+ VideoInfo:
+ properties:
+ id:
+ type: integer
+ uuid:
+ type: string
+ name:
+ type: string
Video:
properties:
id:
- type: number
+ type: integer
uuid:
type: string
createdAt:
description:
type: string
duration:
- type: number
+ type: integer
isLocal:
type: boolean
name:
embedPath:
type: string
views:
- type: number
+ type: integer
likes:
- type: number
+ type: integer
dislikes:
- type: number
+ type: integer
nsfw:
type: boolean
waitTranscoding:
$ref: '#/components/schemas/VideoStateConstant'
scheduledUpdate:
nullable: true
- $ref: '#/components/schemas/VideoScheduledUpdate'
+ allOf:
+ - $ref: '#/components/schemas/VideoScheduledUpdate'
blacklisted:
nullable: true
type: boolean
nullable: true
type: string
account:
- $ref: '#/components/schemas/VideoAccountSummary'
+ $ref: '#/components/schemas/AccountSummary'
channel:
$ref: '#/components/schemas/VideoChannelSummary'
userHistory:
type: object
properties:
currentTime:
- type: number
+ type: integer
VideoDetails:
allOf:
- $ref: '#/components/schemas/Video'
- 1
- 2
- 3
- description: 'The video import state (Pending = 1, Success = 2, Failed = 3)'
+ description: 'The video import state (Pending = `1`, Success = `2`, Failed = `3`)'
label:
type: string
VideoImport:
properties:
id:
- type: number
+ type: integer
targetUrl:
type: string
magnetUri:
VideoAbuse:
properties:
id:
- type: number
+ type: integer
reason:
type: string
+ predefinedReasons:
+ $ref: '#/components/schemas/VideoAbusePredefinedReasons'
reporterAccount:
$ref: '#/components/schemas/Account'
+ state:
+ $ref: '#/components/schemas/VideoAbuseStateConstant'
+ moderationComment:
+ type: string
video:
type: object
properties:
id:
- type: number
+ type: integer
name:
type: string
uuid:
type: string
- url:
- type: string
createdAt:
type: string
VideoBlacklist:
properties:
id:
- type: number
+ type: integer
videoId:
- type: number
+ type: integer
createdAt:
type: string
updatedAt:
description:
type: string
duration:
- type: number
+ type: integer
views:
- type: number
+ type: integer
likes:
- type: number
+ type: integer
dislikes:
- type: number
+ type: integer
nsfw:
type: boolean
VideoChannel:
type: object
properties:
id:
- type: number
+ type: integer
uuid:
type: string
VideoPlaylist:
properties:
id:
- type: number
+ type: integer
createdAt:
type: string
updatedAt:
isLocal:
type: boolean
videoLength:
- type: number
+ type: integer
thumbnailPath:
type: string
privacy:
- type: object
- properties:
- id:
- type: number
- label:
- type: string
+ $ref: '#/components/schemas/VideoPlaylistPrivacyConstant'
type:
- type: object
- properties:
- id:
- type: number
- label:
- type: string
+ $ref: '#/components/schemas/VideoPlaylistTypeConstant'
ownerAccount:
- type: object
- properties:
- id:
- type: number
- name:
- type: string
- displayName:
- type: string
- url:
- type: string
- host:
- type: string
+ $ref: '#/components/schemas/AccountSummary'
+ videoChannel:
+ $ref: '#/components/schemas/VideoChannelSummary'
VideoComment:
properties:
id:
- type: number
+ type: integer
url:
type: string
text:
type: string
threadId:
- type: number
+ type: integer
inReplyToCommentId:
- type: number
+ type: integer
videoId:
- type: number
+ type: integer
createdAt:
type: string
updatedAt:
type: string
totalRepliesFromVideoAuthor:
- type: number
+ type: integer
totalReplies:
- type: number
+ type: integer
account:
$ref: '#/components/schemas/Account'
VideoCommentThreadTree:
type: string
updatedAt:
type: string
+ ActorInfo:
+ properties:
+ id:
+ type: integer
+ name:
+ type: string
+ displayName:
+ type: string
+ host:
+ type: string
+ avatar:
+ nullable: true
+ type: object
+ properties:
+ path:
+ type: string
Actor:
properties:
id:
- type: number
+ type: integer
url:
type: string
name:
host:
type: string
followingCount:
- type: number
+ type: integer
followersCount:
- type: number
+ type: integer
createdAt:
type: string
updatedAt:
User:
properties:
id:
- type: number
+ type: integer
username:
type: string
email:
type: string
- displayNSFW:
+ theme:
+ type: string
+ description: 'Theme enabled by this user'
+ emailVerified:
+ type: boolean
+ description: 'Has the user confirmed their email address?'
+ nsfwPolicy:
+ $ref: '#/components/schemas/NSFWPolicy'
+ webtorrentEnabled:
type: boolean
autoPlayVideo:
type: boolean
+ description: 'Automatically start playing the video on the watch page'
role:
- type: integer
- enum:
- - 0
- - 1
- - 2
- description: 'The user role (Admin = 0, Moderator = 1, User = 2)'
+ $ref: '#/components/schemas/UserRole'
roleLabel:
type: string
enum:
- Moderator
- Administrator
videoQuota:
- type: number
+ type: integer
videoQuotaDaily:
- type: number
+ type: integer
+ videosCount:
+ type: integer
+ videoAbusesCount:
+ type: integer
+ videoAbusesAcceptedCount:
+ type: integer
+ videoAbusesCreatedCount:
+ type: integer
+ videoCommentsCount:
+ type: integer
+ noInstanceConfigWarningModal:
+ type: boolean
+ noWelcomeModal:
+ type: boolean
+ blocked:
+ type: boolean
+ blockedReason:
+ type: string
createdAt:
type: string
account:
UserWatchingVideo:
properties:
currentTime:
- type: number
+ type: integer
ServerConfig:
properties:
instance:
type: string
css:
type: string
+ search:
+ type: object
+ properties:
+ remoteUri:
+ type: object
+ properties:
+ users:
+ type: boolean
+ anonymous:
+ type: boolean
plugin:
type: object
properties:
properties:
enabled:
type: boolean
+ webtorrent:
+ type: object
+ properties:
+ enabled:
+ type: boolean
enabledResolutions:
type: array
items:
- type: number
+ type: integer
import:
type: object
properties:
type: object
properties:
max:
- type: number
+ type: integer
extensions:
type: array
items:
type: object
properties:
max:
- type: number
+ type: integer
file:
type: object
properties:
type: object
properties:
max:
- type: number
+ type: integer
extensions:
type: array
items:
type: object
properties:
videoQuota:
- type: number
+ type: integer
videoQuotaDaily:
- type: number
+ type: integer
trending:
type: object
properties:
type: object
properties:
intervalDays:
- type: number
+ type: integer
tracker:
type: object
properties:
enabled:
type: boolean
+ followings:
+ type: object
+ properties:
+ instance:
+ type: object
+ properties:
+ autoFollowIndex:
+ type: object
+ properties:
+ indexUrl:
+ type: string
ServerConfigAbout:
properties:
instance:
type: object
properties:
size:
- type: number
+ type: integer
captions:
type: object
properties:
size:
- type: number
+ type: integer
signup:
type: object
properties:
enabled:
type: boolean
limit:
- type: number
+ type: integer
requiresEmailVerification:
type: boolean
admin:
type: object
properties:
videoQuota:
- type: number
+ type: integer
videoQuotaDaily:
- type: number
+ type: integer
transcoding:
type: object
properties:
allowAudioFiles:
type: boolean
threads:
- type: number
+ type: integer
resolutions:
type: object
properties:
Follow:
properties:
id:
- type: number
+ type: integer
follower:
$ref: '#/components/schemas/Actor'
following:
Job:
properties:
id:
- type: number
+ type: integer
state:
type: string
enum:
AddUserResponse:
properties:
id:
- type: number
+ type: integer
uuid:
type: string
VideoUploadResponse:
type: object
properties:
id:
- type: number
+ type: integer
uuid:
type: string
CommentThreadResponse:
properties:
total:
- type: number
+ type: integer
data:
type: array
items:
VideoListResponse:
properties:
total:
- type: number
+ type: integer
data:
type: array
items:
properties:
username:
type: string
- description: 'The user username '
+ description: 'The user username'
+ minLength: 1
+ maxLength: 50
password:
type: string
- description: 'The user password '
+ description: 'The user password. If the smtp server is configured, you can leave empty and an email will be sent'
+ minLength: 6
+ maxLength: 255
email:
type: string
- description: 'The user email '
+ description: 'The user email. MUST be in the format of an email address.'
videoQuota:
type: string
- description: 'The user videoQuota '
+ description: 'The user video quota'
videoQuotaDaily:
type: string
- description: 'The user daily video quota '
+ description: 'The user daily video quota'
role:
- type: integer
- enum:
- - 0
- - 1
- - 2
- description: 'The user role (Admin = 0, Moderator = 1, User = 2)'
+ $ref: '#/components/schemas/UserRole'
required:
- username
- password
properties:
id:
type: string
- description: 'The user id '
+ description: 'The user id'
email:
type: string
- description: 'The updated email of the user '
+ description: 'The updated email of the user'
videoQuota:
type: string
- description: 'The updated videoQuota of the user '
+ description: 'The updated video quota of the user'
videoQuotaDaily:
type: string
- description: 'The updated daily video quota of the user '
+ description: 'The updated daily video quota of the user'
role:
- type: integer
- enum:
- - 0
- - 1
- - 2
- description: 'The user role (Admin = 0, Moderator = 1, User = 2)'
+ $ref: '#/components/schemas/UserRole'
required:
- id
- email
properties:
password:
type: string
- description: 'Your new password '
+ description: 'Your new password'
email:
type: string
- description: 'Your new email '
+ description: 'Your new email'
displayNSFW:
type: string
- description: 'Your new displayNSFW '
+ description: 'Your new displayNSFW'
autoPlayVideo:
type: string
- description: 'Your new autoPlayVideo '
+ description: 'Your new autoPlayVideo'
required:
- password
- email
properties:
id:
type: string
- description: 'Id of the video '
+ description: 'Id of the video'
rating:
type: number
- description: 'Rating of the video '
+ description: 'Rating of the video'
required:
- id
- rating
properties:
username:
type: string
- description: 'The username of the user '
+ description: 'The username of the user'
password:
type: string
- description: 'The password of the user '
+ description: 'The password of the user'
email:
type: string
- description: 'The email of the user '
+ description: 'The email of the user'
displayName:
type: string
description: 'The user display name'
properties:
name:
type: string
- description: 'The default channel name'
+ description: 'The name for the default channel'
displayName:
type: string
- description: 'The default channel display name'
+ description: 'The display name for the default channel'
required:
- username
type: string
support:
type: string
+ description: 'A text shown by default on all videos of this channel, to tell the audience how to support it'
required:
- name
- displayName
type: string
support:
type: string
+ description: 'A text shown by default on all videos of this channel, to tell the audience how to support it'
bulkVideosSupportUpdate:
type: boolean
- description: 'Update all videos support field of this channel'
+ description: 'Update the support field for all videos of this channel'
+ MRSSPeerLink:
+ type: object
+ xml:
+ name: 'media:peerLink'
+ properties:
+ href:
+ type: string
+ xml:
+ attribute: true
+ type:
+ type: string
+ enum:
+ - application/x-bittorrent
+ xml:
+ attribute: true
+ MRSSGroupContent:
+ type: object
+ xml:
+ name: 'media:content'
+ properties:
+ url:
+ type: string
+ xml:
+ attribute: true
+ fileSize:
+ type: integer
+ xml:
+ attribute: true
+ type:
+ type: string
+ xml:
+ attribute: true
+ framerate:
+ type: integer
+ xml:
+ attribute: true
+ duration:
+ type: integer
+ xml:
+ attribute: true
+ height:
+ type: integer
+ xml:
+ attribute: true
+ lang:
+ type: string
+ xml:
+ attribute: true
+ VideoCommentsForXML:
+ type: array
+ xml:
+ wrapped: true
+ name: 'channel'
+ items:
+ type: object
+ xml:
+ name: 'item'
+ properties:
+ link:
+ type: string
+ guid:
+ type: string
+ pubDate:
+ type: string
+ format: date-time
+ 'content:encoded':
+ type: string
+ 'dc:creator':
+ type: string
+ VideosForXML:
+ type: array
+ xml:
+ wrapped: true
+ name: 'channel'
+ items:
+ type: object
+ xml:
+ name: 'item'
+ properties:
+ link:
+ type: string
+ description: video watch page URL
+ guid:
+ type: string
+ description: video canonical URL
+ pubDate:
+ type: string
+ format: date-time
+ description: video publication date
+ description:
+ type: string
+ description: video description
+ 'content:encoded':
+ type: string
+ description: video description
+ 'dc:creator':
+ type: string
+ description: publisher user name
+ 'media:category':
+ type: integer
+ description: video category (MRSS)
+ 'media:community':
+ type: object
+ description: see [media:community](https://www.rssboard.org/media-rss#media-community) (MRSS)
+ properties:
+ 'media:statistics':
+ type: object
+ properties:
+ views:
+ type: integer
+ xml:
+ attribute: true
+ 'media:embed':
+ type: object
+ properties:
+ url:
+ type: string
+ description: video embed path, relative to the canonical URL domain (MRSS)
+ xml:
+ attribute: true
+ 'media:player':
+ type: object
+ properties:
+ url:
+ type: string
+ description: video watch path, relative to the canonical URL domain (MRSS)
+ xml:
+ attribute: true
+ 'media:thumbnail':
+ type: object
+ properties:
+ url:
+ type: string
+ xml:
+ attribute: true
+ height:
+ type: integer
+ xml:
+ attribute: true
+ width:
+ type: integer
+ xml:
+ attribute: true
+ 'media:title':
+ type: string
+ description: see [media:title](https://www.rssboard.org/media-rss#media-title) (MRSS). We only use `plain` titles.
+ 'media:description':
+ type: string
+ 'media:rating':
+ type: string
+ enum:
+ - nonadult
+ - adult
+ description: see [media:rating](https://www.rssboard.org/media-rss#media-rating) (MRSS)
+ 'enclosure':
+ type: object
+ description: main streamable file for the video
+ properties:
+ url:
+ type: string
+ xml:
+ attribute: true
+ type:
+ type: string
+ enum:
+ - application/x-bittorrent
+ xml:
+ attribute: true
+ length:
+ type: integer
+ xml:
+ attribute: true
+ 'media:group':
+ type: array
+ description: list of streamable files for the video. see [media:peerLink](https://www.rssboard.org/media-rss#media-peerlink) and [media:content](https://www.rssboard.org/media-rss#media-content) or (MRSS)
+ items:
+ anyOf:
+ - $ref: '#/components/schemas/MRSSPeerLink'
+ - $ref: '#/components/schemas/MRSSGroupContent'
+ NotificationSettingValue:
+ type: integer
+ description: >
+ Notification type
+ - `0` NONE
+ - `1` WEB
+ - `2` EMAIL
+ enum:
+ - 0
+ - 1
+ - 3
+ Notification:
+ properties:
+ id:
+ type: integer
+ type:
+ type: integer
+ description: >
+ Notification type, following the `UserNotificationType` enum:
+ - `1` NEW_VIDEO_FROM_SUBSCRIPTION
+ - `2` NEW_COMMENT_ON_MY_VIDEO
+ - `3` NEW_VIDEO_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` COMMENT_MENTION
+ - `12` VIDEO_AUTO_BLACKLIST_FOR_MODERATORS
+ - `13` NEW_INSTANCE_FOLLOWER
+ - `14` AUTO_INSTANCE_FOLLOWING
+ read:
+ type: boolean
+ video:
+ nullable: true
+ allOf:
+ - $ref: '#/components/schemas/VideoInfo'
+ - type: object
+ properties:
+ channel:
+ $ref: '#/components/schemas/ActorInfo'
+ videoImport:
+ nullable: true
+ type: object
+ properties:
+ id:
+ type: integer
+ video:
+ nullable: true
+ $ref: '#/components/schemas/VideoInfo'
+ torrentName:
+ type: string
+ nullable: true
+ magnetUri:
+ type: string
+ nullable: true
+ targetUri:
+ type: string
+ nullable: true
+ comment:
+ nullable: true
+ type: object
+ properties:
+ id:
+ type: integer
+ threadId:
+ type: integer
+ video:
+ $ref: '#/components/schemas/VideoInfo'
+ account:
+ $ref: '#/components/schemas/ActorInfo'
+ videoAbuse:
+ nullable: true
+ type: object
+ properties:
+ id:
+ type: integer
+ video:
+ allOf:
+ - $ref: '#/components/schemas/VideoInfo'
+ videoBlacklist:
+ nullable: true
+ type: object
+ properties:
+ id:
+ type: integer
+ video:
+ allOf:
+ - $ref: '#/components/schemas/VideoInfo'
+ account:
+ nullable: true
+ allOf:
+ - $ref: '#/components/schemas/ActorInfo'
+ actorFollow:
+ type: object
+ nullable: true
+ properties:
+ id:
+ type: integer
+ follower:
+ $ref: '#/components/schemas/ActorInfo'
+ state:
+ type: string
+ enum:
+ - pending
+ - accepted
+ following:
+ type: object
+ properties:
+ type:
+ type: string
+ enum:
+ - account
+ - channel
+ - instance
+ name:
+ type: string
+ displayName:
+ type: string
+ host:
+ type: string
+ createdAt:
+ type: string
+ format: date-time
+ updatedAt:
+ type: string
+ format: date-time
+ NotificationListResponse:
+ properties:
+ total:
+ type: integer
+ data:
+ type: array
+ items:
+ $ref: '#/components/schemas/Notification'
\ No newline at end of file
projects / oweals / peertube.git / blobdiff