PeerTube · Example Payload

Requestuserexport

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

User Exports

Requestuserexport 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": "requestUserExport",
  "method": "POST",
  "path": "/api/v1/users/{userId}/exports/request",
  "summary": "Request user export",
  "description": "Request an archive of user data. An email is sent when the archive is ready.",
  "tags": [
    "User Exports"
  ],
  "parameters": [
    {
      "name": null,
      "in": null,
      "required": false,
      "description": "",
      "schema": {}
    }
  ],
  "requestBody": {
    "contentType": "application/json",
    "schema": {
      "type": "object",
      "properties": {
        "withVideoFiles": {
          "type": "boolean",
          "description": "Whether to include video files in the archive"
        }
      }
    },
    "example": {}
  },
  "responses": {
    "200": {
      "description": "successful operation",
      "examples": {}
    }
  }
}