PeerTube · Example Payload

Post_Api_V1_Server_Following

Instance Follows

Post_Api_V1_Server_Following 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_following",
  "method": "POST",
  "path": "/api/v1/server/following",
  "summary": "Follow a list of actors (PeerTube instance, channel or account)",
  "description": "",
  "tags": [
    "Instance Follows"
  ],
  "parameters": [],
  "requestBody": {
    "contentType": "application/json",
    "schema": {
      "type": "object",
      "properties": {
        "hosts": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "hostname"
          },
          "uniqueItems": true
        },
        "handles": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "uniqueItems": true
        }
      }
    },
    "example": {}
  },
  "responses": {
    "204": {
      "description": "successful operation",
      "examples": {}
    },
    "500": {
      "description": "cannot follow a non-HTTPS server",
      "examples": {}
    }
  }
}