Skip to main content

Network API 1.5.0

Network and communication-related controller operations.

Base path: https://{controller_ip}/api/v1. API description version: 1.5.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/network
POST/network

GET /network​

Section: Network.

Returns data for the network endpoint /network.

Request example​

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

Response command example​

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

Response example​

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

POST /network​

Section: Network.

Creates a record or starts an operation for the network endpoint /network.

Request example​

curl -k -X POST "https://{controller_ip}/api/v1/network" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "dhcp": false,
  "ip": "192.168.1.10",
  "mask": "255.255.255.0",
  "gateway": "192.168.1.1"
}'

Request body example​

{
  "dhcp": false,
  "ip": "192.168.1.10",
  "mask": "255.255.255.0",
  "gateway": "192.168.1.1"
}

Response command example​

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

Response example​

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