PeerTube · Example Payload

Post_Api_V1_Runners_Register

API used by PeerTube runners

Runners

Post_Api_V1_Runners_Register 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_runners_register",
  "method": "POST",
  "path": "/api/v1/runners/register",
  "summary": "Register a new runner",
  "description": "API used by PeerTube runners",
  "tags": [
    "Runners"
  ],
  "parameters": [],
  "requestBody": {
    "contentType": "application/json",
    "schema": {
      "type": "object",
      "properties": {
        "registrationToken": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        }
      },
      "required": [
        "registrationToken",
        "name"
      ]
    },
    "example": {}
  },
  "responses": {
    "200": {
      "description": "successful operation",
      "examples": {}
    }
  }
}