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

Поиск контроллеров API 1.5.0

Поиск контроллеров и состояние процесса поиска.

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

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

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

МетодПуть
GET/controller_search
GET/controller_search/status
POST/controller_search

Раздел: Поиск контроллеров.

Возвращает результат поиска контроллера.

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

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

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/controller_search" \
  -H "Authorization: Bearer <token>" | jq .

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

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/controller_search"
  }
}

GET /controller_search/status​

Раздел: Поиск контроллеров.

Возвращает статус поиска контроллеров.

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

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

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/controller_search/status" \
  -H "Authorization: Bearer <token>" | jq .

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

{
  "status": "ready",
  "active": true
}

POST /controller_search​

Раздел: Поиск контроллеров.

Запускает и останавливает поиск контроллеров.

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

curl -k -X POST "https://{IP_контроллера}/api/v1/controller_search" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "network": "192.168.1.0/24"
}'

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

{
  "network": "192.168.1.0/24"
}

Пример получения ответа​

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

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

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}