miteruzo
/
nizika_video
1
0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
ニジカ投稿局 https://tv.nizika.tv
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
13 Commits
1 Branch
24 MiB
 
 
 
 
 
Tree: d9e598748f
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'd9e598748f'
${ noResults }
nizika_video/support/doc/api/openapi.yaml

11224 lines
324 KiB
Raw Blame History 

  1. openapi: 3.0.0

  2. info:

  3.   title: PeerTube

  4.   version: 6.1.0

  5.   contact:

  6.     name: PeerTube Community

  7.     url: https://joinpeertube.org

  8.   license:

  9.     name: AGPLv3.0

  10.     url: https://github.com/Chocobozzz/PeerTube/blob/master/LICENSE

  11.   x-logo:

  12.     url: https://joinpeertube.org/img/brand.png

  13.     altText: PeerTube Project Homepage

  14.   description: |

  15.     The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite

  16.     HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with

  17.     [openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO)

  18.     which generates a client SDK in the language of your choice - we generate some client SDKs automatically:

  19. 

  20.     - [Python](https://framagit.org/framasoft/peertube/clients/python)

  21.     - [Go](https://framagit.org/framasoft/peertube/clients/go)

  22.     - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin)

  23. 

  24.     See the [REST API quick start](https://docs.joinpeertube.org/api/rest-getting-started) for a few

  25.     examples of using the PeerTube API.

  26. 

  27.     # Authentication

  28. 

  29.     When you sign up for an account on a PeerTube instance, you are given the possibility

  30.     to generate sessions on it, and authenticate there using an access token. Only __one

  31.     access token can currently be used at a time__.

  32. 

  33.     ## Roles

  34. 

  35.     Accounts are given permissions based on their role. There are three roles on

  36.     PeerTube: Administrator, Moderator, and User. See the [roles guide](https://docs.joinpeertube.org/admin/managing-users#roles) for a detail of their permissions.

  37. 

  38.     # Errors

  39. 

  40.     The API uses standard HTTP status codes to indicate the success or failure

  41.     of the API call, completed by a [RFC7807-compliant](https://tools.ietf.org/html/rfc7807) response body.

  42. 

  43.     ```

  44.     HTTP 1.1 404 Not Found

  45.     Content-Type: application/problem+json; charset=utf-8

  46. 

  47.     {

  48.       "detail": "Video not found",

  49.       "docs": "https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo",

  50.       "status": 404,

  51.       "title": "Not Found",

  52.       "type": "about:blank"

  53.     }

  54.     ```

  55. 

  56.     We provide error `type` (following RFC7807) and `code` (internal PeerTube code) values for [a growing number of cases](https://github.com/Chocobozzz/PeerTube/blob/develop/packages/models/src/server/server-error-code.enum.ts),

  57.     but it is still optional. Types are used to disambiguate errors that bear the same status code

  58.     and are non-obvious:

  59. 

  60.     ```

  61.     HTTP 1.1 403 Forbidden

  62.     Content-Type: application/problem+json; charset=utf-8

  63. 

  64.     {

  65.       "detail": "Cannot get this video regarding follow constraints",

  66.       "docs": "https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo",

  67.       "status": 403,

  68.       "title": "Forbidden",

  69.       "type": "https://docs.joinpeertube.org/api-rest-reference.html#section/Errors/does_not_respect_follow_constraints"

  70.     }

  71.     ```

  72. 

  73.     Here a 403 error could otherwise mean that the video is private or blocklisted.

  74. 

  75.     ### Validation errors

  76. 

  77.     Each parameter is evaluated on its own against a set of rules before the route validator

  78.     proceeds with potential testing involving parameter combinations. Errors coming from validation

  79.     errors appear earlier and benefit from a more detailed error description:

  80. 

  81.     ```

  82.     HTTP 1.1 400 Bad Request

  83.     Content-Type: application/problem+json; charset=utf-8

  84. 

  85.     {

  86.       "detail": "Incorrect request parameters: id",

  87.       "docs": "https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo",

  88.       "instance": "/api/v1/videos/9c9de5e8-0a1e-484a-b099-e80766180",

  89.       "invalid-params": {

  90.         "id": {

  91.           "location": "params",

  92.           "msg": "Invalid value",

  93.           "param": "id",

  94.           "value": "9c9de5e8-0a1e-484a-b099-e80766180"

  95.         }

  96.       },

  97.       "status": 400,

  98.       "title": "Bad Request",

  99.       "type": "about:blank"

  100.     }

  101.     ```

  102. 

  103.     Where `id` is the name of the field concerned by the error, within the route definition.

  104.     `invalid-params.<field>.location` can be either 'params', 'body', 'header', 'query' or 'cookies', and

  105.     `invalid-params.<field>.value` reports the value that didn't pass validation whose `invalid-params.<field>.msg`

  106.     is about.

  107. 

  108.     ### Deprecated error fields

  109. 

  110.     Some fields could be included with previous versions. They are still included but their use is deprecated:

  111.     - `error`: superseded by `detail`

  112. 

  113.     # Rate limits

  114. 

  115.     We are rate-limiting all endpoints of PeerTube's API. Custom values can be set by administrators:

  116. 

  117.     | Endpoint (prefix: `/api/v1`) | Calls         | Time frame   |

  118.     |------------------------------|---------------|--------------|

  119.     | `/*`                         | 50            | 10 seconds   |

  120.     | `POST /users/token`          | 15            | 5 minutes    |

  121.     | `POST /users/register`       | 2<sup>*</sup> | 5 minutes    |

  122.     | `POST /users/ask-send-verify-email` | 3      | 5 minutes    |

  123. 

  124.     Depending on the endpoint, <sup>*</sup>failed requests are not taken into account. A service

  125.     limit is announced by a `429 Too Many Requests` status code.

  126. 

  127.     You can get details about the current state of your rate limit by reading the

  128.     following headers:

  129. 

  130.     | Header                  | Description                                                |

  131.     |-------------------------|------------------------------------------------------------|

  132.     | `X-RateLimit-Limit`     | Number of max requests allowed in the current time period  |

  133.     | `X-RateLimit-Remaining` | Number of remaining requests in the current time period    |

  134.     | `X-RateLimit-Reset`     | Timestamp of end of current time period as UNIX timestamp  |

  135.     | `Retry-After`           | Seconds to delay after the first `429` is received         |

  136. 

  137.     # CORS

  138. 

  139.     This API features [Cross-Origin Resource Sharing (CORS)](https://fetch.spec.whatwg.org/),

  140.     allowing cross-domain communication from the browser for some routes:

  141. 

  142.     | Endpoint                    |

  143.     |------------------------- ---|

  144.     | `/api/*`                    |

  145.     | `/download/*`               |

  146.     | `/lazy-static/*`            |

  147.     | `/.well-known/webfinger`    |

  148. 

  149.     In addition, all routes serving ActivityPub are CORS-enabled for all origins.

  150. externalDocs:

  151.   url: https://docs.joinpeertube.org/api-rest-reference.html

  152. tags:

  153.   - name: Register

  154.     description: |

  155.       As a visitor, you can use this API to open an account (if registrations are open on

  156.       that PeerTube instance). As an admin, you should use the dedicated [User creation

  157.       API](#operation/addUser) instead.

  158.   - name: Session

  159.     x-displayName: Login/Logout

  160.     description: |

  161.       Sessions deal with access tokens over time. Only __one session token can currently be used at a time__.

  162.   - name: Accounts

  163.     description: >

  164.       Accounts encompass remote accounts discovered across the federation,

  165.       and correspond to the main Actor, along with video channels a user can create, which

  166.       are also Actors.

  167. 

  168.       When a comment is posted, it is done with your Account's Actor.

  169.   - name: Users

  170.     description: >

  171.       Using some features of PeerTube require authentication, for which User

  172.       provide different levels of permission as well as associated user

  173.       information. Each user has a corresponding local Account for federation.

  174.   - name: User Exports

  175.     description: >

  176.       To create an archive of user data.

  177.   - name: User Imports

  178.     description: >

  179.       To import an archive of user data.

  180.   - name: My User

  181.     description: >

  182.       Operations related to your own User, when logged-in.

  183.   - name: My Subscriptions

  184.     description: >

  185.       Operations related to your subscriptions to video channels, their

  186.       new videos, and how to keep up to date with their latest publications!

  187.   - name: My History

  188.     description: >

  189.       Operations related to your watch history.

  190.   - name: My Notifications

  191.     description: >

  192.       Notifications following new videos, follows or reports. They allow you

  193.       to keep track of the interactions and overall important information that

  194.       concerns you. You MAY set per-notification type delivery preference, to

  195.       receive the info either by mail, by in-browser notification or both.

  196.   - name: Config

  197.     description: >

  198.       Each server exposes public information regarding supported videos and

  199.       options.

  200.   - name: Job

  201.     description: >

  202.       Jobs are long-running tasks enqueued and processed by the instance

  203.       itself. No additional worker registration is currently available.

  204.   - name: Instance Follows

  205.     description: >

  206.       Managing servers which the instance interacts with is crucial to the

  207.       concept of federation in PeerTube and external video indexation. The PeerTube

  208.       server then deals with inter-server ActivityPub operations and propagates

  209.       information across its social graph by posting activities to actors' inbox

  210.       endpoints.

  211.     externalDocs:

  212.       url: https://docs.joinpeertube.org/admin/following-instances#instances-follows

  213.   - name: Instance Redundancy

  214.     description: >

  215.       Redundancy is part of the inter-server solidarity that PeerTube fosters.

  216.       Manage the list of instances you wish to help by seeding their videos according

  217.       to the policy of video selection of your choice. Note that you have a similar functionality

  218.       to mirror individual videos, see [video mirroring](#tag/Video-Mirroring).

  219.     externalDocs:

  220.       url: https://docs.joinpeertube.org/admin/following-instances#instances-redundancy

  221.   - name: Plugins

  222.     description: >

  223.       Managing plugins installed from a local path or from NPM, or search for new ones.

  224.     externalDocs:

  225.       url: https://docs.joinpeertube.org/api/plugins

  226.   - name: Abuses

  227.     description: |

  228.       Abuses deal with reports of local or remote videos/comments/accounts alike.

  229.   - name: Video

  230.     description: |

  231.       Operations dealing with listing, uploading, fetching or modifying videos.

  232.   - name: Video Upload

  233.     description: |

  234.       Operations dealing with adding video or audio. PeerTube supports two upload modes, and three import modes.

  235. 

  236.       ### Upload

  237. 

  238.       - [_legacy_](#operation/uploadLegacy), where the video file is sent in a single request

  239.       - [_resumable_](#operation/uploadResumableInit), where the video file is sent in chunks

  240. 

  241.       You can upload videos more reliably by using the resumable variant. Its protocol lets

  242.       you resume an upload operation after a network interruption or other transmission failure,

  243.       saving time and bandwidth in the event of network failures.

  244. 

  245.       Favor using resumable uploads in any of the following cases:

  246.       - You are transferring large files

  247.       - The likelihood of a network interruption is high

  248.       - Uploads are originating from a device with a low-bandwidth or unstable Internet connection,

  249.         such as a mobile device

  250. 

  251.       ### Import

  252. 

  253.       - _URL_-based: where the URL points to any service supported by [youtube-dl](https://ytdl-org.github.io/youtube-dl/)

  254.       - _magnet_-based: where the URI resolves to a BitTorrent resource containing a single supported video file

  255.       - _torrent_-based: where the metainfo file resolves to a BitTorrent resource containing a single supported video file

  256. 

  257.       The import function is practical when the desired video/audio is available online. It makes PeerTube

  258.       download it for you, saving you as much bandwidth and avoiding any instability or limitation your network might have.

  259.   - name: Video Imports

  260.     description: Operations dealing with listing, adding and removing video imports.

  261.   - name: Channels Sync

  262.     description: Operations dealing with synchronizing PeerTube user's channel with channels of other platforms

  263.   - name: Video Captions

  264.     description: Operations dealing with listing, adding and removing closed captions of a video.

  265.   - name: Video Chapters

  266.     description: Operations dealing with managing chapters of a video.

  267.   - name: Video Channels

  268.     description: Operations dealing with the creation, modification and listing of videos within a channel.

  269.   - name: Video Comments

  270.     description: >

  271.       Operations dealing with comments to a video. Comments are organized in threads: adding a

  272.       comment in response to the video starts a thread, adding a reply to a comment adds it to

  273.       its root comment thread.

  274.   - name: Video Blocks

  275.     description: Operations dealing with blocking videos (removing them from view and preventing interactions).

  276.   - name: Automatic Tags

  277.     description: Automatic tags set on objects (like comments or videos) by specific rules (external link, watched words, etc.)

  278.   - name: Watched Words

  279.     description: Manage list of watched words to detect patterns on objects (like comments of videos)

  280.   - name: Video Rates

  281.     description: Like/dislike a video.

  282.   - name: Video Playlists

  283.     description: Operations dealing with playlists of videos. Playlists are bound to users and/or channels.

  284.   - name: Video Files

  285.     description: Operations on video files

  286.   - name: Video Transcoding

  287.     description: Video transcoding related operations

  288.   - name: Video Stats

  289.     description: Video statistics

  290.   - name: Video Feeds

  291.     description: Server syndication feeds of videos

  292.   - name: Search

  293.     description: |

  294.       The search helps to find _videos_ or _channels_ from within the instance and beyond.

  295.       Videos from other instances federated by the instance (that is, instances

  296.       followed by the instance) can be found via keywords and other criteria of

  297.       the advanced search.

  298. 

  299.       Administrators can also enable the use of a remote search system, indexing

  300.       videos and channels not could be not federated by the instance.

  301.   - name: Homepage

  302.     description: Get and update the custom homepage

  303.   - name: Video Mirroring

  304.     description: |

  305.       PeerTube instances can mirror videos from one another, and help distribute some videos.

  306. 

  307.       For importing videos as your own, refer to [video imports](#operation/importVideo).

  308.   - name: Stats

  309.     description: |

  310.       Statistics

  311.   - name: Runner Registration Token

  312.     description: |

  313.       Manage runner registration token

  314.   - name: Video Passwords

  315.     description: Operation on video passwords

  316. 

  317. x-tagGroups:

  318.   - name: Static endpoints

  319.     tags:

  320.       - Static Video Files

  321.   - name: Feeds

  322.     tags:

  323.       - Video Feeds

  324.   - name: Auth

  325.     tags:

  326.       - Register

  327.       - Session

  328.   - name: Accounts

  329.     tags:

  330.       - Accounts

  331.       - Users

  332.       - User Exports

  333.       - User Imports

  334.       - My User

  335.       - My Subscriptions

  336.       - My Notifications

  337.       - My History

  338.   - name: Videos

  339.     tags:

  340.       - Video

  341.       - Video Upload

  342.       - Video Imports

  343.       - Video Captions

  344.       - Video Chapters

  345.       - Video Channels

  346.       - Video Comments

  347.       - Video Rates

  348.       - Video Playlists

  349.       - Video Stats

  350.       - Video Ownership Change

  351.       - Video Mirroring

  352.       - Video Files

  353.       - Video Transcoding

  354.       - Live Videos

  355.       - Channels Sync

  356.       - Video Passwords

  357.   - name: Search

  358.     tags:

  359.       - Search

  360.   - name: Moderation

  361.     tags:

  362.       - Abuses

  363.       - Video Blocks

  364.       - Account Blocks

  365.       - Server Blocks

  366.       - Automatic Tags

  367.       - Watched Words

  368.   - name: Instance

  369.     tags:

  370.       - Config

  371.       - Homepage

  372.       - Instance Follows

  373.       - Instance Redundancy

  374.       - Plugins

  375.       - Stats

  376.       - Logs

  377.       - Job

  378.   - name: Remote Jobs

  379.     tags:

  380.       - Runner Registration Token

  381.       - Runner Jobs

  382.       - Runners

  383. 

  384. paths:

  385.   '/static/web-videos/{filename}':

  386.     get:

  387.       tags:

  388.         - Static Video Files

  389.       summary: Get public Web Video file

  390.       description: "**PeerTube >= 6.0**"

  391.       parameters:

  392.         - $ref: '#/components/parameters/staticFilename'

  393.       responses:

  394.         '200':

  395.           description: successful operation

  396.         '404':

  397.           description: not found

  398.   '/static/web-videos/private/{filename}':

  399.     get:

  400.       tags:

  401.         - Static Video Files

  402.       summary: Get private Web Video file

  403.       description: "**PeerTube >= 6.0**"

  404.       parameters:

  405.         - $ref: '#/components/parameters/staticFilename'

  406.         - $ref: '#/components/parameters/videoFileToken'

  407.       security:

  408.         - OAuth2: []

  409.       responses:

  410.         '200':

  411.           description: successful operation

  412.         '403':

  413.           description: invalid auth

  414.         '404':

  415.           description: not found

  416. 

  417.   '/static/streaming-playlists/hls/{filename}':

  418.     get:

  419.       tags:

  420.         - Static Video Files

  421.       summary: Get public HLS video file

  422.       parameters:

  423.         - $ref: '#/components/parameters/staticFilename'

  424.       security:

  425.         - OAuth2: []

  426.       responses:

  427.         '200':

  428.           description: successful operation

  429.         '403':

  430.           description: invalid auth

  431.         '404':

  432.           description: not found

  433.   '/static/streaming-playlists/hls/private/{filename}':

  434.     get:

  435.       tags:

  436.         - Static Video Files

  437.       summary: Get private HLS video file

  438.       parameters:

  439.         - $ref: '#/components/parameters/staticFilename'

  440.         - $ref: '#/components/parameters/videoFileToken'

  441.         - $ref: '#/components/parameters/reinjectVideoFileToken'

  442.       security:

  443.         - OAuth2: []

  444.       responses:

  445.         '200':

  446.           description: successful operation

  447.         '403':

  448.           description: invalid auth

  449.         '404':

  450.           description: not found

  451. 

  452. 

  453.   '/feeds/video-comments.{format}':

  454.     get:

  455.       tags:

  456.         - Video Feeds

  457.       summary: Comments on videos feeds

  458.       operationId: getSyndicatedComments

  459.       parameters:

  460.         - name: format

  461.           in: path

  462.           required: true

  463.           description: 'format expected (we focus on making `rss` the most featureful ; it serves [Media RSS](https://www.rssboard.org/media-rss))'

  464.           schema:

  465.             type: string

  466.             enum:

  467.               - xml

  468.               - rss

  469.               - rss2

  470.               - atom

  471.               - atom1

  472.               - json

  473.               - json1

  474.         - name: videoId

  475.           in: query

  476.           description: 'limit listing comments to a specific video'

  477.           schema:

  478.             type: string

  479.         - name: accountId

  480.           in: query

  481.           description: 'limit listing comments to videos of a specific account'

  482.           schema:

  483.             type: string

  484.         - name: accountName

  485.           in: query

  486.           description: 'limit listing comments to videos of a specific account'

  487.           schema:

  488.             type: string

  489.         - name: videoChannelId

  490.           in: query

  491.           description: 'limit listing comments to videos of a specific video channel'

  492.           schema:

  493.             type: string

  494.         - name: videoChannelName

  495.           in: query

  496.           description: 'limit listing comments to videos of a specific video channel'

  497.           schema:

  498.             type: string

  499.       responses:

  500.         '200':

  501.           description: successful operation

  502.           headers:

  503.             Cache-Control:

  504.               schema:

  505.                 type: string

  506.                 default: 'max-age=900' # 15 min cache

  507.           content:

  508.             application/xml:

  509.               schema:

  510.                 $ref: '#/components/schemas/VideoCommentsForXML'

  511.               examples:

  512.                 nightly:

  513.                   externalValue: https://peertube2.cpy.re/feeds/video-comments.xml?filter=local

  514.             application/rss+xml:

  515.               schema:

  516.                 $ref: '#/components/schemas/VideoCommentsForXML'

  517.               examples:

  518.                 nightly:

  519.                   externalValue: https://peertube2.cpy.re/feeds/video-comments.rss?filter=local

  520.             text/xml:

  521.               schema:

  522.                 $ref: '#/components/schemas/VideoCommentsForXML'

  523.               examples:

  524.                 nightly:

  525.                   externalValue: https://peertube2.cpy.re/feeds/video-comments.xml?filter=local

  526.             application/atom+xml:

  527.               schema:

  528.                 $ref: '#/components/schemas/VideoCommentsForXML'

  529.               examples:

  530.                 nightly:

  531.                   externalValue: https://peertube2.cpy.re/feeds/video-comments.atom?filter=local

  532.             application/json:

  533.               schema:

  534.                 type: object

  535.               examples:

  536.                 nightly:

  537.                   externalValue: https://peertube2.cpy.re/feeds/video-comments.json?filter=local

  538.         '400':

  539.           x-summary: field inconsistencies

  540.           description: >

  541.             Arises when:

  542.               - videoId filter is mixed with a channel filter

  543.         '404':

  544.           description: video, video channel or account not found

  545.         '406':

  546.           description: accept header unsupported

  547. 

  548.   '/feeds/videos.{format}':

  549.     get:

  550.       tags:

  551.         - Video Feeds

  552.       summary: Common videos feeds

  553.       operationId: getSyndicatedVideos

  554.       parameters:

  555.         - name: format

  556.           in: path

  557.           required: true

  558.           description: 'format expected (we focus on making `rss` the most featureful ; it serves [Media RSS](https://www.rssboard.org/media-rss))'

  559.           schema:

  560.             type: string

  561.             enum:

  562.               - xml

  563.               - rss

  564.               - rss2

  565.               - atom

  566.               - atom1

  567.               - json

  568.               - json1

  569.         - name: accountId

  570.           in: query

  571.           description: 'limit listing to a specific account'

  572.           schema:

  573.             type: string

  574.         - name: accountName

  575.           in: query

  576.           description: 'limit listing to a specific account'

  577.           schema:

  578.             type: string

  579.         - name: videoChannelId

  580.           in: query

  581.           description: 'limit listing to a specific video channel'

  582.           schema:

  583.             type: string

  584.         - name: videoChannelName

  585.           in: query

  586.           description: 'limit listing to a specific video channel'

  587.           schema:

  588.             type: string

  589.         - $ref: '#/components/parameters/sort'

  590.         - $ref: '#/components/parameters/nsfw'

  591.         - $ref: '#/components/parameters/isLocal'

  592.         - $ref: '#/components/parameters/include'

  593.         - $ref: '#/components/parameters/privacyOneOf'

  594.         - $ref: '#/components/parameters/hasHLSFiles'

  595.         - $ref: '#/components/parameters/hasWebVideoFiles'

  596.       responses:

  597.         '200':

  598.           description: successful operation

  599.           headers:

  600.             Cache-Control:

  601.               schema:

  602.                 type: string

  603.                 default: 'max-age=900' # 15 min cache

  604.           content:

  605.             application/xml:

  606.               schema:

  607.                 $ref: '#/components/schemas/VideosForXML'

  608.               examples:

  609.                 nightly:

  610.                   externalValue: https://peertube2.cpy.re/feeds/videos.xml?filter=local

  611.             application/rss+xml:

  612.               schema:

  613.                 $ref: '#/components/schemas/VideosForXML'

  614.               examples:

  615.                 nightly:

  616.                   externalValue: https://peertube2.cpy.re/feeds/videos.rss?filter=local

  617.             text/xml:

  618.               schema:

  619.                 $ref: '#/components/schemas/VideosForXML'

  620.               examples:

  621.                 nightly:

  622.                   externalValue: https://peertube2.cpy.re/feeds/videos.xml?filter=local

  623.             application/atom+xml:

  624.               schema:

  625.                 $ref: '#/components/schemas/VideosForXML'

  626.               examples:

  627.                 nightly:

  628.                   externalValue: https://peertube2.cpy.re/feeds/videos.atom?filter=local

  629.             application/json:

  630.               schema:

  631.                 type: object

  632.               examples:

  633.                 nightly:

  634.                   externalValue: https://peertube2.cpy.re/feeds/videos.json?filter=local

  635.         '404':

  636.           description: video channel or account not found

  637.         '406':

  638.           description: accept header unsupported

  639. 

  640.   '/feeds/subscriptions.{format}':

  641.     get:

  642.       tags:

  643.         - Video Feeds

  644.       summary: Videos of subscriptions feeds

  645.       operationId: getSyndicatedSubscriptionVideos

  646.       parameters:

  647.         - name: format

  648.           in: path

  649.           required: true

  650.           description: 'format expected (we focus on making `rss` the most featureful ; it serves [Media RSS](https://www.rssboard.org/media-rss))'

  651.           schema:

  652.             type: string

  653.             enum:

  654.               - xml

  655.               - rss

  656.               - rss2

  657.               - atom

  658.               - atom1

  659.               - json

  660.               - json1

  661.         - name: accountId

  662.           in: query

  663.           description: limit listing to a specific account

  664.           schema:

  665.             type: string

  666.           required: true

  667.         - name: token

  668.           in: query

  669.           description: private token allowing access

  670.           schema:

  671.             type: string

  672.           required: true

  673.         - $ref: '#/components/parameters/sort'

  674.         - $ref: '#/components/parameters/nsfw'

  675.         - $ref: '#/components/parameters/isLocal'

  676.         - $ref: '#/components/parameters/include'

  677.         - $ref: '#/components/parameters/privacyOneOf'

  678.         - $ref: '#/components/parameters/hasHLSFiles'

  679.         - $ref: '#/components/parameters/hasWebVideoFiles'

  680.       responses:

  681.         '200':

  682.           description: successful operation

  683.           headers:

  684.             Cache-Control:

  685.               schema:

  686.                 type: string

  687.                 default: 'max-age=900' # 15 min cache

  688.           content:

  689.             application/xml:

  690.               schema:

  691.                 $ref: '#/components/schemas/VideosForXML'

  692.             application/rss+xml:

  693.               schema:

  694.                 $ref: '#/components/schemas/VideosForXML'

  695.             text/xml:

  696.               schema:

  697.                 $ref: '#/components/schemas/VideosForXML'

  698.             application/atom+xml:

  699.               schema:

  700.                 $ref: '#/components/schemas/VideosForXML'

  701.             application/json:

  702.               schema:

  703.                 type: object

  704.         '406':

  705.           description: accept header unsupported

  706. 

  707.   '/feeds/podcast/videos.xml':

  708.     get:

  709.       tags:

  710.         - Video Feeds

  711.       summary: Videos podcast feed

  712.       operationId: getVideosPodcastFeed

  713.       parameters:

  714.         - name: videoChannelId

  715.           in: query

  716.           description: 'Limit listing to a specific video channel'

  717.           required: true

  718.           schema:

  719.             type: string

  720.       responses:

  721.         '200':

  722.           description: successful operation

  723.           headers:

  724.             Cache-Control:

  725.               schema:

  726.                 type: string

  727.                 default: 'max-age=900' # 15 min cache

  728.         '404':

  729.           description: video channel not found

  730. 

  731.   '/api/v1/accounts/{name}':

  732.     get:

  733.       tags:

  734.         - Accounts

  735.       summary: Get an account

  736.       operationId: getAccount

  737.       parameters:

  738.         - $ref: '#/components/parameters/name'

  739.       responses:

  740.         '200':

  741.           description: successful operation

  742.           content:

  743.             application/json:

  744.               schema:

  745.                 $ref: '#/components/schemas/Account'

  746.         '404':

  747.           description: account not found

  748. 

  749.   '/api/v1/accounts/{name}/videos':

  750.     get:

  751.       tags:

  752.         - Accounts

  753.         - Video

  754.       summary: 'List videos of an account'

  755.       operationId: getAccountVideos

  756.       parameters:

  757.         - $ref: '#/components/parameters/name'

  758.         - $ref: '#/components/parameters/categoryOneOf'

  759.         - $ref: '#/components/parameters/isLive'

  760.         - $ref: '#/components/parameters/tagsOneOf'

  761.         - $ref: '#/components/parameters/tagsAllOf'

  762.         - $ref: '#/components/parameters/licenceOneOf'

  763.         - $ref: '#/components/parameters/languageOneOf'

  764.         - $ref: '#/components/parameters/autoTagOneOfVideo'

  765.         - $ref: '#/components/parameters/nsfw'

  766.         - $ref: '#/components/parameters/isLocal'

  767.         - $ref: '#/components/parameters/include'

  768.         - $ref: '#/components/parameters/privacyOneOf'

  769.         - $ref: '#/components/parameters/hasHLSFiles'

  770.         - $ref: '#/components/parameters/hasWebVideoFiles'

  771.         - $ref: '#/components/parameters/skipCount'

  772.         - $ref: '#/components/parameters/start'

  773.         - $ref: '#/components/parameters/count'

  774.         - $ref: '#/components/parameters/videosSort'

  775.         - $ref: '#/components/parameters/excludeAlreadyWatched'

  776.       responses:

  777.         '200':

  778.           description: successful operation

  779.           content:

  780.             application/json:

  781.               schema:

  782.                 $ref: '#/components/schemas/VideoListResponse'

  783.       x-codeSamples:

  784.         - lang: JavaScript

  785.           source: |

  786.             fetch('https://peertube2.cpy.re/api/v1/accounts/{name}/videos')

  787.             .then(function(response) {

  788.               return response.json()

  789.             }).then(function(data) {

  790.               console.log(data)

  791.             })

  792.         - lang: Shell

  793.           source: |

  794.             ## DEPENDENCIES: jq

  795.             curl -s https://peertube2.cpy.re/api/v1/accounts/{name}/videos | jq

  796.         - lang: Ruby

  797.           source: |

  798.             require 'net/http'

  799.             require 'json'

  800. 

  801.             uri = URI.parse("https://peertube2.cpy.re/api/v1/accounts/{name}/videos")

  802. 

  803.             http = Net::HTTP.new(uri.host, uri.port)

  804.             http.use_ssl = true

  805. 

  806.             response = http.get(uri.request_uri)

  807. 

  808.             puts JSON.parse(response.read_body)

  809.         - lang: Python

  810.           source: |

  811.             import requests

  812. 

  813.             r = requests.get("https://peertube2.cpy.re/api/v1//accounts/{name}/videos")

  814.             json = r.json()

  815. 

  816.             print(json)

  817. 

  818.   '/api/v1/accounts/{name}/followers':

  819.     get:

  820.       tags:

  821.         - Accounts

  822.       summary: 'List followers of an account'

  823.       security:

  824.         - OAuth2: []

  825.       operationId: getAccountFollowers

  826.       parameters:

  827.         - $ref: '#/components/parameters/name'

  828.         - $ref: '#/components/parameters/start'

  829.         - $ref: '#/components/parameters/count'

  830.         - $ref: '#/components/parameters/followersSort'

  831.         - $ref: '#/components/parameters/search'

  832.       responses:

  833.         '200':

  834.           description: successful operation

  835.           content:

  836.             application/json:

  837.               schema:

  838.                 type: object

  839.                 properties:

  840.                   total:

  841.                     type: integer

  842.                     example: 1

  843.                   data:

  844.                     type: array

  845.                     items:

  846.                       $ref: '#/components/schemas/Follow'

  847. 

  848.   /api/v1/accounts:

  849.     get:

  850.       tags:

  851.         - Accounts

  852.       summary: List accounts

  853.       operationId: getAccounts

  854.       parameters:

  855.         - $ref: '#/components/parameters/start'

  856.         - $ref: '#/components/parameters/count'

  857.         - $ref: '#/components/parameters/sort'

  858.       responses:

  859.         '200':

  860.           description: successful operation

  861.           content:

  862.             'application/json':

  863.               schema:

  864.                 type: object

  865.                 properties:

  866.                   total:

  867.                     type: integer

  868.                     example: 1

  869.                   data:

  870.                     type: array

  871.                     items:

  872.                       $ref: '#/components/schemas/Account'

  873. 

  874.   /api/v1/config:

  875.     get:

  876.       tags:

  877.         - Config

  878.       summary: Get instance public configuration

  879.       operationId: getConfig

  880.       responses:

  881.         '200':

  882.           description: successful operation

  883.           content:

  884.             application/json:

  885.               schema:

  886.                 $ref: '#/components/schemas/ServerConfig'

  887.               examples:

  888.                 nightly:

  889.                   externalValue: https://peertube2.cpy.re/api/v1/config

  890. 

  891.   /api/v1/config/about:

  892.     get:

  893.       summary: Get instance "About" information

  894.       operationId: getAbout

  895.       tags:

  896.         - Config

  897.       responses:

  898.         '200':

  899.           description: successful operation

  900.           content:

  901.             application/json:

  902.               schema:

  903.                 $ref: '#/components/schemas/ServerConfigAbout'

  904.               examples:

  905.                 nightly:

  906.                   externalValue: https://peertube2.cpy.re/api/v1/config/about

  907. 

  908.   /api/v1/config/custom:

  909.     get:

  910.       summary: Get instance runtime configuration

  911.       operationId: getCustomConfig

  912.       tags:

  913.         - Config

  914.       security:

  915.         - OAuth2:

  916.           - admin

  917.       responses:

  918.         '200':

  919.           description: successful operation

  920.           content:

  921.             application/json:

  922.               schema:

  923.                 $ref: '#/components/schemas/ServerConfigCustom'

  924.     put:

  925.       summary: Set instance runtime configuration

  926.       operationId: putCustomConfig

  927.       tags:

  928.         - Config

  929.       security:

  930.         - OAuth2:

  931.           - admin

  932.       responses:

  933.         '200':

  934.           description: successful operation

  935.         '400':

  936.           x-summary: field inconsistencies

  937.           description: >

  938.             Arises when:

  939.               - the emailer is disabled and the instance is open to registrations

  940.               - web videos and hls are disabled with transcoding enabled - you need at least one enabled

  941.     delete:

  942.       summary: Delete instance runtime configuration

  943.       operationId: delCustomConfig

  944.       tags:

  945.         - Config

  946.       security:

  947.         - OAuth2:

  948.           - admin

  949.       responses:

  950.         '200':

  951.           description: successful operation

  952. 

  953.   /api/v1/config/instance-banner/pick:

  954.     post:

  955.       summary: Update instance banner

  956.       security:

  957.         - OAuth2:

  958.           - admin

  959.       tags:

  960.         - Config

  961.       responses:

  962.         '204':

  963.           description: successful operation

  964.         '413':

  965.           description: image file too large

  966.           headers:

  967.             X-File-Maximum-Size:

  968.               schema:

  969.                 type: string

  970.                 format: Nginx size

  971.               description: Maximum file size for the banner

  972.       requestBody:

  973.         content:

  974.           multipart/form-data:

  975.             schema:

  976.               type: object

  977.               properties:

  978.                 bannerfile:

  979.                   description: The file to upload.

  980.                   type: string

  981.                   format: binary

  982.             encoding:

  983.               bannerfile:

  984.                 contentType: image/png, image/jpeg

  985. 

  986.   '/api/v1/config/instance-banner':

  987.     delete:

  988.       summary: Delete instance banner

  989.       security:

  990.         - OAuth2:

  991.           - admin

  992.       tags:

  993.         - Config

  994.       responses:

  995.         '204':

  996.           description: successful operation

  997. 

  998.   /api/v1/config/instance-avatar/pick:

  999.     post:

  1000.       summary: Update instance avatar

  1001.       security:

  1002.         - OAuth2:

  1003.           - admin

  1004.       tags:

  1005.         - Config

  1006.       responses:

  1007.         '204':

  1008.           description: successful operation

  1009.         '413':

  1010.           description: image file too large

  1011.           headers:

  1012.             X-File-Maximum-Size:

  1013.               schema:

  1014.                 type: string

  1015.                 format: Nginx size

  1016.               description: Maximum file size for the avatar

  1017.       requestBody:

  1018.         content:

  1019.           multipart/form-data:

  1020.             schema:

  1021.               type: object

  1022.               properties:

  1023.                 avatarfile:

  1024.                   description: The file to upload.

  1025.                   type: string

  1026.                   format: binary

  1027.             encoding:

  1028.               avatarfile:

  1029.                 contentType: image/png, image/jpeg

  1030. 

  1031.   '/api/v1/config/instance-avatar':

  1032.     delete:

  1033.       summary: Delete instance avatar

  1034.       security:

  1035.         - OAuth2:

  1036.           - admin

  1037.       tags:

  1038.         - Config

  1039.       responses:

  1040.         '204':

  1041.           description: successful operation

  1042. 

  1043.   /api/v1/custom-pages/homepage/instance:

  1044.     get:

  1045.       summary: Get instance custom homepage

  1046.       tags:

  1047.         - Homepage

  1048.       responses:

  1049.         '404':

  1050.           description: No homepage set

  1051.         '200':

  1052.           description: successful operation

  1053.           content:

  1054.             application/json:

  1055.               schema:

  1056.                 $ref: '#/components/schemas/CustomHomepage'

  1057.     put:

  1058.       summary: Set instance custom homepage

  1059.       tags:

  1060.         - Homepage

  1061.       security:

  1062.         - OAuth2:

  1063.           - admin

  1064.       requestBody:

  1065.         content:

  1066.           application/json:

  1067.             schema:

  1068.               type: object

  1069.               properties:

  1070.                 content:

  1071.                   type: string

  1072.                   description: content of the homepage, that will be injected in the client

  1073.       responses:

  1074.         '204':

  1075.           description: successful operation

  1076. 

  1077.   /api/v1/jobs/pause:

  1078.     post:

  1079.       summary: Pause job queue

  1080.       security:

  1081.         - OAuth2:

  1082.           - admin

  1083.       tags:

  1084.         - Job

  1085.       responses:

  1086.         '204':

  1087.           description: successful operation

  1088. 

  1089.   /api/v1/jobs/resume:

  1090.     post:

  1091.       summary: Resume job queue

  1092.       security:

  1093.         - OAuth2:

  1094.           - admin

  1095.       tags:

  1096.         - Job

  1097.       responses:

  1098.         '204':

  1099.           description: successful operation

  1100. 

  1101.   /api/v1/jobs/{state}:

  1102.     get:

  1103.       summary: List instance jobs

  1104.       operationId: getJobs

  1105.       security:

  1106.         - OAuth2:

  1107.           - admin

  1108.       tags:

  1109.         - Job

  1110.       parameters:

  1111.         - name: state

  1112.           in: path

  1113.           required: true

  1114.           description: The state of the job ('' for for no filter)

  1115.           schema:

  1116.             type: string

  1117.             enum:

  1118.               - ''

  1119.               - active

  1120.               - completed

  1121.               - failed

  1122.               - waiting

  1123.               - delayed

  1124.         - $ref: '#/components/parameters/jobType'

  1125.         - $ref: '#/components/parameters/start'

  1126.         - $ref: '#/components/parameters/count'

  1127.         - $ref: '#/components/parameters/sort'

  1128.       responses:

  1129.         '200':

  1130.           description: successful operation

  1131.           content:

  1132.             application/json:

  1133.               schema:

  1134.                 type: object

  1135.                 properties:

  1136.                   total:

  1137.                     type: integer

  1138.                     example: 1

  1139.                   data:

  1140.                     type: array

  1141.                     maxItems: 100

  1142.                     items:

  1143.                       $ref: '#/components/schemas/Job'

  1144. 

  1145.   /api/v1/server/followers:

  1146.     get:

  1147.       tags:

  1148.         - Instance Follows

  1149.       summary: List instances following the server

  1150.       parameters:

  1151.         - $ref: '#/components/parameters/followState'

  1152.         - $ref: '#/components/parameters/actorType'

  1153.         - $ref: '#/components/parameters/start'

  1154.         - $ref: '#/components/parameters/count'

  1155.         - $ref: '#/components/parameters/sort'

  1156.       responses:

  1157.         '200':

  1158.           description: successful operation

  1159.           content:

  1160.             application/json:

  1161.               schema:

  1162.                 type: object

  1163.                 properties:

  1164.                   total:

  1165.                     type: integer

  1166.                     example: 1

  1167.                   data:

  1168.                     type: array

  1169.                     items:

  1170.                       $ref: '#/components/schemas/Follow'

  1171. 

  1172.   '/api/v1/server/followers/{nameWithHost}':

  1173.     delete:

  1174.       summary: Remove or reject a follower to your server

  1175.       security:

  1176.         - OAuth2:

  1177.           - admin

  1178.       tags:

  1179.         - Instance Follows

  1180.       parameters:

  1181.         - name: nameWithHost

  1182.           in: path

  1183.           required: true

  1184.           description: The remote actor handle to remove from your followers

  1185.           schema:

  1186.             type: string

  1187.             format: email

  1188.       responses:

  1189.         '204':

  1190.           description: successful operation

  1191.         '404':

  1192.           description: follower not found

  1193. 

  1194.   '/api/v1/server/followers/{nameWithHost}/reject':

  1195.     post:

  1196.       summary: Reject a pending follower to your server

  1197.       security:

  1198.         - OAuth2:

  1199.           - admin

  1200.       tags:

  1201.         - Instance Follows

  1202.       parameters:

  1203.         - name: nameWithHost

  1204.           in: path

  1205.           required: true

  1206.           description: The remote actor handle to remove from your followers

  1207.           schema:

  1208.             type: string

  1209.             format: email

  1210.       responses:

  1211.         '204':

  1212.           description: successful operation

  1213.         '404':

  1214.           description: follower not found

  1215. 

  1216.   '/api/v1/server/followers/{nameWithHost}/accept':

  1217.     post:

  1218.       summary: Accept a pending follower to your server

  1219.       security:

  1220.         - OAuth2:

  1221.           - admin

  1222.       tags:

  1223.         - Instance Follows

  1224.       parameters:

  1225.         - name: nameWithHost

  1226.           in: path

  1227.           required: true

  1228.           description: The remote actor handle to remove from your followers

  1229.           schema:

  1230.             type: string

  1231.             format: email

  1232.       responses:

  1233.         '204':

  1234.           description: successful operation

  1235.         '404':

  1236.           description: follower not found

  1237. 

  1238.   /api/v1/server/following:

  1239.     get:

  1240.       tags:

  1241.         - Instance Follows

  1242.       summary: List instances followed by the server

  1243.       parameters:

  1244.         - $ref: '#/components/parameters/followState'

  1245.         - $ref: '#/components/parameters/actorType'

  1246.         - $ref: '#/components/parameters/start'

  1247.         - $ref: '#/components/parameters/count'

  1248.         - $ref: '#/components/parameters/sort'

  1249.       responses:

  1250.         '200':

  1251.           description: successful operation

  1252.           content:

  1253.             application/json:

  1254.               schema:

  1255.                 type: object

  1256.                 properties:

  1257.                   total:

  1258.                     type: integer

  1259.                     example: 1

  1260.                   data:

  1261.                     type: array

  1262.                     items:

  1263.                       $ref: '#/components/schemas/Follow'

  1264.     post:

  1265.       security:

  1266.         - OAuth2:

  1267.           - admin

  1268.       tags:

  1269.         - Instance Follows

  1270.       summary: Follow a list of actors (PeerTube instance, channel or account)

  1271.       responses:

  1272.         '204':

  1273.           description: successful operation

  1274.         '500':

  1275.           description: cannot follow a non-HTTPS server

  1276.       requestBody:

  1277.         content:

  1278.           application/json:

  1279.             schema:

  1280.               type: object

  1281.               properties:

  1282.                 hosts:

  1283.                   type: array

  1284.                   items:

  1285.                     type: string

  1286.                     format: hostname

  1287.                   uniqueItems: true

  1288.                 handles:

  1289.                   type: array

  1290.                   items:

  1291.                     type: string

  1292.                   uniqueItems: true

  1293. 

  1294.   '/api/v1/server/following/{hostOrHandle}':

  1295.     delete:

  1296.       summary: Unfollow an actor (PeerTube instance, channel or account)

  1297.       security:

  1298.         - OAuth2:

  1299.           - admin

  1300.       tags:

  1301.         - Instance Follows

  1302.       parameters:

  1303.         - name: hostOrHandle

  1304.           in: path

  1305.           required: true

  1306.           description: The hostOrHandle to unfollow

  1307.           schema:

  1308.             type: string

  1309.       responses:

  1310.         '204':

  1311.           description: successful operation

  1312.         '404':

  1313.           description: host or handle not found

  1314. 

  1315.   /api/v1/users:

  1316.     post:

  1317.       summary: Create a user

  1318.       operationId: addUser

  1319.       security:

  1320.         - OAuth2:

  1321.           - admin

  1322.       tags:

  1323.         - Users

  1324.       responses:

  1325.         '200':

  1326.           description: user created

  1327.           content:

  1328.             application/json:

  1329.               schema:

  1330.                 $ref: '#/components/schemas/AddUserResponse'

  1331.           links:

  1332.             # GET /users/{id}

  1333.             GetUser:

  1334.               operationId: getUser

  1335.               parameters:

  1336.                 id: '$response.body#/user/id'

  1337.             # PUT /users/{id}

  1338.             PutUser:

  1339.               operationId: putUser

  1340.               parameters:

  1341.                 id: '$response.body#/user/id'

  1342.             # DELETE /users/{id}

  1343.             DelUser:

  1344.               operationId: delUser

  1345.               parameters:

  1346.                 id: '$response.body#/user/id'

  1347.         '403':

  1348.           description: insufficient authority to create an admin or moderator

  1349.       requestBody:

  1350.         content:

  1351.           application/json:

  1352.             schema:

  1353.               $ref: '#/components/schemas/AddUser'

  1354.         description: |

  1355.           If the smtp server is configured, you can leave the password empty and an email will be sent

  1356.           asking the user to set it first.

  1357.         required: true

  1358.     get:

  1359.       summary: List users

  1360.       operationId: getUsers

  1361.       security:

  1362.         - OAuth2:

  1363.           - admin

  1364.       tags:

  1365.         - Users

  1366.       parameters:

  1367.         - $ref: '#/components/parameters/usersSearch'

  1368.         - $ref: '#/components/parameters/usersBlocked'

  1369.         - $ref: '#/components/parameters/start'

  1370.         - $ref: '#/components/parameters/count'

  1371.         - $ref: '#/components/parameters/usersSort'

  1372.       responses:

  1373.         '200':

  1374.           description: successful operation

  1375.           content:

  1376.             application/json:

  1377.               schema:

  1378.                 type: array

  1379.                 items:

  1380.                   $ref: '#/components/schemas/User'

  1381. 

  1382.   '/api/v1/users/{id}':

  1383.     parameters:

  1384.       - $ref: '#/components/parameters/id'

  1385.     delete:

  1386.       summary: Delete a user

  1387.       security:

  1388.         - OAuth2:

  1389.           - admin

  1390.       tags:

  1391.         - Users

  1392.       operationId: delUser

  1393.       responses:

  1394.         '204':

  1395.           description: successful operation

  1396.     get:

  1397.       summary: Get a user

  1398.       security:

  1399.         - OAuth2: []

  1400.       tags:

  1401.         - Users

  1402.       operationId: getUser

  1403.       parameters:

  1404.         - name: withStats

  1405.           in: query

  1406.           description: include statistics about the user (only available as a moderator/admin)

  1407.           schema:

  1408.             type: boolean

  1409.       responses:

  1410.         '200':

  1411.           x-summary: successful operation

  1412.           description: |

  1413.             As an admin/moderator, you can request a response augmented with statistics about the user's

  1414.             moderation relations and videos usage, by using the `withStats` parameter.

  1415.           content:

  1416.             application/json:

  1417.               schema:

  1418.                 oneOf:

  1419.                   - $ref: '#/components/schemas/User'

  1420.                   - $ref: '#/components/schemas/UserWithStats'

  1421.     put:

  1422.       summary: Update a user

  1423.       security:

  1424.         - OAuth2: []

  1425.       tags:

  1426.         - Users

  1427.       operationId: putUser

  1428.       responses:

  1429.         '204':

  1430.           description: successful operation

  1431.       requestBody:

  1432.         content:

  1433.           application/json:

  1434.             schema:

  1435.               $ref: '#/components/schemas/UpdateUser'

  1436.         required: true

  1437. 

  1438.   /api/v1/oauth-clients/local:

  1439.     get:

  1440.       summary: Login prerequisite

  1441.       description: You need to retrieve a client id and secret before [logging in](#operation/getOAuthToken).

  1442.       operationId: getOAuthClient

  1443.       tags:

  1444.         - Session

  1445.       responses:

  1446.         '200':

  1447.           description: successful operation

  1448.           content:

  1449.             application/json:

  1450.               schema:

  1451.                 $ref: '#/components/schemas/OAuthClient'

  1452.           links:

  1453.             UseOAuthClientToLogin:

  1454.               operationId: getOAuthToken

  1455.               parameters:

  1456.                 client_id: '$response.body#/client_id'

  1457.                 client_secret: '$response.body#/client_secret'

  1458.       x-codeSamples:

  1459.         - lang: Shell

  1460.           source: |

  1461.             API="https://peertube2.cpy.re/api/v1"

  1462. 

  1463.             ## AUTH

  1464.             curl -s "$API/oauth-clients/local"

  1465. 

  1466.   /api/v1/users/token:

  1467.     post:

  1468.       summary: Login

  1469.       operationId: getOAuthToken

  1470.       description: With your [client id and secret](#operation/getOAuthClient), you can retrieve an access and refresh tokens.

  1471.       tags:

  1472.         - Session

  1473.       requestBody:

  1474.         content:

  1475.           application/x-www-form-urlencoded:

  1476.             schema:

  1477.               oneOf:

  1478.                 - $ref: '#/components/schemas/OAuthToken-password'

  1479.                 - $ref: '#/components/schemas/OAuthToken-refresh_token'

  1480.               discriminator:

  1481.                 propertyName: grant_type

  1482.                 mapping:

  1483.                   password: '#/components/schemas/OAuthToken-password'

  1484.                   refresh_token: '#/components/schemas/OAuthToken-refresh_token'

  1485.       responses:

  1486.         '200':

  1487.           description: successful operation

  1488.           content:

  1489.             application/json:

  1490.               schema:

  1491.                 type: object

  1492.                 properties:

  1493.                   token_type:

  1494.                     type: string

  1495.                     example: Bearer

  1496.                   access_token:

  1497.                     type: string

  1498.                     example: 90286a0bdf0f7315d9d3fe8dabf9e1d2be9c97d0

  1499.                     description: valid for 1 day

  1500.                   refresh_token:

  1501.                     type: string

  1502.                     example: 2e0d675df9fc96d2e4ec8a3ebbbf45eca9137bb7

  1503.                     description: valid for 2 weeks

  1504.                   expires_in:

  1505.                     type: integer

  1506.                     minimum: 0

  1507.                     example: 14399

  1508.                   refresh_token_expires_in:

  1509.                     type: integer

  1510.                     minimum: 0

  1511.                     example: 1209600

  1512.         '400':

  1513.           x-summary: client or credentials are invalid

  1514.           description: |

  1515.             Disambiguate via `code`:

  1516.             - `invalid_client` for an unmatched `client_id`

  1517.             - `invalid_grant` for unmatched credentials

  1518.         '401':

  1519.           x-summary: token expired or two factor header is missing

  1520.           description: |

  1521.             Disambiguate via `code`:

  1522.             - default value for a regular authentication failure

  1523.             - `invalid_token` for an expired token

  1524.             - `missing_two_factor` if two factor header is missing

  1525.       x-codeSamples:

  1526.         - lang: Shell

  1527.           source: |

  1528.             ## DEPENDENCIES: jq

  1529.             API="https://peertube2.cpy.re/api/v1"

  1530.             USERNAME="<your_username>"

  1531.             PASSWORD="<your_password>"

  1532. 

  1533.             ## AUTH

  1534.             client_id=$(curl -s "$API/oauth-clients/local" | jq -r ".client_id")

  1535.             client_secret=$(curl -s "$API/oauth-clients/local" | jq -r ".client_secret")

  1536.             curl -s "$API/users/token" \

  1537.               --data client_id="$client_id" \

  1538.               --data client_secret="$client_secret" \

  1539.               --data grant_type=password \

  1540.               --data username="$USERNAME" \

  1541.               --data-urlencode password="$PASSWORD" \

  1542.               | jq -r ".access_token"

  1543. 

  1544.   /api/v1/users/revoke-token:

  1545.     post:

  1546.       summary: Logout

  1547.       description: Revokes your access token and its associated refresh token, destroying your current session.

  1548.       operationId: revokeOAuthToken

  1549.       tags:

  1550.         - Session

  1551.       security:

  1552.         - OAuth2: []

  1553.       responses:

  1554.         '200':

  1555.           description: successful operation

  1556. 

  1557.   /api/v1/users/ask-send-verify-email:

  1558.     post:

  1559.       summary: Resend user verification link

  1560.       operationId: resendEmailToVerifyUser

  1561.       tags:

  1562.         - Users

  1563.         - Register

  1564.       requestBody:

  1565.         content:

  1566.           application/json:

  1567.             schema:

  1568.               type: object

  1569.               properties:

  1570.                 email:

  1571.                   type: string

  1572.                   description: User email

  1573.               required:

  1574.                 - email

  1575.       responses:

  1576.         '204':

  1577.           description: successful operation

  1578. 

  1579.   /api/v1/users/registrations/ask-send-verify-email:

  1580.     post:

  1581.       summary: Resend verification link to registration email

  1582.       operationId: resendEmailToVerifyRegistration

  1583.       tags:

  1584.         - Register

  1585.       requestBody:

  1586.         content:

  1587.           application/json:

  1588.             schema:

  1589.               type: object

  1590.               properties:

  1591.                 email:

  1592.                   type: string

  1593.                   description: Registration email

  1594.               required:

  1595.                 - email

  1596.       responses:

  1597.         '204':

  1598.           description: successful operation

  1599. 

  1600.   /api/v1/users/{id}/verify-email:

  1601.     post:

  1602.       summary: Verify a user

  1603.       operationId: verifyUser

  1604.       description: |

  1605.         Following a user registration, the new user will receive an email asking to click a link

  1606.         containing a secret.

  1607.         This endpoint can also be used to verify a new email set in the user account.

  1608.       tags:

  1609.         - Users

  1610.         - Register

  1611.       parameters:

  1612.         - $ref: '#/components/parameters/id'

  1613.       requestBody:

  1614.         content:

  1615.           application/json:

  1616.             schema:

  1617.               type: object

  1618.               properties:

  1619.                 verificationString:

  1620.                   type: string

  1621.                   format: url

  1622.                 isPendingEmail:

  1623.                   type: boolean

  1624.               required:

  1625.                 - verificationString

  1626.       responses:

  1627.         '204':

  1628.           description: successful operation

  1629.         '403':

  1630.           description: invalid verification string

  1631.         '404':

  1632.           description: user not found

  1633. 

  1634.   /api/v1/users/registrations/{registrationId}/verify-email:

  1635.     post:

  1636.       summary: Verify a registration email

  1637.       operationId: verifyRegistrationEmail

  1638.       description: |

  1639.         Following a user registration request, the user will receive an email asking to click a link

  1640.         containing a secret.

  1641.       tags:

  1642.         - Register

  1643.       parameters:

  1644.         - $ref: '#/components/parameters/registrationId'

  1645.       requestBody:

  1646.         content:

  1647.           application/json:

  1648.             schema:

  1649.               type: object

  1650.               properties:

  1651.                 verificationString:

  1652.                   type: string

  1653.                   format: url

  1654.               required:

  1655.                 - verificationString

  1656.       responses:

  1657.         '204':

  1658.           description: successful operation

  1659.         '403':

  1660.           description: invalid verification string

  1661.         '404':

  1662.           description: registration not found

  1663. 

  1664.   /api/v1/users/{id}/two-factor/request:

  1665.     post:

  1666.       summary: Request two factor auth

  1667.       operationId: requestTwoFactor

  1668.       description: Request two factor authentication for a user

  1669.       security:

  1670.         - OAuth2: []

  1671.       tags:

  1672.         - Users

  1673.       parameters:

  1674.         - $ref: '#/components/parameters/id'

  1675.       requestBody:

  1676.         content:

  1677.           application/json:

  1678.             schema:

  1679.               type: object

  1680.               properties:

  1681.                 currentPassword:

  1682.                   type: string

  1683.                   description: Password of the currently authenticated user

  1684.       responses:

  1685.         '200':

  1686.           description: successful operation

  1687.           content:

  1688.             application/json:

  1689.               schema:

  1690.                 type: array

  1691.                 items:

  1692.                   $ref: '#/components/schemas/RequestTwoFactorResponse'

  1693.         '403':

  1694.           description: invalid password

  1695.         '404':

  1696.           description: user not found

  1697. 

  1698.   /api/v1/users/{id}/two-factor/confirm-request:

  1699.     post:

  1700.       summary: Confirm two factor auth

  1701.       operationId: confirmTwoFactorRequest

  1702.       description: Confirm a two factor authentication request

  1703.       security:

  1704.         - OAuth2: []

  1705.       tags:

  1706.         - Users

  1707.       parameters:

  1708.         - $ref: '#/components/parameters/id'

  1709.       requestBody:

  1710.         content:

  1711.           application/json:

  1712.             schema:

  1713.               type: object

  1714.               properties:

  1715.                 requestToken:

  1716.                   type: string

  1717.                   description: Token to identify the two factor request

  1718.                 otpToken:

  1719.                   type: string

  1720.                   description: OTP token generated by the app

  1721.               required:

  1722.                 - requestToken

  1723.                 - otpToken

  1724.       responses:

  1725.         '204':

  1726.           description: successful operation

  1727.         '403':

  1728.           description: invalid request token or OTP token

  1729.         '404':

  1730.           description: user not found

  1731. 

  1732.   /api/v1/users/{id}/two-factor/disable:

  1733.     post:

  1734.       summary: Disable two factor auth

  1735.       operationId: disableTwoFactor

  1736.       description: Disable two factor authentication of a user

  1737.       security:

  1738.         - OAuth2: []

  1739.       tags:

  1740.         - Users

  1741.       parameters:

  1742.         - $ref: '#/components/parameters/id'

  1743.       requestBody:

  1744.         content:

  1745.           application/json:

  1746.             schema:

  1747.               type: object

  1748.               properties:

  1749.                 currentPassword:

  1750.                   type: string

  1751.                   description: Password of the currently authenticated user

  1752.       responses:

  1753.         '204':

  1754.           description: successful operation

  1755.         '403':

  1756.           description: invalid password

  1757.         '404':

  1758.           description: user not found

  1759. 

  1760.   /api/v1/users/{userId}/imports/import-resumable:

  1761.     post:

  1762.       summary: Initialize the resumable user import

  1763.       description: "**PeerTube >= 6.1** Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to initialize the import of the archive"

  1764.       operationId: userImportResumableInit

  1765.       security:

  1766.         - OAuth2: []

  1767.       tags:

  1768.         - User Imports

  1769.       parameters:

  1770.         - $ref: '#/components/parameters/resumableUploadInitContentLengthHeader'

  1771.         - $ref: '#/components/parameters/resumableUploadInitContentTypeHeader'

  1772.       requestBody:

  1773.         content:

  1774.           application/json:

  1775.             schema:

  1776.               $ref: '#/components/schemas/UserImportResumable'

  1777.       responses:

  1778.         '201':

  1779.           description: created

  1780.           headers:

  1781.             Location:

  1782.               schema:

  1783.                 type: string

  1784.                 format: url

  1785.             Content-Length:

  1786.               schema:

  1787.                 type: number

  1788.                 example: 0

  1789.     put:

  1790.       summary: Send chunk for the resumable user import

  1791.       description: "**PeerTube >= 6.1** Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to continue, pause or resume the import of the archive"

  1792.       operationId: userImportResumable

  1793.       security:

  1794.         - OAuth2: []

  1795.       tags:

  1796.         - User Imports

  1797.       parameters:

  1798.         - $ref: '#/components/parameters/resumableUploadId'

  1799.         - $ref: '#/components/parameters/resumableUploadChunkContentRangeHeader'

  1800.         - $ref: '#/components/parameters/resumableUploadChunkContentLengthHeader'

  1801.       requestBody:

  1802.         content:

  1803.           application/octet-stream:

  1804.             schema:

  1805.               type: string

  1806.               format: binary

  1807.       responses:

  1808.         '204':

  1809.           description: 'last chunk received: successful operation'

  1810.         '308':

  1811.           description: resume incomplete

  1812.           headers:

  1813.             Range:

  1814.               schema:

  1815.                 type: string

  1816.                 example: bytes=0-262143

  1817.             Content-Length:

  1818.               schema:

  1819.                 type: number

  1820.                 example: 0

  1821.     delete:

  1822.       summary: Cancel the resumable user import

  1823.       description: "**PeerTube >= 6.1** Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to cancel the resumable user import"

  1824.       operationId: userImportResumableCancel

  1825.       security:

  1826.         - OAuth2: []

  1827.       tags:

  1828.         - User Imports

  1829.       parameters:

  1830.         - $ref: '#/components/parameters/resumableUploadId'

  1831.         - name: Content-Length

  1832.           in: header

  1833.           required: true

  1834.           schema:

  1835.             type: number

  1836.             example: 0

  1837.       responses:

  1838.         '204':

  1839.           description: import cancelled

  1840.           headers:

  1841.             Content-Length:

  1842.               schema:

  1843.                 type: number

  1844.                 example: 0

  1845. 

  1846.   /api/v1/users/{userId}/imports/latest:

  1847.     get:

  1848.       summary: Get latest user import

  1849.       description: "**PeerTube >= 6.1**"

  1850.       operationId: getLatestUserImport

  1851.       security:

  1852.         - OAuth2: []

  1853.       tags:

  1854.         - User Imports

  1855.       parameters:

  1856.         - $ref: '#/components/parameters/userId'

  1857.       responses:

  1858.         '200':

  1859.           description: successful operation

  1860.           content:

  1861.             application/json:

  1862.               schema:

  1863.                 type: object

  1864.                 properties:

  1865.                   id:

  1866.                     type: integer

  1867.                   state:

  1868.                     type: object

  1869.                     properties:

  1870.                       id:

  1871.                         $ref: '#/components/schemas/UserImportState'

  1872.                       label:

  1873.                         type: string

  1874.                   createdAt:

  1875.                     type: string

  1876.                     format: date-time

  1877. 

  1878.   /api/v1/users/{userId}/exports/request:

  1879.     post:

  1880.       summary: Request user export

  1881.       operationId: requestUserExport

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

  1883.       security:

  1884.         - OAuth2: []

  1885.       tags:

  1886.         - User Exports

  1887.       parameters:

  1888.         - $ref: '#/components/parameters/userId'

  1889.       requestBody:

  1890.         content:

  1891.           application/json:

  1892.             schema:

  1893.               type: object

  1894.               properties:

  1895.                 withVideoFiles:

  1896.                   type: boolean

  1897.                   description: Whether to include video files in the archive

  1898.       responses:

  1899.         '200':

  1900.           description: successful operation

  1901.           content:

  1902.             application/json:

  1903.               schema:

  1904.                 type: object

  1905.                 properties:

  1906.                   export:

  1907.                     type: object

  1908.                     properties:

  1909.                       id:

  1910.                         type: integer

  1911. 

  1912.   /api/v1/users/{userId}/exports:

  1913.     get:

  1914.       summary: List user exports

  1915.       description: "**PeerTube >= 6.1**"

  1916.       operationId: listUserExports

  1917.       security:

  1918.         - OAuth2: []

  1919.       tags:

  1920.         - User Exports

  1921.       parameters:

  1922.         - $ref: '#/components/parameters/userId'

  1923.       responses:

  1924.         '200':

  1925.           description: successful operation

  1926.           content:

  1927.             application/json:

  1928.               schema:

  1929.                 type: object

  1930.                 properties:

  1931.                   id:

  1932.                     type: integer

  1933.                   state:

  1934.                     type: object

  1935.                     properties:

  1936.                       id:

  1937.                         $ref: '#/components/schemas/UserExportState'

  1938.                       label:

  1939.                         type: string

  1940.                   size:

  1941.                     type: integer

  1942.                     description: Size of the archive file in bytes

  1943.                   privateDownloadUrl:

  1944.                     type: string

  1945.                     description: This URL already contains the JWT token, so no additional authentication credentials are required

  1946.                   createdAt:

  1947.                     type: string

  1948.                     format: date-time

  1949.                   expiresOn:

  1950.                     type: string

  1951.                     format: date-time

  1952.   /api/v1/users/{userId}/exports/{id}:

  1953.     delete:

  1954.       summary: Delete a user export

  1955.       description: "**PeerTube >= 6.1**"

  1956.       operationId: deleteUserExport

  1957.       security:

  1958.         - OAuth2: []

  1959.       tags:

  1960.         - User Exports

  1961.       parameters:

  1962.         - $ref: '#/components/parameters/userId'

  1963.         - $ref: '#/components/parameters/id'

  1964.       responses:

  1965.         '204':

  1966.           description: successful operation

  1967. 

  1968.   /api/v1/users/me:

  1969.     get:

  1970.       summary: Get my user information

  1971.       operationId: getUserInfo

  1972.       security:

  1973.         - OAuth2:

  1974.           - user

  1975.       tags:

  1976.         - My User

  1977.       responses:

  1978.         '200':

  1979.           description: successful operation

  1980.           content:

  1981.             application/json:

  1982.               schema:

  1983.                 type: array

  1984.                 items:

  1985.                   $ref: '#/components/schemas/User'

  1986.     put:

  1987.       summary: Update my user information

  1988.       operationId: putUserInfo

  1989.       security:

  1990.         - OAuth2:

  1991.           - user

  1992.       tags:

  1993.         - My User

  1994.       responses:

  1995.         '204':

  1996.           description: successful operation

  1997.       requestBody:

  1998.         content:

  1999.           application/json:

  2000.             schema:

  2001.               $ref: '#/components/schemas/UpdateMe'

  2002.         required: true

  2003. 

  2004.   '/api/v1/users/me/videos/comments':

  2005.     get:

  2006.       summary: List comments on user's videos

  2007.       description: "**PeerTube >= 6.2**"

  2008.       security:

  2009.         - OAuth2: []

  2010.       tags:

  2011.         - Video Comments

  2012.       parameters:

  2013.         - $ref: '#/components/parameters/search'

  2014.         - $ref: '#/components/parameters/searchAccountForComments'

  2015.         - $ref: '#/components/parameters/searchVideoForComments'

  2016.         - $ref: '#/components/parameters/videoId'

  2017.         - $ref: '#/components/parameters/videoChannelId'

  2018.         - $ref: '#/components/parameters/autoTagOneOfComment'

  2019.         - $ref: '#/components/parameters/isHeldForReview'

  2020.       responses:

  2021.         '200':

  2022.           description: successful operation

  2023.           content:

  2024.             application/json:

  2025.               schema:

  2026.                 type: object

  2027.                 properties:

  2028.                   total:

  2029.                     type: integer

  2030.                     example: 1

  2031.                   data:

  2032.                     type: array

  2033.                     items:

  2034.                       $ref: '#/components/schemas/VideoCommentForOwnerOrAdmin'

  2035. 

  2036.   /api/v1/users/me/videos/imports:

  2037.     get:

  2038.       summary: Get video imports of my user

  2039.       security:

  2040.         - OAuth2:

  2041.           - user

  2042.       tags:

  2043.         - Videos

  2044.         - My User

  2045.       parameters:

  2046.         - $ref: '#/components/parameters/start'

  2047.         - $ref: '#/components/parameters/count'

  2048.         - $ref: '#/components/parameters/sort'

  2049.         -

  2050.           name: targetUrl

  2051.           in: query

  2052.           required: false

  2053.           description: Filter on import target URL

  2054.           schema:

  2055.             type: string

  2056.         -

  2057.           name: videoChannelSyncId

  2058.           in: query

  2059.           required: false

  2060.           description: Filter on imports created by a specific channel synchronization

  2061.           schema:

  2062.             type: number

  2063.         -

  2064.           name: search

  2065.           in: query

  2066.           required: false

  2067.           description: Search in video names

  2068.           schema:

  2069.             type: string

  2070.       responses:

  2071.         '200':

  2072.           description: successful operation

  2073.           content:

  2074.             application/json:

  2075.               schema:

  2076.                 $ref: '#/components/schemas/VideoImportsList'

  2077. 

  2078.   /api/v1/users/me/video-quota-used:

  2079.     get:

  2080.       summary: Get my user used quota

  2081.       security:

  2082.         - OAuth2:

  2083.           - user

  2084.       tags:

  2085.         - My User

  2086.       responses:

  2087.         '200':

  2088.           description: successful operation

  2089.           content:

  2090.             application/json:

  2091.               schema:

  2092.                 type: object

  2093.                 properties:

  2094.                   videoQuotaUsed:

  2095.                     type: number

  2096.                     description: The user video quota used so far in bytes

  2097.                     example: 16810141515

  2098.                   videoQuotaUsedDaily:

  2099.                     type: number

  2100.                     description: The user video quota used today in bytes

  2101.                     example: 1681014151

  2102. 

  2103.   '/api/v1/users/me/videos/{videoId}/rating':

  2104.     get:

  2105.       summary: Get rate of my user for a video

  2106.       security:

  2107.         - OAuth2: []

  2108.       tags:

  2109.         - My User

  2110.         - Video Rates

  2111.       parameters:

  2112.         - name: videoId

  2113.           in: path

  2114.           required: true

  2115.           description: The video id

  2116.           schema:

  2117.             $ref: '#/components/schemas/Video/properties/id'

  2118.       responses:

  2119.         '200':

  2120.           description: successful operation

  2121.           content:

  2122.             application/json:

  2123.               schema:

  2124.                 $ref: '#/components/schemas/GetMeVideoRating'

  2125. 

  2126.   /api/v1/users/me/videos:

  2127.     get:

  2128.       summary: List videos of my user

  2129.       security:

  2130.         - OAuth2:

  2131.           - user

  2132.       tags:

  2133.         - My User

  2134.         - Videos

  2135.       parameters:

  2136.         - $ref: '#/components/parameters/start'

  2137.         - $ref: '#/components/parameters/count'

  2138.         - $ref: '#/components/parameters/sort'

  2139.       responses:

  2140.         '200':

  2141.           description: successful operation

  2142.           content:

  2143.             application/json:

  2144.               schema:

  2145.                 $ref: '#/components/schemas/VideoListResponse'

  2146. 

  2147.   /api/v1/users/me/subscriptions:

  2148.     get:

  2149.       summary: Get my user subscriptions

  2150.       security:

  2151.         - OAuth2:

  2152.           - user

  2153.       tags:

  2154.         - My Subscriptions

  2155.       parameters:

  2156.         - $ref: '#/components/parameters/start'

  2157.         - $ref: '#/components/parameters/count'

  2158.         - $ref: '#/components/parameters/sort'

  2159.       responses:

  2160.         '200':

  2161.           description: successful operation

  2162.           content:

  2163.             application/json:

  2164.               schema:

  2165.                 $ref: '#/components/schemas/VideoChannelList'

  2166.     post:

  2167.       tags:

  2168.         - My Subscriptions

  2169.       summary: Add subscription to my user

  2170.       security:

  2171.         - OAuth2:

  2172.           - user

  2173.       requestBody:

  2174.         content:

  2175.           application/json:

  2176.             schema:

  2177.               type: object

  2178.               properties:

  2179.                 uri:

  2180.                   type: string

  2181.                   format: uri

  2182.                   description: uri of the video channels to subscribe to

  2183.               required:

  2184.                 - uri

  2185.             examples:

  2186.               default:

  2187.                 value:

  2188.                   uri: 008a0e54-375d-49d0-8379-143202e24152@video.lqdn.fr

  2189.       responses:

  2190.         '200':

  2191.           description: successful operation

  2192. 

  2193.   /api/v1/users/me/subscriptions/exist:

  2194.     get:

  2195.       summary: Get if subscriptions exist for my user

  2196.       security:

  2197.         - OAuth2:

  2198.           - user

  2199.       tags:

  2200.         - My Subscriptions

  2201.       parameters:

  2202.         - $ref: '#/components/parameters/subscriptionsUris'

  2203.       responses:

  2204.         '200':

  2205.           description: successful operation

  2206.           content:

  2207.             application/json:

  2208.               schema:

  2209.                 type: object

  2210. 

  2211.   /api/v1/users/me/subscriptions/videos:

  2212.     get:

  2213.       summary: List videos of subscriptions of my user

  2214.       security:

  2215.         - OAuth2:

  2216.           - user

  2217.       tags:

  2218.         - My Subscriptions

  2219.         - Videos

  2220.       parameters:

  2221.         - $ref: '#/components/parameters/categoryOneOf'

  2222.         - $ref: '#/components/parameters/isLive'

  2223.         - $ref: '#/components/parameters/tagsOneOf'

  2224.         - $ref: '#/components/parameters/tagsAllOf'

  2225.         - $ref: '#/components/parameters/licenceOneOf'

  2226.         - $ref: '#/components/parameters/languageOneOf'

  2227.         - $ref: '#/components/parameters/autoTagOneOfVideo'

  2228.         - $ref: '#/components/parameters/nsfw'

  2229.         - $ref: '#/components/parameters/isLocal'

  2230.         - $ref: '#/components/parameters/include'

  2231.         - $ref: '#/components/parameters/privacyOneOf'

  2232.         - $ref: '#/components/parameters/hasHLSFiles'

  2233.         - $ref: '#/components/parameters/hasWebVideoFiles'

  2234.         - $ref: '#/components/parameters/skipCount'

  2235.         - $ref: '#/components/parameters/start'

  2236.         - $ref: '#/components/parameters/count'

  2237.         - $ref: '#/components/parameters/videosSort'

  2238.         - $ref: '#/components/parameters/excludeAlreadyWatched'

  2239.       responses:

  2240.         '200':

  2241.           description: successful operation

  2242.           content:

  2243.             application/json:

  2244.               schema:

  2245.                 $ref: '#/components/schemas/VideoListResponse'

  2246. 

  2247.   '/api/v1/users/me/subscriptions/{subscriptionHandle}':

  2248.     get:

  2249.       summary: Get subscription of my user

  2250.       security:

  2251.         - OAuth2:

  2252.           - user

  2253.       tags:

  2254.         - My Subscriptions

  2255.       parameters:

  2256.         - $ref: '#/components/parameters/subscriptionHandle'

  2257.       responses:

  2258.         '200':

  2259.           description: successful operation

  2260.           content:

  2261.             application/json:

  2262.               schema:

  2263.                 $ref: '#/components/schemas/VideoChannel'

  2264.     delete:

  2265.       summary: Delete subscription of my user

  2266.       security:

  2267.         - OAuth2:

  2268.           - user

  2269.       tags:

  2270.         - My Subscriptions

  2271.       parameters:

  2272.         - $ref: '#/components/parameters/subscriptionHandle'

  2273.       responses:

  2274.         '200':

  2275.           description: successful operation

  2276. 

  2277.   /api/v1/users/me/notifications:

  2278.     get:

  2279.       summary: List my notifications

  2280.       security:

  2281.         - OAuth2: []

  2282.       tags:

  2283.         - My Notifications

  2284.       parameters:

  2285.         - name: unread

  2286.           in: query

  2287.           description: only list unread notifications

  2288.           schema:

  2289.             type: boolean

  2290.         - $ref: '#/components/parameters/start'

  2291.         - $ref: '#/components/parameters/count'

  2292.         - $ref: '#/components/parameters/sort'

  2293.       responses:

  2294.         '200':

  2295.           description: successful operation

  2296.           content:

  2297.             application/json:

  2298.               schema:

  2299.                 $ref: '#/components/schemas/NotificationListResponse'

  2300. 

  2301.   /api/v1/users/me/notifications/read:

  2302.     post:

  2303.       summary: Mark notifications as read by their id

  2304.       security:

  2305.         - OAuth2: []

  2306.       tags:

  2307.         - My Notifications

  2308.       requestBody:

  2309.         content:

  2310.           application/json:

  2311.             schema:

  2312.               type: object

  2313.               properties:

  2314.                 ids:

  2315.                   type: array

  2316.                   description: ids of the notifications to mark as read

  2317.                   items:

  2318.                     type: integer

  2319.               required:

  2320.                 - ids

  2321.       responses:

  2322.         '204':

  2323.           description: successful operation

  2324. 

  2325.   /api/v1/users/me/notifications/read-all:

  2326.     post:

  2327.       summary: Mark all my notification as read

  2328.       security:

  2329.         - OAuth2: []

  2330.       tags:

  2331.         - My Notifications

  2332.       responses:

  2333.         '204':

  2334.           description: successful operation

  2335. 

  2336.   /api/v1/users/me/notification-settings:

  2337.     put:

  2338.       summary: Update my notification settings

  2339.       security:

  2340.         - OAuth2: []

  2341.       tags:

  2342.         - My Notifications

  2343.       requestBody:

  2344.         content:

  2345.           application/json:

  2346.             schema:

  2347.               type: object

  2348.               properties:

  2349.                 newVideoFromSubscription:

  2350.                   $ref: '#/components/schemas/NotificationSettingValue'

  2351.                 newCommentOnMyVideo:

  2352.                   $ref: '#/components/schemas/NotificationSettingValue'

  2353.                 abuseAsModerator:

  2354.                   $ref: '#/components/schemas/NotificationSettingValue'

  2355.                 videoAutoBlacklistAsModerator:

  2356.                   $ref: '#/components/schemas/NotificationSettingValue'

  2357.                 blacklistOnMyVideo:

  2358.                   $ref: '#/components/schemas/NotificationSettingValue'

  2359.                 myVideoPublished:

  2360.                   $ref: '#/components/schemas/NotificationSettingValue'

  2361.                 myVideoImportFinished:

  2362.                   $ref: '#/components/schemas/NotificationSettingValue'

  2363.                 newFollow:

  2364.                   $ref: '#/components/schemas/NotificationSettingValue'

  2365.                 newUserRegistration:

  2366.                   $ref: '#/components/schemas/NotificationSettingValue'

  2367.                 commentMention:

  2368.                   $ref: '#/components/schemas/NotificationSettingValue'

  2369.                 newInstanceFollower:

  2370.                   $ref: '#/components/schemas/NotificationSettingValue'

  2371.                 autoInstanceFollowing:

  2372.                   $ref: '#/components/schemas/NotificationSettingValue'

  2373.       responses:

  2374.         '204':

  2375.           description: successful operation

  2376. 

  2377.   /api/v1/users/me/history/videos:

  2378.     get:

  2379.       summary: List watched videos history

  2380.       security:

  2381.         - OAuth2: []

  2382.       tags:

  2383.         - My History

  2384.       parameters:

  2385.         - $ref: '#/components/parameters/start'

  2386.         - $ref: '#/components/parameters/count'

  2387.         - $ref: '#/components/parameters/search'

  2388.       responses:

  2389.         '200':

  2390.           description: successful operation

  2391.           content:

  2392.             application/json:

  2393.               schema:

  2394.                 $ref: '#/components/schemas/VideoListResponse'

  2395. 

  2396.   /api/v1/users/me/history/videos/{videoId}:

  2397.     delete:

  2398.       summary: Delete history element

  2399.       security:

  2400.         - OAuth2: []

  2401.       tags:

  2402.         - My History

  2403.       parameters:

  2404.         - name: videoId

  2405.           in: path

  2406.           required: true

  2407.           schema:

  2408.             $ref: '#/components/schemas/Video/properties/id'

  2409.       responses:

  2410.         '204':

  2411.           description: successful operation

  2412. 

  2413.   /api/v1/users/me/history/videos/remove:

  2414.     post:

  2415.       summary: Clear video history

  2416.       security:

  2417.         - OAuth2: []

  2418.       tags:

  2419.         - My History

  2420.       requestBody:

  2421.         content:

  2422.           multipart/form-data:

  2423.             schema:

  2424.               type: object

  2425.               properties:

  2426.                 beforeDate:

  2427.                   description: history before this date will be deleted

  2428.                   type: string

  2429.                   format: date-time

  2430.       responses:

  2431.         '204':

  2432.           description: successful operation

  2433. 

  2434.   /api/v1/users/me/avatar/pick:

  2435.     post:

  2436.       summary: Update my user avatar

  2437.       security:

  2438.         - OAuth2: []

  2439.       tags:

  2440.         - My User

  2441.       responses:

  2442.         '200':

  2443.           description: successful operation

  2444.           content:

  2445.             application/json:

  2446.               schema:

  2447.                 type: object

  2448.                 properties:

  2449.                   avatars:

  2450.                     type: array

  2451.                     items:

  2452.                       $ref: '#/components/schemas/ActorImage'

  2453.         '413':

  2454.           description: image file too large

  2455.           headers:

  2456.             X-File-Maximum-Size:

  2457.               schema:

  2458.                 type: string

  2459.                 format: Nginx size

  2460.               description: Maximum file size for the avatar

  2461.       requestBody:

  2462.         content:

  2463.           multipart/form-data:

  2464.             schema:

  2465.               type: object

  2466.               properties:

  2467.                 avatarfile:

  2468.                   description: The file to upload

  2469.                   type: string

  2470.                   format: binary

  2471.             encoding:

  2472.               avatarfile:

  2473.                 contentType: image/png, image/jpeg

  2474. 

  2475.   /api/v1/users/me/avatar:

  2476.     delete:

  2477.       summary: Delete my avatar

  2478.       security:

  2479.         - OAuth2: []

  2480.       tags:

  2481.         - My User

  2482.       responses:

  2483.         '204':

  2484.           description: successful operation

  2485. 

  2486.   /api/v1/users/register:

  2487.     post:

  2488.       summary: Register a user

  2489.       operationId: registerUser

  2490.       description: Signup has to be enabled and signup approval is not required

  2491.       tags:

  2492.         - Register

  2493.       responses:

  2494.         '204':

  2495.           description: successful operation

  2496.         '400':

  2497.           description: request error

  2498.         '403':

  2499.           description: user registration is not enabled, user limit is reached, registration is not allowed for the ip, requires approval or blocked by a plugin

  2500.         '409':

  2501.           description: 'a user with this username, channel name or email already exists'

  2502.       requestBody:

  2503.         content:

  2504.           application/json:

  2505.             schema:

  2506.               $ref: '#/components/schemas/RegisterUser'

  2507.         required: true

  2508. 

  2509.   /api/v1/users/registrations/request:

  2510.     post:

  2511.       summary: Request registration

  2512.       description: Signup has to be enabled and require approval on the instance

  2513.       operationId: requestRegistration

  2514.       tags:

  2515.         - Register

  2516.       responses:

  2517.         '200':

  2518.           description: successful operation

  2519.           content:

  2520.             application/json:

  2521.               schema:

  2522.                 $ref: '#/components/schemas/UserRegistration'

  2523.         '400':

  2524.           description: request error or signup approval is not enabled on the instance

  2525.         '403':

  2526.           description: user registration is not enabled, user limit is reached, registration is not allowed for the ip or blocked by a plugin

  2527.         '409':

  2528.           description: 'a user or registration with this username, channel name or email already exists'

  2529.       requestBody:

  2530.         content:

  2531.           application/json:

  2532.             schema:

  2533.               $ref: '#/components/schemas/UserRegistrationRequest'

  2534. 

  2535.   /api/v1/users/registrations/{registrationId}/accept:

  2536.     post:

  2537.       security:

  2538.         - OAuth2:

  2539.           - admin

  2540.           - moderator

  2541.       summary: Accept registration

  2542.       operationId: acceptRegistration

  2543.       tags:

  2544.         - Register

  2545.       parameters:

  2546.         - $ref: '#/components/parameters/registrationId'

  2547.       requestBody:

  2548.         content:

  2549.           application/json:

  2550.             schema:

  2551.               $ref: '#/components/schemas/UserRegistrationAcceptOrReject'

  2552.       responses:

  2553.         '204':

  2554.           description: successful operation

  2555. 

  2556.   /api/v1/users/registrations/{registrationId}/reject:

  2557.     post:

  2558.       security:

  2559.         - OAuth2:

  2560.           - admin

  2561.           - moderator

  2562.       summary: Reject registration

  2563.       operationId: rejectRegistration

  2564.       tags:

  2565.         - Register

  2566.       parameters:

  2567.         - $ref: '#/components/parameters/registrationId'

  2568.       requestBody:

  2569.         content:

  2570.           application/json:

  2571.             schema:

  2572.               $ref: '#/components/schemas/UserRegistrationAcceptOrReject'

  2573.       responses:

  2574.         '204':

  2575.           description: successful operation

  2576. 

  2577.   /api/v1/users/registrations/{registrationId}:

  2578.     delete:

  2579.       security:

  2580.         - OAuth2:

  2581.           - admin

  2582.           - moderator

  2583.       summary: Delete registration

  2584.       description: 'Delete the registration entry. It will not remove the user associated with this registration (if any)'

  2585.       operationId: deleteRegistration

  2586.       tags:

  2587.         - Register

  2588.       parameters:

  2589.         - $ref: '#/components/parameters/registrationId'

  2590.       responses:

  2591.         '204':

  2592.           description: successful operation

  2593. 

  2594.   /api/v1/users/registrations:

  2595.     get:

  2596.       security:

  2597.         - OAuth2:

  2598.           - admin

  2599.           - moderator

  2600.       summary: List registrations

  2601.       operationId: listRegistrations

  2602.       tags:

  2603.         - Register

  2604.       parameters:

  2605.         - $ref: '#/components/parameters/start'

  2606.         - $ref: '#/components/parameters/count'

  2607.         - name: search

  2608.           in: query

  2609.           required: false

  2610.           schema:

  2611.             type: string

  2612.         - name: sort

  2613.           in: query

  2614.           required: false

  2615.           schema:

  2616.             type: string

  2617.             enum:

  2618.             - -createdAt

  2619.             - createdAt

  2620.             - state

  2621.             - -state

  2622.       responses:

  2623.         '200':

  2624.           description: successful operation

  2625.           content:

  2626.             application/json:

  2627.               schema:

  2628.                 type: object

  2629.                 properties:

  2630.                   total:

  2631.                     type: integer

  2632.                     example: 1

  2633.                   data:

  2634.                     type: array

  2635.                     items:

  2636.                       $ref: '#/components/schemas/UserRegistration'

  2637. 

  2638.   /api/v1/videos/ownership:

  2639.     get:

  2640.       summary: List video ownership changes

  2641.       tags:

  2642.         - Video Ownership Change

  2643.       security:

  2644.         - OAuth2: []

  2645.       responses:

  2646.         '200':

  2647.           description: successful operation

  2648. 

  2649.   '/api/v1/videos/ownership/{id}/accept':

  2650.     post:

  2651.       summary: Accept ownership change request

  2652.       tags:

  2653.         - Video Ownership Change

  2654.       security:

  2655.         - OAuth2: []

  2656.       parameters:

  2657.         - $ref: '#/components/parameters/idOrUUID'

  2658.       responses:

  2659.         '204':

  2660.           description: successful operation

  2661.         '403':

  2662.           description: cannot terminate an ownership change of another user

  2663.         '404':

  2664.           description: video ownership change not found

  2665. 

  2666.   '/api/v1/videos/ownership/{id}/refuse':

  2667.     post:

  2668.       summary: Refuse ownership change request

  2669.       tags:

  2670.         - Video Ownership Change

  2671.       security:

  2672.         - OAuth2: []

  2673.       parameters:

  2674.         - $ref: '#/components/parameters/idOrUUID'

  2675.       responses:

  2676.         '204':

  2677.           description: successful operation

  2678.         '403':

  2679.           description: cannot terminate an ownership change of another user

  2680.         '404':

  2681.           description: video ownership change not found

  2682. 

  2683.   '/api/v1/videos/{id}/give-ownership':

  2684.     post:

  2685.       summary: Request ownership change

  2686.       tags:

  2687.         - Video Ownership Change

  2688.       security:

  2689.         - OAuth2: []

  2690.       parameters:

  2691.         - $ref: '#/components/parameters/idOrUUID'

  2692.       requestBody:

  2693.         required: true

  2694.         content:

  2695.           application/x-www-form-urlencoded:

  2696.             schema:

  2697.               type: object

  2698.               properties:

  2699.                 username:

  2700.                   type: string

  2701.               required:

  2702.                 - username

  2703.       responses:

  2704.         '204':

  2705.           description: successful operation

  2706.         '400':

  2707.           description: changing video ownership to a remote account is not supported yet

  2708.         '404':

  2709.           description: video not found

  2710. 

  2711.   '/api/v1/videos/{id}/token':

  2712.     post:

  2713.       summary: Request video token

  2714.       operationId: requestVideoToken

  2715.       description: Request special tokens that expire quickly to use them in some context (like accessing private static files)

  2716.       tags:

  2717.         - Video

  2718.       security:

  2719.         - OAuth2: []

  2720.       parameters:

  2721.         - $ref: '#/components/parameters/idOrUUID'

  2722.         - $ref: '#/components/parameters/videoPasswordHeader'

  2723.       responses:

  2724.         '200':

  2725.           description: successful operation

  2726.           content:

  2727.             application/json:

  2728.               schema:

  2729.                 $ref: '#/components/schemas/VideoTokenResponse'

  2730.         '400':

  2731.           description: incorrect parameters

  2732.         '404':

  2733.           description: video not found

  2734. 

  2735.   /api/v1/videos/{id}/studio/edit:

  2736.     post:

  2737.       summary: Create a studio task

  2738.       tags:

  2739.         - Video Transcoding

  2740.         - Video

  2741.       description: Create a task to edit a video  (cut, add intro/outro etc)

  2742.       security:

  2743.         - OAuth2: []

  2744.       parameters:

  2745.         - $ref: '#/components/parameters/idOrUUID'

  2746.       requestBody:

  2747.         required: true

  2748.         content:

  2749.           application/x-www-form-urlencoded:

  2750.             schema:

  2751.               $ref: '#/components/schemas/VideoStudioCreateTask'

  2752.       responses:

  2753.         '204':

  2754.           description: successful operation

  2755.         '400':

  2756.           description: incorrect parameters

  2757.         '404':

  2758.           description: video not found

  2759. 

  2760.   /api/v1/videos:

  2761.     get:

  2762.       summary: List videos

  2763.       operationId: getVideos

  2764.       tags:

  2765.         - Video

  2766.       parameters:

  2767.         - $ref: '#/components/parameters/categoryOneOf'

  2768.         - $ref: '#/components/parameters/isLive'

  2769.         - $ref: '#/components/parameters/tagsOneOf'

  2770.         - $ref: '#/components/parameters/tagsAllOf'

  2771.         - $ref: '#/components/parameters/licenceOneOf'

  2772.         - $ref: '#/components/parameters/languageOneOf'

  2773.         - $ref: '#/components/parameters/autoTagOneOfVideo'

  2774.         - $ref: '#/components/parameters/nsfw'

  2775.         - $ref: '#/components/parameters/isLocal'

  2776.         - $ref: '#/components/parameters/include'

  2777.         - $ref: '#/components/parameters/privacyOneOf'

  2778.         - $ref: '#/components/parameters/hasHLSFiles'

  2779.         - $ref: '#/components/parameters/hasWebVideoFiles'

  2780.         - $ref: '#/components/parameters/skipCount'

  2781.         - $ref: '#/components/parameters/start'

  2782.         - $ref: '#/components/parameters/count'

  2783.         - $ref: '#/components/parameters/videosSort'

  2784.         - $ref: '#/components/parameters/excludeAlreadyWatched'

  2785.       responses:

  2786.         '200':

  2787.           description: successful operation

  2788.           content:

  2789.             application/json:

  2790.               schema:

  2791.                 $ref: '#/components/schemas/VideoListResponse'

  2792. 

  2793.   /api/v1/videos/categories:

  2794.     get:

  2795.       summary: List available video categories

  2796.       operationId: getCategories

  2797.       tags:

  2798.         - Video

  2799.       responses:

  2800.         '200':

  2801.           description: successful operation

  2802.           content:

  2803.             application/json:

  2804.               schema:

  2805.                 type: array

  2806.                 items:

  2807.                   type: string

  2808.               examples:

  2809.                 nightly:

  2810.                   externalValue: https://peertube2.cpy.re/api/v1/videos/categories

  2811. 

  2812.   /api/v1/videos/licences:

  2813.     get:

  2814.       summary: List available video licences

  2815.       operationId: getLicences

  2816.       tags:

  2817.         - Video

  2818.       responses:

  2819.         '200':

  2820.           description: successful operation

  2821.           content:

  2822.             application/json:

  2823.               schema:

  2824.                 type: array

  2825.                 items:

  2826.                   type: string

  2827.               examples:

  2828.                 nightly:

  2829.                   externalValue: https://peertube2.cpy.re/api/v1/videos/licences

  2830. 

  2831.   /api/v1/videos/languages:

  2832.     get:

  2833.       summary: List available video languages

  2834.       operationId: getLanguages

  2835.       tags:

  2836.         - Video

  2837.       responses:

  2838.         '200':

  2839.           description: successful operation

  2840.           content:

  2841.             application/json:

  2842.               schema:

  2843.                 type: array

  2844.                 items:

  2845.                   type: string

  2846.               examples:

  2847.                 nightly:

  2848.                   externalValue: https://peertube2.cpy.re/api/v1/videos/languages

  2849. 

  2850.   /api/v1/videos/privacies:

  2851.     get:

  2852.       summary: List available video privacy policies

  2853.       operationId: getVideoPrivacyPolicies

  2854.       tags:

  2855.         - Video

  2856.       responses:

  2857.         '200':

  2858.           description: successful operation

  2859.           content:

  2860.             application/json:

  2861.               schema:

  2862.                 type: array

  2863.                 items:

  2864.                   type: string

  2865.               examples:

  2866.                 nightly:

  2867.                   externalValue: https://peertube2.cpy.re/api/v1/videos/privacies

  2868. 

  2869.   '/api/v1/videos/{id}':

  2870.     put:

  2871.       summary: Update a video

  2872.       operationId: putVideo

  2873.       security:

  2874.         - OAuth2: []

  2875.       tags:

  2876.         - Video

  2877.       parameters:

  2878.         - $ref: '#/components/parameters/idOrUUID'

  2879.       responses:

  2880.         '204':

  2881.           description: successful operation

  2882.       requestBody:

  2883.         content:

  2884.           multipart/form-data:

  2885.             schema:

  2886.               type: object

  2887.               properties:

  2888.                 thumbnailfile:

  2889.                   description: Video thumbnail file

  2890.                   type: string

  2891.                   format: binary

  2892.                 previewfile:

  2893.                   description: Video preview file

  2894.                   type: string

  2895.                   format: binary

  2896.                 category:

  2897.                   $ref: '#/components/schemas/VideoCategorySet'

  2898.                 licence:

  2899.                   $ref: '#/components/schemas/VideoLicenceSet'

  2900.                 language:

  2901.                   $ref: '#/components/schemas/VideoLanguageSet'

  2902.                 privacy:

  2903.                   $ref: '#/components/schemas/VideoPrivacySet'

  2904.                 description:

  2905.                   description: Video description

  2906.                   type: string

  2907.                 waitTranscoding:

  2908.                   description: Whether or not we wait transcoding before publish the video

  2909.                   type: string

  2910.                 support:

  2911.                   description: A text tell the audience how to support the video creator

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

  2913.                   type: string

  2914.                 nsfw:

  2915.                   description: Whether or not this video contains sensitive content

  2916.                   type: boolean

  2917.                 name:

  2918.                   description: Video name

  2919.                   type: string

  2920.                   minLength: 3

  2921.                   maxLength: 120

  2922.                 tags:

  2923.                   description: Video tags (maximum 5 tags each between 2 and 30 characters)

  2924.                   type: array

  2925.                   minItems: 1

  2926.                   maxItems: 5

  2927.                   items:

  2928.                     type: string

  2929.                     minLength: 2

  2930.                     maxLength: 30

  2931.                 commentsEnabled:

  2932.                   deprecated: true

  2933.                   description: 'Deprecated in 6.2, use commentsPolicy instead'

  2934.                   type: boolean

  2935.                 commentsPolicy:

  2936.                   $ref: '#/components/schemas/VideoCommentsPolicySet'

  2937.                 downloadEnabled:

  2938.                   description: Enable or disable downloading for this video

  2939.                   type: boolean

  2940.                 originallyPublishedAt:

  2941.                   description: Date when the content was originally published

  2942.                   type: string

  2943.                   format: date-time

  2944.                   nullable: true

  2945.                 scheduleUpdate:

  2946.                   $ref: '#/components/schemas/VideoScheduledUpdate'

  2947.                 videoPasswords:

  2948.                   $ref: '#/components/schemas/AddVideoPasswords'

  2949.             encoding:

  2950.               thumbnailfile:

  2951.                 contentType: image/jpeg

  2952.               previewfile:

  2953.                 contentType: image/jpeg

  2954.     get:

  2955.       summary: Get a video

  2956.       operationId: getVideo

  2957.       tags:

  2958.         - Video

  2959.       parameters:

  2960.         - $ref: '#/components/parameters/idOrUUID'

  2961.         - $ref: '#/components/parameters/videoPasswordHeader'

  2962.       responses:

  2963.         '200':

  2964.           description: successful operation

  2965.           content:

  2966.             application/json:

  2967.               schema:

  2968.                 $ref: '#/components/schemas/VideoDetails'

  2969.         '403':

  2970.           description: provide a correct password to access this password protected video

  2971.     delete:

  2972.       summary: Delete a video

  2973.       operationId: delVideo

  2974.       security:

  2975.         - OAuth2: []

  2976.       tags:

  2977.         - Video

  2978.       parameters:

  2979.         - $ref: '#/components/parameters/idOrUUID'

  2980.       responses:

  2981.         '204':

  2982.           description: successful operation

  2983. 

  2984.   '/api/v1/videos/{id}/description':

  2985.     get:

  2986.       summary: Get complete video description

  2987.       operationId: getVideoDesc

  2988.       tags:

  2989.         - Video

  2990.       parameters:

  2991.         - $ref: '#/components/parameters/idOrUUID'

  2992.         - $ref: '#/components/parameters/videoPasswordHeader'

  2993.       responses:

  2994.         '200':

  2995.           description: successful operation

  2996.           content:

  2997.             application/json:

  2998.               schema:

  2999.                 nullable: true

  3000.                 type: string

  3001.                 minLength: 3

  3002.                 maxLength: 10000

  3003.                 example: |

  3004.                   **[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\r\n\r\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**

  3005. 

  3006.   '/api/v1/videos/{id}/views':

  3007.     post:

  3008.       summary: Notify user is watching a video

  3009.       description: 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.

  3010.       operationId: addView

  3011.       tags:

  3012.         - Video

  3013.       parameters:

  3014.         - $ref: '#/components/parameters/idOrUUID'

  3015.       requestBody:

  3016.         content:

  3017.           application/json:

  3018.             schema:

  3019.               $ref: '#/components/schemas/UserViewingVideo'

  3020.         required: true

  3021.       responses:

  3022.         '204':

  3023.           description: successful operation

  3024. 

  3025.   '/api/v1/videos/{id}/watching':

  3026.     put:

  3027.       summary: Set watching progress of a video

  3028.       deprecated: true

  3029.       description: This endpoint has been deprecated. Use `/videos/{id}/views` instead

  3030.       tags:

  3031.         - Video

  3032.       security:

  3033.         - OAuth2: []

  3034.       parameters:

  3035.         - $ref: '#/components/parameters/idOrUUID'

  3036.       requestBody:

  3037.         content:

  3038.           application/json:

  3039.             schema:

  3040.               $ref: '#/components/schemas/UserViewingVideo'

  3041.         required: true

  3042.       responses:

  3043.         '204':

  3044.           description: successful operation

  3045. 

  3046.   '/api/v1/videos/{id}/stats/overall':

  3047.     get:

  3048.       summary: Get overall stats of a video

  3049.       tags:

  3050.         - Video Stats

  3051.       security:

  3052.         - OAuth2: []

  3053.       parameters:

  3054.         - $ref: '#/components/parameters/idOrUUID'

  3055.         - name: startDate

  3056.           in: query

  3057.           description: Filter stats by start date

  3058.           schema:

  3059.             type: string

  3060.             format: date-time

  3061.         - name: endDate

  3062.           in: query

  3063.           description: Filter stats by end date

  3064.           schema:

  3065.             type: string

  3066.             format: date-time

  3067.       responses:

  3068.         '200':

  3069.           description: successful operation

  3070.           content:

  3071.             application/json:

  3072.               schema:

  3073.                 $ref: '#/components/schemas/VideoStatsOverall'

  3074. 

  3075.   '/api/v1/videos/{id}/stats/retention':

  3076.     get:

  3077.       summary: Get retention stats of a video

  3078.       tags:

  3079.         - Video Stats

  3080.       security:

  3081.         - OAuth2: []

  3082.       parameters:

  3083.         - $ref: '#/components/parameters/idOrUUID'

  3084.       responses:

  3085.         '200':

  3086.           description: successful operation

  3087.           content:

  3088.             application/json:

  3089.               schema:

  3090.                 $ref: '#/components/schemas/VideoStatsRetention'

  3091. 

  3092.   '/api/v1/videos/{id}/stats/timeseries/{metric}':

  3093.     get:

  3094.       summary: Get timeserie stats of a video

  3095.       tags:

  3096.         - Video Stats

  3097.       security:

  3098.         - OAuth2: []

  3099.       parameters:

  3100.         - $ref: '#/components/parameters/idOrUUID'

  3101.         -

  3102.           name: metric

  3103.           in: path

  3104.           required: true

  3105.           description: The metric to get

  3106.           schema:

  3107.             type: string

  3108.             enum:

  3109.               - 'viewers'

  3110.               - 'aggregateWatchTime'

  3111.         - name: startDate

  3112.           in: query

  3113.           description: Filter stats by start date

  3114.           schema:

  3115.             type: string

  3116.             format: date-time

  3117.         - name: endDate

  3118.           in: query

  3119.           description: Filter stats by end date

  3120.           schema:

  3121.             type: string

  3122.             format: date-time

  3123.       responses:

  3124.         '200':

  3125.           description: successful operation

  3126.           content:

  3127.             application/json:

  3128.               schema:

  3129.                 $ref: '#/components/schemas/VideoStatsTimeserie'

  3130. 

  3131.   /api/v1/videos/upload:

  3132.     post:

  3133.       summary: Upload a video

  3134.       description: Uses a single request to upload a video.

  3135.       operationId: uploadLegacy

  3136.       security:

  3137.         - OAuth2: []

  3138.       tags:

  3139.         - Video

  3140.         - Video Upload

  3141.       responses:

  3142.         '200':

  3143.           description: successful operation

  3144.           content:

  3145.             application/json:

  3146.               schema:

  3147.                 $ref: '#/components/schemas/VideoUploadResponse'

  3148.         '403':

  3149.           description: video didn't pass upload filter

  3150.         '408':

  3151.           description: upload has timed out

  3152.         '413':

  3153.           x-summary: video file too large, due to quota or max body size limit set by the reverse-proxy

  3154.           description: |

  3155.             If the response has no body, it means the reverse-proxy didn't let it through. Otherwise disambiguate via `code`:

  3156.             - `quota_reached` for quota limits whether daily or global

  3157.           headers:

  3158.             X-File-Maximum-Size:

  3159.               schema:

  3160.                 type: string

  3161.                 format: Nginx size

  3162.               description: Maximum file size for the video

  3163.         '415':

  3164.           description: video type unsupported

  3165.         '422':

  3166.           description: video unreadable

  3167.       requestBody:

  3168.         content:

  3169.           multipart/form-data:

  3170.             schema:

  3171.               $ref: '#/components/schemas/VideoUploadRequestLegacy'

  3172.             encoding:

  3173.               videofile:

  3174.                 contentType: video/mp4, video/webm, video/ogg, video/avi, video/quicktime, video/x-msvideo, video/x-flv, video/x-matroska, application/octet-stream

  3175.               thumbnailfile:

  3176.                 contentType: image/jpeg

  3177.               previewfile:

  3178.                 contentType: image/jpeg

  3179.       x-codeSamples:

  3180.         - lang: Shell

  3181.           source: |

  3182.             ## DEPENDENCIES: jq

  3183.             USERNAME="<your_username>"

  3184.             PASSWORD="<your_password>"

  3185.             FILE_PATH="<your_file_path>"

  3186.             CHANNEL_ID="<your_channel_id>"

  3187.             NAME="<video_name>"

  3188.             API="https://peertube2.cpy.re/api/v1"

  3189. 

  3190.             ## AUTH

  3191.             client_id=$(curl -s "$API/oauth-clients/local" | jq -r ".client_id")

  3192.             client_secret=$(curl -s "$API/oauth-clients/local" | jq -r ".client_secret")

  3193.             token=$(curl -s "$API/users/token" \

  3194.               --data client_id="$client_id" \

  3195.               --data client_secret="$client_secret" \

  3196.               --data grant_type=password \

  3197.               --data username="$USERNAME" \

  3198.               --data password="$PASSWORD" \

  3199.               | jq -r ".access_token")

  3200. 

  3201.             ## VIDEO UPLOAD

  3202.             curl -s "$API/videos/upload" \

  3203.               -H "Authorization: Bearer $token" \

  3204.               --max-time 600 \

  3205.               --form videofile=@"$FILE_PATH" \

  3206.               --form channelId=$CHANNEL_ID \

  3207.               --form name="$NAME"

  3208. 

  3209.   /api/v1/videos/upload-resumable:

  3210.     post:

  3211.       summary: Initialize the resumable upload of a video

  3212.       description: Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to initialize the upload of a video

  3213.       operationId: uploadResumableInit

  3214.       security:

  3215.         - OAuth2: []

  3216.       tags:

  3217.         - Video

  3218.         - Video Upload

  3219.       parameters:

  3220.         - $ref: '#/components/parameters/resumableUploadInitContentLengthHeader'

  3221.         - $ref: '#/components/parameters/resumableUploadInitContentTypeHeader'

  3222.       requestBody:

  3223.         content:

  3224.           application/json:

  3225.             schema:

  3226.               $ref: '#/components/schemas/VideoUploadRequestResumable'

  3227.       responses:

  3228.         '200':

  3229.           description: file already exists, send a [`resume`](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) request instead

  3230.         '201':

  3231.           description: created

  3232.           headers:

  3233.             Location:

  3234.               schema:

  3235.                 type: string

  3236.                 format: url

  3237.                 example: /api/v1/videos/upload-resumable?upload_id=471e97554f21dec3b8bb5d4602939c51

  3238.             Content-Length:

  3239.               schema:

  3240.                 type: number

  3241.                 example: 0

  3242.         '413':

  3243.           x-summary: video file too large, due to quota, absolute max file size or concurrent partial upload limit

  3244.           description: |

  3245.             Disambiguate via `code`:

  3246.             - `max_file_size_reached` for the absolute file size limit

  3247.             - `quota_reached` for quota limits whether daily or global

  3248.         '415':

  3249.           description: video type unsupported

  3250.     put:

  3251.       summary: Send chunk for the resumable upload of a video

  3252.       description: Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to continue, pause or resume the upload of a video

  3253.       operationId: uploadResumable

  3254.       security:

  3255.         - OAuth2: []

  3256.       tags:

  3257.         - Video

  3258.         - Video Upload

  3259.       parameters:

  3260.         - $ref: '#/components/parameters/resumableUploadId'

  3261.         - $ref: '#/components/parameters/resumableUploadChunkContentRangeHeader'

  3262.         - $ref: '#/components/parameters/resumableUploadChunkContentLengthHeader'

  3263.       requestBody:

  3264.         content:

  3265.           application/octet-stream:

  3266.             schema:

  3267.               type: string

  3268.               format: binary

  3269.       responses:

  3270.         '200':

  3271.           description: last chunk received

  3272.           headers:

  3273.             Content-Length:

  3274.               schema:

  3275.                 type: number

  3276.           content:

  3277.             application/json:

  3278.               schema:

  3279.                 $ref: '#/components/schemas/VideoUploadResponse'

  3280.         '308':

  3281.           description: resume incomplete

  3282.           headers:

  3283.             Range:

  3284.               schema:

  3285.                 type: string

  3286.                 example: bytes=0-262143

  3287.             Content-Length:

  3288.               schema:

  3289.                 type: number

  3290.                 example: 0

  3291.         '403':

  3292.           description: video didn't pass upload filter

  3293.         '404':

  3294.           description: upload not found

  3295.         '409':

  3296.           description: chunk doesn't match range

  3297.         '422':

  3298.           description: video unreadable

  3299.         '429':

  3300.           description: too many concurrent requests

  3301.         '503':

  3302.           description: upload is already being processed

  3303.           headers:

  3304.             'Retry-After':

  3305.               schema:

  3306.                 type: number

  3307.                 example: 300

  3308.     delete:

  3309.       summary: Cancel the resumable upload of a video, deleting any data uploaded so far

  3310.       description: Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to cancel the upload of a video

  3311.       operationId: uploadResumableCancel

  3312.       security:

  3313.         - OAuth2: []

  3314.       tags:

  3315.         - Video

  3316.         - Video Upload

  3317.       parameters:

  3318.         - $ref: '#/components/parameters/resumableUploadId'

  3319.         - name: Content-Length

  3320.           in: header

  3321.           required: true

  3322.           schema:

  3323.             type: number

  3324.             example: 0

  3325.       responses:

  3326.         '204':

  3327.           description: upload cancelled

  3328.           headers:

  3329.             Content-Length:

  3330.               schema:

  3331.                 type: number

  3332.                 example: 0

  3333.         '404':

  3334.           description: upload not found

  3335. 

  3336.   /api/v1/videos/imports:

  3337.     post:

  3338.       summary: Import a video

  3339.       description: Import a torrent or magnetURI or HTTP resource (if enabled by the instance administrator)

  3340.       operationId: importVideo

  3341.       security:

  3342.         - OAuth2: []

  3343.       tags:

  3344.         - Video Imports

  3345.         - Video Upload

  3346.       requestBody:

  3347.         content:

  3348.           multipart/form-data:

  3349.             schema:

  3350.               $ref: '#/components/schemas/VideoCreateImport'

  3351.             encoding:

  3352.               torrentfile:

  3353.                 contentType: application/x-bittorrent

  3354.               thumbnailfile:

  3355.                 contentType: image/jpeg

  3356.               previewfile:

  3357.                 contentType: image/jpeg

  3358.       responses:

  3359.         '200':

  3360.           description: successful operation

  3361.           content:

  3362.             application/json:

  3363.               schema:

  3364.                 $ref: '#/components/schemas/VideoUploadResponse'

  3365.         '400':

  3366.           description: '`magnetUri` or `targetUrl` or a torrent file missing'

  3367.         '403':

  3368.           description: video didn't pass pre-import filter

  3369.         '409':

  3370.           description: HTTP or Torrent/magnetURI import not enabled

  3371. 

  3372.   /api/v1/videos/imports/{id}/cancel:

  3373.     post:

  3374.       summary: Cancel video import

  3375.       description: Cancel a pending video import

  3376.       security:

  3377.         - OAuth2: []

  3378.       tags:

  3379.         - Video Imports

  3380.       parameters:

  3381.         - $ref: '#/components/parameters/id'

  3382.       responses:

  3383.         '204':

  3384.           description: successful operation

  3385. 

  3386.   /api/v1/videos/imports/{id}:

  3387.     delete:

  3388.       summary: Delete video import

  3389.       description: Delete ended video import

  3390.       security:

  3391.         - OAuth2: []

  3392.       tags:

  3393.         - Video Imports

  3394.       parameters:

  3395.         - $ref: '#/components/parameters/id'

  3396.       responses:

  3397.         '204':

  3398.           description: successful operation

  3399. 

  3400.   /api/v1/videos/live:

  3401.     post:

  3402.       summary: Create a live

  3403.       operationId: addLive

  3404.       security:

  3405.         - OAuth2: []

  3406.       tags:

  3407.         - Live Videos

  3408.         - Video

  3409.       responses:

  3410.         '200':

  3411.           description: successful operation

  3412.           content:

  3413.             application/json:

  3414.               schema:

  3415.                 $ref: '#/components/schemas/VideoUploadResponse'

  3416.         '400':

  3417.           x-summary: validation error, or conflicting `saveReplay` and `permanentLive` parameter set

  3418.           description: |

  3419.             Disambiguate via `code`:

  3420.             - default type for a validation error

  3421.             - `live_conflicting_permanent_and_save_replay` for conflicting parameters set

  3422.         '403':

  3423.           x-summary: live is not enabled, allow replay is not enabled, or max instance/user live videos limit is exceeded

  3424.           description: |

  3425.             Disambiguate via `code`:

  3426.             - `live_not_enabled` for a disabled live feature

  3427.             - `live_not_allowing_replay` for a disabled replay feature

  3428.             - `max_instance_lives_limit_reached` for the absolute concurrent live limit

  3429.             - `max_user_lives_limit_reached` for the user concurrent live limit

  3430.       requestBody:

  3431.         content:

  3432.           multipart/form-data:

  3433.             schema:

  3434.               type: object

  3435.               properties:

  3436.                 channelId:

  3437.                   description: Channel id that will contain this live video

  3438.                   type: integer

  3439.                 saveReplay:

  3440.                   type: boolean

  3441.                 replaySettings:

  3442.                   $ref: '#/components/schemas/LiveVideoReplaySettings'

  3443.                 permanentLive:

  3444.                   description: User can stream multiple times in a permanent live

  3445.                   type: boolean

  3446.                 latencyMode:

  3447.                   description: User can select live latency mode if enabled by the instance

  3448.                   $ref: '#/components/schemas/LiveVideoLatencyMode'

  3449.                 thumbnailfile:

  3450.                   description: Live video/replay thumbnail file

  3451.                   type: string

  3452.                   format: binary

  3453.                 previewfile:

  3454.                   description: Live video/replay preview file

  3455.                   type: string

  3456.                   format: binary

  3457.                 privacy:

  3458.                   $ref: '#/components/schemas/VideoPrivacySet'

  3459.                 category:

  3460.                   $ref: '#/components/schemas/VideoCategorySet'

  3461.                 licence:

  3462.                   $ref: '#/components/schemas/VideoLicenceSet'

  3463.                 language:

  3464.                   $ref: '#/components/schemas/VideoLanguageSet'

  3465.                 description:

  3466.                   description: Live video/replay description

  3467.                   type: string

  3468.                 support:

  3469.                   description: A text tell the audience how to support the creator

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

  3471.                   type: string

  3472.                 nsfw:

  3473.                   description: Whether or not this live video/replay contains sensitive content

  3474.                   type: boolean

  3475.                 name:

  3476.                   description: Live video/replay name

  3477.                   type: string

  3478.                   minLength: 3

  3479.                   maxLength: 120

  3480.                 tags:

  3481.                   description: Live video/replay tags (maximum 5 tags each between 2 and 30 characters)

  3482.                   type: array

  3483.                   minItems: 1

  3484.                   maxItems: 5

  3485.                   items:

  3486.                     type: string

  3487.                     minLength: 2

  3488.                     maxLength: 30

  3489.                 commentsEnabled:

  3490.                   deprecated: true

  3491.                   description: 'Deprecated in 6.2, use commentsPolicy instead'

  3492.                   type: boolean

  3493.                 commentsPolicy:

  3494.                   $ref: '#/components/schemas/VideoCommentsPolicySet'

  3495.                 downloadEnabled:

  3496.                   description: Enable or disable downloading for the replay of this live video

  3497.                   type: boolean

  3498.               required:

  3499.                 - channelId

  3500.                 - name

  3501.             encoding:

  3502.               thumbnailfile:

  3503.                 contentType: image/jpeg

  3504.               previewfile:

  3505.                 contentType: image/jpeg

  3506. 

  3507.   /api/v1/videos/live/{id}:

  3508.     get:

  3509.       summary: Get information about a live

  3510.       operationId: getLiveId

  3511.       security:

  3512.         - OAuth2: []

  3513.       tags:

  3514.         - Live Videos

  3515.         - Video

  3516.       parameters:

  3517.         - $ref: '#/components/parameters/idOrUUID'

  3518.       responses:

  3519.         '200':

  3520.           description: successful operation

  3521.           content:

  3522.             application/json:

  3523.               schema:

  3524.                 $ref: '#/components/schemas/LiveVideoResponse'

  3525.     put:

  3526.       summary: Update information about a live

  3527.       operationId: updateLiveId

  3528.       security:

  3529.         - OAuth2: []

  3530.       tags:

  3531.         - Live Videos

  3532.         - Video

  3533.       parameters:

  3534.         - $ref: '#/components/parameters/idOrUUID'

  3535.       requestBody:

  3536.         content:

  3537.           application/json:

  3538.             schema:

  3539.               $ref: '#/components/schemas/LiveVideoUpdate'

  3540.       responses:

  3541.         '204':

  3542.           description: successful operation

  3543.         '400':

  3544.           description: bad parameters or trying to update a live that has already started

  3545.         '403':

  3546.           description: trying to save replay of the live but saving replay is not enabled on the instance

  3547.   /api/v1/videos/live/{id}/sessions:

  3548.     get:

  3549.       summary: List live sessions

  3550.       description: List all sessions created in a particular live

  3551.       security:

  3552.         - OAuth2: []

  3553.       tags:

  3554.         - Live Videos

  3555.       parameters:

  3556.         - $ref: '#/components/parameters/idOrUUID'

  3557.       responses:

  3558.         '200':

  3559.           description: successful operation

  3560.           content:

  3561.             application/json:

  3562.               schema:

  3563.                 type: object

  3564.                 properties:

  3565.                   total:

  3566.                     type: integer

  3567.                     example: 1

  3568.                   data:

  3569.                     type: array

  3570.                     items:

  3571.                       $ref: '#/components/schemas/LiveVideoSessionResponse'

  3572.   /api/v1/videos/{id}/live-session:

  3573.     get:

  3574.       summary: Get live session of a replay

  3575.       description: If the video is a replay of a live, you can find the associated live session using this endpoint

  3576.       security:

  3577.         - OAuth2: []

  3578.       tags:

  3579.         - Live Videos

  3580.       parameters:

  3581.         - $ref: '#/components/parameters/idOrUUID'

  3582.         - $ref: '#/components/parameters/videoPasswordHeader'

  3583.       responses:

  3584.         '200':

  3585.           description: successful operation

  3586.           content:

  3587.             application/json:

  3588.               schema:

  3589.                 $ref: '#/components/schemas/LiveVideoSessionResponse'

  3590. 

  3591.   '/api/v1/videos/{id}/source':

  3592.     get:

  3593.       summary: Get video source file metadata

  3594.       operationId: getVideoSource

  3595.       security:

  3596.         - OAuth2: []

  3597.       tags:

  3598.         - Video

  3599.       parameters:

  3600.         - $ref: '#/components/parameters/idOrUUID'

  3601.       responses:

  3602.         '200':

  3603.           description: successful operation

  3604.           content:

  3605.             application/json:

  3606.               schema:

  3607.                 $ref: '#/components/schemas/VideoSource'

  3608. 

  3609.   '/api/v1/videos/{id}/source/file':

  3610.     delete:

  3611.       summary: Delete video source file

  3612.       operationId: deleteVideoSourceFile

  3613.       tags:

  3614.         - Video

  3615.       security:

  3616.         - OAuth2:

  3617.           - admin

  3618.           - moderator

  3619.       parameters:

  3620.         - $ref: '#/components/parameters/idOrUUID'

  3621.       responses:

  3622.         '204':

  3623.           description: successful operation

  3624.         '404':

  3625.           description: video source not found

  3626. 

  3627.   '/api/v1/videos/{id}/source/replace-resumable':

  3628.     post:

  3629.       summary: Initialize the resumable replacement of a video

  3630.       description: "**PeerTube >= 6.0** Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to initialize the replacement of a video"

  3631.       operationId: replaceVideoSourceResumableInit

  3632.       security:

  3633.         - OAuth2: []

  3634.       tags:

  3635.         - Video

  3636.         - Video Upload

  3637.       parameters:

  3638.         - $ref: '#/components/parameters/resumableUploadInitContentLengthHeader'

  3639.         - $ref: '#/components/parameters/resumableUploadInitContentTypeHeader'

  3640.       requestBody:

  3641.         content:

  3642.           application/json:

  3643.             schema:

  3644.               $ref: '#/components/schemas/VideoReplaceSourceRequestResumable'

  3645.       responses:

  3646.         '200':

  3647.           description: file already exists, send a [`resume`](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) request instead

  3648.         '201':

  3649.           description: created

  3650.           headers:

  3651.             Location:

  3652.               schema:

  3653.                 type: string

  3654.                 format: url

  3655.             Content-Length:

  3656.               schema:

  3657.                 type: number

  3658.                 example: 0

  3659.         '413':

  3660.           x-summary: video file too large, due to quota, absolute max file size or concurrent partial upload limit

  3661.           description: |

  3662.             Disambiguate via `code`:

  3663.             - `max_file_size_reached` for the absolute file size limit

  3664.             - `quota_reached` for quota limits whether daily or global

  3665.         '415':

  3666.           description: video type unsupported

  3667.     put:

  3668.       summary: Send chunk for the resumable replacement of a video

  3669.       description: "**PeerTube >= 6.0** Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to continue, pause or resume the replacement of a video"

  3670.       operationId: replaceVideoSourceResumable

  3671.       security:

  3672.         - OAuth2: []

  3673.       tags:

  3674.         - Video

  3675.         - Video Upload

  3676.       parameters:

  3677.         - $ref: '#/components/parameters/resumableUploadId'

  3678.         - $ref: '#/components/parameters/resumableUploadChunkContentRangeHeader'

  3679.         - $ref: '#/components/parameters/resumableUploadChunkContentLengthHeader'

  3680.       requestBody:

  3681.         content:

  3682.           application/octet-stream:

  3683.             schema:

  3684.               type: string

  3685.               format: binary

  3686.       responses:

  3687.         '204':

  3688.           description: 'last chunk received: successful operation'

  3689.         '308':

  3690.           description: resume incomplete

  3691.           headers:

  3692.             Range:

  3693.               schema:

  3694.                 type: string

  3695.                 example: bytes=0-262143

  3696.             Content-Length:

  3697.               schema:

  3698.                 type: number

  3699.                 example: 0

  3700.         '403':

  3701.           description: video didn't pass file replacement filter

  3702.         '404':

  3703.           description: replace upload not found

  3704.         '409':

  3705.           description: chunk doesn't match range

  3706.         '422':

  3707.           description: video unreadable

  3708.         '429':

  3709.           description: too many concurrent requests

  3710.         '503':

  3711.           description: upload is already being processed

  3712.           headers:

  3713.             'Retry-After':

  3714.               schema:

  3715.                 type: number

  3716.                 example: 300

  3717.     delete:

  3718.       summary: Cancel the resumable replacement of a video

  3719.       description: "**PeerTube >= 6.0** Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to cancel the replacement of a video"

  3720.       operationId: replaceVideoSourceResumableCancel

  3721.       security:

  3722.         - OAuth2: []

  3723.       tags:

  3724.         - Video

  3725.         - Video Upload

  3726.       parameters:

  3727.         - $ref: '#/components/parameters/resumableUploadId'

  3728.         - name: Content-Length

  3729.           in: header

  3730.           required: true

  3731.           schema:

  3732.             type: number

  3733.             example: 0

  3734.       responses:

  3735.         '204':

  3736.           description: source file replacement cancelled

  3737.           headers:

  3738.             Content-Length:

  3739.               schema:

  3740.                 type: number

  3741.                 example: 0

  3742.         '404':

  3743.           description: source file replacement not found

  3744. 

  3745.   /api/v1/users/me/abuses:

  3746.     get:

  3747.       summary: List my abuses

  3748.       operationId: getMyAbuses

  3749.       security:

  3750.         - OAuth2: []

  3751.       tags:

  3752.         - Abuses

  3753.         - My User

  3754.       parameters:

  3755.         - name: id

  3756.           in: query

  3757.           description: only list the report with this id

  3758.           schema:

  3759.             type: integer

  3760.         - name: state

  3761.           in: query

  3762.           schema:

  3763.             $ref: '#/components/schemas/AbuseStateSet'

  3764.         - $ref: '#/components/parameters/abusesSort'

  3765.         - $ref: '#/components/parameters/start'

  3766.         - $ref: '#/components/parameters/count'

  3767.       responses:

  3768.         '200':

  3769.           description: successful operation

  3770.           content:

  3771.             application/json:

  3772.               schema:

  3773.                 type: object

  3774.                 properties:

  3775.                   total:

  3776.                     type: integer

  3777.                     example: 1

  3778.                   data:

  3779.                     type: array

  3780.                     items:

  3781.                       $ref: '#/components/schemas/Abuse'

  3782. 

  3783.   /api/v1/abuses:

  3784.     get:

  3785.       summary: List abuses

  3786.       operationId: getAbuses

  3787.       security:

  3788.         - OAuth2:

  3789.           - admin

  3790.           - moderator

  3791.       tags:

  3792.         - Abuses

  3793.       parameters:

  3794.         - name: id

  3795.           in: query

  3796.           description: only list the report with this id

  3797.           schema:

  3798.             type: integer

  3799.         - name: predefinedReason

  3800.           in: query

  3801.           description: predefined reason the listed reports should contain

  3802.           schema:

  3803.             $ref: '#/components/schemas/PredefinedAbuseReasons'

  3804.         - name: search

  3805.           in: query

  3806.           description: plain search that will match with video titles, reporter names and more

  3807.           schema:

  3808.             type: string

  3809.         - name: state

  3810.           in: query

  3811.           schema:

  3812.             $ref: '#/components/schemas/AbuseStateSet'

  3813.         - name: searchReporter

  3814.           in: query

  3815.           description: only list reports of a specific reporter

  3816.           schema:

  3817.             type: string

  3818.         - name: searchReportee

  3819.           description: only list reports of a specific reportee

  3820.           in: query

  3821.           schema:

  3822.             type: string

  3823.         - name: searchVideo

  3824.           in: query

  3825.           description: only list reports of a specific video

  3826.           schema:

  3827.             type: string

  3828.         - name: searchVideoChannel

  3829.           in: query

  3830.           description: only list reports of a specific video channel

  3831.           schema:

  3832.             type: string

  3833.         - name: videoIs

  3834.           in: query

  3835.           description: only list deleted or blocklisted videos

  3836.           schema:

  3837.             type: string

  3838.             enum:

  3839.             - 'deleted'

  3840.             - 'blacklisted'

  3841.         - name: filter

  3842.           in: query

  3843.           description: only list account, comment or video reports

  3844.           schema:

  3845.             type: string

  3846.             enum:

  3847.             - 'video'

  3848.             - 'comment'

  3849.             - 'account'

  3850.         - $ref: '#/components/parameters/start'

  3851.         - $ref: '#/components/parameters/count'

  3852.         - $ref: '#/components/parameters/abusesSort'

  3853.       responses:

  3854.         '200':

  3855.           description: successful operation

  3856.           content:

  3857.             application/json:

  3858.               schema:

  3859.                 type: object

  3860.                 properties:

  3861.                   total:

  3862.                     type: integer

  3863.                     example: 1

  3864.                   data:

  3865.                     type: array

  3866.                     items:

  3867.                       $ref: '#/components/schemas/Abuse'

  3868.     post:

  3869.       summary: Report an abuse

  3870.       security:

  3871.         - OAuth2: []

  3872.       tags:

  3873.         - Abuses

  3874.       requestBody:

  3875.         required: true

  3876.         content:

  3877.           application/json:

  3878.             schema:

  3879.               type: object

  3880.               properties:

  3881.                 reason:

  3882.                   description: Reason why the user reports this video

  3883.                   type: string

  3884.                   minLength: 2

  3885.                   maxLength: 3000

  3886.                 predefinedReasons:

  3887.                   $ref: '#/components/schemas/PredefinedAbuseReasons'

  3888.                 video:

  3889.                   type: object

  3890.                   properties:

  3891.                     id:

  3892.                       description: Video id to report

  3893.                       allOf:

  3894.                         - $ref: '#/components/schemas/Video/properties/id'

  3895.                     startAt:

  3896.                       type: integer

  3897.                       format: seconds

  3898.                       description: Timestamp in the video that marks the beginning of the report

  3899.                       minimum: 0

  3900.                     endAt:

  3901.                       type: integer

  3902.                       format: seconds

  3903.                       description: Timestamp in the video that marks the ending of the report

  3904.                       minimum: 0

  3905.                 comment:

  3906.                   type: object

  3907.                   properties:

  3908.                     id:

  3909.                       description: Comment id to report

  3910.                       allOf:

  3911.                         - $ref: '#/components/schemas/VideoComment/properties/id'

  3912.                 account:

  3913.                   type: object

  3914.                   properties:

  3915.                     id:

  3916.                       description: Account id to report

  3917.                       type: integer

  3918.               required:

  3919.                 - reason

  3920.       responses:

  3921.         '200':

  3922.           description: successful operation

  3923.           content:

  3924.             application/json:

  3925.               schema:

  3926.                 type: object

  3927.                 properties:

  3928.                   abuse:

  3929.                     type: object

  3930.                     properties:

  3931.                       id:

  3932.                         $ref: '#/components/schemas/id'

  3933.         '400':

  3934.           description: incorrect request parameters

  3935. 

  3936.   '/api/v1/abuses/{abuseId}':

  3937.     put:

  3938.       summary: Update an abuse

  3939.       security:

  3940.         - OAuth2:

  3941.           - admin

  3942.           - moderator

  3943.       tags:

  3944.         - Abuses

  3945.       parameters:

  3946.         - $ref: '#/components/parameters/abuseId'

  3947.       requestBody:

  3948.         content:

  3949.           application/json:

  3950.             schema:

  3951.               type: object

  3952.               properties:

  3953.                 state:

  3954.                   $ref: '#/components/schemas/AbuseStateSet'

  3955.                 moderationComment:

  3956.                   type: string

  3957.                   description: Update the report comment visible only to the moderation team

  3958.                   minLength: 2

  3959.                   maxLength: 3000

  3960.       responses:

  3961.         '204':

  3962.           description: successful operation

  3963.         '404':

  3964.           description: abuse not found

  3965.     delete:

  3966.       tags:

  3967.         - Abuses

  3968.       summary: Delete an abuse

  3969.       security:

  3970.         - OAuth2:

  3971.           - admin

  3972.           - moderator

  3973.       parameters:

  3974.         - $ref: '#/components/parameters/abuseId'

  3975.       responses:

  3976.         '204':

  3977.           description: successful operation

  3978.         '404':

  3979.           description: block not found

  3980. 

  3981.   '/api/v1/abuses/{abuseId}/messages':

  3982.     get:

  3983.       summary: List messages of an abuse

  3984.       security:

  3985.         - OAuth2: []

  3986.       tags:

  3987.         - Abuses

  3988.       parameters:

  3989.         - $ref: '#/components/parameters/abuseId'

  3990.       responses:

  3991.         '200':

  3992.           description: successful operation

  3993.           content:

  3994.             application/json:

  3995.               schema:

  3996.                 type: object

  3997.                 properties:

  3998.                   total:

  3999.                     type: integer

  4000.                     example: 1

  4001.                   data:

  4002.                     type: array

  4003.                     items:

  4004.                       $ref: '#/components/schemas/AbuseMessage'

  4005.     post:

  4006.       summary: Add message to an abuse

  4007.       security:

  4008.         - OAuth2: []

  4009.       tags:

  4010.         - Abuses

  4011.       parameters:

  4012.         - $ref: '#/components/parameters/abuseId'

  4013.       requestBody:

  4014.         required: true

  4015.         content:

  4016.           application/json:

  4017.             schema:

  4018.               type: object

  4019.               properties:

  4020.                 message:

  4021.                   description: Message to send

  4022.                   type: string

  4023.                   minLength: 2

  4024.                   maxLength: 3000

  4025.               required:

  4026.                 - message

  4027.       responses:

  4028.         '200':

  4029.           description: successful operation

  4030.         '400':

  4031.           description: incorrect request parameters

  4032. 

  4033.   '/api/v1/abuses/{abuseId}/messages/{abuseMessageId}':

  4034.     delete:

  4035.       summary: Delete an abuse message

  4036.       security:

  4037.         - OAuth2: []

  4038.       tags:

  4039.         - Abuses

  4040.       parameters:

  4041.         - $ref: '#/components/parameters/abuseId'

  4042.         - $ref: '#/components/parameters/abuseMessageId'

  4043.       responses:

  4044.         '204':

  4045.           description: successful operation

  4046. 

  4047.   '/api/v1/videos/{id}/blacklist':

  4048.     post:

  4049.       summary: Block a video

  4050.       operationId: addVideoBlock

  4051.       security:

  4052.         - OAuth2:

  4053.           - admin

  4054.           - moderator

  4055.       tags:

  4056.         - Video Blocks

  4057.       parameters:

  4058.         - $ref: '#/components/parameters/idOrUUID'

  4059.       responses:

  4060.         '204':

  4061.           description: successful operation

  4062.     delete:

  4063.       summary: Unblock a video by its id

  4064.       operationId: delVideoBlock

  4065.       security:

  4066.         - OAuth2:

  4067.           - admin

  4068.           - moderator

  4069.       tags:

  4070.         - Video Blocks

  4071.       parameters:

  4072.         - $ref: '#/components/parameters/idOrUUID'

  4073.       responses:

  4074.         '204':

  4075.           description: successful operation

  4076.         '404':

  4077.           description: block not found

  4078. 

  4079.   /api/v1/videos/blacklist:

  4080.     get:

  4081.       tags:

  4082.         - Video Blocks

  4083.       summary: List video blocks

  4084.       operationId: getVideoBlocks

  4085.       security:

  4086.         - OAuth2:

  4087.           - admin

  4088.           - moderator

  4089.       parameters:

  4090.         - name: type

  4091.           in: query

  4092.           description: >

  4093.             list only blocks that match this type:

  4094. 

  4095.             - `1`: manual block

  4096. 

  4097.             - `2`: automatic block that needs review

  4098.           schema:

  4099.             type: integer

  4100.             enum:

  4101.               - 1

  4102.               - 2

  4103.         - name: search

  4104.           in: query

  4105.           description: plain search that will match with video titles, and more

  4106.           schema:

  4107.             type: string

  4108.         - $ref: '#/components/parameters/start'

  4109.         - $ref: '#/components/parameters/count'

  4110.         - $ref: '#/components/parameters/blacklistsSort'

  4111.       responses:

  4112.         '200':

  4113.           description: successful operation

  4114.           content:

  4115.             application/json:

  4116.               schema:

  4117.                 type: object

  4118.                 properties:

  4119.                   total:

  4120.                     type: integer

  4121.                     example: 1

  4122.                   data:

  4123.                     type: array

  4124.                     items:

  4125.                       $ref: '#/components/schemas/VideoBlacklist'

  4126. 

  4127.   /api/v1/videos/{id}/storyboards:

  4128.     get:

  4129.       summary: List storyboards of a video

  4130.       description: "**PeerTube >= 6.0**"

  4131.       operationId: listVideoStoryboards

  4132.       tags:

  4133.         - Video

  4134.       parameters:

  4135.         - $ref: '#/components/parameters/idOrUUID'

  4136.       responses:

  4137.         '200':

  4138.           description: successful operation

  4139.           content:

  4140.             application/json:

  4141.               schema:

  4142.                 type: object

  4143.                 properties:

  4144.                   storyboards:

  4145.                     type: array

  4146.                     items:

  4147.                       $ref: '#/components/schemas/Storyboard'

  4148. 

  4149.   /api/v1/videos/{id}/captions:

  4150.     get:

  4151.       summary: List captions of a video

  4152.       operationId: getVideoCaptions

  4153.       tags:

  4154.         - Video Captions

  4155.       parameters:

  4156.         - $ref: '#/components/parameters/idOrUUID'

  4157.         - $ref: '#/components/parameters/videoPasswordHeader'

  4158.       responses:

  4159.         '200':

  4160.           description: successful operation

  4161.           content:

  4162.             application/json:

  4163.               schema:

  4164.                 type: object

  4165.                 properties:

  4166.                   total:

  4167.                     type: integer

  4168.                     example: 1

  4169.                   data:

  4170.                     type: array

  4171.                     items:

  4172.                       $ref: '#/components/schemas/VideoCaption'

  4173. 

  4174.   /api/v1/videos/{id}/captions/generate:

  4175.     post:

  4176.       summary: Generate a video caption

  4177.       operationId: generateVideoCaption

  4178.       description: "**PeerTube >= 6.2** This feature has to be enabled by the administrator"

  4179.       security:

  4180.         - OAuth2:

  4181.           - user

  4182.       tags:

  4183.         - Video Captions

  4184.       requestBody:

  4185.         content:

  4186.           application/json:

  4187.             schema:

  4188.               type: object

  4189.               properties:

  4190.                 forceTranscription:

  4191.                   type: boolean

  4192.                   default: false

  4193.       responses:

  4194.         '204':

  4195.           description: successful operation

  4196.         '404':

  4197.           description: video not found

  4198. 

  4199. 

  4200.   /api/v1/videos/{id}/captions/{captionLanguage}:

  4201.     put:

  4202.       summary: Add or replace a video caption

  4203.       operationId: addVideoCaption

  4204.       security:

  4205.         - OAuth2:

  4206.           - user

  4207.       tags:

  4208.         - Video Captions

  4209.       parameters:

  4210.         - $ref: '#/components/parameters/idOrUUID'

  4211.         - $ref: '#/components/parameters/captionLanguage'

  4212.       requestBody:

  4213.         content:

  4214.           multipart/form-data:

  4215.             schema:

  4216.               type: object

  4217.               properties:

  4218.                 captionfile:

  4219.                   description: The file to upload.

  4220.                   type: string

  4221.                   format: binary

  4222.             encoding:

  4223.               captionfile:

  4224.                 contentType: text/vtt, application/x-subrip, text/plain

  4225.       responses:

  4226.         '204':

  4227.           description: successful operation

  4228.         '404':

  4229.           description: video or language not found

  4230.     delete:

  4231.       summary: Delete a video caption

  4232.       operationId: delVideoCaption

  4233.       security:

  4234.         - OAuth2:

  4235.           - user

  4236.       tags:

  4237.         - Video Captions

  4238.       parameters:

  4239.         - $ref: '#/components/parameters/idOrUUID'

  4240.         - $ref: '#/components/parameters/captionLanguage'

  4241.       responses:

  4242.         '204':

  4243.           description: successful operation

  4244.         '404':

  4245.           description: video or language or caption for that language not found

  4246. 

  4247.   /api/v1/videos/{id}/chapters:

  4248.     get:

  4249.       summary: Get chapters of a video

  4250.       description: "**PeerTube >= 6.0**"

  4251.       operationId: getVideoChapters

  4252.       tags:

  4253.         - Video Chapters

  4254.       parameters:

  4255.         - $ref: '#/components/parameters/idOrUUID'

  4256.         - $ref: '#/components/parameters/videoPasswordHeader'

  4257.       responses:

  4258.         '200':

  4259.           description: successful operation

  4260.           content:

  4261.             application/json:

  4262.               schema:

  4263.                 $ref: '#/components/schemas/VideoChapters'

  4264.     put:

  4265.       summary: Replace video chapters

  4266.       description: "**PeerTube >= 6.0**"

  4267.       operationId: replaceVideoChapters

  4268.       security:

  4269.         - OAuth2:

  4270.           - user

  4271.       tags:

  4272.         - Video Chapters

  4273.       parameters:

  4274.         - $ref: '#/components/parameters/idOrUUID'

  4275.       requestBody:

  4276.         content:

  4277.           application/json:

  4278.             schema:

  4279.               type: object

  4280.               properties:

  4281.                 chapters:

  4282.                   type: array

  4283.                   items:

  4284.                     type: object

  4285.                     properties:

  4286.                       title:

  4287.                         type: string

  4288.                       timecode:

  4289.                         type: integer

  4290.       responses:

  4291.         '204':

  4292.           description: successful operation

  4293.         '404':

  4294.           description: video not found

  4295. 

  4296.   /api/v1/videos/{id}/passwords:

  4297.     get:

  4298.       summary: List video passwords

  4299.       description: "**PeerTube >= 6.0**"

  4300.       security:

  4301.         - OAuth2:

  4302.           - user

  4303.       tags:

  4304.         - Video Passwords

  4305.       parameters:

  4306.         - $ref: '#/components/parameters/idOrUUID'

  4307.         - $ref: '#/components/parameters/start'

  4308.         - $ref: '#/components/parameters/count'

  4309.         - $ref: '#/components/parameters/sort'

  4310.       responses:

  4311.         '204':

  4312.           description: successful operation

  4313.           content:

  4314.             application/json:

  4315.               schema:

  4316.                 $ref: '#/components/schemas/VideoPasswordList'

  4317.         '400':

  4318.           description: video is not password protected

  4319.     put:

  4320.       summary: Update video passwords

  4321.       description: "**PeerTube >= 6.0**"

  4322.       security:

  4323.         - OAuth2:

  4324.           - user

  4325.       tags:

  4326.         - Video Passwords

  4327.       parameters:

  4328.         - $ref: '#/components/parameters/idOrUUID'

  4329.       requestBody:

  4330.         content:

  4331.           application/json:

  4332.             schema:

  4333.               type: object

  4334.               properties:

  4335.                 passwords:

  4336.                   $ref: '#/components/schemas/AddVideoPasswords'

  4337.       responses:

  4338.         '204':

  4339.           description: successful operation

  4340.         '400':

  4341.           description: video is not password protected

  4342. 

  4343.   /api/v1/videos/{id}/passwords/{videoPasswordId}:

  4344.     delete:

  4345.       summary: Delete a video password

  4346.       description: "**PeerTube >= 6.0**"

  4347.       security:

  4348.         - OAuth2:

  4349.           - user

  4350.       tags:

  4351.         - Video Passwords

  4352.       parameters:

  4353.         - $ref: '#/components/parameters/idOrUUID'

  4354.         - $ref: '#/components/parameters/videoPasswordId'

  4355.       responses:

  4356.         '204':

  4357.           description: successful operation

  4358.         '403':

  4359.           description: cannot delete the last password of the protected video

  4360.         '400':

  4361.           description: video is not password protected

  4362. 

  4363.   /api/v1/video-channels:

  4364.     get:

  4365.       summary: List video channels

  4366.       operationId: getVideoChannels

  4367.       tags:

  4368.         - Video Channels

  4369.       parameters:

  4370.         - $ref: '#/components/parameters/start'

  4371.         - $ref: '#/components/parameters/count'

  4372.         - $ref: '#/components/parameters/sort'

  4373.       responses:

  4374.         '200':

  4375.           description: successful operation

  4376.           content:

  4377.             application/json:

  4378.               schema:

  4379.                 $ref: '#/components/schemas/VideoChannelList'

  4380.     post:

  4381.       summary: Create a video channel

  4382.       operationId: addVideoChannel

  4383.       security:

  4384.         - OAuth2: []

  4385.       tags:

  4386.         - Video Channels

  4387.       responses:

  4388.         '200':

  4389.           description: successful operation

  4390.           content:

  4391.             application/json:

  4392.               schema:

  4393.                 type: object

  4394.                 properties:

  4395.                   videoChannel:

  4396.                     type: object

  4397.                     properties:

  4398.                       id:

  4399.                         $ref: '#/components/schemas/id'

  4400.       requestBody:

  4401.         content:

  4402.           application/json:

  4403.             schema:

  4404.               $ref: '#/components/schemas/VideoChannelCreate'

  4405. 

  4406.   '/api/v1/video-channels/{channelHandle}':

  4407.     get:

  4408.       summary: Get a video channel

  4409.       operationId: getVideoChannel

  4410.       tags:

  4411.         - Video Channels

  4412.       parameters:

  4413.         - $ref: '#/components/parameters/channelHandle'

  4414.       responses:

  4415.         '200':

  4416.           description: successful operation

  4417.           content:

  4418.             application/json:

  4419.               schema:

  4420.                 $ref: '#/components/schemas/VideoChannel'

  4421.     put:

  4422.       summary: Update a video channel

  4423.       operationId: putVideoChannel

  4424.       security:

  4425.         - OAuth2: []

  4426.       tags:

  4427.         - Video Channels

  4428.       parameters:

  4429.         - $ref: '#/components/parameters/channelHandle'

  4430.       responses:

  4431.         '204':

  4432.           description: successful operation

  4433.       requestBody:

  4434.         content:

  4435.           application/json:

  4436.             schema:

  4437.               $ref: '#/components/schemas/VideoChannelUpdate'

  4438.     delete:

  4439.       summary: Delete a video channel

  4440.       operationId: delVideoChannel

  4441.       security:

  4442.         - OAuth2: []

  4443.       tags:

  4444.         - Video Channels

  4445.       parameters:

  4446.         - $ref: '#/components/parameters/channelHandle'

  4447.       responses:

  4448.         '204':

  4449.           description: successful operation

  4450. 

  4451.   '/api/v1/video-channels/{channelHandle}/videos':

  4452.     get:

  4453.       summary: List videos of a video channel

  4454.       operationId: getVideoChannelVideos

  4455.       tags:

  4456.         - Video

  4457.         - Video Channels

  4458.       parameters:

  4459.         - $ref: '#/components/parameters/channelHandle'

  4460.         - $ref: '#/components/parameters/categoryOneOf'

  4461.         - $ref: '#/components/parameters/isLive'

  4462.         - $ref: '#/components/parameters/tagsOneOf'

  4463.         - $ref: '#/components/parameters/tagsAllOf'

  4464.         - $ref: '#/components/parameters/licenceOneOf'

  4465.         - $ref: '#/components/parameters/languageOneOf'

  4466.         - $ref: '#/components/parameters/autoTagOneOfVideo'

  4467.         - $ref: '#/components/parameters/nsfw'

  4468.         - $ref: '#/components/parameters/isLocal'

  4469.         - $ref: '#/components/parameters/include'

  4470.         - $ref: '#/components/parameters/privacyOneOf'

  4471.         - $ref: '#/components/parameters/hasHLSFiles'

  4472.         - $ref: '#/components/parameters/hasWebVideoFiles'

  4473.         - $ref: '#/components/parameters/skipCount'

  4474.         - $ref: '#/components/parameters/start'

  4475.         - $ref: '#/components/parameters/count'

  4476.         - $ref: '#/components/parameters/videosSort'

  4477.         - $ref: '#/components/parameters/excludeAlreadyWatched'

  4478.       responses:

  4479.         '200':

  4480.           description: successful operation

  4481.           content:

  4482.             application/json:

  4483.               schema:

  4484.                 $ref: '#/components/schemas/VideoListResponse'

  4485. 

  4486.   '/api/v1/video-channels/{channelHandle}/video-playlists':

  4487.     get:

  4488.       summary: List playlists of a channel

  4489.       tags:

  4490.         - Video Playlists

  4491.         - Video Channels

  4492.       parameters:

  4493.         - $ref: '#/components/parameters/channelHandle'

  4494.         - $ref: '#/components/parameters/start'

  4495.         - $ref: '#/components/parameters/count'

  4496.         - $ref: '#/components/parameters/sort'

  4497.         - $ref: '#/components/parameters/videoPlaylistType'

  4498.       responses:

  4499.         '200':

  4500.           description: successful operation

  4501.           content:

  4502.             application/json:

  4503.               schema:

  4504.                 type: object

  4505.                 properties:

  4506.                   total:

  4507.                     type: integer

  4508.                     example: 1

  4509.                   data:

  4510.                     type: array

  4511.                     items:

  4512.                       $ref: '#/components/schemas/VideoPlaylist'

  4513. 

  4514.   '/api/v1/video-channels/{channelHandle}/followers':

  4515.     get:

  4516.       tags:

  4517.         - Video Channels

  4518.       summary: 'List followers of a video channel'

  4519.       security:

  4520.         - OAuth2: []

  4521.       operationId: getVideoChannelFollowers

  4522.       parameters:

  4523.         - $ref: '#/components/parameters/channelHandle'

  4524.         - $ref: '#/components/parameters/start'

  4525.         - $ref: '#/components/parameters/count'

  4526.         - $ref: '#/components/parameters/followersSort'

  4527.         - $ref: '#/components/parameters/search'

  4528.       responses:

  4529.         '200':

  4530.           description: successful operation

  4531.           content:

  4532.             application/json:

  4533.               schema:

  4534.                 type: object

  4535.                 properties:

  4536.                   total:

  4537.                     type: integer

  4538.                     example: 1

  4539.                   data:

  4540.                     type: array

  4541.                     items:

  4542.                       $ref: '#/components/schemas/Follow'

  4543. 

  4544.   '/api/v1/video-channels/{channelHandle}/avatar/pick':

  4545.     post:

  4546.       summary: Update channel avatar

  4547.       security:

  4548.         - OAuth2: []

  4549.       tags:

  4550.         - Video Channels

  4551.       parameters:

  4552.         - $ref: '#/components/parameters/channelHandle'

  4553.       responses:

  4554.         '200':

  4555.           description: successful operation

  4556.           content:

  4557.             application/json:

  4558.               schema:

  4559.                 type: object

  4560.                 properties:

  4561.                   avatars:

  4562.                     type: array

  4563.                     items:

  4564.                       $ref: '#/components/schemas/ActorImage'

  4565.         '413':

  4566.           description: image file too large

  4567.           headers:

  4568.             X-File-Maximum-Size:

  4569.               schema:

  4570.                 type: string

  4571.                 format: Nginx size

  4572.               description: Maximum file size for the avatar

  4573.       requestBody:

  4574.         content:

  4575.           multipart/form-data:

  4576.             schema:

  4577.               type: object

  4578.               properties:

  4579.                 avatarfile:

  4580.                   description: The file to upload.

  4581.                   type: string

  4582.                   format: binary

  4583.             encoding:

  4584.               avatarfile:

  4585.                 contentType: image/png, image/jpeg

  4586. 

  4587.   '/api/v1/video-channels/{channelHandle}/avatar':

  4588.     delete:

  4589.       summary: Delete channel avatar

  4590.       security:

  4591.         - OAuth2: []

  4592.       tags:

  4593.         - Video Channels

  4594.       parameters:

  4595.         - $ref: '#/components/parameters/channelHandle'

  4596.       responses:

  4597.         '204':

  4598.           description: successful operation

  4599. 

  4600.   '/api/v1/video-channels/{channelHandle}/banner/pick':

  4601.     post:

  4602.       summary: Update channel banner

  4603.       security:

  4604.         - OAuth2: []

  4605.       tags:

  4606.         - Video Channels

  4607.       parameters:

  4608.         - $ref: '#/components/parameters/channelHandle'

  4609.       responses:

  4610.         '200':

  4611.           description: successful operation

  4612.           content:

  4613.             application/json:

  4614.               schema:

  4615.                 type: object

  4616.                 properties:

  4617.                   banners:

  4618.                     type: array

  4619.                     items:

  4620.                       $ref: '#/components/schemas/ActorImage'

  4621.         '413':

  4622.           description: image file too large

  4623.           headers:

  4624.             X-File-Maximum-Size:

  4625.               schema:

  4626.                 type: string

  4627.                 format: Nginx size

  4628.               description: Maximum file size for the banner

  4629.       requestBody:

  4630.         content:

  4631.           multipart/form-data:

  4632.             schema:

  4633.               type: object

  4634.               properties:

  4635.                 bannerfile:

  4636.                   description: The file to upload.

  4637.                   type: string

  4638.                   format: binary

  4639.             encoding:

  4640.               bannerfile:

  4641.                 contentType: image/png, image/jpeg

  4642. 

  4643.   '/api/v1/video-channels/{channelHandle}/banner':

  4644.     delete:

  4645.       summary: Delete channel banner

  4646.       security:

  4647.         - OAuth2: []

  4648.       tags:

  4649.         - Video Channels

  4650.       parameters:

  4651.         - $ref: '#/components/parameters/channelHandle'

  4652.       responses:

  4653.         '204':

  4654.           description: successful operation

  4655. 

  4656.   '/api/v1/video-channels/{channelHandle}/import-videos':

  4657.     post:

  4658.       summary: Import videos in channel

  4659.       description: Import a remote channel/playlist videos into a channel

  4660.       security:

  4661.         - OAuth2: []

  4662.       tags:

  4663.         - Video Channels

  4664.         - Channels Sync

  4665.       parameters:

  4666.         - $ref: '#/components/parameters/channelHandle'

  4667.       requestBody:

  4668.         content:

  4669.           application/json:

  4670.             schema:

  4671.               $ref: '#/components/schemas/ImportVideosInChannelCreate'

  4672.       responses:

  4673.         '204':

  4674.           description: successful operation

  4675. 

  4676.   '/api/v1/video-channel-syncs':

  4677.     post:

  4678.       summary: Create a synchronization for a video channel

  4679.       operationId: addVideoChannelSync

  4680.       security:

  4681.         - OAuth2: []

  4682.       tags:

  4683.         - Channels Sync

  4684.       requestBody:

  4685.         content:

  4686.           application/json:

  4687.             schema:

  4688.               $ref: '#/components/schemas/VideoChannelSyncCreate'

  4689.       responses:

  4690.         '200':

  4691.           description: successful operation

  4692.           content:

  4693.             application/json:

  4694.               schema:

  4695.                 type: object

  4696.                 properties:

  4697.                   videoChannelSync:

  4698.                     $ref: "#/components/schemas/VideoChannelSync"

  4699. 

  4700.   '/api/v1/video-channel-syncs/{channelSyncId}':

  4701.     delete:

  4702.       summary: Delete a video channel synchronization

  4703.       operationId: delVideoChannelSync

  4704.       security:

  4705.         - OAuth2: []

  4706.       tags:

  4707.         - Channels Sync

  4708.       parameters:

  4709.         - $ref: '#/components/parameters/channelSyncId'

  4710.       responses:

  4711.         '204':

  4712.           description: successful operation

  4713. 

  4714.   '/api/v1/video-channel-syncs/{channelSyncId}/sync':

  4715.     post:

  4716.       summary: Triggers the channel synchronization job, fetching all the videos from the remote channel

  4717.       operationId: triggerVideoChannelSync

  4718.       security:

  4719.         - OAuth2: []

  4720.       tags:

  4721.         - Channels Sync

  4722.       parameters:

  4723.         - $ref: '#/components/parameters/channelSyncId'

  4724.       responses:

  4725.         '204':

  4726.           description: successful operation

  4727. 

  4728. 

  4729.   /api/v1/video-playlists/privacies:

  4730.     get:

  4731.       summary: List available playlist privacy policies

  4732.       operationId: getPlaylistPrivacyPolicies

  4733.       tags:

  4734.         - Video Playlists

  4735.       responses:

  4736.         '200':

  4737.           description: successful operation

  4738.           content:

  4739.             application/json:

  4740.               schema:

  4741.                 type: array

  4742.                 items:

  4743.                   type: string

  4744.               examples:

  4745.                 nightly:

  4746.                   externalValue: https://peertube2.cpy.re/api/v1/video-playlists/privacies

  4747. 

  4748.   /api/v1/video-playlists:

  4749.     get:

  4750.       summary: List video playlists

  4751.       operationId: getPlaylists

  4752.       tags:

  4753.         - Video Playlists

  4754.       parameters:

  4755.         - $ref: '#/components/parameters/start'

  4756.         - $ref: '#/components/parameters/count'

  4757.         - $ref: '#/components/parameters/sort'

  4758.         - $ref: '#/components/parameters/videoPlaylistType'

  4759.       responses:

  4760.         '200':

  4761.           description: successful operation

  4762.           content:

  4763.             application/json:

  4764.               schema:

  4765.                 type: object

  4766.                 properties:

  4767.                   total:

  4768.                     type: integer

  4769.                     example: 1

  4770.                   data:

  4771.                     type: array

  4772.                     items:

  4773.                       $ref: '#/components/schemas/VideoPlaylist'

  4774.     post:

  4775.       summary: Create a video playlist

  4776.       description: If the video playlist is set as public, `videoChannelId` is mandatory.

  4777.       operationId: addPlaylist

  4778.       security:

  4779.         - OAuth2: []

  4780.       tags:

  4781.         - Video Playlists

  4782.       responses:

  4783.         '200':

  4784.           description: successful operation

  4785.           content:

  4786.             application/json:

  4787.               schema:

  4788.                 type: object

  4789.                 properties:

  4790.                   videoPlaylist:

  4791.                     type: object

  4792.                     properties:

  4793.                       id:

  4794.                         $ref: '#/components/schemas/VideoPlaylist/properties/id'

  4795.                       uuid:

  4796.                         $ref: '#/components/schemas/VideoPlaylist/properties/uuid'

  4797.                       shortUUID:

  4798.                         $ref: '#/components/schemas/VideoPlaylist/properties/shortUUID'

  4799.       requestBody:

  4800.         content:

  4801.           multipart/form-data:

  4802.             schema:

  4803.               type: object

  4804.               properties:

  4805.                 displayName:

  4806.                   description: Video playlist display name

  4807.                   type: string

  4808.                   minLength: 1

  4809.                   maxLength: 120

  4810.                 thumbnailfile:

  4811.                   description: Video playlist thumbnail file

  4812.                   type: string

  4813.                   format: binary

  4814.                 privacy:

  4815.                   $ref: '#/components/schemas/VideoPlaylistPrivacySet'

  4816.                 description:

  4817.                   description: Video playlist description

  4818.                   type: string

  4819.                   minLength: 3

  4820.                   maxLength: 1000

  4821.                 videoChannelId:

  4822.                   allOf:

  4823.                     - $ref: '#/components/schemas/id'

  4824.                   description: Video channel in which the playlist will be published

  4825.               required:

  4826.                 - displayName

  4827.             encoding:

  4828.               thumbnailfile:

  4829.                 contentType: image/jpeg

  4830. 

  4831.   /api/v1/video-playlists/{playlistId}:

  4832.     get:

  4833.       summary: Get a video playlist

  4834.       tags:

  4835.         - Video Playlists

  4836.       parameters:

  4837.         - $ref: '#/components/parameters/playlistId'

  4838.       responses:

  4839.         '200':

  4840.           description: successful operation

  4841.           content:

  4842.             application/json:

  4843.               schema:

  4844.                 $ref: '#/components/schemas/VideoPlaylist'

  4845.     put:

  4846.       summary: Update a video playlist

  4847.       description: 'If the video playlist is set as public, the playlist must have a assigned channel.'

  4848.       security:

  4849.         - OAuth2: []

  4850.       tags:

  4851.         - Video Playlists

  4852.       responses:

  4853.         '204':

  4854.           description: successful operation

  4855.       parameters:

  4856.         - $ref: '#/components/parameters/playlistId'

  4857.       requestBody:

  4858.         content:

  4859.           multipart/form-data:

  4860.             schema:

  4861.               type: object

  4862.               properties:

  4863.                 displayName:

  4864.                   description: Video playlist display name

  4865.                   type: string

  4866.                   minLength: 1

  4867.                   maxLength: 120

  4868.                 thumbnailfile:

  4869.                   description: Video playlist thumbnail file

  4870.                   type: string

  4871.                   format: binary

  4872.                 privacy:

  4873.                   $ref: '#/components/schemas/VideoPlaylistPrivacySet'

  4874.                 description:

  4875.                   description: Video playlist description

  4876.                   type: string

  4877.                 videoChannelId:

  4878.                   allOf:

  4879.                     - $ref: '#/components/schemas/id'

  4880.                   description: Video channel in which the playlist will be published

  4881.             encoding:

  4882.               thumbnailfile:

  4883.                 contentType: image/jpeg

  4884.     delete:

  4885.       summary: Delete a video playlist

  4886.       security:

  4887.         - OAuth2: []

  4888.       tags:

  4889.         - Video Playlists

  4890.       parameters:

  4891.         - $ref: '#/components/parameters/playlistId'

  4892.       responses:

  4893.         '204':

  4894.           description: successful operation

  4895. 

  4896.   /api/v1/video-playlists/{playlistId}/videos:

  4897.     get:

  4898.       summary: 'List videos of a playlist'

  4899.       operationId: getVideoPlaylistVideos

  4900.       tags:

  4901.         - Videos

  4902.         - Video Playlists

  4903.       parameters:

  4904.         - $ref: '#/components/parameters/playlistId'

  4905.         - $ref: '#/components/parameters/start'

  4906.         - $ref: '#/components/parameters/count'

  4907.       responses:

  4908.         '200':

  4909.           description: successful operation

  4910.           content:

  4911.             application/json:

  4912.               schema:

  4913.                 $ref: '#/components/schemas/VideoListResponse'

  4914.     post:

  4915.       summary: Add a video in a playlist

  4916.       operationId: addVideoPlaylistVideo

  4917.       security:

  4918.         - OAuth2: []

  4919.       tags:

  4920.         - Videos

  4921.         - Video Playlists

  4922.       parameters:

  4923.         - $ref: '#/components/parameters/playlistId'

  4924.       responses:

  4925.         '200':

  4926.           description: successful operation

  4927.           content:

  4928.             application/json:

  4929.               schema:

  4930.                 type: object

  4931.                 properties:

  4932.                   videoPlaylistElement:

  4933.                     type: object

  4934.                     properties:

  4935.                       id:

  4936.                         type: integer

  4937.                         example: 2

  4938.       requestBody:

  4939.         content:

  4940.           application/json:

  4941.             schema:

  4942.               type: object

  4943.               properties:

  4944.                 videoId:

  4945.                   oneOf:

  4946.                     - $ref: '#/components/schemas/Video/properties/uuid'

  4947.                     - $ref: '#/components/schemas/Video/properties/id'

  4948.                   description: Video to add in the playlist

  4949.                 startTimestamp:

  4950.                   type: integer

  4951.                   format: seconds

  4952.                   description: Start the video at this specific timestamp

  4953.                 stopTimestamp:

  4954.                   type: integer

  4955.                   format: seconds

  4956.                   description: Stop the video at this specific timestamp

  4957.               required:

  4958.                 - videoId

  4959. 

  4960.   /api/v1/video-playlists/{playlistId}/videos/reorder:

  4961.     post:

  4962.       summary: 'Reorder a playlist'

  4963.       operationId: reorderVideoPlaylist

  4964.       security:

  4965.         - OAuth2: []

  4966.       tags:

  4967.         - Video Playlists

  4968.       parameters:

  4969.         - $ref: '#/components/parameters/playlistId'

  4970.       responses:

  4971.         '204':

  4972.           description: successful operation

  4973.       requestBody:

  4974.         content:

  4975.           application/json:

  4976.             schema:

  4977.               type: object

  4978.               properties:

  4979.                 startPosition:

  4980.                   type: integer

  4981.                   description: 'Start position of the element to reorder'

  4982.                   minimum: 1

  4983.                 insertAfterPosition:

  4984.                   type: integer

  4985.                   description: 'New position for the block to reorder, to add the block before the first element'

  4986.                   minimum: 0

  4987.                 reorderLength:

  4988.                   type: integer

  4989.                   description: 'How many element from `startPosition` to reorder'

  4990.                   minimum: 1

  4991.               required:

  4992.                 - startPosition

  4993.                 - insertAfterPosition

  4994. 

  4995.   /api/v1/video-playlists/{playlistId}/videos/{playlistElementId}:

  4996.     put:

  4997.       summary: Update a playlist element

  4998.       operationId: putVideoPlaylistVideo

  4999.       security:

  5000.         - OAuth2: []

  5001.       tags:

  5002.         - Video Playlists

  5003.       parameters:

  5004.         - $ref: '#/components/parameters/playlistId'

  5005.         - $ref: '#/components/parameters/playlistElementId'

  5006.       responses:

  5007.         '204':

  5008.           description: successful operation

  5009.       requestBody:

  5010.         content:

  5011.           application/json:

  5012.             schema:

  5013.               type: object

  5014.               properties:

  5015.                 startTimestamp:

  5016.                   type: integer

  5017.                   format: seconds

  5018.                   description: Start the video at this specific timestamp

  5019.                 stopTimestamp:

  5020.                   type: integer

  5021.                   format: seconds

  5022.                   description: Stop the video at this specific timestamp

  5023.     delete:

  5024.       summary: Delete an element from a playlist

  5025.       operationId: delVideoPlaylistVideo

  5026.       security:

  5027.         - OAuth2: []

  5028.       tags:

  5029.         - Video Playlists

  5030.       parameters:

  5031.         - $ref: '#/components/parameters/playlistId'

  5032.         - $ref: '#/components/parameters/playlistElementId'

  5033.       responses:

  5034.         '204':

  5035.           description: successful operation

  5036. 

  5037.   '/api/v1/users/me/video-playlists/videos-exist':

  5038.     get:

  5039.       summary: Check video exists in my playlists

  5040.       security:

  5041.         - OAuth2: []

  5042.       tags:

  5043.         - Video Playlists

  5044.       parameters:

  5045.         - name: videoIds

  5046.           in: query

  5047.           required: true

  5048.           description: The video ids to check

  5049.           schema:

  5050.             type: array

  5051.             items:

  5052.               $ref: '#/components/schemas/Video/properties/id'

  5053.       responses:

  5054.         '200':

  5055.           description: successful operation

  5056.           content:

  5057.             application/json:

  5058.               schema:

  5059.                 type: object

  5060.                 properties:

  5061.                   videoId:

  5062.                     type: array

  5063.                     items:

  5064.                       type: object

  5065.                       properties:

  5066.                         playlistElementId:

  5067.                           type: integer

  5068.                         playlistId:

  5069.                           type: integer

  5070.                         startTimestamp:

  5071.                           type: integer

  5072.                           format: seconds

  5073.                         stopTimestamp:

  5074.                           type: integer

  5075. 

  5076.   '/api/v1/accounts/{name}/video-playlists':

  5077.     get:

  5078.       summary: List playlists of an account

  5079.       tags:

  5080.         - Video Playlists

  5081.         - Accounts

  5082.       parameters:

  5083.         - $ref: '#/components/parameters/name'

  5084.         - $ref: '#/components/parameters/start'

  5085.         - $ref: '#/components/parameters/count'

  5086.         - $ref: '#/components/parameters/sort'

  5087.         - $ref: '#/components/parameters/search'

  5088.         - $ref: '#/components/parameters/videoPlaylistType'

  5089.       responses:

  5090.         '200':

  5091.           description: successful operation

  5092.           content:

  5093.             application/json:

  5094.               schema:

  5095.                 type: object

  5096.                 properties:

  5097.                   total:

  5098.                     type: integer

  5099.                     example: 1

  5100.                   data:

  5101.                     type: array

  5102.                     items:

  5103.                       $ref: '#/components/schemas/VideoPlaylist'

  5104. 

  5105.   '/api/v1/accounts/{name}/video-channels':

  5106.     get:

  5107.       summary: List video channels of an account

  5108.       tags:

  5109.         - Video Channels

  5110.         - Accounts

  5111.       parameters:

  5112.         - $ref: '#/components/parameters/name'

  5113.         - name: withStats

  5114.           in: query

  5115.           description: include daily view statistics for the last 30 days and total views (only if authentified as the account user)

  5116.           schema:

  5117.             type: boolean

  5118.         - $ref: '#/components/parameters/start'

  5119.         - $ref: '#/components/parameters/count'

  5120.         - $ref: '#/components/parameters/sort'

  5121.       responses:

  5122.         '200':

  5123.           description: successful operation

  5124.           content:

  5125.             application/json:

  5126.               schema:

  5127.                 $ref: '#/components/schemas/VideoChannelList'

  5128. 

  5129.   '/api/v1/accounts/{name}/video-channel-syncs':

  5130.     get:

  5131.       summary: List the synchronizations of video channels of an account

  5132.       tags:

  5133.         - Video Channels

  5134.         - Channels Sync

  5135.         - Accounts

  5136.       parameters:

  5137.         - $ref: '#/components/parameters/name'

  5138.         - $ref: '#/components/parameters/start'

  5139.         - $ref: '#/components/parameters/count'

  5140.         - $ref: '#/components/parameters/sort'

  5141.       responses:

  5142.         '200':

  5143.           description: successful operation

  5144.           content:

  5145.             application/json:

  5146.               schema:

  5147.                 $ref: '#/components/schemas/VideoChannelSyncList'

  5148. 

  5149.   '/api/v1/accounts/{name}/ratings':

  5150.     get:

  5151.       summary: List ratings of an account

  5152.       security:

  5153.         - OAuth2: []

  5154.       tags:

  5155.         - Accounts

  5156.       parameters:

  5157.         - $ref: '#/components/parameters/name'

  5158.         - $ref: '#/components/parameters/start'

  5159.         - $ref: '#/components/parameters/count'

  5160.         - $ref: '#/components/parameters/sort'

  5161.         - name: rating

  5162.           in: query

  5163.           required: false

  5164.           description: Optionally filter which ratings to retrieve

  5165.           schema:

  5166.             type: string

  5167.             enum:

  5168.               - like

  5169.               - dislike

  5170.       responses:

  5171.         '200':

  5172.           description: successful operation

  5173.           content:

  5174.             application/json:

  5175.               schema:

  5176.                 type: array

  5177.                 items:

  5178.                   $ref: '#/components/schemas/VideoRating'

  5179. 

  5180.   '/api/v1/videos/{id}/comment-threads':

  5181.     get:

  5182.       summary: List threads of a video

  5183.       tags:

  5184.         - Video Comments

  5185.       parameters:

  5186.         - $ref: '#/components/parameters/idOrUUID'

  5187.         - $ref: '#/components/parameters/start'

  5188.         - $ref: '#/components/parameters/count'

  5189.         - $ref: '#/components/parameters/commentsSort'

  5190.         - $ref: '#/components/parameters/videoPasswordHeader'

  5191.       responses:

  5192.         '200':

  5193.           description: successful operation

  5194.           content:

  5195.             application/json:

  5196.               schema:

  5197.                 $ref: '#/components/schemas/CommentThreadResponse'

  5198.     post:

  5199.       summary: Create a thread

  5200.       security:

  5201.         - OAuth2: []

  5202.       tags:

  5203.         - Video Comments

  5204.       parameters:

  5205.         - $ref: '#/components/parameters/idOrUUID'

  5206.       responses:

  5207.         '200':

  5208.           description: successful operation

  5209.           content:

  5210.             application/json:

  5211.               schema:

  5212.                 $ref: '#/components/schemas/CommentThreadPostResponse'

  5213.         '404':

  5214.           description: video does not exist

  5215.       requestBody:

  5216.         content:

  5217.           application/json:

  5218.             schema:

  5219.               type: object

  5220.               properties:

  5221.                 text:

  5222.                   allOf:

  5223.                     - $ref: '#/components/schemas/VideoComment/properties/text'

  5224.                   format: markdown

  5225.                   maxLength: 10000

  5226.               required:

  5227.                 - text

  5228. 

  5229.   '/api/v1/videos/{id}/comment-threads/{threadId}':

  5230.     get:

  5231.       summary: Get a thread

  5232.       tags:

  5233.         - Video Comments

  5234.       parameters:

  5235.         - $ref: '#/components/parameters/idOrUUID'

  5236.         - $ref: '#/components/parameters/threadId'

  5237.         - $ref: '#/components/parameters/videoPasswordHeader'

  5238.       responses:

  5239.         '200':

  5240.           description: successful operation

  5241.           content:

  5242.             application/json:

  5243.               schema:

  5244.                 $ref: '#/components/schemas/VideoCommentThreadTree'

  5245. 

  5246.   '/api/v1/videos/comments':

  5247.     get:

  5248.       summary: List instance comments

  5249.       security:

  5250.         - OAuth2:

  5251.           - admin

  5252.           - moderator

  5253.       tags:

  5254.         - Video Comments

  5255.       parameters:

  5256.         - $ref: '#/components/parameters/search'

  5257.         - $ref: '#/components/parameters/searchAccountForComments'

  5258.         - $ref: '#/components/parameters/searchVideoForComments'

  5259.         - $ref: '#/components/parameters/videoId'

  5260.         - $ref: '#/components/parameters/videoChannelId'

  5261.         - $ref: '#/components/parameters/autoTagOneOfComment'

  5262.         - $ref: '#/components/parameters/isLocal'

  5263.         - $ref: '#/components/parameters/onLocalVideo'

  5264. 

  5265.       responses:

  5266.         '200':

  5267.           description: successful operation

  5268.           content:

  5269.             application/json:

  5270.               schema:

  5271.                 type: object

  5272.                 properties:

  5273.                   total:

  5274.                     type: integer

  5275.                     example: 1

  5276.                   data:

  5277.                     type: array

  5278.                     items:

  5279.                       $ref: '#/components/schemas/VideoCommentForOwnerOrAdmin'

  5280. 

  5281.   '/api/v1/videos/{id}/comments/{commentId}':

  5282.     post:

  5283.       summary: Reply to a thread of a video

  5284.       security:

  5285.         - OAuth2: []

  5286.       tags:

  5287.         - Video Comments

  5288.       parameters:

  5289.         - $ref: '#/components/parameters/idOrUUID'

  5290.         - $ref: '#/components/parameters/commentId'

  5291.         - $ref: '#/components/parameters/videoPasswordHeader'

  5292.       responses:

  5293.         '200':

  5294.           description: successful operation

  5295.           content:

  5296.             application/json:

  5297.               schema:

  5298.                 $ref: '#/components/schemas/CommentThreadPostResponse'

  5299.         '404':

  5300.           description: thread or video does not exist

  5301.       requestBody:

  5302.         content:

  5303.           application/json:

  5304.             schema:

  5305.               type: object

  5306.               properties:

  5307.                 text:

  5308.                   allOf:

  5309.                     - $ref: '#/components/schemas/VideoComment/properties/text'

  5310.                   format: markdown

  5311.                   maxLength: 10000

  5312.               required:

  5313.                 - text

  5314.     delete:

  5315.       summary: Delete a comment or a reply

  5316.       security:

  5317.         - OAuth2: []

  5318.       tags:

  5319.         - Video Comments

  5320.       parameters:

  5321.         - $ref: '#/components/parameters/idOrUUID'

  5322.         - $ref: '#/components/parameters/commentId'

  5323.       responses:

  5324.         '204':

  5325.           description: successful operation

  5326.         '403':

  5327.           description: cannot remove comment of another user

  5328.         '404':

  5329.           description: comment or video does not exist

  5330.         '409':

  5331.           description: comment is already deleted

  5332. 

  5333.   '/api/v1/videos/{id}/comments/{commentId}/approve':

  5334.     post:

  5335.       summary: Approve a comment

  5336.       description: "**PeerTube >= 6.2** Approve a comment that requires a review"

  5337.       security:

  5338.         - OAuth2: []

  5339.       tags:

  5340.         - Video Comments

  5341.       parameters:

  5342.         - $ref: '#/components/parameters/idOrUUID'

  5343.         - $ref: '#/components/parameters/commentId'

  5344.       responses:

  5345.         '204':

  5346.           description: successful operation

  5347. 

  5348.   '/api/v1/videos/{id}/rate':

  5349.     put:

  5350.       summary: Like/dislike a video

  5351.       security:

  5352.         - OAuth2: []

  5353.       tags:

  5354.         - Video Rates

  5355.       parameters:

  5356.         - $ref: '#/components/parameters/idOrUUID'

  5357.         - $ref: '#/components/parameters/videoPasswordHeader'

  5358.       requestBody:

  5359.         content:

  5360.           application/json:

  5361.             schema:

  5362.               type: object

  5363.               properties:

  5364.                 rating:

  5365.                   type: string

  5366.                   enum:

  5367.                     - like

  5368.                     - dislike

  5369.               required:

  5370.                 - rating

  5371.       responses:

  5372.         '204':

  5373.           description: successful operation

  5374.         '404':

  5375.           description: video does not exist

  5376. 

  5377.   '/api/v1/videos/{id}/hls':

  5378.     delete:

  5379.       summary: Delete video HLS files

  5380.       security:

  5381.         - OAuth2:

  5382.           - admin

  5383.       tags:

  5384.         - Video Files

  5385.       operationId: delVideoHLS

  5386.       parameters:

  5387.         - $ref: '#/components/parameters/idOrUUID'

  5388.       responses:

  5389.         '204':

  5390.           description: successful operation

  5391.         '404':

  5392.           description: video does not exist

  5393.   '/api/v1/videos/{id}/web-videos':

  5394.     delete:

  5395.       summary: Delete video Web Video files

  5396.       description: "**PeerTube >= 6.0**"

  5397.       security:

  5398.         - OAuth2:

  5399.           - admin

  5400.       tags:

  5401.         - Video Files

  5402.       operationId: delVideoWebVideos

  5403.       parameters:

  5404.         - $ref: '#/components/parameters/idOrUUID'

  5405.       responses:

  5406.         '204':

  5407.           description: successful operation

  5408.         '404':

  5409.           description: video does not exist

  5410. 

  5411.   '/api/v1/videos/{id}/transcoding':

  5412.     post:

  5413.       summary: Create a transcoding job

  5414.       security:

  5415.         - OAuth2:

  5416.           - admin

  5417.       tags:

  5418.         - Video Transcoding

  5419.       operationId: createVideoTranscoding

  5420.       parameters:

  5421.         - $ref: '#/components/parameters/idOrUUID'

  5422.       requestBody:

  5423.           content:

  5424.             application/json:

  5425.               schema:

  5426.                 type: object

  5427.                 properties:

  5428.                   transcodingType:

  5429.                     type: string

  5430.                     enum:

  5431.                       - hls

  5432.                       - web-video

  5433.                   forceTranscoding:

  5434.                     type: boolean

  5435.                     default: false

  5436.                     description: If the video is stuck in transcoding state, do it anyway

  5437.                 required:

  5438.                   - transcodingType

  5439.       responses:

  5440.         '204':

  5441.           description: successful operation

  5442.         '404':

  5443.           description: video does not exist

  5444. 

  5445.   /api/v1/search/videos:

  5446.     get:

  5447.       tags:

  5448.         - Search

  5449.         - Video

  5450.       summary: Search videos

  5451.       operationId: searchVideos

  5452.       parameters:

  5453.         - name: search

  5454.           in: query

  5455.           required: true

  5456.           allowEmptyValue: false

  5457.           description: >

  5458.             String to search. If the user can make a remote URI search, and the string is an URI then the

  5459.             PeerTube instance will fetch the remote object and add it to its database. Then,

  5460.             you can use the REST API to fetch the complete video information and interact with it.

  5461.           schema:

  5462.             type: string

  5463.         - $ref: '#/components/parameters/categoryOneOf'

  5464.         - $ref: '#/components/parameters/isLive'

  5465.         - $ref: '#/components/parameters/tagsOneOf'

  5466.         - $ref: '#/components/parameters/tagsAllOf'

  5467.         - $ref: '#/components/parameters/licenceOneOf'

  5468.         - $ref: '#/components/parameters/languageOneOf'

  5469.         - $ref: '#/components/parameters/autoTagOneOfVideo'

  5470.         - $ref: '#/components/parameters/nsfw'

  5471.         - $ref: '#/components/parameters/isLocal'

  5472.         - $ref: '#/components/parameters/include'

  5473.         - $ref: '#/components/parameters/privacyOneOf'

  5474.         - $ref: '#/components/parameters/uuids'

  5475.         - $ref: '#/components/parameters/hasHLSFiles'

  5476.         - $ref: '#/components/parameters/hasWebVideoFiles'

  5477.         - $ref: '#/components/parameters/skipCount'

  5478.         - $ref: '#/components/parameters/start'

  5479.         - $ref: '#/components/parameters/count'

  5480.         - $ref: '#/components/parameters/searchTarget'

  5481.         - $ref: '#/components/parameters/videosSearchSort'

  5482.         - $ref: '#/components/parameters/excludeAlreadyWatched'

  5483.         - $ref: '#/components/parameters/host'

  5484.         - name: startDate

  5485.           in: query

  5486.           description: Get videos that are published after this date

  5487.           schema:

  5488.             type: string

  5489.             format: date-time

  5490.         - name: endDate

  5491.           in: query

  5492.           description: Get videos that are published before this date

  5493.           schema:

  5494.             type: string

  5495.             format: date-time

  5496.         - name: originallyPublishedStartDate

  5497.           in: query

  5498.           description: Get videos that are originally published after this date

  5499.           schema:

  5500.             type: string

  5501.             format: date-time

  5502.         - name: originallyPublishedEndDate

  5503.           in: query

  5504.           description: Get videos that are originally published before this date

  5505.           schema:

  5506.             type: string

  5507.             format: date-time

  5508.         - name: durationMin

  5509.           in: query

  5510.           description: Get videos that have this minimum duration

  5511.           schema:

  5512.             type: integer

  5513.         - name: durationMax

  5514.           in: query

  5515.           description: Get videos that have this maximum duration

  5516.           schema:

  5517.             type: integer

  5518.       callbacks:

  5519.         'searchTarget === search-index':

  5520.           $ref: '#/components/callbacks/searchIndex'

  5521.       responses:

  5522.         '200':

  5523.           description: successful operation

  5524.           content:

  5525.             application/json:

  5526.               schema:

  5527.                 $ref: '#/components/schemas/VideoListResponse'

  5528.         '500':

  5529.           description: search index unavailable

  5530. 

  5531.   /api/v1/search/video-channels:

  5532.     get:

  5533.       tags:

  5534.         - Search

  5535.         - Video Channels

  5536.       summary: Search channels

  5537.       operationId: searchChannels

  5538.       parameters:

  5539.         - name: search

  5540.           in: query

  5541.           required: true

  5542.           description: >

  5543.             String to search. If the user can make a remote URI search, and the string is an URI then the

  5544.             PeerTube instance will fetch the remote object and add it to its database. Then,

  5545.             you can use the REST API to fetch the complete channel information and interact with it.

  5546.           schema:

  5547.             type: string

  5548.         - $ref: '#/components/parameters/start'

  5549.         - $ref: '#/components/parameters/count'

  5550.         - $ref: '#/components/parameters/searchTarget'

  5551.         - $ref: '#/components/parameters/sort'

  5552.         - $ref: '#/components/parameters/host'

  5553.         - $ref: '#/components/parameters/handles'

  5554.       callbacks:

  5555.         'searchTarget === search-index':

  5556.           $ref: '#/components/callbacks/searchIndex'

  5557.       responses:

  5558.         '200':

  5559.           description: successful operation

  5560.           content:

  5561.             application/json:

  5562.               schema:

  5563.                 $ref: '#/components/schemas/VideoChannelList'

  5564.         '500':

  5565.           description: search index unavailable

  5566. 

  5567.   /api/v1/search/video-playlists:

  5568.     get:

  5569.       tags:

  5570.         - Search

  5571.         - Video Playlists

  5572.       summary: Search playlists

  5573.       operationId: searchPlaylists

  5574.       parameters:

  5575.         - name: search

  5576.           in: query

  5577.           required: true

  5578.           description: >

  5579.             String to search. If the user can make a remote URI search, and the string is an URI then the

  5580.             PeerTube instance will fetch the remote object and add it to its database. Then,

  5581.             you can use the REST API to fetch the complete playlist information and interact with it.

  5582.           schema:

  5583.             type: string

  5584.         - $ref: '#/components/parameters/start'

  5585.         - $ref: '#/components/parameters/count'

  5586.         - $ref: '#/components/parameters/searchTarget'

  5587.         - $ref: '#/components/parameters/sort'

  5588.         - $ref: '#/components/parameters/host'

  5589.         - $ref: '#/components/parameters/uuids'

  5590.       callbacks:

  5591.         'searchTarget === search-index':

  5592.           $ref: '#/components/callbacks/searchIndex'

  5593.       responses:

  5594.         '200':

  5595.           description: successful operation

  5596.           content:

  5597.             application/json:

  5598.               schema:

  5599.                 type: object

  5600.                 properties:

  5601.                   total:

  5602.                     type: integer

  5603.                     example: 1

  5604.                   data:

  5605.                     type: array

  5606.                     items:

  5607.                       $ref: '#/components/schemas/VideoPlaylist'

  5608.         '500':

  5609.           description: search index unavailable

  5610. 

  5611.   /api/v1/blocklist/status:

  5612.     get:

  5613.       tags:

  5614.         - Account Blocks

  5615.         - Server Blocks

  5616.       summary: Get block status of accounts/hosts

  5617.       parameters:

  5618.         -

  5619.           name: 'accounts'

  5620.           in: query

  5621.           description: 'Check if these accounts are blocked'

  5622.           example: [ 'goofy@example.com', 'donald@example.com' ]

  5623.           schema:

  5624.             type: array

  5625.             items:

  5626.               type: string

  5627.         -

  5628.           name: 'hosts'

  5629.           in: query

  5630.           description: 'Check if these hosts are blocked'

  5631.           example: [ 'example.com' ]

  5632.           schema:

  5633.             type: array

  5634.             items:

  5635.               type: string

  5636.       responses:

  5637.         '200':

  5638.           description: successful operation

  5639.           content:

  5640.             'application/json':

  5641.               schema:

  5642.                 $ref: '#/components/schemas/BlockStatus'

  5643. 

  5644.   /api/v1/server/blocklist/accounts:

  5645.     get:

  5646.       tags:

  5647.         - Account Blocks

  5648.       summary: List account blocks

  5649.       security:

  5650.         - OAuth2:

  5651.           - admin

  5652.       parameters:

  5653.         - $ref: '#/components/parameters/start'

  5654.         - $ref: '#/components/parameters/count'

  5655.         - $ref: '#/components/parameters/sort'

  5656.       responses:

  5657.         '200':

  5658.           description: successful operation

  5659.     post:

  5660.       tags:

  5661.         - Account Blocks

  5662.       summary: Block an account

  5663.       security:

  5664.         - OAuth2:

  5665.           - admin

  5666.       requestBody:

  5667.         content:

  5668.           application/json:

  5669.             schema:

  5670.               type: object

  5671.               properties:

  5672.                 accountName:

  5673.                   type: string

  5674.                   example: chocobozzz@example.org

  5675.                   description: account to block, in the form `username@domain`

  5676.               required:

  5677.                 - accountName

  5678.       responses:

  5679.         '200':

  5680.           description: successful operation

  5681.         '409':

  5682.           description: self-blocking forbidden

  5683. 

  5684.   '/api/v1/server/blocklist/accounts/{accountName}':

  5685.     delete:

  5686.       tags:

  5687.         - Account Blocks

  5688.       summary: Unblock an account by its handle

  5689.       security:

  5690.         - OAuth2:

  5691.           - admin

  5692.       parameters:

  5693.         - name: accountName

  5694.           in: path

  5695.           required: true

  5696.           description: account to unblock, in the form `username@domain`

  5697.           schema:

  5698.             type: string

  5699.       responses:

  5700.         '201':

  5701.           description: successful operation

  5702.         '404':

  5703.           description: account or account block does not exist

  5704. 

  5705.   /api/v1/server/blocklist/servers:

  5706.     get:

  5707.       tags:

  5708.         - Server Blocks

  5709.       summary: List server blocks

  5710.       security:

  5711.         - OAuth2:

  5712.           - admin

  5713.       parameters:

  5714.         - $ref: '#/components/parameters/start'

  5715.         - $ref: '#/components/parameters/count'

  5716.         - $ref: '#/components/parameters/sort'

  5717.       responses:

  5718.         '200':

  5719.           description: successful operation

  5720.     post:

  5721.       tags:

  5722.         - Server Blocks

  5723.       summary: Block a server

  5724.       security:

  5725.         - OAuth2:

  5726.           - admin

  5727.       requestBody:

  5728.         content:

  5729.           application/json:

  5730.             schema:

  5731.               type: object

  5732.               properties:

  5733.                 host:

  5734.                   type: string

  5735.                   format: hostname

  5736.                   description: server domain to block

  5737.               required:

  5738.                 - host

  5739.       responses:

  5740.         '204':

  5741.           description: successful operation

  5742.         '409':

  5743.           description: self-blocking forbidden

  5744. 

  5745.   '/api/v1/server/blocklist/servers/{host}':

  5746.     delete:

  5747.       tags:

  5748.         - Server Blocks

  5749.       summary: Unblock a server by its domain

  5750.       security:

  5751.         - OAuth2:

  5752.           - admin

  5753.       parameters:

  5754.         - name: host

  5755.           in: path

  5756.           required: true

  5757.           description: server domain to unblock

  5758.           schema:

  5759.             type: string

  5760.             format: hostname

  5761.       responses:

  5762.         '204':

  5763.           description: successful operation

  5764.         '404':

  5765.           description: account block does not exist

  5766. 

  5767.   /api/v1/server/redundancy/{host}:

  5768.     put:

  5769.       tags:

  5770.         - Instance Redundancy

  5771.       summary: Update a server redundancy policy

  5772.       security:

  5773.         - OAuth2:

  5774.           - admin

  5775.       parameters:

  5776.         - name: host

  5777.           in: path

  5778.           required: true

  5779.           description: server domain to mirror

  5780.           schema:

  5781.             type: string

  5782.             format: hostname

  5783.       requestBody:

  5784.         content:

  5785.           application/json:

  5786.             schema:

  5787.               type: object

  5788.               properties:

  5789.                 redundancyAllowed:

  5790.                   type: boolean

  5791.                   description: allow mirroring of the host's local videos

  5792.               required:

  5793.                 - redundancyAllowed

  5794.       responses:

  5795.         '204':

  5796.           description: successful operation

  5797.         '404':

  5798.           description: server is not already known

  5799. 

  5800.   /api/v1/server/redundancy/videos:

  5801.     get:

  5802.       tags:

  5803.         - Video Mirroring

  5804.       summary: List videos being mirrored

  5805.       operationId: getMirroredVideos

  5806.       security:

  5807.         - OAuth2:

  5808.           - admin

  5809.       parameters:

  5810.         - name: target

  5811.           in: query

  5812.           required: true

  5813.           description: direction of the mirror

  5814.           schema:

  5815.             type: string

  5816.             enum:

  5817.               - my-videos

  5818.               - remote-videos

  5819.         - $ref: '#/components/parameters/start'

  5820.         - $ref: '#/components/parameters/count'

  5821.         - $ref: '#/components/parameters/videoRedundanciesSort'

  5822.       responses:

  5823.         '200':

  5824.           description: successful operation

  5825.           content:

  5826.             application/json:

  5827.               schema:

  5828.                 type: array

  5829.                 items:

  5830.                   $ref: '#/components/schemas/VideoRedundancy'

  5831.     post:

  5832.       tags:

  5833.         - Video Mirroring

  5834.       summary: Mirror a video

  5835.       operationId: putMirroredVideo

  5836.       security:

  5837.         - OAuth2:

  5838.           - admin

  5839.       requestBody:

  5840.         content:

  5841.           application/json:

  5842.             schema:

  5843.               type: object

  5844.               properties:

  5845.                 videoId:

  5846.                   $ref: '#/components/schemas/Video/properties/id'

  5847.               required:

  5848.                 - videoId

  5849.       responses:

  5850.         '204':

  5851.           description: successful operation

  5852.         '400':

  5853.           description: cannot mirror a local video

  5854.         '404':

  5855.           description: video does not exist

  5856.         '409':

  5857.           description: video is already mirrored

  5858. 

  5859.   /api/v1/server/redundancy/videos/{redundancyId}:

  5860.     delete:

  5861.       tags:

  5862.         - Video Mirroring

  5863.       summary: Delete a mirror done on a video

  5864.       operationId: delMirroredVideo

  5865.       security:

  5866.         - OAuth2:

  5867.           - admin

  5868.       parameters:

  5869.         - name: redundancyId

  5870.           in: path

  5871.           required: true

  5872.           description: id of an existing redundancy on a video

  5873.           schema:

  5874.             type: string

  5875.       responses:

  5876.         '204':

  5877.           description: successful operation

  5878.         '404':

  5879.           description: video redundancy not found

  5880. 

  5881.   /api/v1/server/stats:

  5882.     get:

  5883.       tags:

  5884.         - Stats

  5885.       summary: Get instance stats

  5886.       description: Get instance public statistics. This endpoint is cached.

  5887.       operationId: getInstanceStats

  5888.       responses:

  5889.         '200':

  5890.           description: successful operation

  5891.           content:

  5892.             application/json:

  5893.               schema:

  5894.                 $ref: '#/components/schemas/ServerStats'

  5895. 

  5896.   /api/v1/server/logs/client:

  5897.     post:

  5898.       tags:

  5899.         - Logs

  5900.       summary: Send client log

  5901.       operationId: sendClientLog

  5902.       requestBody:

  5903.         content:

  5904.           application/json:

  5905.             schema:

  5906.               $ref: '#/components/schemas/SendClientLog'

  5907.       responses:

  5908.         '204':

  5909.           description: successful operation

  5910. 

  5911.   /api/v1/server/logs:

  5912.     get:

  5913.       tags:

  5914.         - Logs

  5915.       summary: Get instance logs

  5916.       operationId: getInstanceLogs

  5917.       security:

  5918.         - OAuth2:

  5919.           - admin

  5920.       responses:

  5921.         '200':

  5922.           description: successful operation

  5923.           content:

  5924.             application/json:

  5925.               schema:

  5926.                 type: array

  5927.                 items:

  5928.                   type: string

  5929. 

  5930.   /api/v1/server/audit-logs:

  5931.     get:

  5932.       tags:

  5933.         - Logs

  5934.       summary: Get instance audit logs

  5935.       operationId: getInstanceAuditLogs

  5936.       security:

  5937.         - OAuth2:

  5938.           - admin

  5939.       responses:

  5940.         '200':

  5941.           description: successful operation

  5942.           content:

  5943.             application/json:

  5944.               schema:

  5945.                 type: array

  5946.                 items:

  5947.                   type: string

  5948. 

  5949.   /api/v1/plugins:

  5950.     get:

  5951.       tags:

  5952.         - Plugins

  5953.       summary: List plugins

  5954.       operationId: getPlugins

  5955.       security:

  5956.         - OAuth2:

  5957.           - admin

  5958.       parameters:

  5959.         - name: pluginType

  5960.           in: query

  5961.           schema:

  5962.             type: integer

  5963.         - name: uninstalled

  5964.           in: query

  5965.           schema:

  5966.             type: boolean

  5967.         - $ref: '#/components/parameters/start'

  5968.         - $ref: '#/components/parameters/count'

  5969.         - $ref: '#/components/parameters/sort'

  5970.       responses:

  5971.         '200':

  5972.           description: successful operation

  5973.           content:

  5974.             application/json:

  5975.               schema:

  5976.                 $ref: '#/components/schemas/PluginResponse'

  5977. 

  5978.   /api/v1/plugins/available:

  5979.     get:

  5980.       tags:

  5981.         - Plugins

  5982.       summary: List available plugins

  5983.       operationId: getAvailablePlugins

  5984.       security:

  5985.         - OAuth2:

  5986.           - admin

  5987.       parameters:

  5988.         - name: search

  5989.           in: query

  5990.           schema:

  5991.             type: string

  5992.         - name: pluginType

  5993.           in: query

  5994.           schema:

  5995.             type: integer

  5996.         - name: currentPeerTubeEngine

  5997.           in: query

  5998.           schema:

  5999.             type: string

  6000.         - $ref: '#/components/parameters/start'

  6001.         - $ref: '#/components/parameters/count'

  6002.         - $ref: '#/components/parameters/sort'

  6003.       responses:

  6004.         '200':

  6005.           description: successful operation

  6006.           content:

  6007.             application/json:

  6008.               schema:

  6009.                 $ref: '#/components/schemas/PluginResponse'

  6010.         '503':

  6011.           description: plugin index unavailable

  6012. 

  6013.   /api/v1/plugins/install:

  6014.     post:

  6015.       tags:

  6016.         - Plugins

  6017.       summary: Install a plugin

  6018.       operationId: addPlugin

  6019.       security:

  6020.         - OAuth2:

  6021.           - admin

  6022.       requestBody:

  6023.         content:

  6024.           application/json:

  6025.             schema:

  6026.               oneOf:

  6027.                 - type: object

  6028.                   properties:

  6029.                     npmName:

  6030.                       type: string

  6031.                       example: peertube-plugin-auth-ldap

  6032.                   required:

  6033.                     - npmName

  6034.                   additionalProperties: false

  6035.                 - type: object

  6036.                   properties:

  6037.                     path:

  6038.                       type: string

  6039.                   required:

  6040.                     - path

  6041.                   additionalProperties: false

  6042.       responses:

  6043.         '204':

  6044.           description: successful operation

  6045.         '400':

  6046.           description: should have either `npmName` or `path` set

  6047. 

  6048.   /api/v1/plugins/update:

  6049.     post:

  6050.       tags:

  6051.         - Plugins

  6052.       summary: Update a plugin

  6053.       operationId: updatePlugin

  6054.       security:

  6055.         - OAuth2:

  6056.           - admin

  6057.       requestBody:

  6058.         content:

  6059.           application/json:

  6060.             schema:

  6061.               oneOf:

  6062.                 - type: object

  6063.                   properties:

  6064.                     npmName:

  6065.                       type: string

  6066.                       example: peertube-plugin-auth-ldap

  6067.                   required:

  6068.                     - npmName

  6069.                   additionalProperties: false

  6070.                 - type: object

  6071.                   properties:

  6072.                     path:

  6073.                       type: string

  6074.                   required:

  6075.                     - path

  6076.                   additionalProperties: false

  6077.       responses:

  6078.         '204':

  6079.           description: successful operation

  6080.         '400':

  6081.           description: should have either `npmName` or `path` set

  6082.         '404':

  6083.           description: existing plugin not found

  6084. 

  6085.   /api/v1/plugins/uninstall:

  6086.     post:

  6087.       tags:

  6088.         - Plugins

  6089.       summary: Uninstall a plugin

  6090.       operationId: uninstallPlugin

  6091.       security:

  6092.         - OAuth2:

  6093.           - admin

  6094.       requestBody:

  6095.         content:

  6096.           application/json:

  6097.             schema:

  6098.               type: object

  6099.               properties:

  6100.                 npmName:

  6101.                   type: string

  6102.                   description: name of the plugin/theme in its package.json

  6103.                   example: peertube-plugin-auth-ldap

  6104.               required:

  6105.                 - npmName

  6106.       responses:

  6107.         '204':

  6108.           description: successful operation

  6109.         '404':

  6110.           description: existing plugin not found

  6111. 

  6112.   /api/v1/plugins/{npmName}:

  6113.     get:

  6114.       tags:

  6115.         - Plugins

  6116.       summary: Get a plugin

  6117.       operationId: getPlugin

  6118.       security:

  6119.         - OAuth2:

  6120.           - admin

  6121.       parameters:

  6122.         - $ref: '#/components/parameters/npmName'

  6123.       responses:

  6124.         '200':

  6125.           description: successful operation

  6126.           content:

  6127.             application/json:

  6128.               schema:

  6129.                 $ref: '#/components/schemas/Plugin'

  6130.         '404':

  6131.           description: plugin not found

  6132. 

  6133.   /api/v1/plugins/{npmName}/settings:

  6134.     put:

  6135.       tags:

  6136.         - Plugins

  6137.       summary: Set a plugin's settings

  6138.       security:

  6139.         - OAuth2:

  6140.           - admin

  6141.       parameters:

  6142.         - $ref: '#/components/parameters/npmName'

  6143.       requestBody:

  6144.         content:

  6145.           application/json:

  6146.             schema:

  6147.               type: object

  6148.               properties:

  6149.                 settings:

  6150.                   type: object

  6151.                   additionalProperties: true

  6152.       responses:

  6153.         '204':

  6154.           description: successful operation

  6155.         '404':

  6156.           description: plugin not found

  6157. 

  6158.   /api/v1/plugins/{npmName}/public-settings:

  6159.     get:

  6160.       tags:

  6161.         - Plugins

  6162.       summary: Get a plugin's public settings

  6163.       parameters:

  6164.         - $ref: '#/components/parameters/npmName'

  6165.       responses:

  6166.         '200':

  6167.           description: successful operation

  6168.           content:

  6169.             application/json:

  6170.               schema:

  6171.                 type: object

  6172.                 additionalProperties: true

  6173.         '404':

  6174.           description: plugin not found

  6175. 

  6176.   /api/v1/plugins/{npmName}/registered-settings:

  6177.     get:

  6178.       tags:

  6179.         - Plugins

  6180.       summary: Get a plugin's registered settings

  6181.       security:

  6182.         - OAuth2:

  6183.           - admin

  6184.       parameters:

  6185.         - $ref: '#/components/parameters/npmName'

  6186.       responses:

  6187.         '200':

  6188.           description: successful operation

  6189.           content:

  6190.             application/json:

  6191.               schema:

  6192.                 type: object

  6193.                 additionalProperties: true

  6194.         '404':

  6195.           description: plugin not found

  6196. 

  6197.   /api/v1/metrics/playback:

  6198.     post:

  6199.       summary: Create playback metrics

  6200.       description: These metrics are exposed by OpenTelemetry metrics exporter if enabled.

  6201.       tags:

  6202.         - Stats

  6203.       requestBody:

  6204.         content:

  6205.           application/json:

  6206.             schema:

  6207.               $ref: '#/components/schemas/PlaybackMetricCreate'

  6208.       responses:

  6209.         '204':

  6210.           description: successful operation

  6211. 

  6212.   /api/v1/runners/registration-tokens/generate:

  6213.     post:

  6214.       summary: Generate registration token

  6215.       description: Generate a new runner registration token

  6216.       security:

  6217.         - OAuth2:

  6218.           - admin

  6219.       tags:

  6220.         - Runner Registration Token

  6221.       responses:

  6222.         '204':

  6223.           description: successful operation

  6224. 

  6225.   /api/v1/runners/registration-tokens/{registrationTokenId}:

  6226.     delete:

  6227.       summary: Remove registration token

  6228.       description: Remove a registration token. Runners that used this token for their registration are automatically removed.

  6229.       security:

  6230.         - OAuth2:

  6231.           - admin

  6232.       tags:

  6233.         - Runner Registration Token

  6234.       parameters:

  6235.         - $ref: '#/components/parameters/registrationTokenId'

  6236.       responses:

  6237.         '204':

  6238.           description: successful operation

  6239. 

  6240.   /api/v1/runners/registration-tokens:

  6241.     get:

  6242.       summary: List registration tokens

  6243.       security:

  6244.         - OAuth2:

  6245.           - admin

  6246.       tags:

  6247.         - Runner Registration Token

  6248.       parameters:

  6249.         - $ref: '#/components/parameters/start'

  6250.         - $ref: '#/components/parameters/count'

  6251.         - $ref: '#/components/parameters/registrationTokenSort'

  6252.       responses:

  6253.         '200':

  6254.           description: successful operation

  6255.           content:

  6256.             application/json:

  6257.               schema:

  6258.                 type: object

  6259.                 properties:

  6260.                   total:

  6261.                     type: integer

  6262.                     example: 1

  6263.                   data:

  6264.                     type: array

  6265.                     items:

  6266.                       $ref: '#/components/schemas/RunnerRegistrationToken'

  6267. 

  6268.   /api/v1/runners/register:

  6269.     post:

  6270.       summary: Register a new runner

  6271.       description: API used by PeerTube runners

  6272.       tags:

  6273.         - Runners

  6274.       requestBody:

  6275.         content:

  6276.           application/json:

  6277.             schema:

  6278.               type: object

  6279.               properties:

  6280.                 registrationToken:

  6281.                   type: string

  6282.                 name:

  6283.                   type: string

  6284.                 description:

  6285.                   type: string

  6286.               required:

  6287.                 - registrationToken

  6288.                 - name

  6289.       responses:

  6290.         '200':

  6291.           description: successful operation

  6292.           content:

  6293.             application/json:

  6294.               schema:

  6295.                 type: object

  6296.                 properties:

  6297.                   id:

  6298.                     type: integer

  6299.                     description: Runner id

  6300.                   runnerToken:

  6301.                     type: string

  6302. 

  6303.   /api/v1/runners/unregister:

  6304.     post:

  6305.       summary: Unregister a runner

  6306.       description: API used by PeerTube runners

  6307.       tags:

  6308.         - Runners

  6309.       requestBody:

  6310.         content:

  6311.           application/json:

  6312.             schema:

  6313.               type: object

  6314.               properties:

  6315.                 runnerToken:

  6316.                   type: string

  6317.               required:

  6318.                 - runnerToken

  6319.       responses:

  6320.         '204':

  6321.           description: successful operation

  6322. 

  6323.   /api/v1/runners/{runnerId}:

  6324.     delete:

  6325.       summary: Delete a runner

  6326.       security:

  6327.         - OAuth2:

  6328.           - admin

  6329.       tags:

  6330.         - Runners

  6331.       parameters:

  6332.         - $ref: '#/components/parameters/runnerId'

  6333.       requestBody:

  6334.         content:

  6335.           application/json:

  6336.             schema:

  6337.               type: object

  6338.               properties:

  6339.                 runnerToken:

  6340.                   type: string

  6341.               required:

  6342.                 - runnerToken

  6343.       responses:

  6344.         '204':

  6345.           description: successful operation

  6346. 

  6347.   /api/v1/runners:

  6348.     get:

  6349.       summary: List runners

  6350.       security:

  6351.         - OAuth2:

  6352.           - admin

  6353.       tags:

  6354.         - Runners

  6355.       parameters:

  6356.         - $ref: '#/components/parameters/start'

  6357.         - $ref: '#/components/parameters/count'

  6358.         - $ref: '#/components/parameters/runnerSort'

  6359.       responses:

  6360.         '200':

  6361.           description: successful operation

  6362.           content:

  6363.             application/json:

  6364.               schema:

  6365.                 type: object

  6366.                 properties:

  6367.                   total:

  6368.                     type: integer

  6369.                     example: 1

  6370.                   data:

  6371.                     type: array

  6372.                     items:

  6373.                       $ref: '#/components/schemas/Runner'

  6374. 

  6375. 

  6376.   /api/v1/runners/jobs/request:

  6377.     post:

  6378.       summary: Request a new job

  6379.       description: API used by PeerTube runners

  6380.       tags:

  6381.         - Runner Jobs

  6382.       requestBody:

  6383.         content:

  6384.           application/json:

  6385.             schema:

  6386.               type: object

  6387.               properties:

  6388.                 runnerToken:

  6389.                   type: string

  6390.               required:

  6391.                 - runnerToken

  6392.       responses:

  6393.         '200':

  6394.           description: successful operation

  6395.           content:

  6396.             application/json:

  6397.               schema:

  6398.                 type: object

  6399.                 properties:

  6400.                   availableJobs:

  6401.                     type: array

  6402.                     items:

  6403.                       type: object

  6404.                       properties:

  6405.                         uuid:

  6406.                           $ref: '#/components/schemas/UUIDv4'

  6407.                         type:

  6408.                           $ref: '#/components/schemas/RunnerJobType'

  6409.                         payload:

  6410.                           $ref: '#/components/schemas/RunnerJobPayload'

  6411. 

  6412.   /api/v1/runners/jobs/{jobUUID}/accept:

  6413.     post:

  6414.       summary: Accept job

  6415.       description: API used by PeerTube runners

  6416.       tags:

  6417.         - Runner Jobs

  6418.       parameters:

  6419.         - $ref: '#/components/parameters/jobUUID'

  6420.       requestBody:

  6421.         content:

  6422.           application/json:

  6423.             schema:

  6424.               type: object

  6425.               properties:

  6426.                 runnerToken:

  6427.                   type: string

  6428.               required:

  6429.                 - runnerToken

  6430.       responses:

  6431.         '200':

  6432.           description: successful operation

  6433.           content:

  6434.             application/json:

  6435.               schema:

  6436.                 type: object

  6437.                 properties:

  6438.                   job:

  6439.                     allOf:

  6440.                       - $ref: '#/components/schemas/RunnerJob'

  6441.                       - type: object

  6442.                         properties:

  6443.                           jobToken:

  6444.                             type: string

  6445. 

  6446.   /api/v1/runners/jobs/{jobUUID}/abort:

  6447.     post:

  6448.       summary: Abort job

  6449.       description: API used by PeerTube runners

  6450.       tags:

  6451.         - Runner Jobs

  6452.       parameters:

  6453.         - $ref: '#/components/parameters/jobUUID'

  6454.       requestBody:

  6455.         content:

  6456.           application/json:

  6457.             schema:

  6458.               type: object

  6459.               properties:

  6460.                 runnerToken:

  6461.                   type: string

  6462.                 jobToken:

  6463.                   type: string

  6464.                 reason:

  6465.                   type: string

  6466.                   description: Why the runner aborts this job

  6467.               required:

  6468.                 - runnerToken

  6469.                 - jobToken

  6470.                 - reason

  6471.       responses:

  6472.         '204':

  6473.           description: successful operation

  6474. 

  6475.   /api/v1/runners/jobs/{jobUUID}/update:

  6476.     post:

  6477.       summary: Update job

  6478.       description: API used by PeerTube runners

  6479.       tags:

  6480.         - Runner Jobs

  6481.       parameters:

  6482.         - $ref: '#/components/parameters/jobUUID'

  6483.       requestBody:

  6484.         content:

  6485.           application/json:

  6486.             schema:

  6487.               type: object

  6488.               properties:

  6489.                 runnerToken:

  6490.                   type: string

  6491.                 jobToken:

  6492.                   type: string

  6493.                 progress:

  6494.                   type: integer

  6495.                   description: Update job progression percentage (optional)

  6496.                 payload:

  6497.                   anyOf:

  6498.                     - type: object

  6499.                       description: Provide live transcoding chunks update

  6500.                       properties:

  6501.                         type:

  6502.                           type: string

  6503.                           enum:

  6504.                             - 'add-chunk'

  6505.                             - 'remove-chunk'

  6506.                         masterPlaylistFile:

  6507.                           type: string

  6508.                           format: binary

  6509.                         resolutionPlaylistFile:

  6510.                           type: string

  6511.                           format: binary

  6512.                         resolutionPlaylistFilename:

  6513.                           type: string

  6514.                         videoChunkFile:

  6515.                           type: string

  6516.                           format: binary

  6517.                         videoChunkFilename:

  6518.                           type: string

  6519.               required:

  6520.                 - runnerToken

  6521.                 - jobToken

  6522.       responses:

  6523.         '204':

  6524.           description: successful operation

  6525. 

  6526.   /api/v1/runners/jobs/{jobUUID}/error:

  6527.     post:

  6528.       summary: Post job error

  6529.       description: API used by PeerTube runners

  6530.       tags:

  6531.         - Runner Jobs

  6532.       parameters:

  6533.         - $ref: '#/components/parameters/jobUUID'

  6534.       requestBody:

  6535.         content:

  6536.           application/json:

  6537.             schema:

  6538.               type: object

  6539.               properties:

  6540.                 runnerToken:

  6541.                   type: string

  6542.                 jobToken:

  6543.                   type: string

  6544.                 message:

  6545.                   type: string

  6546.                   description: Why the runner failed to process this job

  6547.               required:

  6548.                 - runnerToken

  6549.                 - jobToken

  6550.                 - message

  6551.       responses:

  6552.         '204':

  6553.           description: successful operation

  6554. 

  6555.   /api/v1/runners/jobs/{jobUUID}/success:

  6556.     post:

  6557.       summary: Post job success

  6558.       description: API used by PeerTube runners

  6559.       tags:

  6560.         - Runner Jobs

  6561.       parameters:

  6562.         - $ref: '#/components/parameters/jobUUID'

  6563.       requestBody:

  6564.         content:

  6565.           application/json:

  6566.             schema:

  6567.               type: object

  6568.               properties:

  6569.                 runnerToken:

  6570.                   type: string

  6571.                 jobToken:

  6572.                   type: string

  6573.                 payload:

  6574.                   anyOf:

  6575.                     - type: object

  6576.                       title: VOD web video transcoding

  6577.                       properties:

  6578.                         videoFile:

  6579.                           type: string

  6580.                           format: binary

  6581.                     - type: object

  6582.                       title: VOD HLS transcoding

  6583.                       properties:

  6584.                         videoFile:

  6585.                           type: string

  6586.                           format: binary

  6587.                         resolutionPlaylistFile:

  6588.                           type: string

  6589.                           format: binary

  6590.                     - type: object

  6591.                       title: VOD audio merge transcoding

  6592.                       properties:

  6593.                         videoFile:

  6594.                           type: string

  6595.                           format: binary

  6596.                     - type: object

  6597.                       title: Live RTMP to HLS transcoding

  6598.               required:

  6599.                 - runnerToken

  6600.                 - jobToken

  6601.                 - payload

  6602.       responses:

  6603.         '204':

  6604.           description: successful operation

  6605. 

  6606.   /api/v1/runners/jobs/{jobUUID}/cancel:

  6607.     get:

  6608.       summary: Cancel a job

  6609.       security:

  6610.         - OAuth2:

  6611.           - admin

  6612.       tags:

  6613.         - Runner Jobs

  6614.       parameters:

  6615.         - $ref: '#/components/parameters/jobUUID'

  6616.       responses:

  6617.         '204':

  6618.           description: successful operation

  6619. 

  6620.   /api/v1/runners/jobs/{jobUUID}:

  6621.     delete:

  6622.       summary: Delete a job

  6623.       description: The endpoint will first cancel the job if needed, and then remove it from the database. Children jobs will also be removed

  6624.       security:

  6625.         - OAuth2:

  6626.           - admin

  6627.       tags:

  6628.         - Runner Jobs

  6629.       parameters:

  6630.         - $ref: '#/components/parameters/jobUUID'

  6631.       responses:

  6632.         '204':

  6633.           description: successful operation

  6634. 

  6635.   /api/v1/runners/jobs:

  6636.     get:

  6637.       summary: List jobs

  6638.       security:

  6639.         - OAuth2:

  6640.           - admin

  6641.       tags:

  6642.         - Runner Jobs

  6643.       parameters:

  6644.         - $ref: '#/components/parameters/start'

  6645.         - $ref: '#/components/parameters/count'

  6646.         - $ref: '#/components/parameters/runnerJobSort'

  6647.         - $ref: '#/components/parameters/search'

  6648.         - name: stateOneOf

  6649.           in: query

  6650.           required: false

  6651.           schema:

  6652.             type: array

  6653.             items:

  6654.               $ref: '#/components/schemas/RunnerJobState'

  6655.       responses:

  6656.         '200':

  6657.           description: successful operation

  6658.           content:

  6659.             application/json:

  6660.               schema:

  6661.                 type: object

  6662.                 properties:

  6663.                   total:

  6664.                     type: integer

  6665.                     example: 1

  6666.                   data:

  6667.                     type: array

  6668.                     items:

  6669.                       $ref: '#/components/schemas/RunnerJobAdmin'

  6670. 

  6671.   /api/v1/automatic-tags/policies/accounts/{accountName}/comments:

  6672.     get:

  6673.       tags:

  6674.         - Automatic Tags

  6675.       summary: Get account auto tag policies on comments

  6676.       description: "**PeerTube >= 6.2**"

  6677.       security:

  6678.         - OAuth2: []

  6679.       parameters:

  6680.         - name: accountName

  6681.           in: path

  6682.           required: true

  6683.           description: account name to get auto tag policies

  6684.           schema:

  6685.             type: string

  6686.       responses:

  6687.         '200':

  6688.           description: successful operation

  6689.           content:

  6690.             application/json:

  6691.               schema:

  6692.                 $ref: '#/components/schemas/CommentAutoTagPolicies'

  6693.     put:

  6694.       tags:

  6695.         - Automatic Tags

  6696.       summary: Update account auto tag policies on comments

  6697.       description: "**PeerTube >= 6.2**"

  6698.       security:

  6699.         - OAuth2: []

  6700.       parameters:

  6701.         - name: accountName

  6702.           in: path

  6703.           required: true

  6704.           description: account name to update auto tag policies

  6705.           schema:

  6706.             type: string

  6707.       requestBody:

  6708.         content:

  6709.           application/json:

  6710.             schema:

  6711.               type: object

  6712.               properties:

  6713.                 review:

  6714.                   description: 'Auto tags that automatically set the comment in review state'

  6715.                   type: array

  6716.                   items:

  6717.                     type: string

  6718.       responses:

  6719.         '204':

  6720.           description: successful operation

  6721. 

  6722.   /api/v1/automatic-tags/accounts/{accountName}/available:

  6723.     get:

  6724.       tags:

  6725.         - Automatic Tags

  6726.       summary: Get account available auto tags

  6727.       description: "**PeerTube >= 6.2**"

  6728.       security:

  6729.         - OAuth2: []

  6730.       parameters:

  6731.         - name: accountName

  6732.           in: path

  6733.           required: true

  6734.           description: account name to get auto tag policies

  6735.           schema:

  6736.             type: string

  6737.       responses:

  6738.         '200':

  6739.           description: successful operation

  6740.           content:

  6741.             application/json:

  6742.               schema:

  6743.                 $ref: '#/components/schemas/AutomaticTagAvailable'

  6744.   /api/v1/automatic-tags/server/available:

  6745.     get:

  6746.       tags:

  6747.         - Automatic Tags

  6748.       summary: Get server available auto tags

  6749.       description: "**PeerTube >= 6.2**"

  6750.       security:

  6751.         - OAuth2:

  6752.           - admin

  6753.           - moderator

  6754.       responses:

  6755.         '200':

  6756.           description: successful operation

  6757.           content:

  6758.             application/json:

  6759.               schema:

  6760.                 $ref: '#/components/schemas/AutomaticTagAvailable'

  6761. 

  6762.   /api/v1/watched-words/accounts/{accountName}/lists:

  6763.     get:

  6764.       tags:

  6765.         - Watched Words

  6766.       summary: List account watched words

  6767.       description: "**PeerTube >= 6.2**"

  6768.       security:

  6769.         - OAuth2: []

  6770.       parameters:

  6771.         - name: accountName

  6772.           in: path

  6773.           required: true

  6774.           description: account name to list watched words

  6775.           schema:

  6776.             type: string

  6777.       responses:

  6778.         '200':

  6779.           description: successful operation

  6780.           content:

  6781.             application/json:

  6782.               schema:

  6783.                 properties:

  6784.                   total:

  6785.                     type: integer

  6786.                     example: 1

  6787.                   data:

  6788.                     type: array

  6789.                     items:

  6790.                       $ref: '#/components/schemas/WatchedWordsLists'

  6791.     post:

  6792.       tags:

  6793.         - Watched Words

  6794.       summary: Add account watched words

  6795.       description: "**PeerTube >= 6.2**"

  6796.       security:

  6797.         - OAuth2: []

  6798.       parameters:

  6799.         - name: accountName

  6800.           in: path

  6801.           required: true

  6802.           schema:

  6803.             type: string

  6804.       requestBody:

  6805.         content:

  6806.           application/json:

  6807.             schema:

  6808.               type: object

  6809.               properties:

  6810.                 listName:

  6811.                   type: string

  6812.                 words:

  6813.                   type: array

  6814.                   items:

  6815.                     type: string

  6816.       responses:

  6817.         '200':

  6818.           description: successful operation

  6819.           content:

  6820.             application/json:

  6821.               schema:

  6822.                 type: object

  6823.                 properties:

  6824.                   watchedWordsList:

  6825.                     type: object

  6826.                     properties:

  6827.                       id:

  6828.                         type: integer

  6829. 

  6830.   /api/v1/watched-words/accounts/{accountName}/lists/{listId}:

  6831.     put:

  6832.       tags:

  6833.         - Watched Words

  6834.       summary: Update account watched words

  6835.       description: "**PeerTube >= 6.2**"

  6836.       security:

  6837.         - OAuth2: []

  6838.       parameters:

  6839.         - name: accountName

  6840.           in: path

  6841.           required: true

  6842.           schema:

  6843.             type: string

  6844.         - name: listId

  6845.           in: path

  6846.           required: true

  6847.           description: list of watched words to update

  6848.           schema:

  6849.             type: string

  6850.       requestBody:

  6851.         content:

  6852.           application/json:

  6853.             schema:

  6854.               type: object

  6855.               properties:

  6856.                 listName:

  6857.                   type: string

  6858.                 words:

  6859.                   type: array

  6860.                   items:

  6861.                     type: string

  6862.       responses:

  6863.         '204':

  6864.           description: successful operation

  6865.     delete:

  6866.       tags:

  6867.         - Watched Words

  6868.       summary: Delete account watched words

  6869.       description: "**PeerTube >= 6.2**"

  6870.       security:

  6871.         - OAuth2: []

  6872.       parameters:

  6873.         - name: accountName

  6874.           in: path

  6875.           required: true

  6876.           schema:

  6877.             type: string

  6878.         - name: listId

  6879.           in: path

  6880.           required: true

  6881.           description: list of watched words to delete

  6882.           schema:

  6883.             type: string

  6884.       responses:

  6885.         '204':

  6886.           description: successful operation

  6887. 

  6888.   /api/v1/watched-words/server/lists:

  6889.     get:

  6890.       tags:

  6891.         - Watched Words

  6892.       summary: List server watched words

  6893.       description: "**PeerTube >= 6.2**"

  6894.       security:

  6895.         - OAuth2:

  6896.           - admin

  6897.           - moderator

  6898.       responses:

  6899.         '200':

  6900.           description: successful operation

  6901.           content:

  6902.             application/json:

  6903.               schema:

  6904.                 properties:

  6905.                   total:

  6906.                     type: integer

  6907.                     example: 1

  6908.                   data:

  6909.                     type: array

  6910.                     items:

  6911.                       $ref: '#/components/schemas/WatchedWordsLists'

  6912.     post:

  6913.       tags:

  6914.         - Watched Words

  6915.       summary: Add server watched words

  6916.       description: "**PeerTube >= 6.2**"

  6917.       security:

  6918.         - OAuth2:

  6919.           - admin

  6920.           - moderator

  6921.       requestBody:

  6922.         content:

  6923.           application/json:

  6924.             schema:

  6925.               type: object

  6926.               properties:

  6927.                 listName:

  6928.                   type: string

  6929.                 words:

  6930.                   type: array

  6931.                   items:

  6932.                     type: string

  6933.       responses:

  6934.         '200':

  6935.           description: successful operation

  6936.           content:

  6937.             application/json:

  6938.               schema:

  6939.                 type: object

  6940.                 properties:

  6941.                   watchedWordsList:

  6942.                     type: object

  6943.                     properties:

  6944.                       id:

  6945.                         type: integer

  6946. 

  6947.   /api/v1/watched-words/server/lists/{listId}:

  6948.     put:

  6949.       tags:

  6950.         - Watched Words

  6951.       summary: Update server watched words

  6952.       description: "**PeerTube >= 6.2**"

  6953.       security:

  6954.         - OAuth2:

  6955.           - admin

  6956.           - moderator

  6957.       parameters:

  6958.         - name: listId

  6959.           in: path

  6960.           required: true

  6961.           description: list of watched words to update

  6962.           schema:

  6963.             type: string

  6964.       requestBody:

  6965.         content:

  6966.           application/json:

  6967.             schema:

  6968.               type: object

  6969.               properties:

  6970.                 listName:

  6971.                   type: string

  6972.                 words:

  6973.                   type: array

  6974.                   items:

  6975.                     type: string

  6976.       responses:

  6977.         '204':

  6978.           description: successful operation

  6979.     delete:

  6980.       tags:

  6981.         - Watched Words

  6982.       summary: Delete server watched words

  6983.       description: "**PeerTube >= 6.2**"

  6984.       security:

  6985.         - OAuth2:

  6986.           - admin

  6987.           - moderator

  6988.       parameters:

  6989.         - name: listId

  6990.           in: path

  6991.           required: true

  6992.           description: list of watched words to delete

  6993.           schema:

  6994.             type: string

  6995.       responses:

  6996.         '204':

  6997.           description: successful operation

  6998. 

  6999. servers:

  7000.   - url: 'https://peertube2.cpy.re'

  7001.     description: Live Test Server (live data - latest nightly version)

  7002.   - url: 'https://peertube3.cpy.re'

  7003.     description: Live Test Server (live data - latest RC version)

  7004.   - url: 'https://peertube.cpy.re'

  7005.     description: Live Test Server (live data - stable version)

  7006. components:

  7007.   parameters:

  7008.     start:

  7009.       name: start

  7010.       in: query

  7011.       required: false

  7012.       description: Offset used to paginate results

  7013.       schema:

  7014.         type: integer

  7015.         minimum: 0

  7016.     count:

  7017.       name: count

  7018.       in: query

  7019.       required: false

  7020.       description: "Number of items to return"

  7021.       schema:

  7022.         type: integer

  7023.         default: 15

  7024.         maximum: 100

  7025.         minimum: 1

  7026.     sort:

  7027.       name: sort

  7028.       in: query

  7029.       required: false

  7030.       description: Sort column

  7031.       schema:

  7032.         type: string

  7033.         example: -createdAt

  7034.     search:

  7035.       name: search

  7036.       in: query

  7037.       required: false

  7038.       description: Plain text search, applied to various parts of the model depending on endpoint

  7039.       schema:

  7040.         type: string

  7041.     searchTarget:

  7042.       name: searchTarget

  7043.       in: query

  7044.       required: false

  7045.       description: >

  7046.         If the administrator enabled search index support, you can override the default search target.

  7047. 

  7048. 

  7049.         **Warning**: If you choose to make an index search, PeerTube will get results from a third party service.

  7050.         It means the instance may not yet know the objects you fetched. If you want to load video/channel information:

  7051.           * If the current user has the ability to make a remote URI search (this information is available in the config endpoint),

  7052.           then reuse the search API to make a search using the object URI so PeerTube instance fetches the remote object and fill its database.

  7053.           After that, you can use the classic REST API endpoints to fetch the complete object or interact with it

  7054.           * If the current user doesn't have the ability to make a remote URI search, then redirect the user on the origin instance or fetch

  7055.           the data from the origin instance API

  7056.       schema:

  7057.         type: string

  7058.         enum:

  7059.           - 'local'

  7060.           - 'search-index'

  7061.     videosSort:

  7062.       name: sort

  7063.       in: query

  7064.       required: false

  7065.       schema:

  7066.         type: string

  7067.         enum:

  7068.           - name

  7069.           - -duration

  7070.           - -createdAt

  7071.           - -publishedAt

  7072.           - -views

  7073.           - -likes

  7074.           - -trending

  7075.           - -hot

  7076.           - -best

  7077.         description: >

  7078.           Sort videos by criteria (prefixing with `-` means `DESC` order):

  7079.             * `hot` - Adaptation of Reddit "hot" algorithm taking into account video views, likes, dislikes and comments and publication date

  7080.             * `best` - Same than `hot`, but also takes into account user video history

  7081.             * `trending` - Sort videos by recent views ("recent" is defined by the admin)

  7082.             * `views` - Sort videos using their `views` counter

  7083.             * `publishedAt` - Sort by video publication date (when it became publicly available)

  7084.     videosSearchSort:

  7085.       name: sort

  7086.       in: query

  7087.       required: false

  7088.       description: >

  7089.         Sort videos by criteria (prefixing with `-` means `DESC` order):

  7090.       schema:

  7091.         type: string

  7092.         enum:

  7093.         - name

  7094.         - -duration

  7095.         - -createdAt

  7096.         - -publishedAt

  7097.         - -views

  7098.         - -likes

  7099.         - -match

  7100.     commentsSort:

  7101.       name: sort

  7102.       in: query

  7103.       required: false

  7104.       description: Sort comments by criteria

  7105.       schema:

  7106.         type: string

  7107.         enum:

  7108.         - -createdAt

  7109.         - -totalReplies

  7110.     blacklistsSort:

  7111.       name: sort

  7112.       in: query

  7113.       required: false

  7114.       description: Sort blocklists by criteria

  7115.       schema:

  7116.         type: string

  7117.         enum:

  7118.         - -id

  7119.         - name

  7120.         - -duration

  7121.         - -views

  7122.         - -likes

  7123.         - -dislikes

  7124.         - -uuid

  7125.         - -createdAt

  7126.     usersSearch:

  7127.       name: search

  7128.       in: query

  7129.       required: false

  7130.       description: Plain text search that will match with user usernames or emails

  7131.       schema:

  7132.         type: string

  7133.     usersBlocked:

  7134.       name: blocked

  7135.       in: query

  7136.       required: false

  7137.       description: Filter results down to (un)banned users

  7138.       schema:

  7139.         type: boolean

  7140.     usersSort:

  7141.       name: sort

  7142.       in: query

  7143.       required: false

  7144.       description: Sort users by criteria

  7145.       schema:

  7146.         type: string

  7147.         enum:

  7148.         - -id

  7149.         - -username

  7150.         - -createdAt

  7151.     abusesSort:

  7152.       name: sort

  7153.       in: query

  7154.       required: false

  7155.       description: Sort abuses by criteria

  7156.       schema:

  7157.         type: string

  7158.         enum:

  7159.         - -id

  7160.         - -createdAt

  7161.         - -state

  7162.     videoRedundanciesSort:

  7163.       name: sort

  7164.       in: query

  7165.       required: false

  7166.       description: Sort abuses by criteria

  7167.       schema:

  7168.         type: string

  7169.         enum:

  7170.         - name

  7171.     followersSort:

  7172.       name: sort

  7173.       in: query

  7174.       required: false

  7175.       description: Sort followers by criteria

  7176.       schema:

  7177.         type: string

  7178.         enum:

  7179.         - createdAt

  7180.     registrationTokenSort:

  7181.       name: sort

  7182.       in: query

  7183.       required: false

  7184.       description: Sort registration tokens by criteria

  7185.       schema:

  7186.         type: string

  7187.         enum:

  7188.         - createdAt

  7189.     runnerSort:

  7190.       name: sort

  7191.       in: query

  7192.       required: false

  7193.       description: Sort runners by criteria

  7194.       schema:

  7195.         type: string

  7196.         enum:

  7197.         - createdAt

  7198.     runnerJobSort:

  7199.       name: sort

  7200.       in: query

  7201.       required: false

  7202.       description: Sort runner jobs by criteria

  7203.       schema:

  7204.         type: string

  7205.         enum:

  7206.         - updatedAt

  7207.         - createdAt

  7208.         - priority

  7209.         - state

  7210.         - progress

  7211. 

  7212.     name:

  7213.       name: name

  7214.       in: path

  7215.       required: true

  7216.       description: The username or handle of the account

  7217.       schema:

  7218.         type: string

  7219.         example: chocobozzz | chocobozzz@example.org

  7220.     id:

  7221.       name: id

  7222.       in: path

  7223.       required: true

  7224.       description: Entity id

  7225.       schema:

  7226.         $ref: '#/components/schemas/id'

  7227.     userId:

  7228.       name: userId

  7229.       in: path

  7230.       required: true

  7231.       description: User id

  7232.       schema:

  7233.         $ref: '#/components/schemas/id'

  7234.     registrationId:

  7235.       name: registrationId

  7236.       in: path

  7237.       required: true

  7238.       description: Registration ID

  7239.       schema:

  7240.         $ref: '#/components/schemas/id'

  7241.     idOrUUID:

  7242.       name: id

  7243.       in: path

  7244.       required: true

  7245.       description: The object id, uuid or short uuid

  7246.       schema:

  7247.         oneOf:

  7248.           - $ref: '#/components/schemas/id'

  7249.           - $ref: '#/components/schemas/UUIDv4'

  7250.           - $ref: '#/components/schemas/shortUUID'

  7251.     playlistId:

  7252.       name: playlistId

  7253.       in: path

  7254.       required: true

  7255.       description: Playlist id

  7256.       schema:

  7257.         $ref: '#/components/schemas/VideoPlaylist/properties/id'

  7258.     playlistElementId:

  7259.       name: playlistElementId

  7260.       in: path

  7261.       required: true

  7262.       description: Playlist element id

  7263.       schema:

  7264.         $ref: '#/components/schemas/id'

  7265.     abuseId:

  7266.       name: abuseId

  7267.       in: path

  7268.       required: true

  7269.       description: Abuse id

  7270.       schema:

  7271.         $ref: '#/components/schemas/Abuse/properties/id'

  7272.     abuseMessageId:

  7273.       name: abuseMessageId

  7274.       in: path

  7275.       required: true

  7276.       description: Abuse message id

  7277.       schema:

  7278.         $ref: '#/components/schemas/AbuseMessage/properties/id'

  7279.     captionLanguage:

  7280.       name: captionLanguage

  7281.       in: path

  7282.       required: true

  7283.       description: The caption language

  7284.       schema:

  7285.         $ref: '#/components/schemas/VideoLanguageSet'

  7286.     channelHandle:

  7287.       name: channelHandle

  7288.       in: path

  7289.       required: true

  7290.       description: The video channel handle

  7291.       schema:

  7292.         type: string

  7293.         example: my_username | my_username@example.com

  7294.     channelSyncId:

  7295.       name: channelSyncId

  7296.       in: path

  7297.       required: true

  7298.       description: Channel Sync id

  7299.       schema:

  7300.         $ref: '#/components/schemas/Abuse/properties/id'

  7301.     subscriptionHandle:

  7302.       name: subscriptionHandle

  7303.       in: path

  7304.       required: true

  7305.       description: The subscription handle

  7306.       schema:

  7307.         type: string

  7308.         example: my_username | my_username@example.com

  7309.     threadId:

  7310.       name: threadId

  7311.       in: path

  7312.       required: true

  7313.       description: The thread id (root comment id)

  7314.       schema:

  7315.         type: integer

  7316.     commentId:

  7317.       name: commentId

  7318.       in: path

  7319.       required: true

  7320.       description: The comment id

  7321.       schema:

  7322.         $ref: '#/components/schemas/VideoComment/properties/id'

  7323.     isLive:

  7324.       name: isLive

  7325.       in: query

  7326.       required: false

  7327.       description: whether or not the video is a live

  7328.       schema:

  7329.         type: boolean

  7330.     categoryOneOf:

  7331.       name: categoryOneOf

  7332.       in: query

  7333.       required: false

  7334.       description: category id of the video (see [/videos/categories](#operation/getCategories))

  7335.       schema:

  7336.         oneOf:

  7337.         - $ref: '#/components/schemas/VideoCategorySet'

  7338.         - type: array

  7339.           items:

  7340.             $ref: '#/components/schemas/VideoCategorySet'

  7341.       style: form

  7342.       explode: true

  7343.     tagsOneOf:

  7344.       name: tagsOneOf

  7345.       in: query

  7346.       required: false

  7347.       description: tag(s) of the video

  7348.       schema:

  7349.         oneOf:

  7350.         - type: string

  7351.         - type: array

  7352.           maxItems: 5

  7353.           items:

  7354.             type: string

  7355.       style: form

  7356.       explode: true

  7357.     tagsAllOf:

  7358.       name: tagsAllOf

  7359.       in: query

  7360.       required: false

  7361.       description: tag(s) of the video, where all should be present in the video

  7362.       schema:

  7363.         oneOf:

  7364.         - type: string

  7365.         - type: array

  7366.           items:

  7367.             type: string

  7368.       style: form

  7369.       explode: true

  7370.     languageOneOf:

  7371.       name: languageOneOf

  7372.       in: query

  7373.       required: false

  7374.       description: language id of the video (see [/videos/languages](#operation/getLanguages)). Use `_unknown` to filter on videos that don't have a video language

  7375.       schema:

  7376.         oneOf:

  7377.         - $ref: '#/components/schemas/VideoLanguageSet'

  7378.         - type: array

  7379.           items:

  7380.             $ref: '#/components/schemas/VideoLanguageSet'

  7381.       style: form

  7382.       explode: true

  7383.     autoTagOneOfVideo:

  7384.       name: autoTagOneOf

  7385.       in: query

  7386.       required: false

  7387.       description: "**PeerTube >= 6.2** **Admins and moderators only** filter on videos that contain one of these automatic tags"

  7388.       schema:

  7389.         oneOf:

  7390.         - type: string

  7391.         - type: array

  7392.           items:

  7393.             type: string

  7394.       style: form

  7395.       explode: true

  7396.     autoTagOneOfComment:

  7397.       name: autoTagOneOf

  7398.       in: query

  7399.       required: false

  7400.       description: "**PeerTube >= 6.2** filter on comments that contain one of these automatic tags"

  7401.       schema:

  7402.         oneOf:

  7403.         - type: string

  7404.         - type: array

  7405.           items:

  7406.             type: string

  7407.       style: form

  7408.       explode: true

  7409.     isHeldForReview:

  7410.       name: isHeldForReview

  7411.       in: query

  7412.       required: false

  7413.       description: only display comments that are held for review

  7414.       schema:

  7415.         type: boolean

  7416.     licenceOneOf:

  7417.       name: licenceOneOf

  7418.       in: query

  7419.       required: false

  7420.       description: licence id of the video (see [/videos/licences](#operation/getLicences))

  7421.       schema:

  7422.         oneOf:

  7423.         - $ref: '#/components/schemas/VideoLicenceSet'

  7424.         - type: array

  7425.           items:

  7426.             $ref: '#/components/schemas/VideoLicenceSet'

  7427.       style: form

  7428.       explode: true

  7429.     skipCount:

  7430.       name: skipCount

  7431.       in: query

  7432.       required: false

  7433.       description: if you don't need the `total` in the response

  7434.       schema:

  7435.         type: string

  7436.         enum:

  7437.           - 'true'

  7438.           - 'false'

  7439.         default: 'false'

  7440.     nsfw:

  7441.       name: nsfw

  7442.       in: query

  7443.       required: false

  7444.       description: whether to include nsfw videos, if any

  7445.       schema:

  7446.         type: string

  7447.         enum:

  7448.         - 'true'

  7449.         - 'false'

  7450.     isLocal:

  7451.       name: isLocal

  7452.       in: query

  7453.       required: false

  7454.       schema:

  7455.         type: boolean

  7456.       description: '**PeerTube >= 4.0** Display only local or remote objects'

  7457.     hasHLSFiles:

  7458.       name: hasHLSFiles

  7459.       in: query

  7460.       required: false

  7461.       schema:

  7462.         type: boolean

  7463.       description: '**PeerTube >= 4.0** Display only videos that have HLS files'

  7464.     hasWebVideoFiles:

  7465.       name: hasWebVideoFiles

  7466.       in: query

  7467.       required: false

  7468.       schema:

  7469.         type: boolean

  7470.       description: '**PeerTube >= 6.0** Display only videos that have Web Video files'

  7471.     privacyOneOf:

  7472.       name: privacyOneOf

  7473.       in: query

  7474.       required: false

  7475.       schema:

  7476.         $ref: '#/components/schemas/VideoPrivacySet'

  7477.       description: '**PeerTube >= 4.0** Display only videos in this specific privacy/privacies'

  7478.     excludeAlreadyWatched:

  7479.       name: excludeAlreadyWatched

  7480.       in: query

  7481.       description: Whether or not to exclude videos that are in the user's video history

  7482.       schema:

  7483.         type: boolean

  7484.     uuids:

  7485.       name: uuids

  7486.       in: query

  7487.       required: false

  7488.       schema:

  7489.         items:

  7490.           type: string

  7491.       description: 'Find elements with specific UUIDs'

  7492.     host:

  7493.       name: host

  7494.       in: query

  7495.       required: false

  7496.       schema:

  7497.           type: string

  7498.       description: 'Find elements owned by this host'

  7499.     handles:

  7500.       name: handles

  7501.       in: query

  7502.       required: false

  7503.       schema:

  7504.         items:

  7505.           type: string

  7506.       description: 'Find elements with these handles'

  7507.     include:

  7508.       name: include

  7509.       in: query

  7510.       required: false

  7511.       schema:

  7512.         type: integer

  7513.         enum:

  7514.         - 0

  7515.         - 1

  7516.         - 2

  7517.         - 4

  7518.         - 8

  7519.         - 16

  7520.         - 32

  7521.       description: >

  7522.         **PeerTube >= 4.0** Include additional videos in results (can be combined using bitwise or operator)

  7523. 

  7524.         - `0` NONE

  7525. 

  7526.         - `1` NOT_PUBLISHED_STATE

  7527. 

  7528.         - `2` BLACKLISTED

  7529. 

  7530.         - `4` BLOCKED_OWNER

  7531. 

  7532.         - `8` FILES

  7533. 

  7534.         - `16` CAPTIONS

  7535. 

  7536.         - `32` VIDEO SOURCE

  7537.     subscriptionsUris:

  7538.       name: uris

  7539.       in: query

  7540.       required: true

  7541.       description: list of uris to check if each is part of the user subscriptions

  7542.       schema:

  7543.         type: array

  7544.         items:

  7545.           type: string

  7546.           format: uri

  7547.     npmName:

  7548.       name: npmName

  7549.       in: path

  7550.       required: true

  7551.       description: name of the plugin/theme on npmjs.com or in its package.json

  7552.       schema:

  7553.         type: string

  7554.         example: peertube-plugin-auth-ldap

  7555.     jobType:

  7556.       name: jobType

  7557.       in: query

  7558.       required: false

  7559.       description: job type

  7560.       schema:

  7561.         type: string

  7562.         enum:

  7563.           - activitypub-follow

  7564.           - activitypub-http-broadcast

  7565.           - activitypub-http-fetcher

  7566.           - activitypub-http-unicast

  7567.           - email

  7568.           - video-transcoding

  7569.           - video-file-import

  7570.           - video-import

  7571.           - videos-views-stats

  7572.           - activitypub-refresher

  7573.           - video-redundancy

  7574.           - video-live-ending

  7575.           - video-channel-import

  7576.     followState:

  7577.       name: state

  7578.       in: query

  7579.       schema:

  7580.         type: string

  7581.         enum:

  7582.           - pending

  7583.           - accepted

  7584.     actorType:

  7585.       name: actorType

  7586.       in: query

  7587.       schema:

  7588.         type: string

  7589.         enum:

  7590.           - Person

  7591.           - Application

  7592.           - Group

  7593.           - Service

  7594.           - Organization

  7595.     staticFilename:

  7596.       name: filename

  7597.       in: path

  7598.       required: true

  7599.       description: Filename

  7600.       schema:

  7601.         type: string

  7602.     videoFileToken:

  7603.       name: videoFileToken

  7604.       in: query

  7605.       required: false

  7606.       description: Video file token [generated](#operation/requestVideoToken) by PeerTube so you don't need to provide an OAuth token in the request header.

  7607.       schema:

  7608.         type: string

  7609.     reinjectVideoFileToken:

  7610.       name: reinjectVideoFileToken

  7611.       in: query

  7612.       required: false

  7613.       description: Ask the server to reinject videoFileToken in URLs in m3u8 playlist

  7614.       schema:

  7615.         type: boolean

  7616.     videoPlaylistType:

  7617.       name: playlistType

  7618.       in: query

  7619.       required: false

  7620.       schema:

  7621.         $ref: '#/components/schemas/VideoPlaylistTypeSet'

  7622.     registrationTokenId:

  7623.       name: registrationTokenId

  7624.       in: path

  7625.       required: true

  7626.       schema:

  7627.         type: integer

  7628.     runnerId:

  7629.       name: runnerId

  7630.       in: path

  7631.       required: true

  7632.       schema:

  7633.         type: integer

  7634.     jobUUID:

  7635.       name: jobUUID

  7636.       in: path

  7637.       required: true

  7638.       schema:

  7639.         $ref: '#/components/schemas/UUIDv4'

  7640.     videoPasswordId:

  7641.       name: videoPasswordId

  7642.       in: path

  7643.       required: true

  7644.       description: The video password id

  7645.       schema:

  7646.         $ref: '#/components/schemas/id'

  7647.     onLocalVideo:

  7648.       name: onLocalVideo

  7649.       in: query

  7650.       required: false

  7651.       schema:

  7652.         type: boolean

  7653.       description: 'Display only objects of local or remote videos'

  7654.     videoChannelId:

  7655.       name: videoChannelId

  7656.       in: query

  7657.       required: false

  7658.       schema:

  7659.         type: integer

  7660.       description: 'Limit results on this specific video channel'

  7661.     videoId:

  7662.       name: videoId

  7663.       in: query

  7664.       required: false

  7665.       schema:

  7666.         type: integer

  7667.       description: 'Limit results on this specific video'

  7668.     searchVideoForComments:

  7669.       name: searchVideo

  7670.       in: query

  7671.       required: false

  7672.       description: Filter comments by searching on the video

  7673.       schema:

  7674.         type: string

  7675.     searchAccountForComments:

  7676.       name: searchAccount

  7677.       in: query

  7678.       required: false

  7679.       description: Filter comments by searching on the account

  7680.       schema:

  7681.         type: string

  7682.     videoPasswordHeader:

  7683.       name: x-peertube-video-password

  7684.       description: Required on password protected video

  7685.       in: header

  7686.       required: false

  7687.       schema:

  7688.         type: string

  7689.     resumableUploadInitContentLengthHeader:

  7690.         name: X-Upload-Content-Length

  7691.         in: header

  7692.         schema:

  7693.           type: number

  7694.           example: 2469036

  7695.         required: true

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

  7697.     resumableUploadInitContentTypeHeader:

  7698.       name: X-Upload-Content-Type

  7699.       in: header

  7700.       schema:

  7701.         type: string

  7702.         format: mimetype

  7703.         example: video/mp4

  7704.       required: true

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

  7706.     resumableUploadChunkContentRangeHeader:

  7707.       name: Content-Range

  7708.       in: header

  7709.       schema:

  7710.         type: string

  7711.         example: bytes 0-262143/2469036

  7712.       required: true

  7713.       description: |

  7714.         Specifies the bytes in the file that the request is uploading.

  7715. 

  7716.         For example, a value of `bytes 0-262143/1000000` shows that the request is sending the first

  7717.         262144 bytes (256 x 1024) in a 2,469,036 byte file.

  7718.     resumableUploadChunkContentLengthHeader:

  7719.       name: Content-Length

  7720.       in: header

  7721.       schema:

  7722.         type: number

  7723.         example: 262144

  7724.       required: true

  7725.       description: |

  7726.         Size of the chunk that the request is sending.

  7727. 

  7728.         Remember that larger chunks are more efficient. PeerTube's web client uses chunks varying from

  7729.         1048576 bytes (~1MB) and increases or reduces size depending on connection health.

  7730.     resumableUploadId:

  7731.       name: upload_id

  7732.       in: query

  7733.       required: true

  7734.       description: |

  7735.         Created session id to proceed with. If you didn't send chunks in the last hour, it is

  7736.         not valid anymore and you need to initialize a new upload.

  7737.       schema:

  7738.         type: string

  7739. 

  7740. 

  7741.   securitySchemes:

  7742.     OAuth2:

  7743.       description: |

  7744.         Authenticating via OAuth requires the following steps:

  7745.         - Have an activated account

  7746.         - [Generate] an access token for that account at `/api/v1/users/token`.

  7747.         - Make requests with the *Authorization: Bearer <token\>* header

  7748.         - Profit, depending on the role assigned to the account

  7749. 

  7750.         Note that the __access token is valid for 1 day__ and is given

  7751.         along with a __refresh token valid for 2 weeks__.

  7752. 

  7753.         [Generate]: https://docs.joinpeertube.org/api/rest-getting-started

  7754.       type: oauth2

  7755.       flows:

  7756.         password:

  7757.           tokenUrl: /api/v1/users/token

  7758.           scopes:

  7759.             admin: Admin scope

  7760.             moderator: Moderator scope

  7761.             user: User scope

  7762.   schemas:

  7763.     # Reusable core properties

  7764.     id:

  7765.       type: integer

  7766.       minimum: 1

  7767.       example: 42

  7768.     UUIDv4:

  7769.       type: string

  7770.       format: uuid

  7771.       example: 9c9de5e8-0a1e-484a-b099-e80766180a6d

  7772.       pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'

  7773.       minLength: 36

  7774.       maxLength: 36

  7775.     shortUUID:

  7776.       type: string

  7777.       description: translation of a uuid v4 with a bigger alphabet to have a shorter uuid

  7778.       example: 2y84q2MQUMWPbiEcxNXMgC

  7779.     username:

  7780.       type: string

  7781.       description: immutable name of the user, used to find or mention its actor

  7782.       example: chocobozzz

  7783.       pattern: '/^[a-z0-9._]+$/'

  7784.       minLength: 1

  7785.       maxLength: 50

  7786.     usernameChannel:

  7787.       type: string

  7788.       description: immutable name of the channel, used to interact with its actor

  7789.       example: framasoft_videos

  7790.       pattern: '/^[a-zA-Z0-9\\-_.:]+$/'

  7791.       minLength: 1

  7792.       maxLength: 50

  7793.     password:

  7794.       type: string

  7795.       format: password

  7796.       minLength: 6

  7797.       maxLength: 255

  7798. 

  7799.     VideoCategorySet:

  7800.       type: integer

  7801.       description: category id of the video (see [/videos/categories](#operation/getCategories))

  7802.       example: 15

  7803.     VideoConstantNumber-Category:

  7804.       properties:

  7805.         id:

  7806.           $ref: '#/components/schemas/VideoCategorySet'

  7807.         label:

  7808.           type: string

  7809.           example: Science & Technology

  7810. 

  7811.     VideoLicenceSet:

  7812.       type: integer

  7813.       description: licence id of the video (see [/videos/licences](#operation/getLicences))

  7814.       example: 2

  7815.     VideoConstantNumber-Licence:

  7816.       properties:

  7817.         id:

  7818.           $ref: '#/components/schemas/VideoLicenceSet'

  7819.         label:

  7820.           type: string

  7821.           example: Attribution - Share Alike

  7822. 

  7823.     VideoLanguageSet:

  7824.       type: string

  7825.       description: language id of the video (see [/videos/languages](#operation/getLanguages))

  7826.       example: en

  7827.     VideoConstantString-Language:

  7828.       properties:

  7829.         id:

  7830.           $ref: '#/components/schemas/VideoLanguageSet'

  7831.         label:

  7832.           type: string

  7833.           example: English

  7834. 

  7835.     VideoPlaylistPrivacySet:

  7836.       type: integer

  7837.       enum:

  7838.         - 1

  7839.         - 2

  7840.         - 3

  7841.       description: Video playlist privacy policy (see [/video-playlists/privacies](#operation/getPlaylistPrivacyPolicies))

  7842.     VideoPlaylistPrivacyConstant:

  7843.       properties:

  7844.         id:

  7845.           $ref: '#/components/schemas/VideoPlaylistPrivacySet'

  7846.         label:

  7847.           type: string

  7848. 

  7849.     VideoPlaylistTypeSet:

  7850.       type: integer

  7851.       enum:

  7852.         - 1

  7853.         - 2

  7854.       description: The video playlist type (Regular = `1`, Watch Later = `2`)

  7855.     VideoPlaylistTypeConstant:

  7856.       properties:

  7857.         id:

  7858.           $ref: '#/components/schemas/VideoPlaylistTypeSet'

  7859.         label:

  7860.           type: string

  7861. 

  7862.     VideoPrivacySet:

  7863.       type: integer

  7864.       enum:

  7865.         - 1

  7866.         - 2

  7867.         - 3

  7868.         - 4

  7869.         - 5

  7870.       description: privacy id of the video (see [/videos/privacies](#operation/getVideoPrivacyPolicies))

  7871.     VideoPrivacyConstant:

  7872.       properties:

  7873.         id:

  7874.           $ref: '#/components/schemas/VideoPrivacySet'

  7875.         label:

  7876.           type: string

  7877. 

  7878.     VideoCommentsPolicySet:

  7879.       type: integer

  7880.       enum:

  7881.         - 1

  7882.         - 2

  7883.         - 3

  7884.       description: Comments policy of the video (Enabled = `1`, Disabled = `2`, Requires Approval = `3`)

  7885.     VideoCommentsPolicyConstant:

  7886.       properties:

  7887.         id:

  7888.           $ref: '#/components/schemas/VideoCommentsPolicySet'

  7889.         label:

  7890.           type: string

  7891. 

  7892.     BlockStatus:

  7893.       properties:

  7894.         accounts:

  7895.           type: object

  7896.           additionalProperties:

  7897.             x-additionalPropertiesName: account

  7898.             type: object

  7899.             properties:

  7900.               blockedByServer:

  7901.                 type: boolean

  7902.               blockedByUser:

  7903.                 type: boolean

  7904.         hosts:

  7905.           type: object

  7906.           additionalProperties:

  7907.             x-additionalPropertiesName: host

  7908.             type: object

  7909.             properties:

  7910.               blockedByServer:

  7911.                 type: boolean

  7912.               blockedByUser:

  7913.                 type: boolean

  7914. 

  7915.     NSFWPolicy:

  7916.       type: string

  7917.       enum:

  7918.         - display

  7919.         - blur

  7920.         - do_not_list

  7921. 

  7922.     UserRole:

  7923.       type: integer

  7924.       enum:

  7925.         - 0

  7926.         - 1

  7927.         - 2

  7928.       description: 'The user role (Admin = `0`, Moderator = `1`, User = `2`)'

  7929.       example: 2

  7930.     UserAdminFlags:

  7931.       type: integer

  7932.       enum:

  7933.         - 0

  7934.         - 1

  7935.       description: 'Admin flags for the user (None = `0`, Bypass video blocklist = `1`)'

  7936.       example: 1

  7937. 

  7938.     LiveVideoLatencyMode:

  7939.       type: integer

  7940.       enum:

  7941.         - 1

  7942.         - 2

  7943.         - 3

  7944.       description: 'The live latency mode (Default = `1`, High latency = `2`, Small Latency = `3`)'

  7945. 

  7946.     LiveVideoReplaySettings:

  7947.       type: object

  7948.       properties:

  7949.         privacy:

  7950.           # description: Video playlist privacy policy (see [../video-playlists/privacies])

  7951.           $ref: '#/components/schemas/VideoPrivacySet'

  7952. 

  7953. 

  7954.     VideoStateConstant:

  7955.       properties:

  7956.         id:

  7957.           type: integer

  7958.           enum:

  7959.             - 1

  7960.             - 2

  7961.             - 3

  7962.             - 4

  7963.             - 5

  7964.             - 6

  7965.             - 7

  7966.             - 8

  7967.             - 9

  7968.           description: |

  7969.             The video state:

  7970.             - `1`: Published

  7971.             - `2`: To transcode

  7972.             - `3`: To import

  7973.             - `4`: Waiting for live stream

  7974.             - `5`: Live ended

  7975.             - `6`: To move to an external storage (object storage...)

  7976.             - `7`: Transcoding failed

  7977.             - `8`: Moving to an external storage failed

  7978.             - `9`: To edit using studio edition feature

  7979.         label:

  7980.           type: string

  7981. 

  7982.     UserExportState:

  7983.       type: integer

  7984.       enum:

  7985.         - 1

  7986.         - 2

  7987.         - 3

  7988.         - 4

  7989.       description: |

  7990.         The user export state:

  7991.           - `1`: Pending

  7992.           - `2`: Processing

  7993.           - `3`: Completed

  7994.           - `4`: Errored

  7995. 

  7996.     UserImportState:

  7997.       type: integer

  7998.       enum:

  7999.         - 1

  8000.         - 2

  8001.         - 3

  8002.         - 4

  8003.       description: |

  8004.         The user import state:

  8005.           - `1`: Pending

  8006.           - `2`: Processing

  8007.           - `3`: Completed

  8008.           - `4`: Errored

  8009. 

  8010.     AbuseStateSet:

  8011.       type: integer

  8012.       enum:

  8013.         - 1

  8014.         - 2

  8015.         - 3

  8016.       description: 'The abuse state (Pending = `1`, Rejected = `2`, Accepted = `3`)'

  8017.     AbuseStateConstant:

  8018.       properties:

  8019.         id:

  8020.           $ref: '#/components/schemas/AbuseStateSet'

  8021.         label:

  8022.           type: string

  8023.     AbusePredefinedReasons:

  8024.       type: array

  8025.       items:

  8026.         type: string

  8027.         enum:

  8028.         - violentOrAbusive

  8029.         - hatefulOrAbusive

  8030.         - spamOrMisleading

  8031.         - privacy

  8032.         - rights

  8033.         - serverRules

  8034.         - thumbnails

  8035.         - captions

  8036.       example: [spamOrMisleading]

  8037. 

  8038.     VideoResolutionSet:

  8039.       type: integer

  8040.       description: |

  8041.         Video resolution (`0`, `240`, `360`, `720`, `1080`, `1440` or `2160`)

  8042. 

  8043.         `0` is used as a special value for stillimage videos dedicated to audio, a.k.a. audio-only videos.

  8044.       example: 240

  8045.     VideoResolutionConstant:

  8046.       description: resolutions and their labels for the video

  8047.       properties:

  8048.         id:

  8049.           $ref: '#/components/schemas/VideoResolutionSet'

  8050.         label:

  8051.           type: string

  8052.           example: 240p

  8053.     VideoScheduledUpdate:

  8054.       properties:

  8055.         privacy:

  8056.           $ref: '#/components/schemas/VideoPrivacySet'

  8057.         updateAt:

  8058.           type: string

  8059.           format: date-time

  8060.           description: When to update the video

  8061.       required:

  8062.         - updateAt

  8063.     AccountSummary:

  8064.       properties:

  8065.         id:

  8066.           type: integer

  8067.         name:

  8068.           type: string

  8069.         displayName:

  8070.           type: string

  8071.         url:

  8072.           type: string

  8073.           format: url

  8074.         host:

  8075.           type: string

  8076.           format: hostname

  8077.         avatars:

  8078.           type: array

  8079.           items:

  8080.             $ref: '#/components/schemas/ActorImage'

  8081.     VideoChannelSummary:

  8082.       properties:

  8083.         id:

  8084.           $ref: '#/components/schemas/id'

  8085.         name:

  8086.           type: string

  8087.         displayName:

  8088.           type: string

  8089.         url:

  8090.           type: string

  8091.           format: url

  8092.         host:

  8093.           type: string

  8094.           format: hostname

  8095.         avatars:

  8096.           type: array

  8097.           items:

  8098.             $ref: '#/components/schemas/ActorImage'

  8099.     PlaylistElement:

  8100.       properties:

  8101.         position:

  8102.           type: integer

  8103.         startTimestamp:

  8104.           type: integer

  8105.           format: seconds

  8106.         stopTimestamp:

  8107.           type: integer

  8108.           format: seconds

  8109.         video:

  8110.           nullable: true

  8111.           allOf:

  8112.             - $ref: '#/components/schemas/Video'

  8113.     VideoFile:

  8114.       readOnly: true

  8115.       properties:

  8116.         id:

  8117.           $ref: '#/components/schemas/id'

  8118.         magnetUri:

  8119.           type: string

  8120.           format: uri

  8121.           description: magnet URI allowing to resolve the video via BitTorrent without a metainfo file

  8122.           pattern: /magnet:\?xt=urn:[a-z0-9]+:[a-z0-9]{32}/i

  8123.         resolution:

  8124.           $ref: '#/components/schemas/VideoResolutionConstant'

  8125.         size:

  8126.           type: integer

  8127.           description: Video file size in bytes

  8128.         torrentUrl:

  8129.           type: string

  8130.           description: Direct URL of the torrent file

  8131.           format: url

  8132.         torrentDownloadUrl:

  8133.           type: string

  8134.           description: URL endpoint that transfers the torrent file as an attachment (so that the browser opens a download dialog)

  8135.           format: url

  8136.         fileUrl:

  8137.           type: string

  8138.           description: Direct URL of the video

  8139.           format: url

  8140.         fileDownloadUrl:

  8141.           type: string

  8142.           description: URL endpoint that transfers the video file as an attachment (so that the browser opens a download dialog)

  8143.           format: url

  8144.         fps:

  8145.           type: number

  8146.           description: Frames per second of the video file

  8147.         width:

  8148.           type: number

  8149.           description: "**PeerTube >= 6.1** Video stream width"

  8150.         height:

  8151.           type: number

  8152.           description: "**PeerTube >= 6.1** Video stream height"

  8153.         metadataUrl:

  8154.           type: string

  8155.           format: url

  8156.           description: URL dereferencing the output of ffprobe on the file

  8157.     VideoStreamingPlaylists:

  8158.       allOf:

  8159.         - type: object

  8160.           properties:

  8161.             id:

  8162.               $ref: '#/components/schemas/id'

  8163.             type:

  8164.               type: integer

  8165.               enum:

  8166.                 - 1

  8167.               description: |

  8168.                 Playlist type:

  8169.                 - `1`: HLS

  8170.         - $ref: '#/components/schemas/VideoStreamingPlaylists-HLS'

  8171.     VideoStreamingPlaylists-HLS:

  8172.       properties:

  8173.         playlistUrl:

  8174.           type: string

  8175.           format: url

  8176.         segmentsSha256Url:

  8177.           type: string

  8178.           format: url

  8179.         files:

  8180.           type: array

  8181.           description: |

  8182.             Video files associated to this playlist.

  8183. 

  8184.             The difference with the root `files` property is that these files are fragmented, so they can be used in this streaming playlist (HLS, etc.)

  8185.           items:

  8186.             $ref: '#/components/schemas/VideoFile'

  8187.         redundancies:

  8188.           type: array

  8189.           items:

  8190.             type: object

  8191.             properties:

  8192.               baseUrl:

  8193.                 type: string

  8194.                 format: url

  8195.     VideoInfo:

  8196.       properties:

  8197.         id:

  8198.           $ref: '#/components/schemas/Video/properties/id'

  8199.         uuid:

  8200.           $ref: '#/components/schemas/Video/properties/uuid'

  8201.         name:

  8202.           $ref: '#/components/schemas/Video/properties/name'

  8203.     Video:

  8204.       properties:

  8205.         id:

  8206.           description: object id for the video

  8207.           allOf:

  8208.             - $ref: '#/components/schemas/id'

  8209.         uuid:

  8210.           description: universal identifier for the video, that can be used across instances

  8211.           allOf:

  8212.             - $ref: '#/components/schemas/UUIDv4'

  8213.         shortUUID:

  8214.           allOf:

  8215.             - $ref: '#/components/schemas/shortUUID'

  8216.         isLive:

  8217.           type: boolean

  8218.         createdAt:

  8219.           type: string

  8220.           format: date-time

  8221.           example: 2017-10-01T10:52:46.396Z

  8222.           description: time at which the video object was first drafted

  8223.         publishedAt:

  8224.           type: string

  8225.           format: date-time

  8226.           example: 2018-10-01T10:52:46.396Z

  8227.           description: time at which the video was marked as ready for playback (with restrictions depending on `privacy`). Usually set after a `state` evolution.

  8228.         updatedAt:

  8229.           type: string

  8230.           format: date-time

  8231.           example: 2021-05-04T08:01:01.502Z

  8232.           description: last time the video's metadata was modified

  8233.         originallyPublishedAt:

  8234.           type: string

  8235.           nullable: true

  8236.           format: date-time

  8237.           example: 2010-10-01T10:52:46.396Z

  8238.           description: used to represent a date of first publication, prior to the practical publication date of `publishedAt`

  8239.         category:

  8240.           allOf:

  8241.             - $ref: '#/components/schemas/VideoConstantNumber-Category'

  8242.           description: category in which the video is classified

  8243.         licence:

  8244.           allOf:

  8245.             - $ref: '#/components/schemas/VideoConstantNumber-Licence'

  8246.           description: licence under which the video is distributed

  8247.         language:

  8248.           allOf:

  8249.             - $ref: '#/components/schemas/VideoConstantString-Language'

  8250.           description: main language used in the video

  8251.         privacy:

  8252.           allOf:

  8253.             - $ref: '#/components/schemas/VideoPrivacyConstant'

  8254.           description: privacy policy used to distribute the video

  8255.         truncatedDescription:

  8256.           type: string

  8257.           nullable: true

  8258.           example: |

  8259.             **[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\r\n\r\n

  8260.             **Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\r\n*A decentralized video hosting network, based on fr...

  8261.           minLength: 3

  8262.           maxLength: 250

  8263.           description: |

  8264.             truncated description of the video, written in Markdown.

  8265.         duration:

  8266.           type: integer

  8267.           example: 1419

  8268.           format: seconds

  8269.           description: duration of the video in seconds

  8270.         aspectRatio:

  8271.           type: number

  8272.           nullable: true

  8273.           format: float

  8274.           example: 1.778

  8275.           description: "**PeerTube >= 6.1** Aspect ratio of the video stream"

  8276.         isLocal:

  8277.           type: boolean

  8278.         name:

  8279.           type: string

  8280.           description: title of the video

  8281.           example: What is PeerTube?

  8282.           minLength: 3

  8283.           maxLength: 120

  8284.         thumbnailPath:

  8285.           type: string

  8286.           example: /lazy-static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg

  8287.         previewPath:

  8288.           type: string

  8289.           example: /lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg

  8290.         embedPath:

  8291.           type: string

  8292.           example: /videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee

  8293.         views:

  8294.           type: integer

  8295.           example: 1337

  8296.         likes:

  8297.           type: integer

  8298.           example: 42

  8299.         dislikes:

  8300.           type: integer

  8301.           example: 7

  8302.         nsfw:

  8303.           type: boolean

  8304.         waitTranscoding:

  8305.           type: boolean

  8306.           nullable: true

  8307.         state:

  8308.           allOf:

  8309.             - $ref: '#/components/schemas/VideoStateConstant'

  8310.           description: represents the internal state of the video processing within the PeerTube instance

  8311.         scheduledUpdate:

  8312.           nullable: true

  8313.           allOf:

  8314.             - $ref: '#/components/schemas/VideoScheduledUpdate'

  8315.         blacklisted:

  8316.           nullable: true

  8317.           type: boolean

  8318.         blacklistedReason:

  8319.           nullable: true

  8320.           type: string

  8321.         account:

  8322.           $ref: '#/components/schemas/AccountSummary'

  8323.         channel:

  8324.           $ref: '#/components/schemas/VideoChannelSummary'

  8325.         userHistory:

  8326.           nullable: true

  8327.           type: object

  8328.           properties:

  8329.             currentTime:

  8330.               type: integer

  8331.     VideoDetails:

  8332.       allOf:

  8333.         - $ref: '#/components/schemas/Video'

  8334.         - type: object

  8335.           properties:

  8336.             viewers:

  8337.               type: integer

  8338.               description: If the video is a live, you have the amount of current viewers

  8339.             description:

  8340.               type: string

  8341.               nullable: true

  8342.               example: |

  8343.                	"**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\r\n\r\n

  8344.                 **Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\r\n*A decentralized video hosting network,

  8345.                 based on free/libre software!*\r\n\r\n**Animation Produced by:** [LILA](https://libreart.info) - [ZeMarmot Team](https://film.zemarmot.net)\r\n

  8346.                 *Directed by* Aryeom\r\n*Assistant* Jehan\r\n**Licence**: [CC-By-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/)\r\n\r\n

  8347.                 **Sponsored by** [Framasoft](https://framasoft.org)\r\n\r\n**Music**: [Red Step Forward](http://play.dogmazic.net/song.php?song_id=52491) - CC-By Ken Bushima\r\n\r\n

  8348.                 **Movie Clip**: [Caminades 3: Llamigos](http://www.caminandes.com/) CC-By Blender Institute\r\n\r\n**Video sources**: https://gitlab.gnome.org/Jehan/what-is-peertube/"

  8349.               minLength: 3

  8350.               maxLength: 1000

  8351.               description: |

  8352.                 full description of the video, written in Markdown.

  8353.             support:

  8354.               type: string

  8355.               nullable: true

  8356.               description: A text tell the audience how to support the video creator

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

  8358.               minLength: 3

  8359.               maxLength: 1000

  8360.             channel:

  8361.               $ref: '#/components/schemas/VideoChannel'

  8362.             account:

  8363.               $ref: '#/components/schemas/Account'

  8364.             tags:

  8365.               example: [flowers, gardening]

  8366.               type: array

  8367.               minItems: 1

  8368.               maxItems: 5

  8369.               items:

  8370.                 type: string

  8371.                 minLength: 2

  8372.                 maxLength: 30

  8373.             commentsEnabled:

  8374.               deprecated: true

  8375.               description: 'Deprecated in 6.2, use commentsPolicy instead'

  8376.               type: boolean

  8377.             commentsPolicy:

  8378.               $ref: '#/components/schemas/VideoCommentsPolicyConstant'

  8379.             downloadEnabled:

  8380.               type: boolean

  8381.             inputFileUpdatedAt:

  8382.               type: string

  8383.               format: date-time

  8384.               nullable: true

  8385.               description: Latest input file update. Null if the file has never been replaced since the original upload

  8386.             trackerUrls:

  8387.               type: array

  8388.               items:

  8389.                 type: string

  8390.                 format: url

  8391.               example:

  8392.                 - https://peertube2.cpy.re/tracker/announce

  8393.                 - wss://peertube2.cpy.re/tracker/socket

  8394.             files:

  8395.               type: array

  8396.               items:

  8397.                 $ref: '#/components/schemas/VideoFile'

  8398.               description: |

  8399.                 Web compatible video files. If Web Video is disabled on the server:

  8400. 

  8401.                 - field will be empty

  8402.                 - video files will be found in `streamingPlaylists[].files` field

  8403.             streamingPlaylists:

  8404.               type: array

  8405.               items:

  8406.                 $ref: '#/components/schemas/VideoStreamingPlaylists'

  8407.               description: |

  8408.                 HLS playlists/manifest files. If HLS is disabled on the server:

  8409. 

  8410.                 - field will be empty

  8411.                 - video files will be found in `files` field

  8412.     FileRedundancyInformation:

  8413.       properties:

  8414.         id:

  8415.           $ref: '#/components/schemas/id'

  8416.         fileUrl:

  8417.           type: string

  8418.           format: url

  8419.         strategy:

  8420.           type: string

  8421.           enum:

  8422.             - manual

  8423.             - most-views

  8424.             - trending

  8425.             - recently-added

  8426.         size:

  8427.           type: integer

  8428.         createdAt:

  8429.           type: string

  8430.           format: date-time

  8431.         updatedAt:

  8432.           type: string

  8433.           format: date-time

  8434.         expiresOn:

  8435.           type: string

  8436.           format: date-time

  8437.     VideoRedundancy:

  8438.       properties:

  8439.         id:

  8440.           $ref: '#/components/schemas/id'

  8441.         name:

  8442.           type: string

  8443.         url:

  8444.           type: string

  8445.           format: url

  8446.         uuid:

  8447.           $ref: '#/components/schemas/UUIDv4'

  8448.         redundancies:

  8449.           type: object

  8450.           properties:

  8451.             files:

  8452.               type: array

  8453.               items:

  8454.                 $ref: '#/components/schemas/FileRedundancyInformation'

  8455.             streamingPlaylists:

  8456.               type: array

  8457.               items:

  8458.                 $ref: '#/components/schemas/FileRedundancyInformation'

  8459.     CommentAutoTagPolicies:

  8460.       properties:

  8461.         review:

  8462.           type: array

  8463.           description: 'Auto tags that automatically set the comment in review state'

  8464.           items:

  8465.             type: string

  8466.     AutomaticTagAvailable:

  8467.       properties:

  8468.         available:

  8469.           type: array

  8470.           description: 'Available auto tags that can be used to filter objects or set a comment in review state'

  8471.           items:

  8472.             type: object

  8473.             properties:

  8474.               name:

  8475.                 type: string

  8476.                 description: tag name

  8477.               type:

  8478.                 type: string

  8479.                 enum:

  8480.                   - 'core'

  8481.                   - 'watched-words-list'

  8482. 

  8483.     VideoImportStateConstant:

  8484.       properties:

  8485.         id:

  8486.           type: integer

  8487.           enum:

  8488.             - 1

  8489.             - 2

  8490.             - 3

  8491.           description: 'The video import state (Pending = `1`, Success = `2`, Failed = `3`)'

  8492.         label:

  8493.           type: string

  8494.           example: Pending

  8495.     VideoCreateImport:

  8496.       allOf:

  8497.         - type: object

  8498.           additionalProperties: false

  8499.           oneOf:

  8500.             - properties:

  8501.                 targetUrl:

  8502.                   $ref: '#/components/schemas/VideoImport/properties/targetUrl'

  8503.               required: [targetUrl]

  8504.             - properties:

  8505.                 magnetUri:

  8506.                   $ref: '#/components/schemas/VideoImport/properties/magnetUri'

  8507.               required: [magnetUri]

  8508.             - properties:

  8509.                 torrentfile:

  8510.                   $ref: '#/components/schemas/VideoImport/properties/torrentfile'

  8511.               required: [torrentfile]

  8512.         - $ref: '#/components/schemas/VideoUploadRequestCommon'

  8513.       required:

  8514.         - channelId

  8515.         - name

  8516.     VideoImport:

  8517.       properties:

  8518.         id:

  8519.           readOnly: true

  8520.           allOf:

  8521.             - $ref: '#/components/schemas/id'

  8522.         targetUrl:

  8523.           type: string

  8524.           format: url

  8525.           description: remote URL where to find the import's source video

  8526.           example: https://framatube.org/videos/watch/9c9de5e8-0a1e-484a-b099-e80766180a6d

  8527.         magnetUri:

  8528.           type: string

  8529.           format: uri

  8530.           description: magnet URI allowing to resolve the import's source video

  8531.           pattern: /magnet:\?xt=urn:[a-z0-9]+:[a-z0-9]{32}/i

  8532.         torrentfile:

  8533.           writeOnly: true

  8534.           type: string

  8535.           format: binary

  8536.           description: Torrent file containing only the video file

  8537.         torrentName:

  8538.           readOnly: true

  8539.           type: string

  8540.         state:

  8541.           readOnly: true

  8542.           allOf:

  8543.             - $ref: '#/components/schemas/VideoImportStateConstant'

  8544.         error:

  8545.           readOnly: true

  8546.           type: string

  8547.         createdAt:

  8548.           readOnly: true

  8549.           type: string

  8550.           format: date-time

  8551.         updatedAt:

  8552.           readOnly: true

  8553.           type: string

  8554.           format: date-time

  8555.         video:

  8556.           readOnly: true

  8557.           nullable: true

  8558.           allOf:

  8559.             - $ref: '#/components/schemas/Video'

  8560.     VideoImportsList:

  8561.       properties:

  8562.         total:

  8563.           type: integer

  8564.           example: 1

  8565.         data:

  8566.           type: array

  8567.           maxItems: 100

  8568.           items:

  8569.             $ref: '#/components/schemas/VideoImport'

  8570.     Abuse:

  8571.       properties:

  8572.         id:

  8573.           $ref: '#/components/schemas/id'

  8574.         reason:

  8575.           type: string

  8576.           example: The video is a spam

  8577.           minLength: 2

  8578.           maxLength: 3000

  8579.         predefinedReasons:

  8580.           $ref: '#/components/schemas/AbusePredefinedReasons'

  8581.         reporterAccount:

  8582.           $ref: '#/components/schemas/Account'

  8583.         state:

  8584.           $ref: '#/components/schemas/AbuseStateConstant'

  8585.         moderationComment:

  8586.           type: string

  8587.           example: Decided to ban the server since it spams us regularly

  8588.           minLength: 2

  8589.           maxLength: 3000

  8590.         video:

  8591.           $ref: '#/components/schemas/VideoInfo'

  8592.         createdAt:

  8593.           type: string

  8594.           format: date-time

  8595.     AbuseMessage:

  8596.       properties:

  8597.         id:

  8598.           $ref: '#/components/schemas/id'

  8599.         message:

  8600.           type: string

  8601.           minLength: 2

  8602.           maxLength: 3000

  8603.         byModerator:

  8604.           type: boolean

  8605.         createdAt:

  8606.           type: string

  8607.           format: date-time

  8608.         account:

  8609.           $ref: '#/components/schemas/AccountSummary'

  8610.     VideoBlacklist:

  8611.       properties:

  8612.         id:

  8613.           $ref: '#/components/schemas/id'

  8614.         videoId:

  8615.           $ref: '#/components/schemas/Video/properties/id'

  8616.         createdAt:

  8617.           type: string

  8618.           format: date-time

  8619.         updatedAt:

  8620.           type: string

  8621.           format: date-time

  8622.         name:

  8623.           type: string

  8624.           minLength: 3

  8625.           maxLength: 120

  8626.         uuid:

  8627.           $ref: '#/components/schemas/UUIDv4'

  8628.         description:

  8629.           type: string

  8630.           minLength: 3

  8631.           maxLength: 10000

  8632.         duration:

  8633.           type: integer

  8634.         views:

  8635.           type: integer

  8636.         likes:

  8637.           type: integer

  8638.         dislikes:

  8639.           type: integer

  8640.         nsfw:

  8641.           type: boolean

  8642.     VideoPlaylist:

  8643.       properties:

  8644.         id:

  8645.           $ref: '#/components/schemas/id'

  8646.         uuid:

  8647.           $ref: '#/components/schemas/UUIDv4'

  8648.         shortUUID:

  8649.           allOf:

  8650.             - $ref: '#/components/schemas/shortUUID'

  8651.         createdAt:

  8652.           type: string

  8653.           format: date-time

  8654.         updatedAt:

  8655.           type: string

  8656.           format: date-time

  8657.         description:

  8658.           type: string

  8659.           minLength: 3

  8660.           maxLength: 1000

  8661.         displayName:

  8662.           type: string

  8663.           minLength: 1

  8664.           maxLength: 120

  8665.         isLocal:

  8666.           type: boolean

  8667.         videoLength:

  8668.           type: integer

  8669.           minimum: 0

  8670.         thumbnailPath:

  8671.           type: string

  8672.         privacy:

  8673.           $ref: '#/components/schemas/VideoPlaylistPrivacyConstant'

  8674.         type:

  8675.           $ref: '#/components/schemas/VideoPlaylistTypeConstant'

  8676.         ownerAccount:

  8677.           $ref: '#/components/schemas/AccountSummary'

  8678.         videoChannel:

  8679.           $ref: '#/components/schemas/VideoChannelSummary'

  8680.     VideoComment:

  8681.       properties:

  8682.         id:

  8683.           $ref: '#/components/schemas/id'

  8684.         url:

  8685.           type: string

  8686.           format: url

  8687.         text:

  8688.           type: string

  8689.           format: html

  8690.           description: Text of the comment

  8691.           minLength: 1

  8692.           example: This video is wonderful!

  8693.         threadId:

  8694.           $ref: '#/components/schemas/id'

  8695.         inReplyToCommentId:

  8696.           nullable: true

  8697.           allOf:

  8698.             - $ref: '#/components/schemas/id'

  8699.         videoId:

  8700.           $ref: '#/components/schemas/Video/properties/id'

  8701.         createdAt:

  8702.           type: string

  8703.           format: date-time

  8704.         updatedAt:

  8705.           type: string

  8706.           format: date-time

  8707.         deletedAt:

  8708.           nullable: true

  8709.           type: string

  8710.           format: date-time

  8711.           default: null

  8712.         isDeleted:

  8713.           type: boolean

  8714.           default: false

  8715.         heldForReview:

  8716.           type: boolean

  8717.         totalRepliesFromVideoAuthor:

  8718.           type: integer

  8719.           minimum: 0

  8720.         totalReplies:

  8721.           type: integer

  8722.           minimum: 0

  8723.         account:

  8724.           $ref: '#/components/schemas/Account'

  8725.     VideoCommentThreadTree:

  8726.       properties:

  8727.         comment:

  8728.           $ref: '#/components/schemas/VideoComment'

  8729.         children:

  8730.           type: array

  8731.           items:

  8732.             $ref: '#/components/schemas/VideoCommentThreadTree'

  8733.     VideoCommentForOwnerOrAdmin:

  8734.       properties:

  8735.         id:

  8736.           $ref: '#/components/schemas/id'

  8737.         url:

  8738.           $ref: '#/components/schemas/VideoComment/properties/url'

  8739.         text:

  8740.           $ref: '#/components/schemas/VideoComment/properties/text'

  8741.         heldForReview:

  8742.           $ref: '#/components/schemas/VideoComment/properties/heldForReview'

  8743.         threadId:

  8744.           $ref: '#/components/schemas/VideoComment/properties/threadId'

  8745.         inReplyToCommentId:

  8746.           $ref: '#/components/schemas/VideoComment/properties/inReplyToCommentId'

  8747.         createdAt:

  8748.           $ref: '#/components/schemas/VideoComment/properties/createdAt'

  8749.         updatedAt:

  8750.           $ref: '#/components/schemas/VideoComment/properties/updatedAt'

  8751.         account:

  8752.           $ref: '#/components/schemas/VideoComment/properties/account'

  8753.         video:

  8754.           $ref: '#/components/schemas/VideoInfo'

  8755.         automaticTags:

  8756.           type: array

  8757.           items:

  8758.             type: string

  8759. 

  8760.     Storyboard:

  8761.       properties:

  8762.         storyboardPath:

  8763.           type: string

  8764.         totalHeight:

  8765.           type: integer

  8766.         totalWidth:

  8767.           type: integer

  8768.         spriteHeight:

  8769.           type: integer

  8770.         spriteWidth:

  8771.           type: integer

  8772.         spriteDuration:

  8773.           type: integer

  8774.     VideoCaption:

  8775.       properties:

  8776.         language:

  8777.           $ref: '#/components/schemas/VideoConstantString-Language'

  8778.         captionPath:

  8779.           type: string

  8780.     VideoChapters:

  8781.       properties:

  8782.         chapters:

  8783.           type: object

  8784.           properties:

  8785.             title:

  8786.               type: string

  8787.             timecode:

  8788.               type: integer

  8789.     VideoSource:

  8790.       properties:

  8791.         filename:

  8792.           type: string

  8793.           deprecated: true

  8794.           description: 'Deprecated in 6.1, use inputFilename instead'

  8795.         inputFilename:

  8796.           type: string

  8797.           description: 'Uploaded/imported filename'

  8798.         fileDownloadUrl:

  8799.           type: string

  8800.           description: "**PeerTube >= 6.1** If enabled by the admin, the video source file is kept on the server and can be downloaded by the owner"

  8801.         resolution:

  8802.           $ref: '#/components/schemas/VideoResolutionConstant'

  8803.           description: "**PeerTube >= 6.1**"

  8804.         size:

  8805.           type: integer

  8806.           description: "**PeerTube >= 6.1** Video file size in bytes"

  8807.         fps:

  8808.           type: number

  8809.           description: "**PeerTube >= 6.1** Frames per second of the video file"

  8810.         width:

  8811.           type: number

  8812.           description: "**PeerTube >= 6.1** Video stream width"

  8813.         height:

  8814.           type: number

  8815.           description: "**PeerTube >= 6.1** Video stream height"

  8816.         createdAt:

  8817.           type: string

  8818.           format: date-time

  8819.     ActorImage:

  8820.       properties:

  8821.         path:

  8822.           type: string

  8823.         width:

  8824.           type: integer

  8825.         createdAt:

  8826.           type: string

  8827.           format: date-time

  8828.         updatedAt:

  8829.           type: string

  8830.           format: date-time

  8831.     ActorInfo:

  8832.       properties:

  8833.         id:

  8834.           $ref: '#/components/schemas/id'

  8835.         name:

  8836.           type: string

  8837.         displayName:

  8838.           type: string

  8839.         host:

  8840.           type: string

  8841.           format: hostname

  8842.         avatars:

  8843.           type: array

  8844.           items:

  8845.             $ref: '#/components/schemas/ActorImage'

  8846.     Actor:

  8847.       properties:

  8848.         id:

  8849.           $ref: '#/components/schemas/id'

  8850.         url:

  8851.           type: string

  8852.           format: url

  8853.         name:

  8854.           description: immutable name of the actor, used to find or mention it

  8855.           allOf:

  8856.             - $ref: '#/components/schemas/username'

  8857.         avatars:

  8858.           type: array

  8859.           items:

  8860.             $ref: '#/components/schemas/ActorImage'

  8861.         host:

  8862.           type: string

  8863.           format: hostname

  8864.           description: server on which the actor is resident

  8865.         hostRedundancyAllowed:

  8866.           type: boolean

  8867.           description: whether this actor's host allows redundancy of its videos

  8868.         followingCount:

  8869.           type: integer

  8870.           minimum: 0

  8871.           description: number of actors subscribed to by this actor, as seen by this instance

  8872.         followersCount:

  8873.           type: integer

  8874.           minimum: 0

  8875.           description: number of followers of this actor, as seen by this instance

  8876.         createdAt:

  8877.           type: string

  8878.           format: date-time

  8879.         updatedAt:

  8880.           type: string

  8881.           format: date-time

  8882.     Account:

  8883.       allOf:

  8884.         - $ref: '#/components/schemas/Actor'

  8885.         - properties:

  8886.             userId:

  8887.               description: object id for the user tied to this account

  8888.               nullable: true

  8889.               allOf:

  8890.                 - $ref: '#/components/schemas/User/properties/id'

  8891.             displayName:

  8892.               type: string

  8893.               description: editable name of the account, displayed in its representations

  8894.               minLength: 3

  8895.               maxLength: 120

  8896.             description:

  8897.               type: string

  8898.               nullable: true

  8899.               description: text or bio displayed on the account's profile

  8900.     UserViewingVideo:

  8901.       required:

  8902.         - currentTime

  8903.       properties:

  8904.         currentTime:

  8905.           type: integer

  8906.           format: seconds

  8907.           description: timestamp within the video, in seconds

  8908.           example: 5

  8909.         viewEvent:

  8910.           type: string

  8911.           enum:

  8912.             - seek

  8913.           description: >

  8914.             Event since last viewing call:

  8915.              * `seek` - If the user seeked the video

  8916.         sessionId:

  8917.           type: string

  8918.           description: >

  8919.             Optional param to represent the current viewer session.

  8920.             Used by the backend to properly count one view per session per video.

  8921.             PeerTube admin can configure the server to not trust this `sessionId` parameter but use the request IP address instead to identify a viewer.

  8922. 

  8923. 

  8924.     VideoStatsOverall:

  8925.       properties:

  8926.         averageWatchTime:

  8927.           type: number

  8928.         totalWatchTime:

  8929.           type: number

  8930.         viewersPeak:

  8931.           type: number

  8932.         viewersPeakDate:

  8933.           type: string

  8934.           format: date-time

  8935.         countries:

  8936.           type: array

  8937.           items:

  8938.             type: object

  8939.             properties:

  8940.               isoCode:

  8941.                 type: string

  8942.               viewers:

  8943.                 type: number

  8944. 

  8945.     VideoStatsRetention:

  8946.       properties:

  8947.         data:

  8948.           type: array

  8949.           items:

  8950.             type: object

  8951.             properties:

  8952.               second:

  8953.                 type: number

  8954.               retentionPercent:

  8955.                 type: number

  8956. 

  8957.     VideoStatsTimeserie:

  8958.       properties:

  8959.         data:

  8960.           type: array

  8961.           items:

  8962.             type: object

  8963.             properties:

  8964.               date:

  8965.                 type: string

  8966.               value:

  8967.                 type: number

  8968. 

  8969.     ServerConfig:

  8970.       properties:

  8971.         instance:

  8972.           type: object

  8973.           properties:

  8974.             name:

  8975.               type: string

  8976.             shortDescription:

  8977.               type: string

  8978.             defaultClientRoute:

  8979.               type: string

  8980.             isNSFW:

  8981.               type: boolean

  8982.             defaultNSFWPolicy:

  8983.               type: string

  8984.             customizations:

  8985.               type: object

  8986.               properties:

  8987.                 javascript:

  8988.                   type: string

  8989.                 css:

  8990.                   type: string

  8991.             avatars:

  8992.               type: array

  8993.               items:

  8994.                 $ref: '#/components/schemas/ActorImage'

  8995.             banners:

  8996.               type: array

  8997.               items:

  8998.                 $ref: '#/components/schemas/ActorImage'

  8999.         search:

  9000.           type: object

  9001.           properties:

  9002.             remoteUri:

  9003.               type: object

  9004.               properties:

  9005.                 users:

  9006.                   type: boolean

  9007.                 anonymous:

  9008.                   type: boolean

  9009.         plugin:

  9010.           type: object

  9011.           properties:

  9012.             registered:

  9013.               type: array

  9014.               items:

  9015.                 type: string

  9016.         theme:

  9017.           type: object

  9018.           properties:

  9019.             registered:

  9020.               type: array

  9021.               items:

  9022.                 type: string

  9023.         email:

  9024.           type: object

  9025.           properties:

  9026.             enabled:

  9027.               type: boolean

  9028.         contactForm:

  9029.           type: object

  9030.           properties:

  9031.             enabled:

  9032.               type: boolean

  9033.         serverVersion:

  9034.           type: string

  9035.         serverCommit:

  9036.           type: string

  9037.         signup:

  9038.           type: object

  9039.           properties:

  9040.             allowed:

  9041.               type: boolean

  9042.             allowedForCurrentIP:

  9043.               type: boolean

  9044.             requiresEmailVerification:

  9045.               type: boolean

  9046.         transcoding:

  9047.           type: object

  9048.           properties:

  9049.             hls:

  9050.               type: object

  9051.               properties:

  9052.                 enabled:

  9053.                   type: boolean

  9054.             web_videos:

  9055.               type: object

  9056.               properties:

  9057.                 enabled:

  9058.                   type: boolean

  9059.             enabledResolutions:

  9060.               type: array

  9061.               items:

  9062.                 $ref: '#/components/schemas/VideoResolutionSet'

  9063.         import:

  9064.           type: object

  9065.           properties:

  9066.             videos:

  9067.               type: object

  9068.               properties:

  9069.                 http:

  9070.                   type: object

  9071.                   properties:

  9072.                     enabled:

  9073.                       type: boolean

  9074.                 torrent:

  9075.                   type: object

  9076.                   properties:

  9077.                     enabled:

  9078.                       type: boolean

  9079.             videoChannelSynchronization:

  9080.               type: object

  9081.               properties:

  9082.                 enabled:

  9083.                   type: boolean

  9084.             users:

  9085.               type: object

  9086.               properties:

  9087.                 enabled:

  9088.                   type: boolean

  9089.         export:

  9090.           type: object

  9091.           properties:

  9092.             users:

  9093.               type: object

  9094.               properties:

  9095.                 enabled:

  9096.                   type: boolean

  9097.                 exportExpiration:

  9098.                   type: number

  9099.                   description: In milliseconds

  9100.                 maxUserVideoQuota:

  9101.                   type: number

  9102.                   description: In bytes

  9103.         autoBlacklist:

  9104.           type: object

  9105.           properties:

  9106.             videos:

  9107.               type: object

  9108.               properties:

  9109.                 ofUsers:

  9110.                   type: object

  9111.                   properties:

  9112.                     enabled:

  9113.                       type: boolean

  9114.         avatar:

  9115.           type: object

  9116.           properties:

  9117.             file:

  9118.               type: object

  9119.               properties:

  9120.                 size:

  9121.                   type: object

  9122.                   properties:

  9123.                     max:

  9124.                       type: integer

  9125.             extensions:

  9126.               type: array

  9127.               items:

  9128.                 type: string

  9129.         video:

  9130.           type: object

  9131.           properties:

  9132.             image:

  9133.               type: object

  9134.               properties:

  9135.                 extensions:

  9136.                   type: array

  9137.                   items:

  9138.                     type: string

  9139.                 size:

  9140.                   type: object

  9141.                   properties:

  9142.                     max:

  9143.                       type: integer

  9144.             file:

  9145.               type: object

  9146.               properties:

  9147.                 extensions:

  9148.                   type: array

  9149.                   items:

  9150.                     type: string

  9151.         videoCaption:

  9152.           type: object

  9153.           properties:

  9154.             file:

  9155.               type: object

  9156.               properties:

  9157.                 size:

  9158.                   type: object

  9159.                   properties:

  9160.                     max:

  9161.                       type: integer

  9162.                 extensions:

  9163.                   type: array

  9164.                   items:

  9165.                     type: string

  9166.         user:

  9167.           type: object

  9168.           properties:

  9169.             videoQuota:

  9170.               type: integer

  9171.               description: In bytes

  9172.               example: 16810141515

  9173.             videoQuotaDaily:

  9174.               type: integer

  9175.               description: In bytes

  9176.               example: 1681014151

  9177.         trending:

  9178.           type: object

  9179.           properties:

  9180.             videos:

  9181.               type: object

  9182.               properties:

  9183.                 intervalDays:

  9184.                   type: integer

  9185.         tracker:

  9186.           type: object

  9187.           properties:

  9188.             enabled:

  9189.               type: boolean

  9190.         followings:

  9191.           type: object

  9192.           properties:

  9193.             instance:

  9194.               type: object

  9195.               properties:

  9196.                 autoFollowIndex:

  9197.                   type: object

  9198.                   properties:

  9199.                     indexUrl:

  9200.                       type: string

  9201.                       format: url

  9202.         homepage:

  9203.           type: object

  9204.           properties:

  9205.             enabled:

  9206.               type: boolean

  9207. 

  9208.         openTelemetry:

  9209.           type: object

  9210.           description: 'PeerTube >= 6.1'

  9211.           properties:

  9212.             metrics:

  9213.               type: object

  9214.               properties:

  9215.                 enabled:

  9216.                   type: boolean

  9217.                 playbackStatsInterval:

  9218.                   type: number

  9219.                   description: 'Milliseconds'

  9220. 

  9221.         views:

  9222.           type: object

  9223.           description: 'PeerTube >= 6.1'

  9224.           properties:

  9225.             views:

  9226.               type: object

  9227.               properties:

  9228.                 watchingInterval:

  9229.                   type: object

  9230.                   properties:

  9231.                     anonymous:

  9232.                       type: number

  9233.                       description: 'Milliseconds'

  9234.                     users:

  9235.                       type: number

  9236.                       description: 'Milliseconds'

  9237. 

  9238.     SendClientLog:

  9239.       properties:

  9240.         message:

  9241.           type: string

  9242.         url:

  9243.           type: string

  9244.           description: URL of the current user page

  9245.         level:

  9246.           enum:

  9247.             - error

  9248.             - warn

  9249.         stackTrace:

  9250.           type: string

  9251.           description: Stack trace of the error if there is one

  9252.         userAgent:

  9253.           type: string

  9254.           description: User agent of the web browser that sends the message

  9255.         meta:

  9256.           type: string

  9257.           description: Additional information regarding this log

  9258.       required:

  9259.         - message

  9260.         - url

  9261.         - level

  9262. 

  9263.     ServerStats:

  9264.       properties:

  9265.         totalUsers:

  9266.           type: number

  9267.         totalDailyActiveUsers:

  9268.           type: number

  9269.         totalWeeklyActiveUsers:

  9270.           type: number

  9271.         totalMonthlyActiveUsers:

  9272.           type: number

  9273.         totalModerators:

  9274.           type: number

  9275.           description: "**PeerTube >= 6.1** Value is null if the admin disabled total moderators stats"

  9276.         totalAdmins:

  9277.           type: number

  9278.           description: "**PeerTube >= 6.1** Value is null if the admin disabled total admins stats"

  9279.         totalLocalVideos:

  9280.           type: number

  9281.         totalLocalVideoViews:

  9282.           type: number

  9283.           description: Total video views made on the instance

  9284.         totalLocalVideoComments:

  9285.           type: number

  9286.           description: Total comments made by local users

  9287.         totalLocalVideoFilesSize:

  9288.           type: number

  9289.         totalVideos:

  9290.           type: number

  9291.         totalVideoComments:

  9292.           type: number

  9293.         totalLocalVideoChannels:

  9294.           type: number

  9295.         totalLocalDailyActiveVideoChannels:

  9296.           type: number

  9297.         totalLocalWeeklyActiveVideoChannels:

  9298.           type: number

  9299.         totalLocalMonthlyActiveVideoChannels:

  9300.           type: number

  9301.         totalLocalPlaylists:

  9302.           type: number

  9303.         totalInstanceFollowers:

  9304.           type: number

  9305.         totalInstanceFollowing:

  9306.           type: number

  9307.         videosRedundancy:

  9308.           type: array

  9309.           items:

  9310.             type: object

  9311.             properties:

  9312.                 strategy:

  9313.                   type: string

  9314.                 totalSize:

  9315.                   type: number

  9316.                 totalUsed:

  9317.                   type: number

  9318.                 totalVideoFiles:

  9319.                   type: number

  9320.                 totalVideos:

  9321.                   type: number

  9322.         totalActivityPubMessagesProcessed:

  9323.           type: number

  9324.         totalActivityPubMessagesSuccesses:

  9325.           type: number

  9326.         totalActivityPubMessagesErrors:

  9327.           type: number

  9328. 

  9329.         activityPubMessagesProcessedPerSecond:

  9330.           type: number

  9331.         totalActivityPubMessagesWaiting:

  9332.           type: number

  9333. 

  9334.         averageRegistrationRequestResponseTimeMs:

  9335.           type: number

  9336.           description: "**PeerTube >= 6.1** Value is null if the admin disabled registration requests stats"

  9337.         totalRegistrationRequestsProcessed:

  9338.           type: number

  9339.           description: "**PeerTube >= 6.1** Value is null if the admin disabled registration requests stats"

  9340.         totalRegistrationRequests:

  9341.           type: number

  9342.           description: "**PeerTube >= 6.1** Value is null if the admin disabled registration requests stats"

  9343. 

  9344.         averageAbuseResponseTimeMs:

  9345.           type: number

  9346.           description: "**PeerTube >= 6.1** Value is null if the admin disabled abuses stats"

  9347.         totalAbusesProcessed:

  9348.           type: number

  9349.           description: "**PeerTube >= 6.1** Value is null if the admin disabled abuses stats"

  9350.         totalAbuses:

  9351.           type: number

  9352.           description: "**PeerTube >= 6.1** Value is null if the admin disabled abuses stats"

  9353. 

  9354.     ServerConfigAbout:

  9355.       properties:

  9356.         instance:

  9357.           type: object

  9358.           properties:

  9359.             name:

  9360.               type: string

  9361.             shortDescription:

  9362.               type: string

  9363.             description:

  9364.               type: string

  9365.             terms:

  9366.               type: string

  9367.             codeOfConduct:

  9368.               type: string

  9369.             hardwareInformation:

  9370.               type: string

  9371.             creationReason:

  9372.               type: string

  9373.             moderationInformation:

  9374.               type: string

  9375.             administrator:

  9376.               type: string

  9377.             maintenanceLifetime:

  9378.               type: string

  9379.             businessModel:

  9380.               type: string

  9381.             languages:

  9382.               type: array

  9383.               items:

  9384.                   type: string

  9385.             categories:

  9386.               type: array

  9387.               items:

  9388.                 type: integer

  9389.             avatars:

  9390.               type: array

  9391.               items:

  9392.                 $ref: '#/components/schemas/ActorImage'

  9393.             banners:

  9394.               type: array

  9395.               items:

  9396.                 $ref: '#/components/schemas/ActorImage'

  9397.     ServerConfigCustom:

  9398.       properties:

  9399.         instance:

  9400.           type: object

  9401.           properties:

  9402.             name:

  9403.               type: string

  9404.             shortDescription:

  9405.               type: string

  9406.             description:

  9407.               type: string

  9408.             terms:

  9409.               type: string

  9410.             defaultClientRoute:

  9411.               type: string

  9412.             isNSFW:

  9413.               type: boolean

  9414.             defaultNSFWPolicy:

  9415.               type: string

  9416.             customizations:

  9417.               type: object

  9418.               properties:

  9419.                 javascript:

  9420.                   type: string

  9421.                 css:

  9422.                   type: string

  9423.         theme:

  9424.           type: object

  9425.           properties:

  9426.             default:

  9427.               type: string

  9428.         services:

  9429.           type: object

  9430.           properties:

  9431.             twitter:

  9432.               type: object

  9433.               properties:

  9434.                 username:

  9435.                   type: string

  9436.         cache:

  9437.           type: object

  9438.           properties:

  9439.             previews:

  9440.               type: object

  9441.               properties:

  9442.                 size:

  9443.                   type: integer

  9444.             captions:

  9445.               type: object

  9446.               properties:

  9447.                 size:

  9448.                   type: integer

  9449.         signup:

  9450.           type: object

  9451.           properties:

  9452.             enabled:

  9453.               type: boolean

  9454.             limit:

  9455.               type: integer

  9456.             requiresEmailVerification:

  9457.               type: boolean

  9458.         admin:

  9459.           type: object

  9460.           properties:

  9461.             email:

  9462.               type: string

  9463.               format: email

  9464.         contactForm:

  9465.           type: object

  9466.           properties:

  9467.             enabled:

  9468.               type: boolean

  9469.         user:

  9470.           type: object

  9471.           description: Settings that apply to new users, if registration is enabled

  9472.           properties:

  9473.             videoQuota:

  9474.               type: integer

  9475.               example: 16810141515

  9476.             videoQuotaDaily:

  9477.               type: integer

  9478.               example: 1681014151

  9479.         transcoding:

  9480.           type: object

  9481.           description: Settings pertaining to transcoding jobs

  9482.           properties:

  9483.             enabled:

  9484.               type: boolean

  9485.             originalFile:

  9486.               type: object

  9487.               properties:

  9488.                 keep:

  9489.                   type: boolean

  9490.             allowAdditionalExtensions:

  9491.               type: boolean

  9492.               description: Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos

  9493.             allowAudioFiles:

  9494.               type: boolean

  9495.               description: If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file

  9496.             threads:

  9497.               type: integer

  9498.               description: Amount of threads used by ffmpeg for 1 transcoding job

  9499.             concurrency:

  9500.               type: number

  9501.               description: Amount of transcoding jobs to execute in parallel

  9502.             profile:

  9503.               type: string

  9504.               enum:

  9505.                 - default

  9506.               description: |

  9507.                 New profiles can be added by plugins ; available in core PeerTube: 'default'.

  9508.             resolutions:

  9509.               type: object

  9510.               description: Resolutions to transcode _new videos_ to

  9511.               properties:

  9512.                 0p:

  9513.                   type: boolean

  9514.                 144p:

  9515.                   type: boolean

  9516.                 240p:

  9517.                   type: boolean

  9518.                 360p:

  9519.                   type: boolean

  9520.                 480p:

  9521.                   type: boolean

  9522.                 720p:

  9523.                   type: boolean

  9524.                 1080p:

  9525.                   type: boolean

  9526.                 1440p:

  9527.                   type: boolean

  9528.                 2160p:

  9529.                   type: boolean

  9530.             web_videos:

  9531.               type: object

  9532.               description: Web Video specific settings

  9533.               properties:

  9534.                 enabled:

  9535.                   type: boolean

  9536.             hls:

  9537.               type: object

  9538.               description: HLS specific settings

  9539.               properties:

  9540.                 enabled:

  9541.                   type: boolean

  9542.         import:

  9543.           type: object

  9544.           properties:

  9545.             videos:

  9546.               type: object

  9547.               properties:

  9548.                 http:

  9549.                   type: object

  9550.                   properties:

  9551.                     enabled:

  9552.                       type: boolean

  9553.                 torrent:

  9554.                   type: object

  9555.                   properties:

  9556.                     enabled:

  9557.                       type: boolean

  9558.             video_channel_synchronization:

  9559.               type: object

  9560.               properties:

  9561.                 enabled:

  9562.                   type: boolean

  9563.         autoBlacklist:

  9564.           type: object

  9565.           properties:

  9566.             videos:

  9567.               type: object

  9568.               properties:

  9569.                 ofUsers:

  9570.                   type: object

  9571.                   properties:

  9572.                     enabled:

  9573.                       type: boolean

  9574.         followers:

  9575.           type: object

  9576.           properties:

  9577.             instance:

  9578.               type: object

  9579.               properties:

  9580.                 enabled:

  9581.                   type: boolean

  9582.                 manualApproval:

  9583.                   type: boolean

  9584. 

  9585.     CustomHomepage:

  9586.       properties:

  9587.         content:

  9588.           type: string

  9589. 

  9590.     Follow:

  9591.       properties:

  9592.         id:

  9593.           $ref: '#/components/schemas/id'

  9594.         follower:

  9595.           $ref: '#/components/schemas/Actor'

  9596.         following:

  9597.           $ref: '#/components/schemas/Actor'

  9598.         score:

  9599.           type: number

  9600.           description: score reflecting the reachability of the actor, with steps of `10` and a base score of `1000`.

  9601.         state:

  9602.           type: string

  9603.           enum:

  9604.             - pending

  9605.             - accepted

  9606.         createdAt:

  9607.           type: string

  9608.           format: date-time

  9609.         updatedAt:

  9610.           type: string

  9611.           format: date-time

  9612. 

  9613.     PredefinedAbuseReasons:

  9614.       description: Reason categories that help triage reports

  9615.       type: array

  9616.       maxItems: 8

  9617.       items:

  9618.         type: string

  9619.         enum:

  9620.         - violentOrAbusive

  9621.         - hatefulOrAbusive

  9622.         - spamOrMisleading

  9623.         - privacy

  9624.         - rights

  9625.         - serverRules

  9626.         - thumbnails

  9627.         - captions

  9628. 

  9629.     Job:

  9630.       properties:

  9631.         id:

  9632.           $ref: '#/components/schemas/id'

  9633.         state:

  9634.           type: string

  9635.           enum:

  9636.             - active

  9637.             - completed

  9638.             - failed

  9639.             - waiting

  9640.             - delayed

  9641.         type:

  9642.           type: string

  9643.           enum:

  9644.             - activitypub-http-unicast

  9645.             - activitypub-http-broadcast

  9646.             - activitypub-http-fetcher

  9647.             - activitypub-follow

  9648.             - video-file-import

  9649.             - video-transcoding

  9650.             - email

  9651.             - video-import

  9652.             - videos-views-stats

  9653.             - activitypub-refresher

  9654.             - video-redundancy

  9655.             - video-channel-import

  9656.         data:

  9657.           type: object

  9658.           additionalProperties: true

  9659.         error:

  9660.           type: object

  9661.           additionalProperties: true

  9662.         createdAt:

  9663.           type: string

  9664.           format: date-time

  9665.         finishedOn:

  9666.           type: string

  9667.           format: date-time

  9668.         processedOn:

  9669.           type: string

  9670.           format: date-time

  9671.     AddUserResponse:

  9672.       properties:

  9673.         user:

  9674.           type: object

  9675.           properties:

  9676.             id:

  9677.               $ref: '#/components/schemas/id'

  9678.             account:

  9679.               type: object

  9680.               properties:

  9681.                 id:

  9682.                   $ref: '#/components/schemas/id'

  9683.     VideoUploadRequestCommon:

  9684.       properties:

  9685.         name:

  9686.           description: Video name

  9687.           type: string

  9688.           example: What is PeerTube?

  9689.           minLength: 3

  9690.           maxLength: 120

  9691.         channelId:

  9692.           description: Channel id that will contain this video

  9693.           type: integer

  9694.           example: 3

  9695.           minimum: 1

  9696.         privacy:

  9697.           $ref: '#/components/schemas/VideoPrivacySet'

  9698.         category:

  9699.           $ref: '#/components/schemas/VideoCategorySet'

  9700.         licence:

  9701.           $ref: '#/components/schemas/VideoLicenceSet'

  9702.         language:

  9703.           $ref: '#/components/schemas/VideoLanguageSet'

  9704.         description:

  9705.           description: Video description

  9706.           type: string

  9707.           example: |

  9708.             **[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\r\n\r\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**

  9709.         waitTranscoding:

  9710.           description: Whether or not we wait transcoding before publish the video

  9711.           type: boolean

  9712.         generateTranscription:

  9713.           description: "**PeerTube >= 6.2** If enabled by the admin, automatically generate a subtitle of the video"

  9714.           type: boolean

  9715.         support:

  9716.           description: A text tell the audience how to support the video creator

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

  9718.           type: string

  9719.         nsfw:

  9720.           description: Whether or not this video contains sensitive content

  9721.           type: boolean

  9722.         tags:

  9723.           description: Video tags (maximum 5 tags each between 2 and 30 characters)

  9724.           type: array

  9725.           minItems: 1

  9726.           maxItems: 5

  9727.           uniqueItems: true

  9728.           example:

  9729.             - framasoft

  9730.             - peertube

  9731.           items:

  9732.             type: string

  9733.             minLength: 2

  9734.             maxLength: 30

  9735.         commentsEnabled:

  9736.           deprecated: true

  9737.           description: 'Deprecated in 6.2, use commentsPolicy instead'

  9738.           type: boolean

  9739.         commentsPolicy:

  9740.           $ref: '#/components/schemas/VideoCommentsPolicySet'

  9741.         downloadEnabled:

  9742.           description: Enable or disable downloading for this video

  9743.           type: boolean

  9744.         originallyPublishedAt:

  9745.           description: Date when the content was originally published

  9746.           type: string

  9747.           format: date-time

  9748.         scheduleUpdate:

  9749.           $ref: '#/components/schemas/VideoScheduledUpdate'

  9750.         thumbnailfile:

  9751.           description: Video thumbnail file

  9752.           type: string

  9753.           format: binary

  9754.         previewfile:

  9755.           description: Video preview file

  9756.           type: string

  9757.           format: binary

  9758.         videoPasswords:

  9759.           $ref: '#/components/schemas/AddVideoPasswords'

  9760.       required:

  9761.         - channelId

  9762.         - name

  9763.     VideoUploadRequestLegacy:

  9764.       allOf:

  9765.         - $ref: '#/components/schemas/VideoUploadRequestCommon'

  9766.         - type: object

  9767.           required:

  9768.             - videofile

  9769.           properties:

  9770.             videofile:

  9771.               description: Video file

  9772.               type: string

  9773.               format: binary

  9774.     VideoUploadRequestResumable:

  9775.       allOf:

  9776.         - $ref: '#/components/schemas/VideoUploadRequestCommon'

  9777.         - type: object

  9778.           required:

  9779.             - filename

  9780.           properties:

  9781.             filename:

  9782.               description: Video filename including extension

  9783.               type: string

  9784.               format: filename

  9785.               example: what_is_peertube.mp4

  9786.             thumbnailfile:

  9787.               description: Video thumbnail file

  9788.               type: string

  9789.               format: binary

  9790.             previewfile:

  9791.               description: Video preview file

  9792.               type: string

  9793.               format: binary

  9794.     VideoUploadResponse:

  9795.       properties:

  9796.         video:

  9797.           type: object

  9798.           properties:

  9799.             id:

  9800.               $ref: '#/components/schemas/Video/properties/id'

  9801.             uuid:

  9802.               $ref: '#/components/schemas/Video/properties/uuid'

  9803.             shortUUID:

  9804.               $ref: '#/components/schemas/Video/properties/shortUUID'

  9805.     VideoReplaceSourceRequestResumable:

  9806.       properties:

  9807.         filename:

  9808.           description: Video filename including extension

  9809.           type: string

  9810.           format: filename

  9811.           example: what_is_peertube.mp4

  9812.     UserImportResumable:

  9813.       properties:

  9814.         filename:

  9815.           description: Archive filename including extension

  9816.           type: string

  9817.           format: filename

  9818.           example: "user-export-6-2024-02-09T10_12_11.682Z"

  9819.     CommentThreadResponse:

  9820.       properties:

  9821.         total:

  9822.           type: integer

  9823.           example: 1

  9824.         data:

  9825.           type: array

  9826.           maxItems: 100

  9827.           items:

  9828.             $ref: '#/components/schemas/VideoComment'

  9829.     CommentThreadPostResponse:

  9830.       properties:

  9831.         comment:

  9832.           $ref: '#/components/schemas/VideoComment'

  9833.     VideoTokenResponse:

  9834.       properties:

  9835.         files:

  9836.           type: object

  9837.           properties:

  9838.             token:

  9839.               type: string

  9840.             expires:

  9841.               type: string

  9842.               format: date-time

  9843.     VideoListResponse:

  9844.       properties:

  9845.         total:

  9846.           type: integer

  9847.           example: 1

  9848.         data:

  9849.           type: array

  9850.           maxItems: 100

  9851.           items:

  9852.             $ref: '#/components/schemas/Video'

  9853.     User:

  9854.       properties:

  9855.         account:

  9856.           $ref: '#/components/schemas/Account'

  9857.         autoPlayNextVideo:

  9858.           type: boolean

  9859.           description: Automatically start playing the upcoming video after the currently playing video

  9860.         autoPlayNextVideoPlaylist:

  9861.           type: boolean

  9862.           description: Automatically start playing the video on the playlist after the currently playing video

  9863.         autoPlayVideo:

  9864.           type: boolean

  9865.           description: Automatically start playing the video on the watch page

  9866.         blocked:

  9867.           type: boolean

  9868.         blockedReason:

  9869.           type: string

  9870.         createdAt:

  9871.           type: string

  9872.         email:

  9873.           type: string

  9874.           format: email

  9875.           description: The user email

  9876.         emailVerified:

  9877.           type: boolean

  9878.           description: Has the user confirmed their email address?

  9879.         id:

  9880.           allOf:

  9881.             - $ref: '#/components/schemas/id'

  9882.           readOnly: true

  9883.         pluginAuth:

  9884.           type: string

  9885.           description: Auth plugin to use to authenticate the user

  9886.         lastLoginDate:

  9887.           type: string

  9888.           format: date-time

  9889.         noInstanceConfigWarningModal:

  9890.           type: boolean

  9891.         noAccountSetupWarningModal:

  9892.           type: boolean

  9893.         noWelcomeModal:

  9894.           type: boolean

  9895.         nsfwPolicy:

  9896.           $ref: '#/components/schemas/NSFWPolicy'

  9897.         role:

  9898.           type: object

  9899.           properties:

  9900.             id:

  9901.               $ref: '#/components/schemas/UserRole'

  9902.             label:

  9903.               type: string

  9904.               enum:

  9905.                 - User

  9906.                 - Moderator

  9907.                 - Administrator

  9908.         theme:

  9909.           type: string

  9910.           description: Theme enabled by this user

  9911.         username:

  9912.           $ref: '#/components/schemas/username'

  9913.         videoChannels:

  9914.           type: array

  9915.           items:

  9916.             $ref: '#/components/schemas/VideoChannel'

  9917.         videoQuota:

  9918.           type: integer

  9919.           description: The user video quota in bytes

  9920.           example: -1

  9921.         videoQuotaDaily:

  9922.           type: integer

  9923.           description: The user daily video quota in bytes

  9924.           example: -1

  9925.         p2pEnabled:

  9926.           type: boolean

  9927.           description: Enable P2P in the player

  9928.     UserWithStats:

  9929.       allOf:

  9930.         - $ref: '#/components/schemas/User'

  9931.         - properties:

  9932.             # optionally present fields: they require WITH_STATS scope

  9933.             videosCount:

  9934.               type: integer

  9935.               description: Count of videos published

  9936.             abusesCount:

  9937.               type: integer

  9938.               description: Count of reports/abuses of which the user is a target

  9939.             abusesAcceptedCount:

  9940.               type: integer

  9941.               description: Count of reports/abuses created by the user and accepted/acted upon by the moderation team

  9942.             abusesCreatedCount:

  9943.               type: integer

  9944.               description: Count of reports/abuses created by the user

  9945.             videoCommentsCount:

  9946.               type: integer

  9947.               description: Count of comments published

  9948.     AddUser:

  9949.       properties:

  9950.         username:

  9951.           $ref: '#/components/schemas/username'

  9952.         password:

  9953.           $ref: '#/components/schemas/password'

  9954.         email:

  9955.           type: string

  9956.           format: email

  9957.           description: The user email

  9958.         videoQuota:

  9959.           type: integer

  9960.           description: The user video quota in bytes

  9961.           example: -1

  9962.         videoQuotaDaily:

  9963.           type: integer

  9964.           description: The user daily video quota in bytes

  9965.           example: -1

  9966.         channelName:

  9967.           $ref: '#/components/schemas/usernameChannel'

  9968.         role:

  9969.           $ref: '#/components/schemas/UserRole'

  9970.         adminFlags:

  9971.           $ref: '#/components/schemas/UserAdminFlags'

  9972.       required:

  9973.         - username

  9974.         - password

  9975.         - email

  9976.         - role

  9977.     UpdateUser:

  9978.       properties:

  9979.         email:

  9980.           description: The updated email of the user

  9981.           allOf:

  9982.             - $ref: '#/components/schemas/User/properties/email'

  9983.         emailVerified:

  9984.           type: boolean

  9985.           description: Set the email as verified

  9986.         videoQuota:

  9987.           type: integer

  9988.           description: The updated video quota of the user in bytes

  9989.         videoQuotaDaily:

  9990.           type: integer

  9991.           description: The updated daily video quota of the user in bytes

  9992.         pluginAuth:

  9993.           type: string

  9994.           nullable: true

  9995.           description: The auth plugin to use to authenticate the user

  9996.           example: 'peertube-plugin-auth-saml2'

  9997.         role:

  9998.           $ref: '#/components/schemas/UserRole'

  9999.         adminFlags:

  10000.           $ref: '#/components/schemas/UserAdminFlags'

  10001.         password:

  10002.           $ref: '#/components/schemas/password'

  10003.     UpdateMe:

  10004.       properties:

  10005.         password:

  10006.           $ref: '#/components/schemas/password'

  10007.         currentPassword:

  10008.           $ref: '#/components/schemas/password'

  10009.         email:

  10010.           description: new email used for login and service communications

  10011.           allOf:

  10012.             - $ref: '#/components/schemas/User/properties/email'

  10013.         displayName:

  10014.           type: string

  10015.           description: new name of the user in its representations

  10016.           minLength: 3

  10017.           maxLength: 120

  10018.         displayNSFW:

  10019.           type: string

  10020.           description: new NSFW display policy

  10021.           enum:

  10022.             - 'true'

  10023.             - 'false'

  10024.             - both

  10025.         p2pEnabled:

  10026.           type: boolean

  10027.           description: whether to enable P2P in the player or not

  10028.         autoPlayVideo:

  10029.           type: boolean

  10030.           description: new preference regarding playing videos automatically

  10031.         autoPlayNextVideo:

  10032.           type: boolean

  10033.           description: new preference regarding playing following videos automatically

  10034.         autoPlayNextVideoPlaylist:

  10035.           type: boolean

  10036.           description: new preference regarding playing following playlist videos automatically

  10037.         videosHistoryEnabled:

  10038.           type: boolean

  10039.           description: whether to keep track of watched history or not

  10040.         videoLanguages:

  10041.           type: array

  10042.           items:

  10043.             type: string

  10044.           description: list of languages to filter videos down to

  10045.         theme:

  10046.           type: string

  10047.         noInstanceConfigWarningModal:

  10048.           type: boolean

  10049.         noAccountSetupWarningModal:

  10050.           type: boolean

  10051.         noWelcomeModal:

  10052.           type: boolean

  10053.     GetMeVideoRating:

  10054.       properties:

  10055.         id:

  10056.           $ref: '#/components/schemas/id'

  10057.         rating:

  10058.           type: string

  10059.           enum:

  10060.             - like

  10061.             - dislike

  10062.             - none

  10063.           description: Rating of the video

  10064.       required:

  10065.         - id

  10066.         - rating

  10067.     VideoRating:

  10068.       properties:

  10069.         video:

  10070.           $ref: '#/components/schemas/Video'

  10071.         rating:

  10072.           type: string

  10073.           enum:

  10074.             - like

  10075.             - dislike

  10076.             - none

  10077.           description: Rating of the video

  10078.       required:

  10079.         - video

  10080.         - rating

  10081. 

  10082.     RegisterUser:

  10083.       properties:

  10084.         username:

  10085.           description: immutable name of the user, used to find or mention its actor

  10086.           allOf:

  10087.             - $ref: '#/components/schemas/username'

  10088.         password:

  10089.           $ref: '#/components/schemas/password'

  10090.         email:

  10091.           type: string

  10092.           format: email

  10093.           description: email of the user, used for login or service communications

  10094.         displayName:

  10095.           type: string

  10096.           description: editable name of the user, displayed in its representations

  10097.           minLength: 1

  10098.           maxLength: 120

  10099.         channel:

  10100.           type: object

  10101.           description: channel base information used to create the first channel of the user

  10102.           properties:

  10103.             name:

  10104.               $ref: '#/components/schemas/usernameChannel'

  10105.             displayName:

  10106.               type: string

  10107.       required:

  10108.         - username

  10109.         - password

  10110.         - email

  10111. 

  10112.     UserRegistrationRequest:

  10113.       allOf:

  10114.         - $ref: '#/components/schemas/RegisterUser'

  10115.         - type: object

  10116.           properties:

  10117.             registrationReason:

  10118.               type: string

  10119.               description: reason for the user to register on the instance

  10120.           required:

  10121.             - registrationReason

  10122. 

  10123.     UserRegistrationAcceptOrReject:

  10124.       type: object

  10125.       properties:

  10126.         moderationResponse:

  10127.           type: string

  10128.           description: Moderation response to send to the user

  10129.         preventEmailDelivery:

  10130.           type: boolean

  10131.           description: Set it to true if you don't want PeerTube to send an email to the user

  10132.       required:

  10133.         - moderationResponse

  10134. 

  10135.     UserRegistration:

  10136.       properties:

  10137.         id:

  10138.           $ref: '#/components/schemas/id'

  10139.         state:

  10140.           type: object

  10141.           properties:

  10142.             id:

  10143.               type: integer

  10144.               enum:

  10145.                 - 1

  10146.                 - 2

  10147.                 - 3

  10148.               description: 'The registration state (Pending = `1`, Rejected = `2`, Accepted = `3`)'

  10149.             label:

  10150.               type: string

  10151.         registrationReason:

  10152.           type: string

  10153.         moderationResponse:

  10154.           type: string

  10155.           nullable: true

  10156.         username:

  10157.           type: string

  10158.         email:

  10159.           type: string

  10160.           format: email

  10161.         emailVerified:

  10162.           type: boolean

  10163.         accountDisplayName:

  10164.           type: string

  10165.         channelHandle:

  10166.           type: string

  10167.         channelDisplayName:

  10168.           type: string

  10169.         createdAt:

  10170.           type: string

  10171.           format: date-time

  10172.         updatedAt:

  10173.           type: string

  10174.           format: date-time

  10175.         user:

  10176.           type: object

  10177.           nullable: true

  10178.           description: If the registration has been accepted, this is a partial user object created by the registration

  10179.           properties:

  10180.             id:

  10181.               $ref: '#/components/schemas/id'

  10182. 

  10183.     OAuthClient:

  10184.       properties:

  10185.         client_id:

  10186.           type: string

  10187.           pattern: /^[a-z0-9]$/

  10188.           maxLength: 32

  10189.           minLength: 32

  10190.           example: v1ikx5hnfop4mdpnci8nsqh93c45rldf

  10191.         client_secret:

  10192.           type: string

  10193.           pattern: /^[a-zA-Z0-9]$/

  10194.           maxLength: 32

  10195.           minLength: 32

  10196.           example: AjWiOapPltI6EnsWQwlFarRtLh4u8tDt

  10197.     OAuthToken-password:

  10198.       allOf:

  10199.         - $ref: '#/components/schemas/OAuthClient'

  10200.         - type: object

  10201.           properties:

  10202.             grant_type:

  10203.               type: string

  10204.               enum:

  10205.                 - password

  10206.                 - refresh_token

  10207.               default: password

  10208.             username:

  10209.               $ref: '#/components/schemas/User/properties/username'

  10210.             password:

  10211.               $ref: '#/components/schemas/password'

  10212.       required:

  10213.         - client_id

  10214.         - client_secret

  10215.         - grant_type

  10216.         - username

  10217.         - password

  10218.     OAuthToken-refresh_token:

  10219.       allOf:

  10220.         - $ref: '#/components/schemas/OAuthClient'

  10221.         - type: object

  10222.           properties:

  10223.             grant_type:

  10224.               type: string

  10225.               enum:

  10226.                 - password

  10227.                 - refresh_token

  10228.               default: password

  10229.             refresh_token:

  10230.               type: string

  10231.               example: 2e0d675df9fc96d2e4ec8a3ebbbf45eca9137bb7

  10232.       required:

  10233.         - client_id

  10234.         - client_secret

  10235.         - grant_type

  10236.         - refresh_token

  10237. 

  10238.     VideoChannel:

  10239.       allOf:

  10240.         - $ref: '#/components/schemas/Actor'

  10241.         - type: object

  10242.           properties:

  10243.             displayName:

  10244.               type: string

  10245.               description: editable name of the channel, displayed in its representations

  10246.               example: Videos of Framasoft

  10247.               minLength: 1

  10248.               maxLength: 120

  10249.             description:

  10250.               type: string

  10251.               nullable: true

  10252.               example: Videos made with <3 by Framasoft

  10253.               minLength: 3

  10254.               maxLength: 1000

  10255.             support:

  10256.               type: string

  10257.               nullable: true

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

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

  10260.               minLength: 3

  10261.               maxLength: 1000

  10262.             isLocal:

  10263.               readOnly: true

  10264.               type: boolean

  10265.             updatedAt:

  10266.               readOnly: true

  10267.               type: string

  10268.               format: date-time

  10269.             banners:

  10270.               type: array

  10271.               items:

  10272.                 $ref: '#/components/schemas/ActorImage'

  10273.             ownerAccount:

  10274.               $ref: '#/components/schemas/Account'

  10275. 

  10276.     VideoChannelEdit:

  10277.       properties:

  10278.         displayName:

  10279.           description: Channel display name

  10280.         description:

  10281.           description: Channel description

  10282.         support:

  10283.           description: How to support/fund the channel

  10284. 

  10285.     VideoChannelCreate:

  10286.       allOf:

  10287.         - $ref: '#/components/schemas/VideoChannelEdit'

  10288.         - properties:

  10289.             name:

  10290.               description: username of the channel to create

  10291.               allOf:

  10292.                 - $ref: '#/components/schemas/usernameChannel'

  10293.       required:

  10294.         - name

  10295.         - displayName

  10296.     VideoChannelUpdate:

  10297.       allOf:

  10298.         - $ref: '#/components/schemas/VideoChannelEdit'

  10299.         - properties:

  10300.             bulkVideosSupportUpdate:

  10301.               type: boolean

  10302.               description: Update the support field for all videos of this channel

  10303. 

  10304.     VideoChannelList:

  10305.       properties:

  10306.         total:

  10307.           type: integer

  10308.           example: 1

  10309.         data:

  10310.           type: array

  10311.           items:

  10312.             allOf:

  10313.               - $ref: '#/components/schemas/VideoChannel'

  10314.               - $ref: '#/components/schemas/Actor'

  10315. 

  10316.     ImportVideosInChannelCreate:

  10317.       type: object

  10318.       properties:

  10319.         externalChannelUrl:

  10320.           type: string

  10321.           example: https://youtube.com/c/UC_myfancychannel

  10322.         videoChannelSyncId:

  10323.           type: integer

  10324.           description: If part of a channel sync process, specify its id to assign video imports to this channel synchronization

  10325.       required:

  10326.         - 'externalChannelUrl'

  10327. 

  10328.     VideoChannelSync:

  10329.       type: object

  10330.       properties:

  10331.         id:

  10332.           $ref: '#/components/schemas/id'

  10333.         state:

  10334.           type: object

  10335.           properties:

  10336.             id:

  10337.               type: integer

  10338.               example: 2

  10339.             label:

  10340.               type: string

  10341.               example: PROCESSING

  10342.         externalChannelUrl:

  10343.           type: string

  10344.           example: 'https://youtube.com/c/UC_myfancychannel'

  10345.         createdAt:

  10346.           type: string

  10347.           format: date-time

  10348.         lastSyncAt:

  10349.           type: string

  10350.           format: date-time

  10351.           nullable: true

  10352.         channel:

  10353.           $ref: '#/components/schemas/VideoChannel'

  10354.     VideoChannelSyncList:

  10355.       type: object

  10356.       properties:

  10357.         total:

  10358.           type: integer

  10359.           example: 1

  10360.         data:

  10361.           type: array

  10362.           items:

  10363.             allOf:

  10364.               - $ref: '#/components/schemas/VideoChannelSync'

  10365.     VideoChannelSyncCreate:

  10366.       type: object

  10367.       properties:

  10368.         externalChannelUrl:

  10369.           type: string

  10370.           example: https://youtube.com/c/UC_myfancychannel

  10371.         videoChannelId:

  10372.           $ref: '#/components/schemas/id'

  10373.     MRSSPeerLink:

  10374.       type: object

  10375.       xml:

  10376.         name: 'media:peerLink'

  10377.       properties:

  10378.         href:

  10379.           type: string

  10380.           xml:

  10381.             attribute: true

  10382.         type:

  10383.           type: string

  10384.           enum:

  10385.             - application/x-bittorrent

  10386.           xml:

  10387.             attribute: true

  10388.     MRSSGroupContent:

  10389.       type: object

  10390.       xml:

  10391.         name: 'media:content'

  10392.       properties:

  10393.         url:

  10394.           type: string

  10395.           format: url

  10396.           xml:

  10397.             attribute: true

  10398.         fileSize:

  10399.           type: integer

  10400.           xml:

  10401.             attribute: true

  10402.         type:

  10403.           type: string

  10404.           xml:

  10405.             attribute: true

  10406.         framerate:

  10407.           type: integer

  10408.           xml:

  10409.             attribute: true

  10410.         duration:

  10411.           type: integer

  10412.           xml:

  10413.             attribute: true

  10414.         height:

  10415.           type: integer

  10416.           xml:

  10417.             attribute: true

  10418.         lang:

  10419.           type: string

  10420.           xml:

  10421.             attribute: true

  10422.     VideoCommentsForXML:

  10423.       type: array

  10424.       xml:

  10425.         wrapped: true

  10426.         name: 'channel'

  10427.       items:

  10428.         type: object

  10429.         xml:

  10430.           name: 'item'

  10431.         properties:

  10432.           link:

  10433.             type: string

  10434.             format: url

  10435.           guid:

  10436.             type: string

  10437.           pubDate:

  10438.             type: string

  10439.             format: date-time

  10440.           'content:encoded':

  10441.             type: string

  10442.           'dc:creator':

  10443.             type: string

  10444.     VideosForXML:

  10445.       type: array

  10446.       xml:

  10447.         wrapped: true

  10448.         name: 'channel'

  10449.       items:

  10450.         type: object

  10451.         xml:

  10452.           name: 'item'

  10453.         properties:

  10454.           link:

  10455.             type: string

  10456.             format: url

  10457.             description: video watch page URL

  10458.           guid:

  10459.             type: string

  10460.             description: video canonical URL

  10461.           pubDate:

  10462.             type: string

  10463.             format: date-time

  10464.             description: video publication date

  10465.           description:

  10466.             type: string

  10467.             description: video description

  10468.           'content:encoded':

  10469.             type: string

  10470.             description: video description

  10471.           'dc:creator':

  10472.             type: string

  10473.             description: publisher user name

  10474.           'media:category':

  10475.             type: integer

  10476.             description: video category (MRSS)

  10477.           'media:community':

  10478.             type: object

  10479.             description: see [media:community](https://www.rssboard.org/media-rss#media-community) (MRSS)

  10480.             properties:

  10481.               'media:statistics':

  10482.                 type: object

  10483.                 properties:

  10484.                   views:

  10485.                     type: integer

  10486.                     xml:

  10487.                       attribute: true

  10488.           'media:embed':

  10489.             type: object

  10490.             properties:

  10491.               url:

  10492.                 type: string

  10493.                 format: url

  10494.                 description: video embed path, relative to the canonical URL domain (MRSS)

  10495.                 xml:

  10496.                   attribute: true

  10497.           'media:player':

  10498.             type: object

  10499.             properties:

  10500.               url:

  10501.                 type: string

  10502.                 format: url

  10503.                 description: video watch path, relative to the canonical URL domain (MRSS)

  10504.                 xml:

  10505.                   attribute: true

  10506.           'media:thumbnail':

  10507.             type: object

  10508.             properties:

  10509.               url:

  10510.                 type: string

  10511.                 format: url

  10512.                 xml:

  10513.                   attribute: true

  10514.               height:

  10515.                 type: integer

  10516.                 xml:

  10517.                   attribute: true

  10518.               width:

  10519.                 type: integer

  10520.                 xml:

  10521.                   attribute: true

  10522.           'media:title':

  10523.             type: string

  10524.             description: see [media:title](https://www.rssboard.org/media-rss#media-title) (MRSS). We only use `plain` titles.

  10525.           'media:description':

  10526.             type: string

  10527.           'media:rating':

  10528.             type: string

  10529.             enum:

  10530.               - nonadult

  10531.               - adult

  10532.             description: see [media:rating](https://www.rssboard.org/media-rss#media-rating) (MRSS)

  10533.           'enclosure':

  10534.             type: object

  10535.             description: main streamable file for the video

  10536.             properties:

  10537.               url:

  10538.                 type: string

  10539.                 format: url

  10540.                 xml:

  10541.                   attribute: true

  10542.               type:

  10543.                 type: string

  10544.                 enum:

  10545.                   - application/x-bittorrent

  10546.                 xml:

  10547.                   attribute: true

  10548.               length:

  10549.                 type: integer

  10550.                 xml:

  10551.                   attribute: true

  10552.           'media:group':

  10553.             type: array

  10554.             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)

  10555.             items:

  10556.               anyOf:

  10557.                 - $ref: '#/components/schemas/MRSSPeerLink'

  10558.                 - $ref: '#/components/schemas/MRSSGroupContent'

  10559.     NotificationSettingValue:

  10560.       type: integer

  10561.       description: >

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

  10563. 

  10564.         - `0` NONE

  10565. 

  10566.         - `1` WEB

  10567. 

  10568.         - `2` EMAIL

  10569.     Notification:

  10570.       properties:

  10571.         id:

  10572.           $ref: '#/components/schemas/id'

  10573.         type:

  10574.           type: integer

  10575.           description: >

  10576.             Notification type, following the `UserNotificationType` enum:

  10577. 

  10578.             - `1` NEW_VIDEO_FROM_SUBSCRIPTION

  10579. 

  10580.             - `2` NEW_COMMENT_ON_MY_VIDEO

  10581. 

  10582.             - `3` NEW_ABUSE_FOR_MODERATORS

  10583. 

  10584.             - `4` BLACKLIST_ON_MY_VIDEO

  10585. 

  10586.             - `5` UNBLACKLIST_ON_MY_VIDEO

  10587. 

  10588.             - `6` MY_VIDEO_PUBLISHED

  10589. 

  10590.             - `7` MY_VIDEO_IMPORT_SUCCESS

  10591. 

  10592.             - `8` MY_VIDEO_IMPORT_ERROR

  10593. 

  10594.             - `9` NEW_USER_REGISTRATION

  10595. 

  10596.             - `10` NEW_FOLLOW

  10597. 

  10598.             - `11` COMMENT_MENTION

  10599. 

  10600.             - `12` VIDEO_AUTO_BLACKLIST_FOR_MODERATORS

  10601. 

  10602.             - `13` NEW_INSTANCE_FOLLOWER

  10603. 

  10604.             - `14` AUTO_INSTANCE_FOLLOWING

  10605. 

  10606.             - `15` ABUSE_STATE_CHANGE

  10607. 

  10608.             - `16` ABUSE_NEW_MESSAGE

  10609. 

  10610.             - `17` NEW_PLUGIN_VERSION

  10611. 

  10612.             - `18` NEW_PEERTUBE_VERSION

  10613. 

  10614.             - `19` MY_VIDEO_STUDIO_EDITION_FINISHED

  10615. 

  10616.             - `20` NEW_USER_REGISTRATION_REQUEST

  10617. 

  10618.             - `21` NEW_LIVE_FROM_SUBSCRIPTION

  10619.         read:

  10620.           type: boolean

  10621.         video:

  10622.           nullable: true

  10623.           allOf:

  10624.             - $ref: '#/components/schemas/VideoInfo'

  10625.             - type: object

  10626.               properties:

  10627.                 channel:

  10628.                   $ref: '#/components/schemas/ActorInfo'

  10629.         videoImport:

  10630.           nullable: true

  10631.           type: object

  10632.           properties:

  10633.             id:

  10634.               $ref: '#/components/schemas/id'

  10635.             video:

  10636.               nullable: true

  10637.               $ref: '#/components/schemas/VideoInfo'

  10638.             torrentName:

  10639.               type: string

  10640.               nullable: true

  10641.             magnetUri:

  10642.               $ref: '#/components/schemas/VideoImport/properties/magnetUri'

  10643.             targetUri:

  10644.               type: string

  10645.               format: uri

  10646.               nullable: true

  10647.         comment:

  10648.           nullable: true

  10649.           type: object

  10650.           properties:

  10651.             id:

  10652.               $ref: '#/components/schemas/id'

  10653.             threadId:

  10654.               type: integer

  10655.             video:

  10656.               $ref: '#/components/schemas/VideoInfo'

  10657.             account:

  10658.               $ref: '#/components/schemas/ActorInfo'

  10659.             heldForReview:

  10660.               type: boolean

  10661.         videoAbuse:

  10662.           nullable: true

  10663.           type: object

  10664.           properties:

  10665.             id:

  10666.               $ref: '#/components/schemas/id'

  10667.             video:

  10668.               allOf:

  10669.                 - $ref: '#/components/schemas/VideoInfo'

  10670.         videoBlacklist:

  10671.           nullable: true

  10672.           type: object

  10673.           properties:

  10674.             id:

  10675.               $ref: '#/components/schemas/id'

  10676.             video:

  10677.               allOf:

  10678.                 - $ref: '#/components/schemas/VideoInfo'

  10679.         account:

  10680.           nullable: true

  10681.           allOf:

  10682.             - $ref: '#/components/schemas/ActorInfo'

  10683.         actorFollow:

  10684.           type: object

  10685.           nullable: true

  10686.           properties:

  10687.             id:

  10688.               $ref: '#/components/schemas/id'

  10689.             follower:

  10690.               $ref: '#/components/schemas/ActorInfo'

  10691.             state:

  10692.               type: string

  10693.               enum:

  10694.                 - pending

  10695.                 - accepted

  10696.             following:

  10697.               type: object

  10698.               properties:

  10699.                 type:

  10700.                   type: string

  10701.                   enum:

  10702.                     - account

  10703.                     - channel

  10704.                     - instance

  10705.                 name:

  10706.                   type: string

  10707.                 displayName:

  10708.                   type: string

  10709.                 host:

  10710.                   type: string

  10711.                   format: hostname

  10712.         createdAt:

  10713.           type: string

  10714.           format: date-time

  10715.         updatedAt:

  10716.           type: string

  10717.           format: date-time

  10718.     NotificationListResponse:

  10719.       properties:

  10720.         total:

  10721.           type: integer

  10722.           example: 1

  10723.         data:

  10724.           type: array

  10725.           maxItems: 100

  10726.           items:

  10727.             $ref: '#/components/schemas/Notification'

  10728.     Plugin:

  10729.       properties:

  10730.         name:

  10731.           type: string

  10732.           example: peertube-plugin-auth-ldap

  10733.         type:

  10734.           type: integer

  10735.           description: >

  10736.             - `1`: PLUGIN

  10737. 

  10738.             - `2`: THEME

  10739.           enum:

  10740.             - 1

  10741.             - 2

  10742.         latestVersion:

  10743.           type: string

  10744.           example: 0.0.3

  10745.         version:

  10746.           type: string

  10747.           example: 0.0.1

  10748.         enabled:

  10749.           type: boolean

  10750.         uninstalled:

  10751.           type: boolean

  10752.         peertubeEngine:

  10753.           type: string

  10754.           example: 2.2.0

  10755.         description:

  10756.           type: string

  10757.         homepage:

  10758.           type: string

  10759.           format: url

  10760.           example: https://framagit.org/framasoft/peertube/official-plugins/tree/master/peertube-plugin-auth-ldap

  10761.         settings:

  10762.           type: object

  10763.           additionalProperties: true

  10764.         createdAt:

  10765.           type: string

  10766.           format: date-time

  10767.         updatedAt:

  10768.           type: string

  10769.           format: date-time

  10770.     PluginResponse:

  10771.       properties:

  10772.         total:

  10773.           type: integer

  10774.           example: 1

  10775.         data:

  10776.           type: array

  10777.           maxItems: 100

  10778.           items:

  10779.             $ref: '#/components/schemas/Plugin'

  10780. 

  10781.     LiveVideoUpdate:

  10782.       properties:

  10783.         saveReplay:

  10784.           type: boolean

  10785.         replaySettings:

  10786.           $ref: '#/components/schemas/LiveVideoReplaySettings'

  10787.         permanentLive:

  10788.           description: User can stream multiple times in a permanent live

  10789.           type: boolean

  10790.         latencyMode:

  10791.           description: User can select live latency mode if enabled by the instance

  10792.           $ref: '#/components/schemas/LiveVideoLatencyMode'

  10793. 

  10794.     LiveVideoResponse:

  10795.       properties:

  10796.         rtmpUrl:

  10797.           type: string

  10798.           description: Included in the response if an appropriate token is provided

  10799.         rtmpsUrl:

  10800.           type: string

  10801.           description: Included in the response if an appropriate token is provided

  10802.         streamKey:

  10803.           type: string

  10804.           description: RTMP stream key to use to stream into this live video. Included in the response if an appropriate token is provided

  10805.         saveReplay:

  10806.           type: boolean

  10807.         replaySettings:

  10808.           $ref: '#/components/schemas/LiveVideoReplaySettings'

  10809.         permanentLive:

  10810.           description: User can stream multiple times in a permanent live

  10811.           type: boolean

  10812.         latencyMode:

  10813.           description: User can select live latency mode if enabled by the instance

  10814.           $ref: '#/components/schemas/LiveVideoLatencyMode'

  10815. 

  10816.     RequestTwoFactorResponse:

  10817.       properties:

  10818.         otpRequest:

  10819.           type: object

  10820.           properties:

  10821.             requestToken:

  10822.               type: string

  10823.               description: The token to send to confirm this request

  10824.             secret:

  10825.               type: string

  10826.               description: The OTP secret

  10827.             uri:

  10828.               type: string

  10829.               description: The OTP URI

  10830. 

  10831.     VideoStudioCreateTask:

  10832.       type: array

  10833.       items:

  10834.         anyOf:

  10835.           -

  10836.             title: cut

  10837.             type: object

  10838.             properties:

  10839.               name:

  10840.                 type: string

  10841.                 enum:

  10842.                   - 'cut'

  10843.               options:

  10844.                 type: object

  10845.                 properties:

  10846.                   start:

  10847.                     type: integer

  10848.                   end:

  10849.                     type: integer

  10850.           -

  10851.             title: add-intro

  10852.             type: object

  10853.             properties:

  10854.               name:

  10855.                 type: string

  10856.                 enum:

  10857.                   - 'add-intro'

  10858.               options:

  10859.                 type: object

  10860.                 properties:

  10861.                   file:

  10862.                     type: string

  10863.                     format: binary

  10864.           -

  10865.             title: add-outro

  10866.             type: object

  10867.             properties:

  10868.               name:

  10869.                 type: string

  10870.                 enum:

  10871.                   - 'add-outro'

  10872.               options:

  10873.                 type: object

  10874.                 properties:

  10875.                   file:

  10876.                     type: string

  10877.                     format: binary

  10878.           -

  10879.             title: add-watermark

  10880.             type: object

  10881.             properties:

  10882.               name:

  10883.                 type: string

  10884.                 enum:

  10885.                   - 'add-watermark'

  10886.               options:

  10887.                 type: object

  10888.                 properties:

  10889.                   file:

  10890.                     type: string

  10891.                     format: binary

  10892. 

  10893.     LiveVideoSessionResponse:

  10894.       properties:

  10895.         id:

  10896.           type: integer

  10897.         startDate:

  10898.           type: string

  10899.           format: date-time

  10900.           description: Start date of the live session

  10901.         endDate:

  10902.           type: string

  10903.           format: date-time

  10904.           nullable: true

  10905.           description: End date of the live session

  10906.         error:

  10907.           type: integer

  10908.           enum:

  10909.             - 1

  10910.             - 2

  10911.             - 3

  10912.             - 4

  10913.             - 5

  10914.           nullable: true

  10915.           description: >

  10916.             Error type if an error occurred during the live session:

  10917.               - `1`: Bad socket health (transcoding is too slow)

  10918.               - `2`: Max duration exceeded

  10919.               - `3`: Quota exceeded

  10920.               - `4`: Quota FFmpeg error

  10921.               - `5`: Video has been blacklisted during the live

  10922.         replayVideo:

  10923.           type: object

  10924.           description: Video replay information

  10925.           properties:

  10926.             id:

  10927.               type: number

  10928.             uuid:

  10929.               $ref: '#/components/schemas/UUIDv4'

  10930.             shortUUID:

  10931.               $ref: '#/components/schemas/shortUUID'

  10932. 

  10933.     PlaybackMetricCreate:

  10934.       properties:

  10935.         playerMode:

  10936.           type: string

  10937.           enum:

  10938.             - 'p2p-media-loader'

  10939.             - 'web-video'

  10940.         resolution:

  10941.           type: number

  10942.           description: Current player video resolution

  10943.         fps:

  10944.           type: number

  10945.           description: Current player video fps

  10946.         p2pEnabled:

  10947.           type: boolean

  10948.         p2pPeers:

  10949.           type: number

  10950.           description: P2P peers connected (doesn't include WebSeed peers)

  10951.         resolutionChanges:

  10952.           type: number

  10953.           description: How many resolution changes occurred since the last metric creation

  10954.         errors:

  10955.           type: number

  10956.           description: How many errors occurred since the last metric creation

  10957.         downloadedBytesP2P:

  10958.           type: number

  10959.           description: How many bytes were downloaded with P2P since the last metric creation

  10960.         downloadedBytesHTTP:

  10961.           type: number

  10962.           description: How many bytes were downloaded with HTTP since the last metric creation

  10963.         uploadedBytesP2P:

  10964.           type: number

  10965.           description: How many bytes were uploaded with P2P since the last metric creation

  10966.         videoId:

  10967.           oneOf:

  10968.             - $ref: '#/components/schemas/id'

  10969.             - $ref: '#/components/schemas/UUIDv4'

  10970.             - $ref: '#/components/schemas/shortUUID'

  10971.       required:

  10972.         - playerMode

  10973.         - resolutionChanges

  10974.         - errors

  10975.         - downloadedBytesP2P

  10976.         - downloadedBytesHTTP

  10977.         - uploadedBytesP2P

  10978.         - p2pEnabled

  10979.         - videoId

  10980. 

  10981.     RunnerRegistrationToken:

  10982.       properties:

  10983.         id:

  10984.           type: integer

  10985.         registrationToken:

  10986.           type: string

  10987.         createdAt:

  10988.           type: string

  10989.           format: date-time

  10990.         updatedAt:

  10991.           type: string

  10992.           format: date-time

  10993.         registeredRunnersCount:

  10994.           type: integer

  10995. 

  10996.     Runner:

  10997.       properties:

  10998.         id:

  10999.           type: integer

  11000.         name:

  11001.           type: string

  11002.         description:

  11003.           type: string

  11004.         ip:

  11005.           type: string

  11006.         updatedAt:

  11007.           type: string

  11008.           format: date-time

  11009.         createdAt:

  11010.           type: string

  11011.           format: date-time

  11012.         lastContact:

  11013.           type: string

  11014.           format: date-time

  11015. 

  11016.     RunnerJobType:

  11017.       type: string

  11018.       enum:

  11019.         - vod-web-video-transcoding

  11020.         - vod-hls-transcoding

  11021.         - vod-audio-merge-transcoding

  11022.         - live-rtmp-hls-transcoding

  11023. 

  11024.     RunnerJobState:

  11025.       type: integer

  11026.       enum:

  11027.         - 1

  11028.         - 2

  11029.         - 3

  11030.         - 4

  11031.         - 5

  11032.         - 6

  11033.         - 7

  11034.         - 8

  11035.       description: >

  11036.         The runner job state:

  11037.           - `1` Pending

  11038.           - `2` Processing

  11039.           - `3` Completed

  11040.           - `4` Errored

  11041.           - `5` Waiting for a parent job

  11042.           - `6` Cancelled

  11043.           - `7` Parent had an error

  11044.           - `8` Parent has been cancelled

  11045. 

  11046.     RunnerJobStateConstant:

  11047.       type: object

  11048.       properties:

  11049.         id:

  11050.           $ref: '#/components/schemas/RunnerJobState'

  11051.         label:

  11052.           type: string

  11053.           example: 'Processing'

  11054. 

  11055.     RunnerJobPayload:

  11056.       anyOf:

  11057.         - type: object

  11058.           title: VOD web video transcoding

  11059.           properties:

  11060.             input:

  11061.               type: object

  11062.               properties:

  11063.                 videoFileUrl:

  11064.                   type: string

  11065.             output:

  11066.               type: object

  11067.               properties:

  11068.                 resolution:

  11069.                   type: number

  11070.                 fps:

  11071.                   type: number

  11072.         - type: object

  11073.           title: VOD HLS transcoding

  11074.           properties:

  11075.             input:

  11076.               type: object

  11077.               properties:

  11078.                 videoFileUrl:

  11079.                   type: string

  11080.             output:

  11081.               type: object

  11082.               properties:

  11083.                 resolution:

  11084.                   type: number

  11085.                 fps:

  11086.                   type: number

  11087.         - type: object

  11088.           title: VOD audio merge transcoding

  11089.           properties:

  11090.             input:

  11091.               type: object

  11092.               properties:

  11093.                 audioFileUrl:

  11094.                   type: string

  11095.                 previewFileUrl:

  11096.                   type: string

  11097.             output:

  11098.               type: object

  11099.               properties:

  11100.                 resolution:

  11101.                   type: number

  11102.                 fps:

  11103.                   type: number

  11104. 

  11105.     RunnerJob:

  11106.       properties:

  11107.         uuid:

  11108.           $ref: '#/components/schemas/UUIDv4'

  11109.         type:

  11110.           $ref: '#/components/schemas/RunnerJobType'

  11111.         state:

  11112.           $ref: '#/components/schemas/RunnerJobStateConstant'

  11113.         payload:

  11114.           $ref: '#/components/schemas/RunnerJobPayload'

  11115.         failures:

  11116.           type: integer

  11117.           description: Number of times a remote runner failed to process this job. After too many failures, the job in "error" state

  11118.         error:

  11119.           nullable: true

  11120.           type: string

  11121.           description: Error message if the job is errored

  11122.         progress:

  11123.           type: integer

  11124.           description: Percentage progress

  11125.         priority:

  11126.           type: integer

  11127.           description: Job priority (less has more priority)

  11128.         updatedAt:

  11129.           type: string

  11130.           format: date-time

  11131.         createdAt:

  11132.           type: string

  11133.           format: date-time

  11134.         startedAt:

  11135.           type: string

  11136.           format: date-time

  11137.         finishedAt:

  11138.           type: string

  11139.           format: date-time

  11140.         parent:

  11141.           nullable: true

  11142.           description: If job has a parent job

  11143.           type: object

  11144.           properties:

  11145.             type:

  11146.               $ref: '#/components/schemas/RunnerJobType'

  11147.             state:

  11148.               $ref: '#/components/schemas/RunnerJobStateConstant'

  11149.             uuid:

  11150.               $ref: '#/components/schemas/UUIDv4'

  11151.         runner:

  11152.           nullable: true

  11153.           description: If job is associated to a runner

  11154.           properties:

  11155.             id:

  11156.               type: number

  11157.             name:

  11158.               type: string

  11159.             description:

  11160.               type: string

  11161. 

  11162.     RunnerJobAdmin:

  11163.       allOf:

  11164.         - $ref: '#/components/schemas/RunnerJob'

  11165.         - type: object

  11166.           properties:

  11167.             privatePayload:

  11168.               type: object

  11169. 

  11170.     WatchedWordsLists:

  11171.       properties:

  11172.         id:

  11173.           $ref: '#/components/schemas/id'

  11174.         listName:

  11175.           type: string

  11176.         words:

  11177.           type: array

  11178.           items:

  11179.             type: string

  11180.         updatedAt:

  11181.           type: string

  11182.           format: date-time

  11183.           example: 2021-05-04T08:01:01.502Z

  11184.         createdAt:

  11185.           type: string

  11186.           format: date-time

  11187.           example: 2021-05-04T08:01:01.502Z

  11188. 

  11189.     VideoPassword:

  11190.       properties:

  11191.         id:

  11192.           $ref: '#/components/schemas/id'

  11193.         password:

  11194.           type: string

  11195.           minLength: 2

  11196.         videoId:

  11197.           $ref: '#/components/schemas/id'

  11198.     VideoPasswordList:

  11199.       properties:

  11200.         total:

  11201.           type: integer

  11202.           example: 1

  11203.         data:

  11204.           type: array

  11205.           items:

  11206.               $ref: '#/components/schemas/VideoPassword'

  11207.     AddVideoPasswords:

  11208.       type: array

  11209.       items:

  11210.         $ref: "#/components/schemas/VideoPassword/properties/password"

  11211.       uniqueItems: true

  11212.   callbacks:

  11213.     searchIndex:

  11214.       'https://search.example.org/api/v1/search/videos':

  11215.         post:

  11216.           summary: third-party search index MAY be used instead of the local index, if enabled by the instance admin. see `searchTarget`

  11217.           responses:

  11218.             '200':

  11219.               description: successful operation

  11220.               content:

  11221.                 application/json:

  11222.                   schema:

  11223.                     $ref: '#/components/schemas/VideoListResponse'