PeerTube · Example Payload

Addvideopassword

**PeerTube >= 8.0**

Video Passwords

Addvideopassword is an example object payload from PeerTube, with 9 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummarydescriptiontagsparametersrequestBodyresponses

Example Payload

Raw ↑ 
{
  "operationId": "addVideoPassword",
  "method": "POST",
  "path": "/api/v1/videos/{id}/passwords",
  "summary": "Add a video password",
  "description": "**PeerTube >= 8.0**",
  "tags": [
    "Video Passwords"
  ],
  "parameters": [
    {
      "name": null,
      "in": null,
      "required": false,
      "description": "",
      "schema": {}
    }
  ],
  "requestBody": {
    "contentType": "application/json",
    "schema": {
      "type": "object",
      "properties": {
        "password": {
          "type": "string"
        }
      }
    },
    "example": {}
  },
  "responses": {
    "204": {
      "description": "successful operation",
      "examples": {}
    },
    "400": {
      "description": "video is not password protected",
      "examples": {}
    }
  }
}