{ "uuid": "27d49474-5170-4d6c-9b23-a8efa89607da", "lastMigration": 29, "name": "PeerTube", "endpointPrefix": "api/v1", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "3280e5df-a7fd-4abe-a2cb-efee38ad2099", "documentation": "List abuses", "method": "get", "endpoint": "abuses", "responses": [ { "uuid": "4416c4c2-5955-4455-85db-64df28bbfde7", "body": "{\n \"data\": [\n {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"id\": 42,\n \"moderationComment\": \"Decided to ban the server since it spams us regularly\",\n \"predefinedReasons\": [\n \"spamOrMisleading\"\n ],\n \"reason\": \"The video is a spam\",\n \"reporterAccount\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"followersCount\": {{faker 'number.int' max=99999}},\n \"followingCount\": {{faker 'number.int' max=99999}},\n \"host\": \"\",\n \"hostRedundancyAllowed\": {{faker 'datatype.boolean'}},\n \"id\": 42,\n \"name\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\",\n \"url\": \"\"\n },\n \"state\": {\n \"id\": \"{{oneOf (array '1' '2' '3')}}\",\n \"label\": \"\"\n },\n \"video\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"name\": \"What is PeerTube?\",\n \"uuid\": \"{{faker 'string.uuid'}}\"\n }\n }\n ],\n \"total\": 1\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9ababbde-8152-4604-94bb-ffb7c777b4f6", "documentation": "Report an abuse", "method": "post", "endpoint": "abuses", "responses": [ { "uuid": "e20141b7-a417-4d46-beb0-21bc9e9d91bf", "body": "{\n \"abuse\": {\n \"id\": 42\n }\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "26747581-6e24-4515-ac2e-2516cdf4d2e7", "body": "", "latency": 0, "statusCode": 400, "label": "incorrect request parameters", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c1001d88-a2f9-4dad-a5f0-70b8c8b736c5", "documentation": "Delete an abuse", "method": "delete", "endpoint": "abuses/:abuseId", "responses": [ { "uuid": "6066eb5b-7003-4f56-97e3-890928775b79", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5684a173-d17b-44e3-b02e-da3534be9fa9", "body": "", "latency": 0, "statusCode": 404, "label": "block not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "921eaca3-219e-4f43-b4c0-8b83ea1730e0", "documentation": "Update an abuse", "method": "put", "endpoint": "abuses/:abuseId", "responses": [ { "uuid": "a3cfd9b8-5ebb-4a26-8039-5acfb2524bea", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "87a9155d-a73a-4f09-88ea-521e71bab779", "body": "", "latency": 0, "statusCode": 404, "label": "abuse not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ab436040-3b0a-4430-b8b4-6b8265e17bd2", "documentation": "List messages of an abuse", "method": "get", "endpoint": "abuses/:abuseId/messages", "responses": [ { "uuid": "1455c150-dd3b-4bf4-88e0-08c15243e0b0", "body": "{\n \"data\": [\n {\n \"account\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"displayName\": \"\",\n \"host\": \"\",\n \"id\": {{faker 'number.int' max=99999}},\n \"name\": \"\",\n \"url\": \"\"\n },\n \"byModerator\": {{faker 'datatype.boolean'}},\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"id\": 42,\n \"message\": \"\"\n }\n ],\n \"total\": 1\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "459540b9-c605-4d00-a5df-1b40a951da64", "documentation": "Add message to an abuse", "method": "post", "endpoint": "abuses/:abuseId/messages", "responses": [ { "uuid": "231a0a32-52ba-4a74-9907-701c0149081d", "body": "", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a4d74236-2df9-4e56-83da-9150724b8cf6", "body": "", "latency": 0, "statusCode": 400, "label": "incorrect request parameters", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "55b32949-6ccc-44dc-bbba-a4a423656c98", "documentation": "Delete an abuse message", "method": "delete", "endpoint": "abuses/:abuseId/messages/:abuseMessageId", "responses": [ { "uuid": "686691be-bf17-4419-9aef-28818e62cbe7", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b8b6206f-8004-497e-931f-7bd39821a8b9", "documentation": "List accounts", "method": "get", "endpoint": "accounts", "responses": [ { "uuid": "f9ccbd31-3492-4975-8881-6bbc4f576008", "body": "[\n {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"followersCount\": {{faker 'number.int' max=99999}},\n \"followingCount\": {{faker 'number.int' max=99999}},\n \"host\": \"\",\n \"hostRedundancyAllowed\": {{faker 'datatype.boolean'}},\n \"id\": 42,\n \"name\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\",\n \"url\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "41e0a179-f49b-49f7-ac55-726d717f0e90", "documentation": "Get an account", "method": "get", "endpoint": "accounts/:name", "responses": [ { "uuid": "1783bdc3-3a4d-49a1-bf26-8717edbe43ae", "body": "{\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"followersCount\": {{faker 'number.int' max=99999}},\n \"followingCount\": {{faker 'number.int' max=99999}},\n \"host\": \"\",\n \"hostRedundancyAllowed\": {{faker 'datatype.boolean'}},\n \"id\": 42,\n \"name\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0d93e1bd-5ad6-4575-96e0-7ced5b7fb4d1", "body": "", "latency": 0, "statusCode": 404, "label": "account not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0f78345f-7ff5-4692-a7f6-39301cbf78b2", "documentation": "List ratings of an account", "method": "get", "endpoint": "accounts/:name/ratings", "responses": [ { "uuid": "897a4fcd-7a4a-4c14-a621-96dd568bfb15", "body": "[\n {\n \"rating\": \"{{oneOf (array 'like' 'dislike' 'none')}}\",\n \"video\": {\n \"account\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"displayName\": \"\",\n \"host\": \"\",\n \"id\": {{faker 'number.int' max=99999}},\n \"name\": \"\",\n \"url\": \"\"\n },\n \"blacklisted\": {{faker 'datatype.boolean'}},\n \"blacklistedReason\": \"\",\n \"category\": {\n \"id\": 15,\n \"label\": \"Science & Technology\"\n },\n \"channel\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"displayName\": \"\",\n \"host\": \"\",\n \"id\": 42,\n \"name\": \"\",\n \"url\": \"\"\n },\n \"createdAt\": \"2017-10-01T10:52:46.396Z\",\n \"description\": \"**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\\\\r\\\\n\\\\r\\\\n\\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\\\\r\\\\n*A decentralized video hosting network, based on fr...\\n\",\n \"dislikes\": 7,\n \"duration\": 1419,\n \"embedPath\": \"/videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee\",\n \"id\": {{faker 'number.int' max=99999}},\n \"isLive\": {{faker 'datatype.boolean'}},\n \"isLocal\": {{faker 'datatype.boolean'}},\n \"language\": {\n \"id\": \"en\",\n \"label\": \"English\"\n },\n \"licence\": {\n \"id\": 2,\n \"label\": \"Attribution - Share Alike\"\n },\n \"likes\": 42,\n \"name\": \"What is PeerTube?\",\n \"nsfw\": {{faker 'datatype.boolean'}},\n \"originallyPublishedAt\": \"2010-10-01T10:52:46.396Z\",\n \"previewPath\": \"/lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg\",\n \"privacy\": {\n \"id\": \"{{oneOf (array '1' '2' '3' '4')}}\",\n \"label\": \"\"\n },\n \"publishedAt\": \"2018-10-01T10:52:46.396Z\",\n \"scheduledUpdate\": {\n \"privacy\": \"{{oneOf (array '1' '2' '3' '4')}}\",\n \"updateAt\": \"{{date '2019' (now) 'yyyy-MM-dd'}}\"\n },\n \"shortUUID\": \"\",\n \"state\": {\n \"id\": \"{{oneOf (array '1' '2' '3')}}\",\n \"label\": \"\"\n },\n \"thumbnailPath\": \"/static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg\",\n \"updatedAt\": \"2021-05-04T08:01:01.502Z\",\n \"userHistory\": {\n \"currentTime\": {{faker 'number.int' max=99999}}\n },\n \"uuid\": \"{{faker 'string.uuid'}}\",\n \"views\": 1337,\n \"waitTranscoding\": {{faker 'datatype.boolean'}}\n }\n }\n]", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "98fae626-c87d-458c-bc25-445eb23642d0", "documentation": "List video channels of an account", "method": "get", "endpoint": "accounts/:name/video-channels", "responses": [ { "uuid": "6c2119c6-fc76-496e-b108-8f851ca012d9", "body": "{\n \"data\": [\n {\n \"description\": \"Videos made with <3 by Framasoft\",\n \"displayName\": \"Videos of Framasoft\",\n \"id\": {{faker 'number.int' max=99999}},\n \"isLocal\": {{faker 'datatype.boolean'}},\n \"ownerAccount\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"uuid\": \"9c9de5e8-0a1e-484a-b099-e80766180a6d\"\n },\n \"support\": \"Please support our work on https://soutenir.framasoft.org/en/ <3\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n }\n ],\n \"total\": 1\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "21d4f224-6672-4a8b-8876-ceb7312f1c6b", "documentation": "List videos of an account", "method": "get", "endpoint": "accounts/:name/videos", "responses": [ { "uuid": "ae8acb6e-57ca-41d5-82bf-1edfac9b974e", "body": "{\n \"data\": [\n {\n \"account\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"displayName\": \"\",\n \"host\": \"\",\n \"id\": {{faker 'number.int' max=99999}},\n \"name\": \"\",\n \"url\": \"\"\n },\n \"blacklisted\": {{faker 'datatype.boolean'}},\n \"blacklistedReason\": \"\",\n \"category\": {\n \"id\": 15,\n \"label\": \"Science & Technology\"\n },\n \"channel\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"displayName\": \"\",\n \"host\": \"\",\n \"id\": 42,\n \"name\": \"\",\n \"url\": \"\"\n },\n \"createdAt\": \"2017-10-01T10:52:46.396Z\",\n \"description\": \"**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\\\\r\\\\n\\\\r\\\\n\\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\\\\r\\\\n*A decentralized video hosting network, based on fr...\\n\",\n \"dislikes\": 7,\n \"duration\": 1419,\n \"embedPath\": \"/videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee\",\n \"id\": {{faker 'number.int' max=99999}},\n \"isLive\": {{faker 'datatype.boolean'}},\n \"isLocal\": {{faker 'datatype.boolean'}},\n \"language\": {\n \"id\": \"en\",\n \"label\": \"English\"\n },\n \"licence\": {\n \"id\": 2,\n \"label\": \"Attribution - Share Alike\"\n },\n \"likes\": 42,\n \"name\": \"What is PeerTube?\",\n \"nsfw\": {{faker 'datatype.boolean'}},\n \"originallyPublishedAt\": \"2010-10-01T10:52:46.396Z\",\n \"previewPath\": \"/lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg\",\n \"privacy\": {\n \"id\": \"{{oneOf (array '1' '2' '3' '4')}}\",\n \"label\": \"\"\n },\n \"publishedAt\": \"2018-10-01T10:52:46.396Z\",\n \"scheduledUpdate\": {\n \"privacy\": \"{{oneOf (array '1' '2' '3' '4')}}\",\n \"updateAt\": \"{{date '2019' (now) 'yyyy-MM-dd'}}\"\n },\n \"shortUUID\": \"\",\n \"state\": {\n \"id\": \"{{oneOf (array '1' '2' '3')}}\",\n \"label\": \"\"\n },\n \"thumbnailPath\": \"/static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg\",\n \"updatedAt\": \"2021-05-04T08:01:01.502Z\",\n \"userHistory\": {\n \"currentTime\": {{faker 'number.int' max=99999}}\n },\n \"uuid\": \"{{faker 'string.uuid'}}\",\n \"views\": 1337,\n \"waitTranscoding\": {{faker 'datatype.boolean'}}\n }\n ],\n \"total\": 1\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d606afe5-aad6-4acc-a65b-f560937a79f6", "documentation": "Get instance public configuration", "method": "get", "endpoint": "config", "responses": [ { "uuid": "e1a05bae-e772-4f2f-bdc1-6332f8bf79cc", "body": "{\n \"autoBlacklist\": {\n \"videos\": {\n \"ofUsers\": {\n \"enabled\": {{faker 'datatype.boolean'}}\n }\n }\n },\n \"avatar\": {\n \"extensions\": [\n \"\"\n ],\n \"file\": {\n \"size\": {\n \"max\": {{faker 'number.int' max=99999}}\n }\n }\n },\n \"contactForm\": {\n \"enabled\": {{faker 'datatype.boolean'}}\n },\n \"email\": {\n \"enabled\": {{faker 'datatype.boolean'}}\n },\n \"followings\": {\n \"instance\": {\n \"autoFollowIndex\": {\n \"indexUrl\": \"\"\n }\n }\n },\n \"homepage\": {\n \"enabled\": {{faker 'datatype.boolean'}}\n },\n \"import\": {\n \"videos\": {\n \"http\": {\n \"enabled\": {{faker 'datatype.boolean'}}\n },\n \"torrent\": {\n \"enabled\": {{faker 'datatype.boolean'}}\n }\n }\n },\n \"instance\": {\n \"customizations\": {\n \"css\": \"\",\n \"javascript\": \"\"\n },\n \"defaultClientRoute\": \"\",\n \"defaultNSFWPolicy\": \"\",\n \"isNSFW\": {{faker 'datatype.boolean'}},\n \"name\": \"\",\n \"shortDescription\": \"\"\n },\n \"plugin\": {\n \"registered\": [\n \"\"\n ]\n },\n \"search\": {\n \"remoteUri\": {\n \"anonymous\": {{faker 'datatype.boolean'}},\n \"users\": {{faker 'datatype.boolean'}}\n }\n },\n \"serverCommit\": \"\",\n \"serverVersion\": \"\",\n \"signup\": {\n \"allowed\": {{faker 'datatype.boolean'}},\n \"allowedForCurrentIP\": {{faker 'datatype.boolean'}},\n \"requiresEmailVerification\": {{faker 'datatype.boolean'}}\n },\n \"theme\": {\n \"registered\": [\n \"\"\n ]\n },\n \"tracker\": {\n \"enabled\": {{faker 'datatype.boolean'}}\n },\n \"transcoding\": {\n \"enabledResolutions\": [\n 240\n ],\n \"hls\": {\n \"enabled\": {{faker 'datatype.boolean'}}\n },\n \"webtorrent\": {\n \"enabled\": {{faker 'datatype.boolean'}}\n }\n },\n \"trending\": {\n \"videos\": {\n \"intervalDays\": {{faker 'number.int' max=99999}}\n }\n },\n \"user\": {\n \"videoQuota\": 16810141515,\n \"videoQuotaDaily\": 1681014151\n },\n \"video\": {\n \"file\": {\n \"extensions\": [\n \"\"\n ]\n },\n \"image\": {\n \"extensions\": [\n \"\"\n ],\n \"size\": {\n \"max\": {{faker 'number.int' max=99999}}\n }\n }\n },\n \"videoCaption\": {\n \"file\": {\n \"extensions\": [\n \"\"\n ],\n \"size\": {\n \"max\": {{faker 'number.int' max=99999}}\n }\n }\n }\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3fb3d5fc-cdc5-4d03-a964-e49573a90e2d", "documentation": "Get instance \"About\" information", "method": "get", "endpoint": "config/about", "responses": [ { "uuid": "61edf2cd-4fe9-4c88-b4b7-56bd2f06c827", "body": "{\n \"instance\": {\n \"description\": \"\",\n \"name\": \"\",\n \"shortDescription\": \"\",\n \"terms\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "814422de-8c20-4464-93d1-4026bfc40461", "documentation": "Delete instance runtime configuration", "method": "delete", "endpoint": "config/custom", "responses": [ { "uuid": "72dc0c89-01f1-41d5-8a8b-2e8567fa225d", "body": "", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a7a1dcb8-c1fc-462d-af3b-c642e2c23e93", "documentation": "Get instance runtime configuration", "method": "get", "endpoint": "config/custom", "responses": [ { "uuid": "fa954814-5c09-419d-8f3f-0de188bcc02c", "body": "{\n \"admin\": {\n \"email\": \"{{faker 'internet.email'}}\"\n },\n \"autoBlacklist\": {\n \"videos\": {\n \"ofUsers\": {\n \"enabled\": {{faker 'datatype.boolean'}}\n }\n }\n },\n \"cache\": {\n \"captions\": {\n \"size\": {{faker 'number.int' max=99999}}\n },\n \"previews\": {\n \"size\": {{faker 'number.int' max=99999}}\n }\n },\n \"contactForm\": {\n \"enabled\": {{faker 'datatype.boolean'}}\n },\n \"followers\": {\n \"instance\": {\n \"enabled\": {{faker 'datatype.boolean'}},\n \"manualApproval\": {{faker 'datatype.boolean'}}\n }\n },\n \"import\": {\n \"videos\": {\n \"http\": {\n \"enabled\": {{faker 'datatype.boolean'}}\n },\n \"torrent\": {\n \"enabled\": {{faker 'datatype.boolean'}}\n }\n }\n },\n \"instance\": {\n \"customizations\": {\n \"css\": \"\",\n \"javascript\": \"\"\n },\n \"defaultClientRoute\": \"\",\n \"defaultNSFWPolicy\": \"\",\n \"description\": \"\",\n \"isNSFW\": {{faker 'datatype.boolean'}},\n \"name\": \"\",\n \"shortDescription\": \"\",\n \"terms\": \"\"\n },\n \"services\": {\n \"twitter\": {\n \"username\": \"\",\n \"whitelisted\": {{faker 'datatype.boolean'}}\n }\n },\n \"signup\": {\n \"enabled\": {{faker 'datatype.boolean'}},\n \"limit\": {{faker 'number.int' max=99999}},\n \"requiresEmailVerification\": {{faker 'datatype.boolean'}}\n },\n \"theme\": {\n \"default\": \"\"\n },\n \"transcoding\": {\n \"allowAdditionalExtensions\": {{faker 'datatype.boolean'}},\n \"allowAudioFiles\": {{faker 'datatype.boolean'}},\n \"concurrency\": {{faker 'number.int' max=99999}},\n \"enabled\": {{faker 'datatype.boolean'}},\n \"hls\": {\n \"enabled\": {{faker 'datatype.boolean'}}\n },\n \"profile\": \"{{oneOf (array 'default')}}\",\n \"resolutions\": {\n \"0p\": {{faker 'datatype.boolean'}},\n \"1080p\": {{faker 'datatype.boolean'}},\n \"1440p\": {{faker 'datatype.boolean'}},\n \"2160p\": {{faker 'datatype.boolean'}},\n \"240p\": {{faker 'datatype.boolean'}},\n \"360p\": {{faker 'datatype.boolean'}},\n \"480p\": {{faker 'datatype.boolean'}},\n \"720p\": {{faker 'datatype.boolean'}}\n },\n \"threads\": {{faker 'number.int' max=99999}},\n \"webtorrent\": {\n \"enabled\": {{faker 'datatype.boolean'}}\n }\n },\n \"user\": {\n \"videoQuota\": 16810141515,\n \"videoQuotaDaily\": 1681014151\n }\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "294b0c54-e2f8-4483-b95f-0842be1ce62f", "documentation": "Set instance runtime configuration", "method": "put", "endpoint": "config/custom", "responses": [ { "uuid": "224d1c4d-e8fc-4534-a113-1758c0773f7d", "body": "", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "fef9f42c-4789-4c77-b065-93c8bb0e07cb", "body": "", "latency": 0, "statusCode": 400, "label": "Arises when:\n - the emailer is disabled and the instance is open to registrations\n - webtorrent and hls are disabled with transcoding enabled - you need at least one enabled\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a5f88287-f28b-46ba-9c02-5fee5c718827", "documentation": "Get instance custom homepage", "method": "get", "endpoint": "custom-pages/homepage/instance", "responses": [ { "uuid": "939c315a-a300-4518-b830-67ac2998ba72", "body": "{\n \"content\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "91c32022-82c4-4c84-af08-725f5c304c38", "body": "", "latency": 0, "statusCode": 404, "label": "No homepage set", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d92efdb4-caf0-47f8-ad40-a9add197b6c3", "documentation": "Set instance custom homepage", "method": "put", "endpoint": "custom-pages/homepage/instance", "responses": [ { "uuid": "742a99e3-80f4-49b5-94b0-b02b48cdaf5f", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a351fc17-a22f-4641-840c-5569b1c6d285", "documentation": "List videos of subscriptions tied to a token", "method": "get", "endpoint": "feeds/subscriptions.:format", "responses": [ { "uuid": "091ad7a6-ca57-4f41-91be-0142c6698f76", "body": "{}", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Cache-Control", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c4692001-3998-4f48-a024-d210c31a239f", "body": "", "latency": 0, "statusCode": 406, "label": "accept header unsupported", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "458c028c-4709-4c2e-86e3-d703c7ff06c2", "documentation": "List comments on videos", "method": "get", "endpoint": "feeds/video-comments.:format", "responses": [ { "uuid": "95d58f86-ce8c-4aa5-b2c8-60898bfd6cca", "body": "{}", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Cache-Control", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9eced53e-666c-495c-9f59-91f64e0bcd99", "body": "", "latency": 0, "statusCode": 400, "label": "Arises when:\n - videoId filter is mixed with a channel filter\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2b3406d3-fb79-4a08-808c-8928b520f7f2", "body": "", "latency": 0, "statusCode": 404, "label": "video, video channel or account not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0ccc3df8-42a9-4086-b47c-d0d575d662ab", "body": "", "latency": 0, "statusCode": 406, "label": "accept header unsupported", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "35f826ea-5829-4391-b428-664000152fcd", "documentation": "List videos", "method": "get", "endpoint": "feeds/videos.:format", "responses": [ { "uuid": "409849bb-c69f-4487-b233-3175ca0bdce3", "body": "{}", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Cache-Control", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "3b54ab88-e2c8-42ca-83e9-9d1dc183681a", "body": "", "latency": 0, "statusCode": 404, "label": "video channel or account not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f62a188f-74b8-42e1-8a4d-06c73ce1c67f", "body": "", "latency": 0, "statusCode": 406, "label": "accept header unsupported", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "19bd825b-5226-4ba5-87a9-f28e17fa7318", "documentation": "List instance jobs", "method": "get", "endpoint": "jobs/:state", "responses": [ { "uuid": "cf3ba8ed-9f45-46c3-b00c-2831f09138de", "body": "{\n \"data\": [\n {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"data\": {},\n \"error\": {},\n \"finishedOn\": \"{{faker 'date.recent' 365}}\",\n \"id\": 42,\n \"processedOn\": \"{{faker 'date.recent' 365}}\",\n \"state\": \"{{oneOf (array 'active' 'completed' 'failed' 'waiting' 'delayed')}}\",\n \"type\": \"{{oneOf (array 'activitypub-http-unicast' 'activitypub-http-broadcast' 'activitypub-http-fetcher' 'activitypub-follow' 'video-file-import' 'video-transcoding' 'email' 'video-import' 'videos-views' 'activitypub-refresher' 'video-redundancy')}}\"\n }\n ],\n \"total\": 1\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "98cf119a-c9f4-40dd-9737-d2684ca4291b", "documentation": "Login prerequisite", "method": "get", "endpoint": "oauth-clients/local", "responses": [ { "uuid": "abab453c-af0f-481b-bab0-414243a82929", "body": "{\n \"client_id\": \"v1ikx5hnfop4mdpnci8nsqh93c45rldf\",\n \"client_secret\": \"AjWiOapPltI6EnsWQwlFarRtLh4u8tDt\"\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e5529328-369b-4fa0-bc06-0e6ae2e9d81b", "documentation": "List plugins", "method": "get", "endpoint": "plugins", "responses": [ { "uuid": "da12a030-cc2a-4771-8dda-45bb71993849", "body": "{\n \"data\": [\n {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"description\": \"\",\n \"enabled\": {{faker 'datatype.boolean'}},\n \"homepage\": \"https://framagit.org/framasoft/peertube/official-plugins/tree/master/peertube-plugin-auth-ldap\",\n \"latestVersion\": \"0.0.3\",\n \"name\": \"peertube-plugin-auth-ldap\",\n \"peertubeEngine\": \"2.2.0\",\n \"settings\": {},\n \"type\": \"{{oneOf (array '1' '2')}}\",\n \"uninstalled\": {{faker 'datatype.boolean'}},\n \"updatedAt\": \"{{faker 'date.recent' 365}}\",\n \"version\": \"0.0.1\"\n }\n ],\n \"total\": 1\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b9512296-c890-476f-ba8e-36fc44c3d90e", "documentation": "List available plugins", "method": "get", "endpoint": "plugins/available", "responses": [ { "uuid": "fe27804f-155f-4a01-beed-b189bf8cbf64", "body": "{\n \"data\": [\n {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"description\": \"\",\n \"enabled\": {{faker 'datatype.boolean'}},\n \"homepage\": \"https://framagit.org/framasoft/peertube/official-plugins/tree/master/peertube-plugin-auth-ldap\",\n \"latestVersion\": \"0.0.3\",\n \"name\": \"peertube-plugin-auth-ldap\",\n \"peertubeEngine\": \"2.2.0\",\n \"settings\": {},\n \"type\": \"{{oneOf (array '1' '2')}}\",\n \"uninstalled\": {{faker 'datatype.boolean'}},\n \"updatedAt\": \"{{faker 'date.recent' 365}}\",\n \"version\": \"0.0.1\"\n }\n ],\n \"total\": 1\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a349ff11-1e2e-494f-b85c-216988f50f3a", "body": "", "latency": 0, "statusCode": 503, "label": "plugin index unavailable", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "92574d74-184a-447f-b123-49b067e345ad", "documentation": "Install a plugin", "method": "post", "endpoint": "plugins/install", "responses": [ { "uuid": "a2d66e67-f085-40c5-be81-78f00df95a74", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c5b051a4-c4b1-4b3e-87cf-ac50d0473167", "body": "", "latency": 0, "statusCode": 400, "label": "should have either `npmName` or `path` set", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "07686d79-ff7a-42fb-81b7-fb6a17dfa2f5", "documentation": "Uninstall a plugin", "method": "post", "endpoint": "plugins/uninstall", "responses": [ { "uuid": "ac0cfb95-6ae9-490e-b7ad-aad3b5b8853b", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "dbd2c673-9aa0-4216-96dc-f254d4957b95", "body": "", "latency": 0, "statusCode": 404, "label": "existing plugin not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ad6fedd1-54ff-43d4-8deb-fde68c2d4308", "documentation": "Update a plugin", "method": "post", "endpoint": "plugins/update", "responses": [ { "uuid": "db78e125-ac7a-4739-a75e-391519253e8c", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2cef0e0b-d6a0-4b8f-801c-91993afa622a", "body": "", "latency": 0, "statusCode": 400, "label": "should have either `npmName` or `path` set", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "bb4d0a81-f52e-4f52-afc4-b0d4542cc218", "body": "", "latency": 0, "statusCode": 404, "label": "existing plugin not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "dadb68ed-2853-4ff8-9819-bdf148079a28", "documentation": "Get a plugin", "method": "get", "endpoint": "plugins/:npmName", "responses": [ { "uuid": "62add2f5-0ff3-4346-ae51-699dade80f47", "body": "{\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"description\": \"\",\n \"enabled\": {{faker 'datatype.boolean'}},\n \"homepage\": \"https://framagit.org/framasoft/peertube/official-plugins/tree/master/peertube-plugin-auth-ldap\",\n \"latestVersion\": \"0.0.3\",\n \"name\": \"peertube-plugin-auth-ldap\",\n \"peertubeEngine\": \"2.2.0\",\n \"settings\": {},\n \"type\": \"{{oneOf (array '1' '2')}}\",\n \"uninstalled\": {{faker 'datatype.boolean'}},\n \"updatedAt\": \"{{faker 'date.recent' 365}}\",\n \"version\": \"0.0.1\"\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8d3471d9-8a40-4a7b-a9be-bf66a2abc7b4", "body": "", "latency": 0, "statusCode": 404, "label": "plugin not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "03d56f82-b396-49f6-bac5-2e6e29005840", "documentation": "Get a plugin's public settings", "method": "get", "endpoint": "plugins/:npmName/public-settings", "responses": [ { "uuid": "716c78c6-ea68-4d44-85c3-cc829875aade", "body": "{}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "bb95463a-967d-4d5c-8490-84683292594a", "body": "", "latency": 0, "statusCode": 404, "label": "plugin not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e1f47f9e-ffb4-4429-b626-5c96155204b3", "documentation": "Get a plugin's registered settings", "method": "get", "endpoint": "plugins/:npmName/registered-settings", "responses": [ { "uuid": "bcad44f8-6e4b-451c-923f-1413fcc63b8a", "body": "{}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "86247d52-909b-40e2-9d53-9e8d1e2f5317", "body": "", "latency": 0, "statusCode": 404, "label": "plugin not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ebc88543-9bbc-419e-8397-d0479be0ec0b", "documentation": "Set a plugin's settings", "method": "put", "endpoint": "plugins/:npmName/settings", "responses": [ { "uuid": "60143f29-07a4-4478-8e06-da6986495cc5", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f59ab46c-7898-414c-98f9-29c4003db70c", "body": "", "latency": 0, "statusCode": 404, "label": "plugin not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "11acc94c-3914-48fd-b6f7-83a6fe73ef52", "documentation": "Search channels", "method": "get", "endpoint": "search/video-channels", "responses": [ { "uuid": "aa307091-05d9-4e32-8fef-d070995ae225", "body": "{\n \"data\": [\n {\n \"description\": \"Videos made with <3 by Framasoft\",\n \"displayName\": \"Videos of Framasoft\",\n \"id\": {{faker 'number.int' max=99999}},\n \"isLocal\": {{faker 'datatype.boolean'}},\n \"ownerAccount\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"uuid\": \"9c9de5e8-0a1e-484a-b099-e80766180a6d\"\n },\n \"support\": \"Please support our work on https://soutenir.framasoft.org/en/ <3\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n }\n ],\n \"total\": 1\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f8034c34-86bf-4b6c-90d8-d13e6e8ca168", "body": "", "latency": 0, "statusCode": 500, "label": "search index unavailable", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c9824ce3-2f68-4401-bc14-b348cc0454c6", "documentation": "Search playlists", "method": "get", "endpoint": "search/video-playlists", "responses": [ { "uuid": "dda5d4d1-8d18-4258-b044-e5bb6a6ae264", "body": "{\n \"data\": [\n {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"description\": \"\",\n \"displayName\": \"\",\n \"id\": 42,\n \"isLocal\": {{faker 'datatype.boolean'}},\n \"ownerAccount\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"displayName\": \"\",\n \"host\": \"\",\n \"id\": {{faker 'number.int' max=99999}},\n \"name\": \"\",\n \"url\": \"\"\n },\n \"privacy\": {\n \"id\": \"{{oneOf (array '1' '2' '3')}}\",\n \"label\": \"\"\n },\n \"shortUUID\": \"\",\n \"thumbnailPath\": \"\",\n \"type\": {\n \"id\": \"{{oneOf (array '1' '2')}}\",\n \"label\": \"\"\n },\n \"updatedAt\": \"{{faker 'date.recent' 365}}\",\n \"uuid\": \"9c9de5e8-0a1e-484a-b099-e80766180a6d\",\n \"videoChannel\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"displayName\": \"\",\n \"host\": \"\",\n \"id\": 42,\n \"name\": \"\",\n \"url\": \"\"\n },\n \"videoLength\": {{faker 'number.int' max=99999}}\n }\n ],\n \"total\": 1\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b1c25375-18b4-4e76-aa53-50a41141444e", "body": "", "latency": 0, "statusCode": 500, "label": "search index unavailable", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2670d89e-9f74-4d39-bc2d-5927c6fb229f", "documentation": "Search videos", "method": "get", "endpoint": "search/videos", "responses": [ { "uuid": "4791eda8-6f95-46aa-a2f8-e3652ea3bc73", "body": "{\n \"data\": [\n {\n \"account\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"displayName\": \"\",\n \"host\": \"\",\n \"id\": {{faker 'number.int' max=99999}},\n \"name\": \"\",\n \"url\": \"\"\n },\n \"blacklisted\": {{faker 'datatype.boolean'}},\n \"blacklistedReason\": \"\",\n \"category\": {\n \"id\": 15,\n \"label\": \"Science & Technology\"\n },\n \"channel\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"displayName\": \"\",\n \"host\": \"\",\n \"id\": 42,\n \"name\": \"\",\n \"url\": \"\"\n },\n \"createdAt\": \"2017-10-01T10:52:46.396Z\",\n \"description\": \"**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\\\\r\\\\n\\\\r\\\\n\\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\\\\r\\\\n*A decentralized video hosting network, based on fr...\\n\",\n \"dislikes\": 7,\n \"duration\": 1419,\n \"embedPath\": \"/videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee\",\n \"id\": {{faker 'number.int' max=99999}},\n \"isLive\": {{faker 'datatype.boolean'}},\n \"isLocal\": {{faker 'datatype.boolean'}},\n \"language\": {\n \"id\": \"en\",\n \"label\": \"English\"\n },\n \"licence\": {\n \"id\": 2,\n \"label\": \"Attribution - Share Alike\"\n },\n \"likes\": 42,\n \"name\": \"What is PeerTube?\",\n \"nsfw\": {{faker 'datatype.boolean'}},\n \"originallyPublishedAt\": \"2010-10-01T10:52:46.396Z\",\n \"previewPath\": \"/lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg\",\n \"privacy\": {\n \"id\": \"{{oneOf (array '1' '2' '3' '4')}}\",\n \"label\": \"\"\n },\n \"publishedAt\": \"2018-10-01T10:52:46.396Z\",\n \"scheduledUpdate\": {\n \"privacy\": \"{{oneOf (array '1' '2' '3' '4')}}\",\n \"updateAt\": \"{{date '2019' (now) 'yyyy-MM-dd'}}\"\n },\n \"shortUUID\": \"\",\n \"state\": {\n \"id\": \"{{oneOf (array '1' '2' '3')}}\",\n \"label\": \"\"\n },\n \"thumbnailPath\": \"/static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg\",\n \"updatedAt\": \"2021-05-04T08:01:01.502Z\",\n \"userHistory\": {\n \"currentTime\": {{faker 'number.int' max=99999}}\n },\n \"uuid\": \"{{faker 'string.uuid'}}\",\n \"views\": 1337,\n \"waitTranscoding\": {{faker 'datatype.boolean'}}\n }\n ],\n \"total\": 1\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e221b1d9-6dce-44e0-9dd2-c6f2a47d6df0", "body": "", "latency": 0, "statusCode": 500, "label": "search index unavailable", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8c7561ae-f6b6-4932-bc39-52fe50cfaa9e", "documentation": "List account blocks", "method": "get", "endpoint": "server/blocklist/accounts", "responses": [ { "uuid": "b8de0baf-1dbe-4710-a756-ff527da0aa4f", "body": "", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e4fcaac4-e12b-43d3-87dd-0f59296a88c0", "documentation": "Block an account", "method": "post", "endpoint": "server/blocklist/accounts", "responses": [ { "uuid": "91f5bfdc-0e24-4fd6-a0c0-f8d02ee7cad5", "body": "", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f7a1c137-3532-493a-8c9b-c1690d3ac692", "body": "", "latency": 0, "statusCode": 409, "label": "self-blocking forbidden", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "cce16584-33e8-4dde-8b88-05606d9897a7", "documentation": "Unblock an account by its handle", "method": "delete", "endpoint": "server/blocklist/accounts/:accountName", "responses": [ { "uuid": "b49b2b80-e100-47f5-934e-ce3a29babcca", "body": "", "latency": 0, "statusCode": 201, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "eb07cb2d-c77a-4a35-ad33-131b0a4b9313", "body": "", "latency": 0, "statusCode": 404, "label": "account or account block does not exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1abad6ff-d229-4577-8ad0-f65dd5f69aed", "documentation": "List server blocks", "method": "get", "endpoint": "server/blocklist/servers", "responses": [ { "uuid": "7073db4e-898c-4c74-8372-190595ed00f3", "body": "", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "41e6fbb6-79bb-4e29-9fd0-d10b6b414e5e", "documentation": "Block a server", "method": "post", "endpoint": "server/blocklist/servers", "responses": [ { "uuid": "12d73fb1-7402-4a86-b9b2-6d5e1598e80f", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "67e04c3e-1f04-4d3e-98cf-8b221af9ade0", "body": "", "latency": 0, "statusCode": 409, "label": "self-blocking forbidden", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "71ada45a-2918-4c8f-95d2-63041dfdc0a4", "documentation": "Unblock a server by its domain", "method": "delete", "endpoint": "server/blocklist/servers/:host", "responses": [ { "uuid": "2af63d8b-b226-4fe2-b086-c83ee2975635", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8563a124-de6a-4b90-b361-1fde3b2c665c", "body": "", "latency": 0, "statusCode": 404, "label": "account block does not exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "42a17133-38f1-4369-a07a-9b93d92e96c8", "documentation": "List instances following the server", "method": "get", "endpoint": "server/followers", "responses": [ { "uuid": "40498c18-fcd5-4928-98c0-f276263cd46d", "body": "{\n \"data\": [\n {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"follower\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"followersCount\": {{faker 'number.int' max=99999}},\n \"followingCount\": {{faker 'number.int' max=99999}},\n \"host\": \"\",\n \"hostRedundancyAllowed\": {{faker 'datatype.boolean'}},\n \"id\": 42,\n \"name\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\",\n \"url\": \"\"\n },\n \"following\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"followersCount\": {{faker 'number.int' max=99999}},\n \"followingCount\": {{faker 'number.int' max=99999}},\n \"host\": \"\",\n \"hostRedundancyAllowed\": {{faker 'datatype.boolean'}},\n \"id\": 42,\n \"name\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\",\n \"url\": \"\"\n },\n \"id\": 42,\n \"score\": {{faker 'number.int' max=99999}},\n \"state\": \"{{oneOf (array 'pending' 'accepted')}}\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n }\n ],\n \"total\": 1\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1df8c686-588d-4fd3-ba17-db8b9ae639e7", "documentation": "Remove or reject a follower to your server", "method": "delete", "endpoint": "server/followers/:nameWithHost", "responses": [ { "uuid": "5a22b487-247e-45a6-96ed-6fa5beae657b", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f6670d36-5aea-44c5-981f-1b38eebe61eb", "body": "", "latency": 0, "statusCode": 404, "label": "follower not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "54eb18e9-263a-4d4b-8384-57186692777d", "documentation": "Accept a pending follower to your server", "method": "post", "endpoint": "server/followers/:nameWithHost/accept", "responses": [ { "uuid": "1e663eef-ac2b-4188-9659-35c6d2e669fa", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5b31bf05-a6fc-43d1-a467-ad33b46b968a", "body": "", "latency": 0, "statusCode": 404, "label": "follower not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0cbae5ee-30b8-4ea1-869a-553c88d8e709", "documentation": "Reject a pending follower to your server", "method": "post", "endpoint": "server/followers/:nameWithHost/reject", "responses": [ { "uuid": "0850f9c1-8c93-497b-928f-67869e220215", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9f87b912-86b8-4641-a6e7-a342f009a77d", "body": "", "latency": 0, "statusCode": 404, "label": "follower not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "962b897c-a5a1-4337-9360-09c9c9607c85", "documentation": "List instances followed by the server", "method": "get", "endpoint": "server/following", "responses": [ { "uuid": "4499483c-845b-4f88-8caa-97dd0bcb3b25", "body": "{\n \"data\": [\n {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"follower\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"followersCount\": {{faker 'number.int' max=99999}},\n \"followingCount\": {{faker 'number.int' max=99999}},\n \"host\": \"\",\n \"hostRedundancyAllowed\": {{faker 'datatype.boolean'}},\n \"id\": 42,\n \"name\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\",\n \"url\": \"\"\n },\n \"following\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"followersCount\": {{faker 'number.int' max=99999}},\n \"followingCount\": {{faker 'number.int' max=99999}},\n \"host\": \"\",\n \"hostRedundancyAllowed\": {{faker 'datatype.boolean'}},\n \"id\": 42,\n \"name\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\",\n \"url\": \"\"\n },\n \"id\": 42,\n \"score\": {{faker 'number.int' max=99999}},\n \"state\": \"{{oneOf (array 'pending' 'accepted')}}\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n }\n ],\n \"total\": 1\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9829b193-f989-47fd-9d45-a74b08759d66", "documentation": "Follow a list of actors (PeerTube instance, channel or account)", "method": "post", "endpoint": "server/following", "responses": [ { "uuid": "d527c71b-6fec-4b06-88db-997291bade26", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8a4d8d2b-254d-4665-b43a-acdea67d396b", "body": "", "latency": 0, "statusCode": 500, "label": "cannot follow a non-HTTPS server", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6d692eff-8386-4c07-930d-62434caaec4d", "documentation": "Unfollow an actor (PeerTube instance, channel or account)", "method": "delete", "endpoint": "server/following/:hostOrHandle", "responses": [ { "uuid": "901467e7-ab99-4428-98bd-735da8261646", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "827a54ec-d4c2-4607-98c9-7b294d89b2da", "body": "", "latency": 0, "statusCode": 404, "label": "host or handle not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7edfb5d9-cc5d-431d-b73f-830f994c0426", "documentation": "List videos being mirrored", "method": "get", "endpoint": "server/redundancy/videos", "responses": [ { "uuid": "f38072ac-0c50-4c70-a72c-d99832f2f0fa", "body": "[\n {\n \"id\": 42,\n \"name\": \"\",\n \"redundancies\": {\n \"files\": [\n {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"expiresOn\": \"{{faker 'date.recent' 365}}\",\n \"fileUrl\": \"\",\n \"id\": 42,\n \"size\": {{faker 'number.int' max=99999}},\n \"strategy\": \"{{oneOf (array 'manual' 'most-views' 'trending' 'recently-added')}}\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n }\n ],\n \"streamingPlaylists\": [\n {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"expiresOn\": \"{{faker 'date.recent' 365}}\",\n \"fileUrl\": \"\",\n \"id\": 42,\n \"size\": {{faker 'number.int' max=99999}},\n \"strategy\": \"{{oneOf (array 'manual' 'most-views' 'trending' 'recently-added')}}\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n }\n ]\n },\n \"url\": \"\",\n \"uuid\": \"9c9de5e8-0a1e-484a-b099-e80766180a6d\"\n }\n]", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0ef1b315-b88f-43e9-a3dc-7bd7dc9610d3", "documentation": "Mirror a video", "method": "post", "endpoint": "server/redundancy/videos", "responses": [ { "uuid": "224312c3-7fd5-4850-a9f6-c1e33a280571", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0bfadd13-9af8-4848-b615-c4b85388f9f9", "body": "", "latency": 0, "statusCode": 400, "label": "cannot mirror a local video", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "939ee548-a88f-4c37-82f0-2f68052ace2c", "body": "", "latency": 0, "statusCode": 404, "label": "video does not exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2ba3a976-09da-492f-bf89-9aa4468a4e4d", "body": "", "latency": 0, "statusCode": 409, "label": "video is already mirrored", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c790350a-b410-489d-8265-ab36f9e53f0f", "documentation": "Delete a mirror done on a video", "method": "delete", "endpoint": "server/redundancy/videos/:redundancyId", "responses": [ { "uuid": "67249fca-f4be-4a67-8fc7-204ce94a0a6b", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b5896018-e5d7-42dc-af37-9e9ed91cccb5", "body": "", "latency": 0, "statusCode": 404, "label": "video redundancy not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "214d42b9-88dc-4cb5-a2fa-ea1ba77637f2", "documentation": "Update a server redundancy policy", "method": "put", "endpoint": "server/redundancy/:host", "responses": [ { "uuid": "4cceb76f-c8ac-43fe-952d-5542f3e6b596", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "6b4dbdbd-908e-4b2b-a2da-4e28422f6bbc", "body": "", "latency": 0, "statusCode": 404, "label": "server is not already known", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7a69b80c-2f36-4a27-9624-d88abb2b4225", "documentation": "List users", "method": "get", "endpoint": "users", "responses": [ { "uuid": "be7053f6-2d75-4666-839b-302187f4381b", "body": "[\n {\n \"account\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"followersCount\": {{faker 'number.int' max=99999}},\n \"followingCount\": {{faker 'number.int' max=99999}},\n \"host\": \"\",\n \"hostRedundancyAllowed\": {{faker 'datatype.boolean'}},\n \"id\": 42,\n \"name\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\",\n \"url\": \"\"\n },\n \"autoPlayNextVideo\": {{faker 'datatype.boolean'}},\n \"autoPlayNextVideoPlaylist\": {{faker 'datatype.boolean'}},\n \"autoPlayVideo\": {{faker 'datatype.boolean'}},\n \"blocked\": {{faker 'datatype.boolean'}},\n \"blockedReason\": \"\",\n \"createdAt\": \"\",\n \"email\": \"{{faker 'internet.email'}}\",\n \"emailVerified\": {{faker 'datatype.boolean'}},\n \"id\": {{faker 'number.int' max=99999}},\n \"lastLoginDate\": \"{{faker 'date.recent' 365}}\",\n \"noInstanceConfigWarningModal\": {{faker 'datatype.boolean'}},\n \"noWelcomeModal\": {{faker 'datatype.boolean'}},\n \"nsfwPolicy\": \"{{oneOf (array 'display' 'blur' 'do_not_list')}}\",\n \"pluginAuth\": \"\",\n \"role\": \"{{oneOf (array '0' '1' '2')}}\",\n \"roleLabel\": \"{{oneOf (array 'User' 'Moderator' 'Administrator')}}\",\n \"theme\": \"\",\n \"username\": \"chocobozzz\",\n \"videoChannels\": [\n {\n \"description\": \"Videos made with <3 by Framasoft\",\n \"displayName\": \"Videos of Framasoft\",\n \"id\": {{faker 'number.int' max=99999}},\n \"isLocal\": {{faker 'datatype.boolean'}},\n \"ownerAccount\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"uuid\": \"9c9de5e8-0a1e-484a-b099-e80766180a6d\"\n },\n \"support\": \"Please support our work on https://soutenir.framasoft.org/en/ <3\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n }\n ],\n \"videoQuota\": -1,\n \"videoQuotaDaily\": -1,\n \"webtorrentEnabled\": {{faker 'datatype.boolean'}}\n }\n]", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "89ca4373-f1af-4240-a226-ada2a624997c", "documentation": "Create a user", "method": "post", "endpoint": "users", "responses": [ { "uuid": "d418d63c-2db3-4078-b2d7-673d16ff9020", "body": "{\n \"user\": {\n \"account\": {\n \"id\": 42\n },\n \"id\": 42\n }\n}", "latency": 0, "statusCode": 200, "label": "user created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "524e2b58-b534-454f-874f-0261f7251e73", "body": "", "latency": 0, "statusCode": 403, "label": "insufficient authority to create an admin or moderator", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3b4504e3-62df-4ffc-b775-840a2fcceb6a", "documentation": "Resend user verification link", "method": "post", "endpoint": "users/ask-send-verify-email", "responses": [ { "uuid": "89d04f4b-caa0-455c-9d08-cfa65d394663", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "73d97a50-cd84-4329-9871-95bf554a3114", "documentation": "Get my user information", "method": "get", "endpoint": "users/me", "responses": [ { "uuid": "1f8b5c86-f342-4608-a60d-20b9f481c9d9", "body": "[\n {\n \"account\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"followersCount\": {{faker 'number.int' max=99999}},\n \"followingCount\": {{faker 'number.int' max=99999}},\n \"host\": \"\",\n \"hostRedundancyAllowed\": {{faker 'datatype.boolean'}},\n \"id\": 42,\n \"name\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\",\n \"url\": \"\"\n },\n \"autoPlayNextVideo\": {{faker 'datatype.boolean'}},\n \"autoPlayNextVideoPlaylist\": {{faker 'datatype.boolean'}},\n \"autoPlayVideo\": {{faker 'datatype.boolean'}},\n \"blocked\": {{faker 'datatype.boolean'}},\n \"blockedReason\": \"\",\n \"createdAt\": \"\",\n \"email\": \"{{faker 'internet.email'}}\",\n \"emailVerified\": {{faker 'datatype.boolean'}},\n \"id\": {{faker 'number.int' max=99999}},\n \"lastLoginDate\": \"{{faker 'date.recent' 365}}\",\n \"noInstanceConfigWarningModal\": {{faker 'datatype.boolean'}},\n \"noWelcomeModal\": {{faker 'datatype.boolean'}},\n \"nsfwPolicy\": \"{{oneOf (array 'display' 'blur' 'do_not_list')}}\",\n \"pluginAuth\": \"\",\n \"role\": \"{{oneOf (array '0' '1' '2')}}\",\n \"roleLabel\": \"{{oneOf (array 'User' 'Moderator' 'Administrator')}}\",\n \"theme\": \"\",\n \"username\": \"chocobozzz\",\n \"videoChannels\": [\n {\n \"description\": \"Videos made with <3 by Framasoft\",\n \"displayName\": \"Videos of Framasoft\",\n \"id\": {{faker 'number.int' max=99999}},\n \"isLocal\": {{faker 'datatype.boolean'}},\n \"ownerAccount\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"uuid\": \"9c9de5e8-0a1e-484a-b099-e80766180a6d\"\n },\n \"support\": \"Please support our work on https://soutenir.framasoft.org/en/ <3\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n }\n ],\n \"videoQuota\": -1,\n \"videoQuotaDaily\": -1,\n \"webtorrentEnabled\": {{faker 'datatype.boolean'}}\n }\n]", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "dc0ea0e2-2b69-47fc-9371-e7e415a5977f", "documentation": "Update my user information", "method": "put", "endpoint": "users/me", "responses": [ { "uuid": "7a315259-8d0c-4f17-bec5-b9d2cf94b7d9", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5ad9f682-ad1d-4788-8a85-f813bf327bd7", "documentation": "List my abuses", "method": "get", "endpoint": "users/me/abuses", "responses": [ { "uuid": "00c9d670-1e8f-4215-a366-b4fe036f0b76", "body": "{\n \"data\": [\n {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"id\": 42,\n \"moderationComment\": \"Decided to ban the server since it spams us regularly\",\n \"predefinedReasons\": [\n \"spamOrMisleading\"\n ],\n \"reason\": \"The video is a spam\",\n \"reporterAccount\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"followersCount\": {{faker 'number.int' max=99999}},\n \"followingCount\": {{faker 'number.int' max=99999}},\n \"host\": \"\",\n \"hostRedundancyAllowed\": {{faker 'datatype.boolean'}},\n \"id\": 42,\n \"name\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\",\n \"url\": \"\"\n },\n \"state\": {\n \"id\": \"{{oneOf (array '1' '2' '3')}}\",\n \"label\": \"\"\n },\n \"video\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"name\": \"What is PeerTube?\",\n \"uuid\": \"{{faker 'string.uuid'}}\"\n }\n }\n ],\n \"total\": 1\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b381342f-dbae-49a9-9417-16f87aad996c", "documentation": "Delete my avatar", "method": "delete", "endpoint": "users/me/avatar", "responses": [ { "uuid": "32fe636f-5cf9-4d72-b9ed-5c2aca515cf2", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "01a43b9c-8633-47e2-b184-e16ecc3d6908", "documentation": "Update my user avatar", "method": "post", "endpoint": "users/me/avatar/pick", "responses": [ { "uuid": "cc248a21-bb5b-4479-9b43-52582c5e1528", "body": "{\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "81d5416f-0037-4a11-bf0c-5e9a28089376", "body": "", "latency": 0, "statusCode": 413, "label": "image file too large", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-File-Maximum-Size", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0b1afa75-3051-45fa-ae8c-25930dd9c9b3", "documentation": "List watched videos history", "method": "get", "endpoint": "users/me/history/videos", "responses": [ { "uuid": "c9315c92-6537-4bab-9727-0851d8aa6b0c", "body": "{\n \"data\": [\n {\n \"account\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"displayName\": \"\",\n \"host\": \"\",\n \"id\": {{faker 'number.int' max=99999}},\n \"name\": \"\",\n \"url\": \"\"\n },\n \"blacklisted\": {{faker 'datatype.boolean'}},\n \"blacklistedReason\": \"\",\n \"category\": {\n \"id\": 15,\n \"label\": \"Science & Technology\"\n },\n \"channel\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"displayName\": \"\",\n \"host\": \"\",\n \"id\": 42,\n \"name\": \"\",\n \"url\": \"\"\n },\n \"createdAt\": \"2017-10-01T10:52:46.396Z\",\n \"description\": \"**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\\\\r\\\\n\\\\r\\\\n\\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\\\\r\\\\n*A decentralized video hosting network, based on fr...\\n\",\n \"dislikes\": 7,\n \"duration\": 1419,\n \"embedPath\": \"/videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee\",\n \"id\": {{faker 'number.int' max=99999}},\n \"isLive\": {{faker 'datatype.boolean'}},\n \"isLocal\": {{faker 'datatype.boolean'}},\n \"language\": {\n \"id\": \"en\",\n \"label\": \"English\"\n },\n \"licence\": {\n \"id\": 2,\n \"label\": \"Attribution - Share Alike\"\n },\n \"likes\": 42,\n \"name\": \"What is PeerTube?\",\n \"nsfw\": {{faker 'datatype.boolean'}},\n \"originallyPublishedAt\": \"2010-10-01T10:52:46.396Z\",\n \"previewPath\": \"/lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg\",\n \"privacy\": {\n \"id\": \"{{oneOf (array '1' '2' '3' '4')}}\",\n \"label\": \"\"\n },\n \"publishedAt\": \"2018-10-01T10:52:46.396Z\",\n \"scheduledUpdate\": {\n \"privacy\": \"{{oneOf (array '1' '2' '3' '4')}}\",\n \"updateAt\": \"{{date '2019' (now) 'yyyy-MM-dd'}}\"\n },\n \"shortUUID\": \"\",\n \"state\": {\n \"id\": \"{{oneOf (array '1' '2' '3')}}\",\n \"label\": \"\"\n },\n \"thumbnailPath\": \"/static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg\",\n \"updatedAt\": \"2021-05-04T08:01:01.502Z\",\n \"userHistory\": {\n \"currentTime\": {{faker 'number.int' max=99999}}\n },\n \"uuid\": \"{{faker 'string.uuid'}}\",\n \"views\": 1337,\n \"waitTranscoding\": {{faker 'datatype.boolean'}}\n }\n ],\n \"total\": 1\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "322241e0-9348-4815-abfe-18c171359222", "documentation": "Clear video history", "method": "post", "endpoint": "users/me/history/videos/remove", "responses": [ { "uuid": "a4b8d28a-8841-467f-8f89-19c2d7ad5e00", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fabbbe30-2958-43ca-9219-7b9964aea83b", "documentation": "Update my notification settings", "method": "put", "endpoint": "users/me/notification-settings", "responses": [ { "uuid": "3dcfe5bc-a45b-4c09-bcdc-d00bd3e9dee1", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f51906fa-bf07-4546-9bd6-f0ed5d6992e0", "documentation": "List my notifications", "method": "get", "endpoint": "users/me/notifications", "responses": [ { "uuid": "0eab4610-3cdf-4822-8bdb-6f33047e109a", "body": "{\n \"data\": [\n {\n \"account\": {\n \"avatar\": {\n \"path\": \"\"\n },\n \"displayName\": \"\",\n \"host\": \"\",\n \"id\": 42,\n \"name\": \"\"\n },\n \"actorFollow\": {\n \"follower\": {\n \"avatar\": {\n \"path\": \"\"\n },\n \"displayName\": \"\",\n \"host\": \"\",\n \"id\": 42,\n \"name\": \"\"\n },\n \"following\": {\n \"displayName\": \"\",\n \"host\": \"\",\n \"name\": \"\",\n \"type\": \"{{oneOf (array 'account' 'channel' 'instance')}}\"\n },\n \"id\": 42,\n \"state\": \"{{oneOf (array 'pending' 'accepted')}}\"\n },\n \"comment\": {\n \"account\": {\n \"avatar\": {\n \"path\": \"\"\n },\n \"displayName\": \"\",\n \"host\": \"\",\n \"id\": 42,\n \"name\": \"\"\n },\n \"id\": 42,\n \"threadId\": {{faker 'number.int' max=99999}},\n \"video\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"name\": \"What is PeerTube?\",\n \"uuid\": \"{{faker 'string.uuid'}}\"\n }\n },\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"id\": 42,\n \"read\": {{faker 'datatype.boolean'}},\n \"type\": {{faker 'number.int' max=99999}},\n \"updatedAt\": \"{{faker 'date.recent' 365}}\",\n \"video\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"name\": \"What is PeerTube?\",\n \"uuid\": \"{{faker 'string.uuid'}}\"\n },\n \"videoAbuse\": {\n \"id\": 42,\n \"video\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"name\": \"What is PeerTube?\",\n \"uuid\": \"{{faker 'string.uuid'}}\"\n }\n },\n \"videoBlacklist\": {\n \"id\": 42,\n \"video\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"name\": \"What is PeerTube?\",\n \"uuid\": \"{{faker 'string.uuid'}}\"\n }\n },\n \"videoImport\": {\n \"id\": 42,\n \"magnetUri\": \"magnet:?xs=https%3A%2F%2Fframatube.org%2Fstatic%2Ftorrents%2F9c9de5e8-0a1e-484a-b099-e80766180a6d-240.torrent&xt=urn:btih:38b4747ff788b30bf61f59d1965cd38f9e48e01f&dn=What+is+PeerTube%3F&tr=wss%3A%2F%2Fframatube.org%2Ftracker%2Fsocket&tr=https%3A%2F%2Fframatube.org%2Ftracker%2Fannounce&ws=https%3A%2F%2Fframatube.org%2Fstatic%2Fwebseed%2F9c9de5e8-0a1e-484a-b099-e80766180a6d-240.mp4\",\n \"targetUri\": \"\",\n \"torrentName\": \"\",\n \"video\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"name\": \"What is PeerTube?\",\n \"uuid\": \"{{faker 'string.uuid'}}\"\n }\n }\n }\n ],\n \"total\": 1\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "77812696-d989-4469-899d-62811a855590", "documentation": "Mark notifications as read by their id", "method": "post", "endpoint": "users/me/notifications/read", "responses": [ { "uuid": "01b3ab8e-6e31-424c-be70-6f650aba9278", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ecabcf65-fc4b-44e1-a480-012b584a31d9", "documentation": "Mark all my notification as read", "method": "post", "endpoint": "users/me/notifications/read-all", "responses": [ { "uuid": "c1c3fea3-4237-453e-939d-15fbb05abfab", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "99f43d64-d702-433c-b86c-eb99e689d296", "documentation": "Get my user subscriptions", "method": "get", "endpoint": "users/me/subscriptions", "responses": [ { "uuid": "2c106e15-1bee-402e-830e-c44eb15b0c97", "body": "{\n \"data\": [\n {\n \"description\": \"Videos made with <3 by Framasoft\",\n \"displayName\": \"Videos of Framasoft\",\n \"id\": {{faker 'number.int' max=99999}},\n \"isLocal\": {{faker 'datatype.boolean'}},\n \"ownerAccount\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"uuid\": \"9c9de5e8-0a1e-484a-b099-e80766180a6d\"\n },\n \"support\": \"Please support our work on https://soutenir.framasoft.org/en/ <3\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n }\n ],\n \"total\": 1\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "048f0da0-79a1-40b3-a380-f6374530e54a", "documentation": "Add subscription to my user", "method": "post", "endpoint": "users/me/subscriptions", "responses": [ { "uuid": "599a084c-7098-44c1-85d9-38e8a72af3c1", "body": "", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3416dff2-deff-4353-b416-95b740df60cc", "documentation": "Get if subscriptions exist for my user", "method": "get", "endpoint": "users/me/subscriptions/exist", "responses": [ { "uuid": "f9cf84ee-d8c0-464d-8a99-995ac1d3f9df", "body": "{}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1e9fee5d-7271-4c32-9581-7ef3ae25aeed", "documentation": "List videos of subscriptions of my user", "method": "get", "endpoint": "users/me/subscriptions/videos", "responses": [ { "uuid": "ed60dacf-8cc0-4c2a-a605-abf06abd46ff", "body": "{\n \"data\": [\n {\n \"account\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"displayName\": \"\",\n \"host\": \"\",\n \"id\": {{faker 'number.int' max=99999}},\n \"name\": \"\",\n \"url\": \"\"\n },\n \"blacklisted\": {{faker 'datatype.boolean'}},\n \"blacklistedReason\": \"\",\n \"category\": {\n \"id\": 15,\n \"label\": \"Science & Technology\"\n },\n \"channel\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"displayName\": \"\",\n \"host\": \"\",\n \"id\": 42,\n \"name\": \"\",\n \"url\": \"\"\n },\n \"createdAt\": \"2017-10-01T10:52:46.396Z\",\n \"description\": \"**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\\\\r\\\\n\\\\r\\\\n\\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\\\\r\\\\n*A decentralized video hosting network, based on fr...\\n\",\n \"dislikes\": 7,\n \"duration\": 1419,\n \"embedPath\": \"/videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee\",\n \"id\": {{faker 'number.int' max=99999}},\n \"isLive\": {{faker 'datatype.boolean'}},\n \"isLocal\": {{faker 'datatype.boolean'}},\n \"language\": {\n \"id\": \"en\",\n \"label\": \"English\"\n },\n \"licence\": {\n \"id\": 2,\n \"label\": \"Attribution - Share Alike\"\n },\n \"likes\": 42,\n \"name\": \"What is PeerTube?\",\n \"nsfw\": {{faker 'datatype.boolean'}},\n \"originallyPublishedAt\": \"2010-10-01T10:52:46.396Z\",\n \"previewPath\": \"/lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg\",\n \"privacy\": {\n \"id\": \"{{oneOf (array '1' '2' '3' '4')}}\",\n \"label\": \"\"\n },\n \"publishedAt\": \"2018-10-01T10:52:46.396Z\",\n \"scheduledUpdate\": {\n \"privacy\": \"{{oneOf (array '1' '2' '3' '4')}}\",\n \"updateAt\": \"{{date '2019' (now) 'yyyy-MM-dd'}}\"\n },\n \"shortUUID\": \"\",\n \"state\": {\n \"id\": \"{{oneOf (array '1' '2' '3')}}\",\n \"label\": \"\"\n },\n \"thumbnailPath\": \"/static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg\",\n \"updatedAt\": \"2021-05-04T08:01:01.502Z\",\n \"userHistory\": {\n \"currentTime\": {{faker 'number.int' max=99999}}\n },\n \"uuid\": \"{{faker 'string.uuid'}}\",\n \"views\": 1337,\n \"waitTranscoding\": {{faker 'datatype.boolean'}}\n }\n ],\n \"total\": 1\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ce210d75-7726-4261-b5da-04337ec89abb", "documentation": "Delete subscription of my user", "method": "delete", "endpoint": "users/me/subscriptions/:subscriptionHandle", "responses": [ { "uuid": "e7d58dfb-33e1-4b34-87ba-a13002dff27d", "body": "", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e5c2845f-42e5-476d-8b4c-f12b5756731e", "documentation": "Get subscription of my user", "method": "get", "endpoint": "users/me/subscriptions/:subscriptionHandle", "responses": [ { "uuid": "2c09e28d-31a0-4790-bd64-54d320a4fd7c", "body": "{\n \"description\": \"Videos made with <3 by Framasoft\",\n \"displayName\": \"Videos of Framasoft\",\n \"id\": {{faker 'number.int' max=99999}},\n \"isLocal\": {{faker 'datatype.boolean'}},\n \"ownerAccount\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"uuid\": \"9c9de5e8-0a1e-484a-b099-e80766180a6d\"\n },\n \"support\": \"Please support our work on https://soutenir.framasoft.org/en/ <3\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "774a3890-7e62-406a-aff4-8102ebdc581a", "documentation": "Check video exists in my playlists", "method": "get", "endpoint": "users/me/video-playlists/videos-exist", "responses": [ { "uuid": "e6ae0c9d-ac2b-407a-838c-78c3460736c2", "body": "{\n \"videoId\": [\n {\n \"playlistElementId\": {{faker 'number.int' max=99999}},\n \"playlistId\": {{faker 'number.int' max=99999}},\n \"startTimestamp\": {{faker 'number.int' max=99999}},\n \"stopTimestamp\": {{faker 'number.int' max=99999}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bc47c555-adc9-4459-a39f-61abeaa7b5f2", "documentation": "Get my user used quota", "method": "get", "endpoint": "users/me/video-quota-used", "responses": [ { "uuid": "98859d9d-b410-4ec4-93ef-1223765a825b", "body": "{\n \"videoQuotaUsed\": 16810141515,\n \"videoQuotaUsedDaily\": 1681014151\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "428c05b4-0b6f-4d56-82d4-e774a521c6bd", "documentation": "Get videos of my user", "method": "get", "endpoint": "users/me/videos", "responses": [ { "uuid": "203e2bc9-47cf-4698-a17b-4a2c0cde4f47", "body": "{\n \"data\": [\n {\n \"account\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"displayName\": \"\",\n \"host\": \"\",\n \"id\": {{faker 'number.int' max=99999}},\n \"name\": \"\",\n \"url\": \"\"\n },\n \"blacklisted\": {{faker 'datatype.boolean'}},\n \"blacklistedReason\": \"\",\n \"category\": {\n \"id\": 15,\n \"label\": \"Science & Technology\"\n },\n \"channel\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"displayName\": \"\",\n \"host\": \"\",\n \"id\": 42,\n \"name\": \"\",\n \"url\": \"\"\n },\n \"createdAt\": \"2017-10-01T10:52:46.396Z\",\n \"description\": \"**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\\\\r\\\\n\\\\r\\\\n\\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\\\\r\\\\n*A decentralized video hosting network, based on fr...\\n\",\n \"dislikes\": 7,\n \"duration\": 1419,\n \"embedPath\": \"/videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee\",\n \"id\": {{faker 'number.int' max=99999}},\n \"isLive\": {{faker 'datatype.boolean'}},\n \"isLocal\": {{faker 'datatype.boolean'}},\n \"language\": {\n \"id\": \"en\",\n \"label\": \"English\"\n },\n \"licence\": {\n \"id\": 2,\n \"label\": \"Attribution - Share Alike\"\n },\n \"likes\": 42,\n \"name\": \"What is PeerTube?\",\n \"nsfw\": {{faker 'datatype.boolean'}},\n \"originallyPublishedAt\": \"2010-10-01T10:52:46.396Z\",\n \"previewPath\": \"/lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg\",\n \"privacy\": {\n \"id\": \"{{oneOf (array '1' '2' '3' '4')}}\",\n \"label\": \"\"\n },\n \"publishedAt\": \"2018-10-01T10:52:46.396Z\",\n \"scheduledUpdate\": {\n \"privacy\": \"{{oneOf (array '1' '2' '3' '4')}}\",\n \"updateAt\": \"{{date '2019' (now) 'yyyy-MM-dd'}}\"\n },\n \"shortUUID\": \"\",\n \"state\": {\n \"id\": \"{{oneOf (array '1' '2' '3')}}\",\n \"label\": \"\"\n },\n \"thumbnailPath\": \"/static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg\",\n \"updatedAt\": \"2021-05-04T08:01:01.502Z\",\n \"userHistory\": {\n \"currentTime\": {{faker 'number.int' max=99999}}\n },\n \"uuid\": \"{{faker 'string.uuid'}}\",\n \"views\": 1337,\n \"waitTranscoding\": {{faker 'datatype.boolean'}}\n }\n ],\n \"total\": 1\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b4159a77-127c-4df9-a162-a0aaebe7b326", "documentation": "Get video imports of my user", "method": "get", "endpoint": "users/me/videos/imports", "responses": [ { "uuid": "ef030507-64e3-4ba5-b59d-081fec30f65c", "body": "{\n \"data\": [\n {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"error\": \"\",\n \"id\": {{faker 'number.int' max=99999}},\n \"magnetUri\": \"magnet:?xs=https%3A%2F%2Fframatube.org%2Fstatic%2Ftorrents%2F9c9de5e8-0a1e-484a-b099-e80766180a6d-240.torrent&xt=urn:btih:38b4747ff788b30bf61f59d1965cd38f9e48e01f&dn=What+is+PeerTube%3F&tr=wss%3A%2F%2Fframatube.org%2Ftracker%2Fsocket&tr=https%3A%2F%2Fframatube.org%2Ftracker%2Fannounce&ws=https%3A%2F%2Fframatube.org%2Fstatic%2Fwebseed%2F9c9de5e8-0a1e-484a-b099-e80766180a6d-240.mp4\",\n \"state\": {\n \"id\": \"{{oneOf (array '1' '2' '3')}}\",\n \"label\": \"Pending\"\n },\n \"targetUrl\": \"https://framatube.org/videos/watch/9c9de5e8-0a1e-484a-b099-e80766180a6d\",\n \"torrentName\": \"\",\n \"torrentfile\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\",\n \"video\": {\n \"account\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"displayName\": \"\",\n \"host\": \"\",\n \"id\": {{faker 'number.int' max=99999}},\n \"name\": \"\",\n \"url\": \"\"\n },\n \"blacklisted\": {{faker 'datatype.boolean'}},\n \"blacklistedReason\": \"\",\n \"category\": {\n \"id\": 15,\n \"label\": \"Science & Technology\"\n },\n \"channel\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"displayName\": \"\",\n \"host\": \"\",\n \"id\": 42,\n \"name\": \"\",\n \"url\": \"\"\n },\n \"createdAt\": \"2017-10-01T10:52:46.396Z\",\n \"description\": \"**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\\\\r\\\\n\\\\r\\\\n\\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\\\\r\\\\n*A decentralized video hosting network, based on fr...\\n\",\n \"dislikes\": 7,\n \"duration\": 1419,\n \"embedPath\": \"/videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee\",\n \"id\": {{faker 'number.int' max=99999}},\n \"isLive\": {{faker 'datatype.boolean'}},\n \"isLocal\": {{faker 'datatype.boolean'}},\n \"language\": {\n \"id\": \"en\",\n \"label\": \"English\"\n },\n \"licence\": {\n \"id\": 2,\n \"label\": \"Attribution - Share Alike\"\n },\n \"likes\": 42,\n \"name\": \"What is PeerTube?\",\n \"nsfw\": {{faker 'datatype.boolean'}},\n \"originallyPublishedAt\": \"2010-10-01T10:52:46.396Z\",\n \"previewPath\": \"/lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg\",\n \"privacy\": {\n \"id\": \"{{oneOf (array '1' '2' '3' '4')}}\",\n \"label\": \"\"\n },\n \"publishedAt\": \"2018-10-01T10:52:46.396Z\",\n \"scheduledUpdate\": {\n \"privacy\": \"{{oneOf (array '1' '2' '3' '4')}}\",\n \"updateAt\": \"{{date '2019' (now) 'yyyy-MM-dd'}}\"\n },\n \"shortUUID\": \"\",\n \"state\": {\n \"id\": \"{{oneOf (array '1' '2' '3')}}\",\n \"label\": \"\"\n },\n \"thumbnailPath\": \"/static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg\",\n \"updatedAt\": \"2021-05-04T08:01:01.502Z\",\n \"userHistory\": {\n \"currentTime\": {{faker 'number.int' max=99999}}\n },\n \"uuid\": \"{{faker 'string.uuid'}}\",\n \"views\": 1337,\n \"waitTranscoding\": {{faker 'datatype.boolean'}}\n }\n }\n ],\n \"total\": 1\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b8cf8155-aaa4-40ed-b382-3dac68cd0446", "documentation": "Get rate of my user for a video", "method": "get", "endpoint": "users/me/videos/:videoId/rating", "responses": [ { "uuid": "030d1f56-d644-4ce2-b720-58c289244377", "body": "{\n \"id\": 42,\n \"rating\": \"{{oneOf (array 'like' 'dislike' 'none')}}\"\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6293bbfc-5df4-46b6-af2f-a77dcfe49289", "documentation": "Register a user", "method": "post", "endpoint": "users/register", "responses": [ { "uuid": "9ee1da26-b458-48e4-847b-2bd373f07b63", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bc11dbae-7260-4439-9422-b27033052406", "documentation": "Logout", "method": "post", "endpoint": "users/revoke-token", "responses": [ { "uuid": "065fbc85-41e6-4eea-b570-7ec06b9058f7", "body": "", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8a1fedad-4fc5-4d58-bbce-f912a0208fd2", "documentation": "Login", "method": "post", "endpoint": "users/token", "responses": [ { "uuid": "f4619829-86bf-428b-bc74-0aae0b5a9fc0", "body": "{\n \"access_token\": \"90286a0bdf0f7315d9d3fe8dabf9e1d2be9c97d0\",\n \"expires_in\": 14399,\n \"refresh_token\": \"2e0d675df9fc96d2e4ec8a3ebbbf45eca9137bb7\",\n \"refresh_token_expires_in\": 1209600,\n \"token_type\": \"Bearer\"\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f5bc9ade-0251-4ced-8d4d-e798f4127317", "body": "", "latency": 0, "statusCode": 400, "label": "Disambiguate via `type`:\n- `invalid_client` for an unmatched `client_id`\n- `invalid_grant` for unmatched credentials\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ff3e8886-5a59-4775-8c98-913b41a91a43", "body": "", "latency": 0, "statusCode": 401, "label": "Disambiguate via `type`:\n- default value for a regular authentication failure\n- `invalid_token` for an expired token\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "092a9555-9cea-4313-b28b-f5f209db4af9", "documentation": "Delete a user", "method": "delete", "endpoint": "users/:id", "responses": [ { "uuid": "836027d0-70a7-4c1d-a6cd-1d3483dbb997", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f9d9f0b6-649b-4649-9710-5bb681693b9f", "documentation": "Get a user", "method": "get", "endpoint": "users/:id", "responses": [ { "uuid": "eda372a3-af08-4746-a054-d03342ee8e56", "body": "{\n \"account\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"followersCount\": {{faker 'number.int' max=99999}},\n \"followingCount\": {{faker 'number.int' max=99999}},\n \"host\": \"\",\n \"hostRedundancyAllowed\": {{faker 'datatype.boolean'}},\n \"id\": 42,\n \"name\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\",\n \"url\": \"\"\n },\n \"autoPlayNextVideo\": {{faker 'datatype.boolean'}},\n \"autoPlayNextVideoPlaylist\": {{faker 'datatype.boolean'}},\n \"autoPlayVideo\": {{faker 'datatype.boolean'}},\n \"blocked\": {{faker 'datatype.boolean'}},\n \"blockedReason\": \"\",\n \"createdAt\": \"\",\n \"email\": \"{{faker 'internet.email'}}\",\n \"emailVerified\": {{faker 'datatype.boolean'}},\n \"id\": {{faker 'number.int' max=99999}},\n \"lastLoginDate\": \"{{faker 'date.recent' 365}}\",\n \"noInstanceConfigWarningModal\": {{faker 'datatype.boolean'}},\n \"noWelcomeModal\": {{faker 'datatype.boolean'}},\n \"nsfwPolicy\": \"{{oneOf (array 'display' 'blur' 'do_not_list')}}\",\n \"pluginAuth\": \"\",\n \"role\": \"{{oneOf (array '0' '1' '2')}}\",\n \"roleLabel\": \"{{oneOf (array 'User' 'Moderator' 'Administrator')}}\",\n \"theme\": \"\",\n \"username\": \"chocobozzz\",\n \"videoChannels\": [\n {\n \"description\": \"Videos made with <3 by Framasoft\",\n \"displayName\": \"Videos of Framasoft\",\n \"id\": {{faker 'number.int' max=99999}},\n \"isLocal\": {{faker 'datatype.boolean'}},\n \"ownerAccount\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"uuid\": \"9c9de5e8-0a1e-484a-b099-e80766180a6d\"\n },\n \"support\": \"Please support our work on https://soutenir.framasoft.org/en/ <3\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n }\n ],\n \"videoQuota\": -1,\n \"videoQuotaDaily\": -1,\n \"webtorrentEnabled\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "As an admin/moderator, you can request a response augmented with statistics about the user's\nmoderation relations and videos usage, by using the `withStats` parameter.\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5d9fbeaf-d359-4c44-b53c-bed14660e397", "documentation": "Update a user", "method": "put", "endpoint": "users/:id", "responses": [ { "uuid": "884776f1-6e9d-40e3-98b8-d90f61799efe", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ce9bb23a-03b7-4956-b094-24c764fb79be", "documentation": "Verify a user", "method": "post", "endpoint": "users/:id/verify-email", "responses": [ { "uuid": "ab3eec61-cde2-4b1a-8782-2b5e09cafa62", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7f22f28c-65f9-4b24-99ec-ea5aeadbf52d", "body": "", "latency": 0, "statusCode": 403, "label": "invalid verification string", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "51cbd2b8-2392-453b-adc4-39c0037a92dc", "body": "", "latency": 0, "statusCode": 404, "label": "user not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4b48993b-18d2-4eea-942e-341f0c4796d7", "documentation": "List video channels", "method": "get", "endpoint": "video-channels", "responses": [ { "uuid": "5869e48c-7572-4eb5-8901-50a2d2f9a6fd", "body": "{\n \"data\": [\n {\n \"description\": \"Videos made with <3 by Framasoft\",\n \"displayName\": \"Videos of Framasoft\",\n \"id\": {{faker 'number.int' max=99999}},\n \"isLocal\": {{faker 'datatype.boolean'}},\n \"ownerAccount\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"uuid\": \"9c9de5e8-0a1e-484a-b099-e80766180a6d\"\n },\n \"support\": \"Please support our work on https://soutenir.framasoft.org/en/ <3\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n }\n ],\n \"total\": 1\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ae60f394-948a-456c-ad25-2ae06a792070", "documentation": "Create a video channel", "method": "post", "endpoint": "video-channels", "responses": [ { "uuid": "0c9ab000-f1e3-4272-ba24-f5ca9f0ffef2", "body": "{\n \"videoChannel\": {\n \"id\": {{faker 'number.int' max=99999}}\n }\n}", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fd6537d1-0c78-4145-ad72-4a72d70657a0", "documentation": "Delete a video channel", "method": "delete", "endpoint": "video-channels/:channelHandle", "responses": [ { "uuid": "2bd46b6d-a88b-4136-9060-cb5b6c9301ac", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ee60e565-6f2a-4c7e-9f59-1f3e7d13b306", "documentation": "Get a video channel", "method": "get", "endpoint": "video-channels/:channelHandle", "responses": [ { "uuid": "fe9e6e0a-4251-4fc6-b8c7-c8a422bd30a5", "body": "{\n \"description\": \"Videos made with <3 by Framasoft\",\n \"displayName\": \"Videos of Framasoft\",\n \"id\": {{faker 'number.int' max=99999}},\n \"isLocal\": {{faker 'datatype.boolean'}},\n \"ownerAccount\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"uuid\": \"9c9de5e8-0a1e-484a-b099-e80766180a6d\"\n },\n \"support\": \"Please support our work on https://soutenir.framasoft.org/en/ <3\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "739d472e-8501-4969-8c54-b9525fc40592", "documentation": "Update a video channel", "method": "put", "endpoint": "video-channels/:channelHandle", "responses": [ { "uuid": "2043d34e-c670-4b19-842c-4436085b91a0", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "611b7d48-6d0b-4941-a689-77fee1527d77", "documentation": "Delete channel avatar", "method": "delete", "endpoint": "video-channels/:channelHandle/avatar", "responses": [ { "uuid": "0d57cf25-d3ce-4f5d-a017-fb6386ba402a", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a80d99fb-3c80-4443-a1b1-f61b73597760", "documentation": "Update channel avatar", "method": "post", "endpoint": "video-channels/:channelHandle/avatar/pick", "responses": [ { "uuid": "1bd1b413-62a0-4592-bd17-b7d12fff61eb", "body": "{\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5345213b-3ae0-4b20-b69f-8eb2a3be6e00", "body": "", "latency": 0, "statusCode": 413, "label": "image file too large", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-File-Maximum-Size", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4062a8c4-1ca9-4ea3-8201-aab2f23dd6ca", "documentation": "Delete channel banner", "method": "delete", "endpoint": "video-channels/:channelHandle/banner", "responses": [ { "uuid": "4b22ccd5-0219-4b74-b1da-28006ce3cb00", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f99d94c5-531b-47da-b780-b21d3eb9292e", "documentation": "Update channel banner", "method": "post", "endpoint": "video-channels/:channelHandle/banner/pick", "responses": [ { "uuid": "c4dd90ac-2af6-4aab-b83f-86054eb37807", "body": "{\n \"banner\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "1b56f638-f84e-4263-8b53-cfc2e44ce97c", "body": "", "latency": 0, "statusCode": 413, "label": "image file too large", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-File-Maximum-Size", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d1f801f9-7028-4351-af4e-21c1444e0e62", "documentation": "List videos of a video channel", "method": "get", "endpoint": "video-channels/:channelHandle/videos", "responses": [ { "uuid": "418b7d03-5792-4be1-9bb4-8d030f41528f", "body": "{\n \"data\": [\n {\n \"account\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"displayName\": \"\",\n \"host\": \"\",\n \"id\": {{faker 'number.int' max=99999}},\n \"name\": \"\",\n \"url\": \"\"\n },\n \"blacklisted\": {{faker 'datatype.boolean'}},\n \"blacklistedReason\": \"\",\n \"category\": {\n \"id\": 15,\n \"label\": \"Science & Technology\"\n },\n \"channel\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"displayName\": \"\",\n \"host\": \"\",\n \"id\": 42,\n \"name\": \"\",\n \"url\": \"\"\n },\n \"createdAt\": \"2017-10-01T10:52:46.396Z\",\n \"description\": \"**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\\\\r\\\\n\\\\r\\\\n\\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\\\\r\\\\n*A decentralized video hosting network, based on fr...\\n\",\n \"dislikes\": 7,\n \"duration\": 1419,\n \"embedPath\": \"/videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee\",\n \"id\": {{faker 'number.int' max=99999}},\n \"isLive\": {{faker 'datatype.boolean'}},\n \"isLocal\": {{faker 'datatype.boolean'}},\n \"language\": {\n \"id\": \"en\",\n \"label\": \"English\"\n },\n \"licence\": {\n \"id\": 2,\n \"label\": \"Attribution - Share Alike\"\n },\n \"likes\": 42,\n \"name\": \"What is PeerTube?\",\n \"nsfw\": {{faker 'datatype.boolean'}},\n \"originallyPublishedAt\": \"2010-10-01T10:52:46.396Z\",\n \"previewPath\": \"/lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg\",\n \"privacy\": {\n \"id\": \"{{oneOf (array '1' '2' '3' '4')}}\",\n \"label\": \"\"\n },\n \"publishedAt\": \"2018-10-01T10:52:46.396Z\",\n \"scheduledUpdate\": {\n \"privacy\": \"{{oneOf (array '1' '2' '3' '4')}}\",\n \"updateAt\": \"{{date '2019' (now) 'yyyy-MM-dd'}}\"\n },\n \"shortUUID\": \"\",\n \"state\": {\n \"id\": \"{{oneOf (array '1' '2' '3')}}\",\n \"label\": \"\"\n },\n \"thumbnailPath\": \"/static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg\",\n \"updatedAt\": \"2021-05-04T08:01:01.502Z\",\n \"userHistory\": {\n \"currentTime\": {{faker 'number.int' max=99999}}\n },\n \"uuid\": \"{{faker 'string.uuid'}}\",\n \"views\": 1337,\n \"waitTranscoding\": {{faker 'datatype.boolean'}}\n }\n ],\n \"total\": 1\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4dbdf704-ff95-4b93-b496-9f0ad044e90c", "documentation": "List video playlists", "method": "get", "endpoint": "video-playlists", "responses": [ { "uuid": "cb19ded1-5beb-40ac-a585-daaf1ced7e6b", "body": "{\n \"data\": [\n {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"description\": \"\",\n \"displayName\": \"\",\n \"id\": 42,\n \"isLocal\": {{faker 'datatype.boolean'}},\n \"ownerAccount\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"displayName\": \"\",\n \"host\": \"\",\n \"id\": {{faker 'number.int' max=99999}},\n \"name\": \"\",\n \"url\": \"\"\n },\n \"privacy\": {\n \"id\": \"{{oneOf (array '1' '2' '3')}}\",\n \"label\": \"\"\n },\n \"shortUUID\": \"\",\n \"thumbnailPath\": \"\",\n \"type\": {\n \"id\": \"{{oneOf (array '1' '2')}}\",\n \"label\": \"\"\n },\n \"updatedAt\": \"{{faker 'date.recent' 365}}\",\n \"uuid\": \"9c9de5e8-0a1e-484a-b099-e80766180a6d\",\n \"videoChannel\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"displayName\": \"\",\n \"host\": \"\",\n \"id\": 42,\n \"name\": \"\",\n \"url\": \"\"\n },\n \"videoLength\": {{faker 'number.int' max=99999}}\n }\n ],\n \"total\": 1\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "12910e47-4102-45ed-a94e-c13ea5e06cbc", "documentation": "Create a video playlist", "method": "post", "endpoint": "video-playlists", "responses": [ { "uuid": "9ecfe86f-9216-42c4-9931-a5e6f27c86c3", "body": "{\n \"videoPlaylist\": {\n \"id\": 42,\n \"shortUUID\": \"\",\n \"uuid\": \"9c9de5e8-0a1e-484a-b099-e80766180a6d\"\n }\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "cebb5eb5-ee6a-40d4-a3fa-b2eda1f4cec8", "documentation": "List available playlist privacy policies", "method": "get", "endpoint": "video-playlists/privacies", "responses": [ { "uuid": "3a16487c-ac4f-4292-ae4a-4ee222a3e10f", "body": "[\n \"\"\n]", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d2863e03-efe9-4964-af3f-9e287bfe73dd", "documentation": "Delete a video playlist", "method": "delete", "endpoint": "video-playlists/:playlistId", "responses": [ { "uuid": "4d729e11-d0cb-4dc9-91c8-fb8a04e56119", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "710f3dae-3b10-4043-8852-5ce74d055ca6", "documentation": "Get a video playlist", "method": "get", "endpoint": "video-playlists/:playlistId", "responses": [ { "uuid": "40000179-01a9-406a-9fd8-80804a9549d8", "body": "{\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"description\": \"\",\n \"displayName\": \"\",\n \"id\": 42,\n \"isLocal\": {{faker 'datatype.boolean'}},\n \"ownerAccount\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"displayName\": \"\",\n \"host\": \"\",\n \"id\": {{faker 'number.int' max=99999}},\n \"name\": \"\",\n \"url\": \"\"\n },\n \"privacy\": {\n \"id\": \"{{oneOf (array '1' '2' '3')}}\",\n \"label\": \"\"\n },\n \"shortUUID\": \"\",\n \"thumbnailPath\": \"\",\n \"type\": {\n \"id\": \"{{oneOf (array '1' '2')}}\",\n \"label\": \"\"\n },\n \"updatedAt\": \"{{faker 'date.recent' 365}}\",\n \"uuid\": \"9c9de5e8-0a1e-484a-b099-e80766180a6d\",\n \"videoChannel\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"displayName\": \"\",\n \"host\": \"\",\n \"id\": 42,\n \"name\": \"\",\n \"url\": \"\"\n },\n \"videoLength\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6034d474-6690-4fdc-8580-fa7187224e27", "documentation": "Update a video playlist", "method": "put", "endpoint": "video-playlists/:playlistId", "responses": [ { "uuid": "5e9ade88-00b5-4b2f-ab66-dd209c6c0e4f", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0e72420b-f946-431f-83a4-631f8b4c32b4", "documentation": "List videos of a playlist", "method": "get", "endpoint": "video-playlists/:playlistId/videos", "responses": [ { "uuid": "93544f06-e549-42a7-b91a-3cb6f4a432f4", "body": "{\n \"data\": [\n {\n \"account\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"displayName\": \"\",\n \"host\": \"\",\n \"id\": {{faker 'number.int' max=99999}},\n \"name\": \"\",\n \"url\": \"\"\n },\n \"blacklisted\": {{faker 'datatype.boolean'}},\n \"blacklistedReason\": \"\",\n \"category\": {\n \"id\": 15,\n \"label\": \"Science & Technology\"\n },\n \"channel\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"displayName\": \"\",\n \"host\": \"\",\n \"id\": 42,\n \"name\": \"\",\n \"url\": \"\"\n },\n \"createdAt\": \"2017-10-01T10:52:46.396Z\",\n \"description\": \"**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\\\\r\\\\n\\\\r\\\\n\\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\\\\r\\\\n*A decentralized video hosting network, based on fr...\\n\",\n \"dislikes\": 7,\n \"duration\": 1419,\n \"embedPath\": \"/videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee\",\n \"id\": {{faker 'number.int' max=99999}},\n \"isLive\": {{faker 'datatype.boolean'}},\n \"isLocal\": {{faker 'datatype.boolean'}},\n \"language\": {\n \"id\": \"en\",\n \"label\": \"English\"\n },\n \"licence\": {\n \"id\": 2,\n \"label\": \"Attribution - Share Alike\"\n },\n \"likes\": 42,\n \"name\": \"What is PeerTube?\",\n \"nsfw\": {{faker 'datatype.boolean'}},\n \"originallyPublishedAt\": \"2010-10-01T10:52:46.396Z\",\n \"previewPath\": \"/lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg\",\n \"privacy\": {\n \"id\": \"{{oneOf (array '1' '2' '3' '4')}}\",\n \"label\": \"\"\n },\n \"publishedAt\": \"2018-10-01T10:52:46.396Z\",\n \"scheduledUpdate\": {\n \"privacy\": \"{{oneOf (array '1' '2' '3' '4')}}\",\n \"updateAt\": \"{{date '2019' (now) 'yyyy-MM-dd'}}\"\n },\n \"shortUUID\": \"\",\n \"state\": {\n \"id\": \"{{oneOf (array '1' '2' '3')}}\",\n \"label\": \"\"\n },\n \"thumbnailPath\": \"/static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg\",\n \"updatedAt\": \"2021-05-04T08:01:01.502Z\",\n \"userHistory\": {\n \"currentTime\": {{faker 'number.int' max=99999}}\n },\n \"uuid\": \"{{faker 'string.uuid'}}\",\n \"views\": 1337,\n \"waitTranscoding\": {{faker 'datatype.boolean'}}\n }\n ],\n \"total\": 1\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c96e5e97-23c0-48ab-81c0-4591ba587290", "documentation": "Add a video in a playlist", "method": "post", "endpoint": "video-playlists/:playlistId/videos", "responses": [ { "uuid": "990af90f-141f-4102-88f3-da5023a798c4", "body": "{\n \"videoPlaylistElement\": {\n \"id\": 2\n }\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "78318698-a245-4784-8b8c-d8afae0d185f", "documentation": "Reorder a playlist", "method": "post", "endpoint": "video-playlists/:playlistId/videos/reorder", "responses": [ { "uuid": "c16c799c-fdcf-44ce-8a2c-17dc946f2e49", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fc13378c-e26a-42e3-b154-d935748c4a8a", "documentation": "Delete an element from a playlist", "method": "delete", "endpoint": "video-playlists/:playlistId/videos/:playlistElementId", "responses": [ { "uuid": "ac94dd64-b09e-4db2-8bdf-ed27b5eb4b5b", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3ea26716-77fb-4d3a-bd1c-93b2d491efe1", "documentation": "Update a playlist element", "method": "put", "endpoint": "video-playlists/:playlistId/videos/:playlistElementId", "responses": [ { "uuid": "e433f1f6-83ab-4207-a4c2-83fe29f2d47a", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3a7d4e39-9e43-420d-b9d0-89b887d168e7", "documentation": "List videos", "method": "get", "endpoint": "videos", "responses": [ { "uuid": "51d8155d-170e-420a-801d-7379dce13455", "body": "{\n \"data\": [\n {\n \"account\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"displayName\": \"\",\n \"host\": \"\",\n \"id\": {{faker 'number.int' max=99999}},\n \"name\": \"\",\n \"url\": \"\"\n },\n \"blacklisted\": {{faker 'datatype.boolean'}},\n \"blacklistedReason\": \"\",\n \"category\": {\n \"id\": 15,\n \"label\": \"Science & Technology\"\n },\n \"channel\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"displayName\": \"\",\n \"host\": \"\",\n \"id\": 42,\n \"name\": \"\",\n \"url\": \"\"\n },\n \"createdAt\": \"2017-10-01T10:52:46.396Z\",\n \"description\": \"**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\\\\r\\\\n\\\\r\\\\n\\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\\\\r\\\\n*A decentralized video hosting network, based on fr...\\n\",\n \"dislikes\": 7,\n \"duration\": 1419,\n \"embedPath\": \"/videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee\",\n \"id\": {{faker 'number.int' max=99999}},\n \"isLive\": {{faker 'datatype.boolean'}},\n \"isLocal\": {{faker 'datatype.boolean'}},\n \"language\": {\n \"id\": \"en\",\n \"label\": \"English\"\n },\n \"licence\": {\n \"id\": 2,\n \"label\": \"Attribution - Share Alike\"\n },\n \"likes\": 42,\n \"name\": \"What is PeerTube?\",\n \"nsfw\": {{faker 'datatype.boolean'}},\n \"originallyPublishedAt\": \"2010-10-01T10:52:46.396Z\",\n \"previewPath\": \"/lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg\",\n \"privacy\": {\n \"id\": \"{{oneOf (array '1' '2' '3' '4')}}\",\n \"label\": \"\"\n },\n \"publishedAt\": \"2018-10-01T10:52:46.396Z\",\n \"scheduledUpdate\": {\n \"privacy\": \"{{oneOf (array '1' '2' '3' '4')}}\",\n \"updateAt\": \"{{date '2019' (now) 'yyyy-MM-dd'}}\"\n },\n \"shortUUID\": \"\",\n \"state\": {\n \"id\": \"{{oneOf (array '1' '2' '3')}}\",\n \"label\": \"\"\n },\n \"thumbnailPath\": \"/static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg\",\n \"updatedAt\": \"2021-05-04T08:01:01.502Z\",\n \"userHistory\": {\n \"currentTime\": {{faker 'number.int' max=99999}}\n },\n \"uuid\": \"{{faker 'string.uuid'}}\",\n \"views\": 1337,\n \"waitTranscoding\": {{faker 'datatype.boolean'}}\n }\n ],\n \"total\": 1\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2b4bcb34-7525-47a1-ba38-7437f47fd9ba", "documentation": "List video blocks", "method": "get", "endpoint": "videos/blacklist", "responses": [ { "uuid": "eb291e17-65ae-406a-84d8-146f62b0b7c3", "body": "{\n \"data\": [\n {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"description\": \"\",\n \"dislikes\": {{faker 'number.int' max=99999}},\n \"duration\": {{faker 'number.int' max=99999}},\n \"id\": 42,\n \"likes\": {{faker 'number.int' max=99999}},\n \"name\": \"\",\n \"nsfw\": {{faker 'datatype.boolean'}},\n \"updatedAt\": \"{{faker 'date.recent' 365}}\",\n \"uuid\": \"9c9de5e8-0a1e-484a-b099-e80766180a6d\",\n \"videoId\": {{faker 'number.int' max=99999}},\n \"views\": {{faker 'number.int' max=99999}}\n }\n ],\n \"total\": 1\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c677e35a-0135-4262-91aa-4758a8bfba4a", "documentation": "List available video categories", "method": "get", "endpoint": "videos/categories", "responses": [ { "uuid": "5b1b595c-5576-41e1-a545-5131faac4505", "body": "[\n \"\"\n]", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d59aeb37-6b68-4bbf-bce9-0d0da0023c48", "documentation": "Import a video", "method": "post", "endpoint": "videos/imports", "responses": [ { "uuid": "526f2224-5b52-442c-9eba-2244a28ea77f", "body": "{\n \"video\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"shortUUID\": \"\",\n \"uuid\": \"{{faker 'string.uuid'}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d1556244-e37b-4a47-b028-dfc1cafb9a42", "body": "", "latency": 0, "statusCode": 400, "label": "`magnetUri` or `targetUrl` or a torrent file missing", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "41bbf284-b0a0-47f6-ac67-470b0e250ca4", "body": "", "latency": 0, "statusCode": 403, "label": "video didn't pass pre-import filter", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "98b8c3bc-8955-49b7-8764-d036b02695bc", "body": "", "latency": 0, "statusCode": 409, "label": "HTTP or Torrent/magnetURI import not enabled", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f9866d9c-090d-4dd9-b8ac-eac512111d26", "documentation": "List available video languages", "method": "get", "endpoint": "videos/languages", "responses": [ { "uuid": "16f43a53-01ca-434d-8d2a-14781e669778", "body": "[\n \"\"\n]", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2231274a-7001-4da8-976b-8eef35ab6d0a", "documentation": "List available video licences", "method": "get", "endpoint": "videos/licences", "responses": [ { "uuid": "d3cb9b2f-dfb2-4926-832a-1d915e427408", "body": "[\n \"\"\n]", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d54f0b36-99b3-43e7-9f5e-efa046dcce85", "documentation": "Create a live", "method": "post", "endpoint": "videos/live", "responses": [ { "uuid": "5d35ac83-bb3b-4772-b725-e5e67f6ce741", "body": "{\n \"video\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"shortUUID\": \"\",\n \"uuid\": \"{{faker 'string.uuid'}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "532da898-23db-49a0-957f-3502f1cba836", "body": "", "latency": 0, "statusCode": 400, "label": "Disambiguate via `type`:\n- default type for a validation error\n- `live_conflicting_permanent_and_save_replay` for conflicting parameters set\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "682103e1-8a26-435c-beff-e7c7162e45f5", "body": "", "latency": 0, "statusCode": 403, "label": "Disambiguate via `type`:\n- `live_not_enabled` for a disabled live feature\n- `live_not_allowing_replay` for a disabled replay feature\n- `max_instance_lives_limit_reached` for the absolute concurrent live limit\n- `max_user_lives_limit_reached` for the user concurrent live limit\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7cbb6f5d-5f83-44b9-acc1-9a08e01131f3", "documentation": "Get information about a live", "method": "get", "endpoint": "videos/live/:id", "responses": [ { "uuid": "09e94900-eb2f-417a-a4fe-ef65599a7120", "body": "{\n \"permanentLive\": {{faker 'datatype.boolean'}},\n \"rtmpUrl\": \"\",\n \"saveReplay\": {{faker 'datatype.boolean'}},\n \"streamKey\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7f34edbd-951a-416f-9feb-f01d9299b4fc", "documentation": "Update information about a live", "method": "put", "endpoint": "videos/live/:id", "responses": [ { "uuid": "ef24eb76-7c09-45b0-988e-366c70056c9d", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "33f28703-dc84-4150-919e-b94c82f366a1", "body": "", "latency": 0, "statusCode": 400, "label": "bad parameters or trying to update a live that has already started", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4cf7be0e-18bf-4bf7-bfa4-85cb901641eb", "body": "", "latency": 0, "statusCode": 403, "label": "trying to save replay of the live but saving replay is not enabled on the instance", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "aa2c5353-5e3e-4a83-a706-12eed38f9575", "documentation": "List video ownership changes", "method": "get", "endpoint": "videos/ownership", "responses": [ { "uuid": "4e1d2cd1-60bf-4164-9ec8-6576c234680b", "body": "", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9c01ae21-acbf-464a-88cb-e21dc2a19b12", "documentation": "Accept ownership change request", "method": "post", "endpoint": "videos/ownership/:id/accept", "responses": [ { "uuid": "3da23591-ab97-460b-929e-e7ceb2146253", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c31d19a7-4585-46e9-8d70-f0e034e84e83", "body": "", "latency": 0, "statusCode": 403, "label": "cannot terminate an ownership change of another user", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "024a1204-b5a1-4be1-bc0b-41a1eefa75be", "body": "", "latency": 0, "statusCode": 404, "label": "video owneship change not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "dedbb5c1-bf9f-41fd-a365-4a480b619416", "documentation": "Refuse ownership change request", "method": "post", "endpoint": "videos/ownership/:id/refuse", "responses": [ { "uuid": "00aad3a8-6402-472a-a604-2f86cffb4821", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9b70c53b-676a-4789-9f64-6bf628589b7b", "body": "", "latency": 0, "statusCode": 403, "label": "cannot terminate an ownership change of another user", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a25629af-d73d-4294-9c79-c8077cd15482", "body": "", "latency": 0, "statusCode": 404, "label": "video owneship change not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c0459c74-1c62-4074-b7fe-8d725cf1d8ba", "documentation": "List available video privacy policies", "method": "get", "endpoint": "videos/privacies", "responses": [ { "uuid": "f30299d2-daf5-4848-8ff8-065a8d2170a9", "body": "[\n \"\"\n]", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7e0162ad-d039-42f7-9894-f016ce8645dd", "documentation": "Upload a video", "method": "post", "endpoint": "videos/upload", "responses": [ { "uuid": "a32b3c19-a7c3-4a07-be04-5d970d68b3d4", "body": "{\n \"video\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"shortUUID\": \"\",\n \"uuid\": \"{{faker 'string.uuid'}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f4cc9c2a-f614-47fa-be01-71998a477cbc", "body": "", "latency": 0, "statusCode": 403, "label": "video didn't pass upload filter", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3cd620c3-aa6b-44f3-9ef3-939a16a8c440", "body": "", "latency": 0, "statusCode": 408, "label": "upload has timed out", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a30fdcee-3985-4488-8e99-439d98c595e9", "body": "", "latency": 0, "statusCode": 413, "label": "If the response has no body, it means the reverse-proxy didn't let it through. Otherwise disambiguate via `type`:\n- `quota_reached` for quota limits wether daily or global\n", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-File-Maximum-Size", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "797d2e5a-dba6-4fe3-8c4c-f18655693c3d", "body": "", "latency": 0, "statusCode": 415, "label": "video type unsupported", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a9f142c8-0c8a-4ca5-85ee-496a5db29824", "body": "", "latency": 0, "statusCode": 422, "label": "video unreadable", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "faceb0e6-eb40-43e5-b41c-33af1771ddfc", "documentation": "Cancel the resumable upload of a video, deleting any data uploaded so far", "method": "delete", "endpoint": "videos/upload-resumable", "responses": [ { "uuid": "c154b848-a1ab-4711-84d3-97a89f2c0c99", "body": "", "latency": 0, "statusCode": 204, "label": "upload cancelled", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d65c8db6-12da-4591-8ff4-799a1af0147f", "body": "", "latency": 0, "statusCode": 404, "label": "upload not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0a14a01c-87ba-4400-b48b-8eea416e1804", "documentation": "Initialize the resumable upload of a video", "method": "post", "endpoint": "videos/upload-resumable", "responses": [ { "uuid": "c4d68bd2-35b3-4129-99db-661191106372", "body": "", "latency": 0, "statusCode": 200, "label": "file already exists, send a [`resume`](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) request instead", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "315d7f3d-f075-461e-9203-22e6bffefba0", "body": "", "latency": 0, "statusCode": 201, "label": "created", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "573765fa-0a15-40bb-bd92-92638afb0911", "body": "", "latency": 0, "statusCode": 413, "label": "Disambiguate via `type`:\n- `max_file_size_reached` for the absolute file size limit\n- `quota_reached` for quota limits whether daily or global\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5db8b27e-1802-4d3c-86a7-1c7ccf51fbbb", "body": "", "latency": 0, "statusCode": 415, "label": "video type unsupported", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f5b62cfb-3257-4b44-9f21-903200b6d0c7", "documentation": "Send chunk for the resumable upload of a video", "method": "put", "endpoint": "videos/upload-resumable", "responses": [ { "uuid": "aea30bff-579d-45a8-9c0e-2f1e81ffeabb", "body": "{\n \"video\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"shortUUID\": \"\",\n \"uuid\": \"{{faker 'string.uuid'}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "last chunk received", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f466f7ee-9367-499f-89ed-ffb0b5282c64", "body": "", "latency": 0, "statusCode": 308, "label": "resume incomplete", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "" }, { "key": "Range", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "eb88b0a5-8daf-40ba-b9c9-bf55e9a284f1", "body": "", "latency": 0, "statusCode": 403, "label": "video didn't pass upload filter", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b7551b98-1d05-40c0-b5d5-eff4aad13479", "body": "", "latency": 0, "statusCode": 404, "label": "upload not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "19293249-1302-441e-9cec-5f078796497e", "body": "", "latency": 0, "statusCode": 409, "label": "chunk doesn't match range", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e98104c1-0bae-49e9-b292-ae88a8c73ae1", "body": "", "latency": 0, "statusCode": 422, "label": "video unreadable", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4bc7072e-c96e-44ae-95df-fb5b35ec1fad", "body": "", "latency": 0, "statusCode": 429, "label": "too many concurrent requests", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6746a76f-1712-4244-b892-d2301e6ba1c0", "documentation": "Delete a video", "method": "delete", "endpoint": "videos/:id", "responses": [ { "uuid": "bed1847d-c9da-4ece-b4f7-245eb62aad24", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9fc5d8ff-7ee5-4090-98ff-6887efcc48fb", "documentation": "Get a video", "method": "get", "endpoint": "videos/:id", "responses": [ { "uuid": "814900df-93ce-4ca9-a9b8-e8e72bf88d0f", "body": "{\n \"account\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"displayName\": \"\",\n \"host\": \"\",\n \"id\": {{faker 'number.int' max=99999}},\n \"name\": \"\",\n \"url\": \"\"\n },\n \"blacklisted\": {{faker 'datatype.boolean'}},\n \"blacklistedReason\": \"\",\n \"category\": {\n \"id\": 15,\n \"label\": \"Science & Technology\"\n },\n \"channel\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"displayName\": \"\",\n \"host\": \"\",\n \"id\": 42,\n \"name\": \"\",\n \"url\": \"\"\n },\n \"createdAt\": \"2017-10-01T10:52:46.396Z\",\n \"description\": \"**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\\\\r\\\\n\\\\r\\\\n\\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\\\\r\\\\n*A decentralized video hosting network, based on fr...\\n\",\n \"dislikes\": 7,\n \"duration\": 1419,\n \"embedPath\": \"/videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee\",\n \"id\": {{faker 'number.int' max=99999}},\n \"isLive\": {{faker 'datatype.boolean'}},\n \"isLocal\": {{faker 'datatype.boolean'}},\n \"language\": {\n \"id\": \"en\",\n \"label\": \"English\"\n },\n \"licence\": {\n \"id\": 2,\n \"label\": \"Attribution - Share Alike\"\n },\n \"likes\": 42,\n \"name\": \"What is PeerTube?\",\n \"nsfw\": {{faker 'datatype.boolean'}},\n \"originallyPublishedAt\": \"2010-10-01T10:52:46.396Z\",\n \"previewPath\": \"/lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg\",\n \"privacy\": {\n \"id\": \"{{oneOf (array '1' '2' '3' '4')}}\",\n \"label\": \"\"\n },\n \"publishedAt\": \"2018-10-01T10:52:46.396Z\",\n \"scheduledUpdate\": {\n \"privacy\": \"{{oneOf (array '1' '2' '3' '4')}}\",\n \"updateAt\": \"{{date '2019' (now) 'yyyy-MM-dd'}}\"\n },\n \"shortUUID\": \"\",\n \"state\": {\n \"id\": \"{{oneOf (array '1' '2' '3')}}\",\n \"label\": \"\"\n },\n \"thumbnailPath\": \"/static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg\",\n \"updatedAt\": \"2021-05-04T08:01:01.502Z\",\n \"userHistory\": {\n \"currentTime\": {{faker 'number.int' max=99999}}\n },\n \"uuid\": \"{{faker 'string.uuid'}}\",\n \"views\": 1337,\n \"waitTranscoding\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "27d95350-9bc1-4b78-be62-ec29e7df51ff", "documentation": "Update a video", "method": "put", "endpoint": "videos/:id", "responses": [ { "uuid": "958c1b2e-9154-4b5a-84db-cf46285b5beb", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f9f7aeb2-d74b-46f6-9631-46ac3eeff82d", "documentation": "Unblock a video by its id", "method": "delete", "endpoint": "videos/:id/blacklist", "responses": [ { "uuid": "361568ca-d3d2-4340-b1c2-90fdbf1a8ce6", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "6e4ff945-da57-4d9f-922b-8628621818d6", "body": "", "latency": 0, "statusCode": 404, "label": "block not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2f14f1f1-ab32-40a4-8786-d60fc84e2b2e", "documentation": "Block a video", "method": "post", "endpoint": "videos/:id/blacklist", "responses": [ { "uuid": "9d540b20-b1c1-4e0a-8898-df6b1a3c96e6", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "732f13fe-db5c-4072-b3eb-ca72b808e708", "documentation": "List captions of a video", "method": "get", "endpoint": "videos/:id/captions", "responses": [ { "uuid": "6cb567c4-a0c8-4a01-988e-2e2f1e4bb792", "body": "{\n \"data\": [\n {\n \"captionPath\": \"\",\n \"language\": {\n \"id\": \"en\",\n \"label\": \"English\"\n }\n }\n ],\n \"total\": 1\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5305627f-5dcf-49b7-9f7b-aba9bb0bf4bf", "documentation": "Delete a video caption", "method": "delete", "endpoint": "videos/:id/captions/:captionLanguage", "responses": [ { "uuid": "23708490-649d-49cb-ab32-738340b70bba", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "cac07ce6-80b6-42ed-95d6-9c8fd8451ce7", "body": "", "latency": 0, "statusCode": 404, "label": "video or language or caption for that language not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d03a3727-2735-4e7f-9af9-843803424f96", "documentation": "Add or replace a video caption", "method": "put", "endpoint": "videos/:id/captions/:captionLanguage", "responses": [ { "uuid": "d54ce641-626b-4682-92ba-8d72f34cf9e7", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "864a88c7-41f9-40f4-8621-f5d19addc81e", "body": "", "latency": 0, "statusCode": 404, "label": "video or language not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d5a52e3b-4448-4515-a6a9-0518426abfc9", "documentation": "List threads of a video", "method": "get", "endpoint": "videos/:id/comment-threads", "responses": [ { "uuid": "00579c63-5261-483b-82ba-922cc883117a", "body": "{\n \"data\": [\n {\n \"account\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"followersCount\": {{faker 'number.int' max=99999}},\n \"followingCount\": {{faker 'number.int' max=99999}},\n \"host\": \"\",\n \"hostRedundancyAllowed\": {{faker 'datatype.boolean'}},\n \"id\": 42,\n \"name\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\",\n \"url\": \"\"\n },\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"deletedAt\": \"{{faker 'date.recent' 365}}\",\n \"id\": 42,\n \"inReplyToCommentId\": {{faker 'number.int' max=99999}},\n \"isDeleted\": {{faker 'datatype.boolean'}},\n \"text\": \"This video is wonderful!\",\n \"threadId\": 42,\n \"totalReplies\": {{faker 'number.int' max=99999}},\n \"totalRepliesFromVideoAuthor\": {{faker 'number.int' max=99999}},\n \"updatedAt\": \"{{faker 'date.recent' 365}}\",\n \"url\": \"\",\n \"videoId\": {{faker 'number.int' max=99999}}\n }\n ],\n \"total\": 1\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "64252f33-0ff6-4b3f-b5fd-4a90628d6881", "documentation": "Create a thread", "method": "post", "endpoint": "videos/:id/comment-threads", "responses": [ { "uuid": "a82f4708-cd09-41f4-b5f4-b8356e5bc6b8", "body": "{\n \"comment\": {\n \"account\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"followersCount\": {{faker 'number.int' max=99999}},\n \"followingCount\": {{faker 'number.int' max=99999}},\n \"host\": \"\",\n \"hostRedundancyAllowed\": {{faker 'datatype.boolean'}},\n \"id\": 42,\n \"name\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\",\n \"url\": \"\"\n },\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"deletedAt\": \"{{faker 'date.recent' 365}}\",\n \"id\": 42,\n \"inReplyToCommentId\": {{faker 'number.int' max=99999}},\n \"isDeleted\": {{faker 'datatype.boolean'}},\n \"text\": \"This video is wonderful!\",\n \"threadId\": 42,\n \"totalReplies\": {{faker 'number.int' max=99999}},\n \"totalRepliesFromVideoAuthor\": {{faker 'number.int' max=99999}},\n \"updatedAt\": \"{{faker 'date.recent' 365}}\",\n \"url\": \"\",\n \"videoId\": {{faker 'number.int' max=99999}}\n }\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "17ad2793-2e5b-4709-b20c-1e260b304be3", "body": "", "latency": 0, "statusCode": 404, "label": "video does not exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5f8eba51-3ad9-4be8-b2fd-b85e357ed1cc", "documentation": "Get a thread", "method": "get", "endpoint": "videos/:id/comment-threads/:threadId", "responses": [ { "uuid": "051105c7-81c9-4aff-88a3-9e0628de76e1", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5fb0c337-2864-41e4-a227-5fe12c070798", "documentation": "Delete a comment or a reply", "method": "delete", "endpoint": "videos/:id/comments/:commentId", "responses": [ { "uuid": "d45f5a99-de38-4e42-a489-d4d22a7c232f", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8800cd89-2f10-40ba-9fff-506ff93c77c6", "body": "", "latency": 0, "statusCode": 403, "label": "cannot remove comment of another user", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8a61e154-919f-4f8f-8fb2-e20907b886d3", "body": "", "latency": 0, "statusCode": 404, "label": "comment or video does not exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ffd52fe3-a87b-4205-944a-cdd4efa08149", "body": "", "latency": 0, "statusCode": 409, "label": "comment is already deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "46447581-937e-45ad-8396-afd65f204ba0", "documentation": "Reply to a thread of a video", "method": "post", "endpoint": "videos/:id/comments/:commentId", "responses": [ { "uuid": "a81ad3e9-0298-4077-82cc-da06bc682349", "body": "{\n \"comment\": {\n \"account\": {\n \"avatar\": {\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"path\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\"\n },\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"followersCount\": {{faker 'number.int' max=99999}},\n \"followingCount\": {{faker 'number.int' max=99999}},\n \"host\": \"\",\n \"hostRedundancyAllowed\": {{faker 'datatype.boolean'}},\n \"id\": 42,\n \"name\": \"\",\n \"updatedAt\": \"{{faker 'date.recent' 365}}\",\n \"url\": \"\"\n },\n \"createdAt\": \"{{faker 'date.recent' 365}}\",\n \"deletedAt\": \"{{faker 'date.recent' 365}}\",\n \"id\": 42,\n \"inReplyToCommentId\": {{faker 'number.int' max=99999}},\n \"isDeleted\": {{faker 'datatype.boolean'}},\n \"text\": \"This video is wonderful!\",\n \"threadId\": 42,\n \"totalReplies\": {{faker 'number.int' max=99999}},\n \"totalRepliesFromVideoAuthor\": {{faker 'number.int' max=99999}},\n \"updatedAt\": \"{{faker 'date.recent' 365}}\",\n \"url\": \"\",\n \"videoId\": {{faker 'number.int' max=99999}}\n }\n}", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "1f5eed7f-b68d-419c-a34e-e2e3076990a4", "body": "", "latency": 0, "statusCode": 404, "label": "thread or video does not exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f91c76ba-65f7-48c3-87c6-3d23397738e8", "documentation": "Get complete video description", "method": "get", "endpoint": "videos/:id/description", "responses": [ { "uuid": "d36a3db2-13f0-4139-bdbf-5f0d3a46a73c", "body": "\"**[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)**\\n\"", "latency": 0, "statusCode": 200, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "eb71cf85-3eca-44ce-a752-a757388fdd96", "documentation": "Request ownership change", "method": "post", "endpoint": "videos/:id/give-ownership", "responses": [ { "uuid": "a5ee462e-e3fa-479d-a7c9-3a5887d9eae9", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "08be1484-8476-4a8f-b825-f534d07e5635", "body": "", "latency": 0, "statusCode": 400, "label": "changing video ownership to a remote account is not supported yet", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e333fc99-92dc-410f-9da0-fa59304661f0", "body": "", "latency": 0, "statusCode": 404, "label": "video not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f456b58f-2eba-410d-8b43-6683753856f7", "documentation": "Like/dislike a video", "method": "put", "endpoint": "videos/:id/rate", "responses": [ { "uuid": "8caa6d0e-9334-4f0c-b4f3-905f7a70182c", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c17ca72a-2036-4734-858c-eb68cbcf3188", "body": "", "latency": 0, "statusCode": 404, "label": "video does not exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d552b646-5d0c-46fa-966c-bc3155981283", "documentation": "Add a view to a video", "method": "post", "endpoint": "videos/:id/views", "responses": [ { "uuid": "1a1598a0-ea7e-44ff-a2de-8b3a30e31ef3", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "dd1b6ee7-7bd0-4a51-9d2d-19567192c3b4", "documentation": "Set watching progress of a video", "method": "put", "endpoint": "videos/:id/watching", "responses": [ { "uuid": "7c086888-a894-4708-b724-4fa5da2252f8", "body": "", "latency": 0, "statusCode": 204, "label": "successful operation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "3280e5df-a7fd-4abe-a2cb-efee38ad2099" }, { "type": "route", "uuid": "9ababbde-8152-4604-94bb-ffb7c777b4f6" }, { "type": "route", "uuid": "c1001d88-a2f9-4dad-a5f0-70b8c8b736c5" }, { "type": "route", "uuid": "921eaca3-219e-4f43-b4c0-8b83ea1730e0" }, { "type": "route", "uuid": "ab436040-3b0a-4430-b8b4-6b8265e17bd2" }, { "type": "route", "uuid": "459540b9-c605-4d00-a5df-1b40a951da64" }, { "type": "route", "uuid": "55b32949-6ccc-44dc-bbba-a4a423656c98" }, { "type": "route", "uuid": "b8b6206f-8004-497e-931f-7bd39821a8b9" }, { "type": "route", "uuid": "41e0a179-f49b-49f7-ac55-726d717f0e90" }, { "type": "route", "uuid": "0f78345f-7ff5-4692-a7f6-39301cbf78b2" }, { "type": "route", "uuid": "98fae626-c87d-458c-bc25-445eb23642d0" }, { "type": "route", "uuid": "21d4f224-6672-4a8b-8876-ceb7312f1c6b" }, { "type": "route", "uuid": "d606afe5-aad6-4acc-a65b-f560937a79f6" }, { "type": "route", "uuid": "3fb3d5fc-cdc5-4d03-a964-e49573a90e2d" }, { "type": "route", "uuid": "814422de-8c20-4464-93d1-4026bfc40461" }, { "type": "route", "uuid": "a7a1dcb8-c1fc-462d-af3b-c642e2c23e93" }, { "type": "route", "uuid": "294b0c54-e2f8-4483-b95f-0842be1ce62f" }, { "type": "route", "uuid": "a5f88287-f28b-46ba-9c02-5fee5c718827" }, { "type": "route", "uuid": "d92efdb4-caf0-47f8-ad40-a9add197b6c3" }, { "type": "route", "uuid": "a351fc17-a22f-4641-840c-5569b1c6d285" }, { "type": "route", "uuid": "458c028c-4709-4c2e-86e3-d703c7ff06c2" }, { "type": "route", "uuid": "35f826ea-5829-4391-b428-664000152fcd" }, { "type": "route", "uuid": "19bd825b-5226-4ba5-87a9-f28e17fa7318" }, { "type": "route", "uuid": "98cf119a-c9f4-40dd-9737-d2684ca4291b" }, { "type": "route", "uuid": "e5529328-369b-4fa0-bc06-0e6ae2e9d81b" }, { "type": "route", "uuid": "b9512296-c890-476f-ba8e-36fc44c3d90e" }, { "type": "route", "uuid": "92574d74-184a-447f-b123-49b067e345ad" }, { "type": "route", "uuid": "07686d79-ff7a-42fb-81b7-fb6a17dfa2f5" }, { "type": "route", "uuid": "ad6fedd1-54ff-43d4-8deb-fde68c2d4308" }, { "type": "route", "uuid": "dadb68ed-2853-4ff8-9819-bdf148079a28" }, { "type": "route", "uuid": "03d56f82-b396-49f6-bac5-2e6e29005840" }, { "type": "route", "uuid": "e1f47f9e-ffb4-4429-b626-5c96155204b3" }, { "type": "route", "uuid": "ebc88543-9bbc-419e-8397-d0479be0ec0b" }, { "type": "route", "uuid": "11acc94c-3914-48fd-b6f7-83a6fe73ef52" }, { "type": "route", "uuid": "c9824ce3-2f68-4401-bc14-b348cc0454c6" }, { "type": "route", "uuid": "2670d89e-9f74-4d39-bc2d-5927c6fb229f" }, { "type": "route", "uuid": "8c7561ae-f6b6-4932-bc39-52fe50cfaa9e" }, { "type": "route", "uuid": "e4fcaac4-e12b-43d3-87dd-0f59296a88c0" }, { "type": "route", "uuid": "cce16584-33e8-4dde-8b88-05606d9897a7" }, { "type": "route", "uuid": "1abad6ff-d229-4577-8ad0-f65dd5f69aed" }, { "type": "route", "uuid": "41e6fbb6-79bb-4e29-9fd0-d10b6b414e5e" }, { "type": "route", "uuid": "71ada45a-2918-4c8f-95d2-63041dfdc0a4" }, { "type": "route", "uuid": "42a17133-38f1-4369-a07a-9b93d92e96c8" }, { "type": "route", "uuid": "1df8c686-588d-4fd3-ba17-db8b9ae639e7" }, { "type": "route", "uuid": "54eb18e9-263a-4d4b-8384-57186692777d" }, { "type": "route", "uuid": "0cbae5ee-30b8-4ea1-869a-553c88d8e709" }, { "type": "route", "uuid": "962b897c-a5a1-4337-9360-09c9c9607c85" }, { "type": "route", "uuid": "9829b193-f989-47fd-9d45-a74b08759d66" }, { "type": "route", "uuid": "6d692eff-8386-4c07-930d-62434caaec4d" }, { "type": "route", "uuid": "7edfb5d9-cc5d-431d-b73f-830f994c0426" }, { "type": "route", "uuid": "0ef1b315-b88f-43e9-a3dc-7bd7dc9610d3" }, { "type": "route", "uuid": "c790350a-b410-489d-8265-ab36f9e53f0f" }, { "type": "route", "uuid": "214d42b9-88dc-4cb5-a2fa-ea1ba77637f2" }, { "type": "route", "uuid": "7a69b80c-2f36-4a27-9624-d88abb2b4225" }, { "type": "route", "uuid": "89ca4373-f1af-4240-a226-ada2a624997c" }, { "type": "route", "uuid": "3b4504e3-62df-4ffc-b775-840a2fcceb6a" }, { "type": "route", "uuid": "73d97a50-cd84-4329-9871-95bf554a3114" }, { "type": "route", "uuid": "dc0ea0e2-2b69-47fc-9371-e7e415a5977f" }, { "type": "route", "uuid": "5ad9f682-ad1d-4788-8a85-f813bf327bd7" }, { "type": "route", "uuid": "b381342f-dbae-49a9-9417-16f87aad996c" }, { "type": "route", "uuid": "01a43b9c-8633-47e2-b184-e16ecc3d6908" }, { "type": "route", "uuid": "0b1afa75-3051-45fa-ae8c-25930dd9c9b3" }, { "type": "route", "uuid": "322241e0-9348-4815-abfe-18c171359222" }, { "type": "route", "uuid": "fabbbe30-2958-43ca-9219-7b9964aea83b" }, { "type": "route", "uuid": "f51906fa-bf07-4546-9bd6-f0ed5d6992e0" }, { "type": "route", "uuid": "77812696-d989-4469-899d-62811a855590" }, { "type": "route", "uuid": "ecabcf65-fc4b-44e1-a480-012b584a31d9" }, { "type": "route", "uuid": "99f43d64-d702-433c-b86c-eb99e689d296" }, { "type": "route", "uuid": "048f0da0-79a1-40b3-a380-f6374530e54a" }, { "type": "route", "uuid": "3416dff2-deff-4353-b416-95b740df60cc" }, { "type": "route", "uuid": "1e9fee5d-7271-4c32-9581-7ef3ae25aeed" }, { "type": "route", "uuid": "ce210d75-7726-4261-b5da-04337ec89abb" }, { "type": "route", "uuid": "e5c2845f-42e5-476d-8b4c-f12b5756731e" }, { "type": "route", "uuid": "774a3890-7e62-406a-aff4-8102ebdc581a" }, { "type": "route", "uuid": "bc47c555-adc9-4459-a39f-61abeaa7b5f2" }, { "type": "route", "uuid": "428c05b4-0b6f-4d56-82d4-e774a521c6bd" }, { "type": "route", "uuid": "b4159a77-127c-4df9-a162-a0aaebe7b326" }, { "type": "route", "uuid": "b8cf8155-aaa4-40ed-b382-3dac68cd0446" }, { "type": "route", "uuid": "6293bbfc-5df4-46b6-af2f-a77dcfe49289" }, { "type": "route", "uuid": "bc11dbae-7260-4439-9422-b27033052406" }, { "type": "route", "uuid": "8a1fedad-4fc5-4d58-bbce-f912a0208fd2" }, { "type": "route", "uuid": "092a9555-9cea-4313-b28b-f5f209db4af9" }, { "type": "route", "uuid": "f9d9f0b6-649b-4649-9710-5bb681693b9f" }, { "type": "route", "uuid": "5d9fbeaf-d359-4c44-b53c-bed14660e397" }, { "type": "route", "uuid": "ce9bb23a-03b7-4956-b094-24c764fb79be" }, { "type": "route", "uuid": "4b48993b-18d2-4eea-942e-341f0c4796d7" }, { "type": "route", "uuid": "ae60f394-948a-456c-ad25-2ae06a792070" }, { "type": "route", "uuid": "fd6537d1-0c78-4145-ad72-4a72d70657a0" }, { "type": "route", "uuid": "ee60e565-6f2a-4c7e-9f59-1f3e7d13b306" }, { "type": "route", "uuid": "739d472e-8501-4969-8c54-b9525fc40592" }, { "type": "route", "uuid": "611b7d48-6d0b-4941-a689-77fee1527d77" }, { "type": "route", "uuid": "a80d99fb-3c80-4443-a1b1-f61b73597760" }, { "type": "route", "uuid": "4062a8c4-1ca9-4ea3-8201-aab2f23dd6ca" }, { "type": "route", "uuid": "f99d94c5-531b-47da-b780-b21d3eb9292e" }, { "type": "route", "uuid": "d1f801f9-7028-4351-af4e-21c1444e0e62" }, { "type": "route", "uuid": "4dbdf704-ff95-4b93-b496-9f0ad044e90c" }, { "type": "route", "uuid": "12910e47-4102-45ed-a94e-c13ea5e06cbc" }, { "type": "route", "uuid": "cebb5eb5-ee6a-40d4-a3fa-b2eda1f4cec8" }, { "type": "route", "uuid": "d2863e03-efe9-4964-af3f-9e287bfe73dd" }, { "type": "route", "uuid": "710f3dae-3b10-4043-8852-5ce74d055ca6" }, { "type": "route", "uuid": "6034d474-6690-4fdc-8580-fa7187224e27" }, { "type": "route", "uuid": "0e72420b-f946-431f-83a4-631f8b4c32b4" }, { "type": "route", "uuid": "c96e5e97-23c0-48ab-81c0-4591ba587290" }, { "type": "route", "uuid": "78318698-a245-4784-8b8c-d8afae0d185f" }, { "type": "route", "uuid": "fc13378c-e26a-42e3-b154-d935748c4a8a" }, { "type": "route", "uuid": "3ea26716-77fb-4d3a-bd1c-93b2d491efe1" }, { "type": "route", "uuid": "3a7d4e39-9e43-420d-b9d0-89b887d168e7" }, { "type": "route", "uuid": "2b4bcb34-7525-47a1-ba38-7437f47fd9ba" }, { "type": "route", "uuid": "c677e35a-0135-4262-91aa-4758a8bfba4a" }, { "type": "route", "uuid": "d59aeb37-6b68-4bbf-bce9-0d0da0023c48" }, { "type": "route", "uuid": "f9866d9c-090d-4dd9-b8ac-eac512111d26" }, { "type": "route", "uuid": "2231274a-7001-4da8-976b-8eef35ab6d0a" }, { "type": "route", "uuid": "d54f0b36-99b3-43e7-9f5e-efa046dcce85" }, { "type": "route", "uuid": "7cbb6f5d-5f83-44b9-acc1-9a08e01131f3" }, { "type": "route", "uuid": "7f34edbd-951a-416f-9feb-f01d9299b4fc" }, { "type": "route", "uuid": "aa2c5353-5e3e-4a83-a706-12eed38f9575" }, { "type": "route", "uuid": "9c01ae21-acbf-464a-88cb-e21dc2a19b12" }, { "type": "route", "uuid": "dedbb5c1-bf9f-41fd-a365-4a480b619416" }, { "type": "route", "uuid": "c0459c74-1c62-4074-b7fe-8d725cf1d8ba" }, { "type": "route", "uuid": "7e0162ad-d039-42f7-9894-f016ce8645dd" }, { "type": "route", "uuid": "faceb0e6-eb40-43e5-b41c-33af1771ddfc" }, { "type": "route", "uuid": "0a14a01c-87ba-4400-b48b-8eea416e1804" }, { "type": "route", "uuid": "f5b62cfb-3257-4b44-9f21-903200b6d0c7" }, { "type": "route", "uuid": "6746a76f-1712-4244-b892-d2301e6ba1c0" }, { "type": "route", "uuid": "9fc5d8ff-7ee5-4090-98ff-6887efcc48fb" }, { "type": "route", "uuid": "27d95350-9bc1-4b78-be62-ec29e7df51ff" }, { "type": "route", "uuid": "f9f7aeb2-d74b-46f6-9631-46ac3eeff82d" }, { "type": "route", "uuid": "2f14f1f1-ab32-40a4-8786-d60fc84e2b2e" }, { "type": "route", "uuid": "732f13fe-db5c-4072-b3eb-ca72b808e708" }, { "type": "route", "uuid": "5305627f-5dcf-49b7-9f7b-aba9bb0bf4bf" }, { "type": "route", "uuid": "d03a3727-2735-4e7f-9af9-843803424f96" }, { "type": "route", "uuid": "d5a52e3b-4448-4515-a6a9-0518426abfc9" }, { "type": "route", "uuid": "64252f33-0ff6-4b3f-b5fd-4a90628d6881" }, { "type": "route", "uuid": "5f8eba51-3ad9-4be8-b2fd-b85e357ed1cc" }, { "type": "route", "uuid": "5fb0c337-2864-41e4-a227-5fe12c070798" }, { "type": "route", "uuid": "46447581-937e-45ad-8396-afd65f204ba0" }, { "type": "route", "uuid": "f91c76ba-65f7-48c3-87c6-3d23397738e8" }, { "type": "route", "uuid": "eb71cf85-3eca-44ce-a752-a757388fdd96" }, { "type": "route", "uuid": "f456b58f-2eba-410d-8b43-6683753856f7" }, { "type": "route", "uuid": "d552b646-5d0c-46fa-966c-bc3155981283" }, { "type": "route", "uuid": "dd1b6ee7-7bd0-4a51-9d2d-19567192c3b4" } ] }