API docs by Redocly

UB-EDGE Wireless Controller API (1.0.0)

Download OpenAPI specification:Download

WiFi Controller

Get Network Configuration

Responses

Response samples

Content type
application/json
{
  • "UUID": 0,
  • "Networks": [
    ],
  • "Wireless": [
    ]
}

Set Network Configuration

Request Body schema: application/json
UUID
integer <int64>

Configuration revision UUID.

Array of objects (Network)
Array of objects (WirelessNetwork)

Responses

Request samples

Content type
application/json
{
  • "UUID": 0,
  • "Networks": [
    ],
  • "Wireless": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Configuration Saved"
}

Get List of Devices (Access Points)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Device Configuration by Node ID (MAC Address)

path Parameters
node_id
required
string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

MAC address of the device.

Responses

Response samples

Content type
application/json
{
  • "uuid": 0,
  • "unit": {
    },
  • "services": {
    },
  • "country_code": "string",
  • "password": true,
  • "radios": {
    },
  • "interfaces": {
    },
  • "wwan": {
    }
}

Get Device Metrics by Node ID (MAC Address)

path Parameters
node_id
required
string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

MAC address of the device.

Responses

Response samples

Content type
application/json
{
  • "memory": {
    },
  • "uptime": 0,
  • "load_average": 0,
  • "online_status": true,
  • "cellular": [
    ]
}

Save Device Metrics by Node ID (MAC Address)

path Parameters
node_id
required
string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

MAC address of the device.

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "error": "string"
}

Get Passwords for a Network

path Parameters
network_id
required
string <uuid>

UUID of the network.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update Passwords for a Network

path Parameters
network_id
required
string <uuid>

UUID of the network.

Request Body schema: application/json
Array
id
string

Internal ID, not directly used for update, but might be present in client requests.

mac_address
string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$
password
string [ 8 .. 63 ] characters

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "Passwords updated"
}

Bind a Client to a Wireless Network

Request Body schema: application/json
mac_address
string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$
password_hash_type
string
Value: "sha256"
password_hash
string
ssid
string

Responses

Request samples

Content type
application/json
{
  • "mac_address": "string",
  • "password_hash_type": "sha256",
  • "password_hash": "string",
  • "ssid": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "accepted": true
}

Subscribe a New Device

Request Body schema: application/json
name
string
mac
string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$
serial
string
ip_address
string <ipv4>
Array of objects
object
object (DeviceSubscribeRequestDeviceInfo)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "mac": "string",
  • "serial": "string",
  • "ip_address": "192.168.0.1",
  • "radios": [
    ],
  • "setup": {
    },
  • "device": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Subscribed",
  • "key": "string"
}

Test Node Connectivity

Responses

Response samples

Content type
application/json
{
  • "message": "OK"
}

Get System Metrics

Responses

Response samples

Content type
application/json
{
  • "memory": {
    },
  • "uptime": 0,
  • "load_average": 0,
  • "online_status": true,
  • "cellular": [
    ]
}