Перейти к основному содержимому

Команды API 1.7.0

Методы API для работы с разделом «Команды».

Базовый путь: https://{IP_контроллера}/api/v1. Версия описания API: 1.7.0.

Примеры используют placeholder-значения для паролей, token, UUID, адресов и секретов. Перед выполнением запроса замените их на значения вашего контроллера.

Методы раздела​

МетодПуть
POST/commands/{command}

POST /commands/{command}​

Раздел: Команды.

Выполняет команду контроллера.

Параметры и ответы по OpenAPI
{
  "description": "Execute command",
  "parameters": [
    {
      "in": "path",
      "name": "command",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "APPLY_STAFF_PROPERTIES",
          "TEST_FLASH",
          "REBOOT",
          "RESTART_REST_API",
          "CLEAR_CONFIG"
        ]
      }
    },
    {
      "in": "query",
      "name": "serial",
      "required": false,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Command accepted",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "name",
              "value_type",
              "values"
            ],
            "properties": {
              "name": {
                "type": "string",
                "minLength": 1
              },
              "value_type": {
                "type": "string",
                "enum": [
                  "string",
                  "integer"
                ]
              },
              "values": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Bad command",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI​

Сформированы по схеме контроллера; значения полей необходимо заменить.

Пример запроса​

curl -k -X POST "https://{IP_контроллера}/api/v1/commands/{command}" \
  -H "Authorization: Bearer <token>"

Пример ответа​

{
  "name": "string",
  "value_type": "string",
  "values": [
    "string"
  ]
}