PeerTube · Example Payload

Get_Api_V1_Blocklist_Status

Account BlocklistServer Blocklist

Get_Api_V1_Blocklist_Status 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": "get_api_v1_blocklist_status",
  "method": "GET",
  "path": "/api/v1/blocklist/status",
  "summary": "Get block status of accounts/hosts",
  "description": "",
  "tags": [
    "Account Blocklist",
    "Server Blocklist"
  ],
  "parameters": [
    {
      "name": "accounts",
      "in": "query",
      "required": false,
      "description": "Check if these accounts are blocked",
      "schema": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    },
    {
      "name": "hosts",
      "in": "query",
      "required": false,
      "description": "Check if these hosts are blocked",
      "schema": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    }
  ],
  "requestBody": null,
  "responses": {
    "200": {
      "description": "successful operation",
      "examples": {}
    }
  }
}