Skip to main content

Controller search API 1.6.0

Controller discovery and controller search operations.

Base path: https://{controller_ip}/api/v1. API description version: 1.6.0.

Examples use placeholder values for passwords, tokens, UUIDs, addresses and secrets. Replace them with values from your controller before sending requests.

Section methods​

MethodPath
GET/controller_search
GET/controller_search/status
POST/controller_search

Section: Controller search.

Returns data for the controller search endpoint /controller_search.

Request example​

curl -k -X GET "https://{controller_ip}/api/v1/controller_search" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X GET "https://{controller_ip}/api/v1/controller_search" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

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

GET /controller_search/status​

Section: Controller search.

Returns data for the controller search endpoint /controller_search/status.

Request example​

curl -k -X GET "https://{controller_ip}/api/v1/controller_search/status" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X GET "https://{controller_ip}/api/v1/controller_search/status" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

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

POST /controller_search​

Section: Controller search.

Creates a record or starts an operation for the controller search endpoint /controller_search.

Request example​

curl -k -X POST "https://{controller_ip}/api/v1/controller_search" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "network": "192.168.1.0/24"
}'

Request body example​

{
  "network": "192.168.1.0/24"
}

Response command example​

curl -k -sS -X POST "https://{controller_ip}/api/v1/controller_search" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

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