Radio Resource Management Service
Returns the RRM algorithm list.
GET /api/v1/algorithms HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Success
[
{
"name": "text",
"description": "text",
"shortName": "text",
"parameterFormat": "text",
"parameterSamples": [
"text"
],
"helper": "text"
}
]
Returns the device configuration by applying all configuration layers.
The device serial number
GET /api/v1/getDeviceConfig?serial=text HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"enableRRM": true,
"schedule": {
"cron": "text",
"algorithms": [
{
"name": "text"
}
]
},
"enableConfig": true,
"enableWifiScan": true,
"boundary": 1,
"location": [
1
],
"allowedChannels": {
"ANY_ADDITIONAL_PROPERTY": [
1
]
},
"allowedChannelWidths": {
"ANY_ADDITIONAL_PROPERTY": [
1
]
},
"autoChannels": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"userChannels": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"allowedTxPowers": {
"ANY_ADDITIONAL_PROPERTY": [
1
]
},
"autoTxPowers": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"userTxPowers": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
Returns the device layered configuration.
GET /api/v1/getDeviceLayeredConfig HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Device layered configuration
{
"apConfig": {
"ANY_ADDITIONAL_PROPERTY": {
"enableRRM": true,
"schedule": {
"cron": "text",
"algorithms": [
{
"name": "text"
}
]
},
"enableConfig": true,
"enableWifiScan": true,
"boundary": 1,
"location": [
1
],
"allowedChannels": {
"ANY_ADDITIONAL_PROPERTY": [
1
]
},
"allowedChannelWidths": {
"ANY_ADDITIONAL_PROPERTY": [
1
]
},
"autoChannels": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"userChannels": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"allowedTxPowers": {
"ANY_ADDITIONAL_PROPERTY": [
1
]
},
"autoTxPowers": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"userTxPowers": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
},
"zoneConfig": {
"ANY_ADDITIONAL_PROPERTY": {
"enableRRM": true,
"schedule": {
"cron": "text",
"algorithms": [
{
"name": "text"
}
]
},
"enableConfig": true,
"enableWifiScan": true,
"boundary": 1,
"location": [
1
],
"allowedChannels": {
"ANY_ADDITIONAL_PROPERTY": [
1
]
},
"allowedChannelWidths": {
"ANY_ADDITIONAL_PROPERTY": [
1
]
},
"autoChannels": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"userChannels": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"allowedTxPowers": {
"ANY_ADDITIONAL_PROPERTY": [
1
]
},
"autoTxPowers": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"userTxPowers": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
},
"networkConfig": {
"enableRRM": true,
"schedule": {
"cron": "text",
"algorithms": [
{
"name": "text"
}
]
},
"enableConfig": true,
"enableWifiScan": true,
"boundary": 1,
"location": [
1
],
"allowedChannels": {
"ANY_ADDITIONAL_PROPERTY": [
1
]
},
"allowedChannelWidths": {
"ANY_ADDITIONAL_PROPERTY": [
1
]
},
"autoChannels": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"userChannels": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"allowedTxPowers": {
"ANY_ADDITIONAL_PROPERTY": [
1
]
},
"autoTxPowers": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"userTxPowers": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
}
Modify the AP layer of the network configuration for the given AP. Any existing fields absent from the request body will be preserved.
The device serial number
POST /api/v1/modifyDeviceApConfig?serial=text HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 481
{
"enableRRM": true,
"schedule": {
"cron": "text",
"algorithms": [
{
"name": "text"
}
]
},
"enableConfig": true,
"enableWifiScan": true,
"boundary": 1,
"location": [
1
],
"allowedChannels": {
"ANY_ADDITIONAL_PROPERTY": [
1
]
},
"allowedChannelWidths": {
"ANY_ADDITIONAL_PROPERTY": [
1
]
},
"autoChannels": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"userChannels": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"allowedTxPowers": {
"ANY_ADDITIONAL_PROPERTY": [
1
]
},
"autoTxPowers": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"userTxPowers": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
No content
Run channel optimizer and return the new channel allocation.
The assignment algorithm to use:
- random: random channel initialization
- least_used: least used channel assignment
- unmanaged_aware: unmanaged AP aware least used channel assignment
The RF zone
Do not apply changes
GET /api/v1/optimizeChannel?mode=random&zone=text HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"data": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
}
Run tx power optimizer and return the new tx power allocation.
The assignment algorithm to use:
- random: random tx power initializer
- measure_ap_client: measurement-based AP-client TPC algorithm
- measure_ap_ap: measurement-based AP-AP TPC algorithm
- location_optimal: location-based optimal TPC algorithm
The RF zone
Do not apply changes
GET /api/v1/optimizeTxPower?mode=random&zone=text HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"data": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
}
Run a specific RRM algorithm now.
The algorithm name
The algorithm arguments
The RF zone
Do not apply changes
PUT /api/v1/runRRM?algorithm=text&venue=text HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"error": "text",
"channelMap": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": 1
}
},
"txPowerMap": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
}
Set the AP layer of the network configuration for the given AP.
The device serial number
POST /api/v1/setDeviceApConfig?serial=text HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 481
{
"enableRRM": true,
"schedule": {
"cron": "text",
"algorithms": [
{
"name": "text"
}
]
},
"enableConfig": true,
"enableWifiScan": true,
"boundary": 1,
"location": [
1
],
"allowedChannels": {
"ANY_ADDITIONAL_PROPERTY": [
1
]
},
"allowedChannelWidths": {
"ANY_ADDITIONAL_PROPERTY": [
1
]
},
"autoChannels": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"userChannels": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"allowedTxPowers": {
"ANY_ADDITIONAL_PROPERTY": [
1
]
},
"autoTxPowers": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"userTxPowers": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
No content
Set the network layer of the device configuration.
POST /api/v1/setDeviceNetworkConfig HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 481
{
"enableRRM": true,
"schedule": {
"cron": "text",
"algorithms": [
{
"name": "text"
}
]
},
"enableConfig": true,
"enableWifiScan": true,
"boundary": 1,
"location": [
1
],
"allowedChannels": {
"ANY_ADDITIONAL_PROPERTY": [
1
]
},
"allowedChannelWidths": {
"ANY_ADDITIONAL_PROPERTY": [
1
]
},
"autoChannels": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"userChannels": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"allowedTxPowers": {
"ANY_ADDITIONAL_PROPERTY": [
1
]
},
"autoTxPowers": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"userTxPowers": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
No content
Set the zone layer of the network configuration for the given zone.
The RF zone
POST /api/v1/setDeviceZoneConfig?zone=text HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 481
{
"enableRRM": true,
"schedule": {
"cron": "text",
"algorithms": [
{
"name": "text"
}
]
},
"enableConfig": true,
"enableWifiScan": true,
"boundary": 1,
"location": [
1
],
"allowedChannels": {
"ANY_ADDITIONAL_PROPERTY": [
1
]
},
"allowedChannelWidths": {
"ANY_ADDITIONAL_PROPERTY": [
1
]
},
"autoChannels": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"userChannels": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"allowedTxPowers": {
"ANY_ADDITIONAL_PROPERTY": [
1
]
},
"autoTxPowers": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"userTxPowers": {
"ANY_ADDITIONAL_PROPERTY": 1
}
}
No content
Returns the system info from the running service.
Get a value
GET /api/v1/system?command=info HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"version": "text",
"uptime": 1,
"start": 1,
"os": "text",
"processors": 1,
"hostname": "text",
"certificates": [
{
"filename": "text",
"expires": 1
}
]
}
Perform some system-wide commands.
POST /api/v1/system HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2
{}
{}