PeerTube · Example Payload

Post_Api_V1_Server_Blocklist_Accounts

Server Blocklist

Post_Api_V1_Server_Blocklist_Accounts 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": "post_api_v1_server_blocklist_accounts",
  "method": "POST",
  "path": "/api/v1/server/blocklist/accounts",
  "summary": "Block an account by server",
  "description": "",
  "tags": [
    "Server Blocklist"
  ],
  "parameters": [],
  "requestBody": {
    "contentType": "application/json",
    "schema": {
      "type": "object",
      "properties": {
        "accountName": {
          "type": "string",
          "example": "chocobozzz@example.org",
          "description": "account to block, in the form `username@domain`"
        }
      },
      "required": [
        "accountName"
      ]
    },
    "example": {}
  },
  "responses": {
    "200": {
      "description": "successful operation",
      "examples": {}
    },
    "409": {
      "description": "self-blocking forbidden",
      "examples": {}
    }
  }
}