PeerTube · Example Payload

Getmyblockedservers

Get the list of servers that the authenticated user has blocked

Account Blocklist

Getmyblockedservers 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": "getMyBlockedServers",
  "method": "GET",
  "path": "/api/v1/users/me/blocklist/servers",
  "summary": "List servers blocked by my account",
  "description": "Get the list of servers that the authenticated user has blocked",
  "tags": [
    "Account Blocklist"
  ],
  "parameters": [
    {
      "name": null,
      "in": null,
      "required": false,
      "description": "",
      "schema": {}
    },
    {
      "name": null,
      "in": null,
      "required": false,
      "description": "",
      "schema": {}
    },
    {
      "name": null,
      "in": null,
      "required": false,
      "description": "",
      "schema": {}
    },
    {
      "name": "search",
      "in": "query",
      "required": false,
      "description": "Search query string",
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": null,
  "responses": {
    "200": {
      "description": "successful operation",
      "examples": {}
    },
    "401": {
      "description": "authentication required",
      "examples": {}
    }
  }
}