Radio Resource Management Service

Get RRM algorithms

Returns the RRM algorithm list.

GET/api/v1/algorithms

Response

200

Success

Body

application/json

namestring

descriptionstring

shortNamestring

parameterFormatstring

parameterSamplesarray of string

helperstring

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/algorithms', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "name": "text",
    "description": "text",
    "shortName": "text",
    "parameterFormat": "text",
    "parameterSamples": [
      "text"
    ],
    "helper": "text"
  }
]

Get current RRM model

Returns the current RRM data model.

GET/api/v1/currentModel

Response

200

Data model

Body

application/json

object

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/currentModel', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get device configuration

Returns the device configuration by applying all configuration layers.

GET/api/v1/getDeviceConfig

Query parameters

Response

200400

Device configuration

Body

application/json

enableRRMboolean

scheduleRRMSchedule (object)

enableConfigboolean

enableWifiScanboolean

boundaryinteger (int32)

locationarray of integer (int32)

allowedChannelsobject

allowedChannelWidthsobject

autoChannelsobject

userChannelsobject

allowedTxPowersobject

autoTxPowersobject

userTxPowersobject

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/getDeviceConfig?serial=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "enableRRM": false,
  "schedule": {
    "cron": "text",
    "algorithms": [
      {
        "name": "text"
      }
    ]
  },
  "enableConfig": false,
  "enableWifiScan": false,
  "boundary": 0,
  "location": [
    0
  ]
}

Get device layered configuration

Returns the device layered configuration.

GET/api/v1/getDeviceLayeredConfig

Response

200

Device layered configuration

Body

application/json

apConfigobject

zoneConfigobject

networkConfigDeviceConfig (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/getDeviceLayeredConfig', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "networkConfig": {
    "enableRRM": false,
    "schedule": {
      "cron": "text",
      "algorithms": [
        {
          "name": "text"
        }
      ]
    },
    "enableConfig": false,
    "enableWifiScan": false,
    "boundary": 0,
    "location": [
      0
    ]
  }
}

Get device topology

Returns the device topology.

GET/api/v1/getTopology

Response

200

Device topology

Body

application/json

DeviceTopology (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/getTopology', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Modify device AP configuration

Modify the AP layer of the network configuration for the given AP. Any existing fields absent from the request body will be preserved.

POST/api/v1/modifyDeviceApConfig

Query parameters

Body

application/json

The device AP configuration

enableRRMboolean

scheduleRRMSchedule (object)

enableConfigboolean

enableWifiScanboolean

boundaryinteger (int32)

locationarray of integer (int32)

allowedChannelsobject

allowedChannelWidthsobject

autoChannelsobject

userChannelsobject

allowedTxPowersobject

autoTxPowersobject

userTxPowersobject

Response

200400

Success

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/modifyDeviceApConfig?serial=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Optimize channel configuration

Run channel optimizer and return the new channel allocation.

GET/api/v1/optimizeChannel

Query parameters

Response

200400

Channel allocation

Body

application/json

dataobject

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/optimizeChannel?mode=random&zone=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{}

Optimize tx power configuration

Run tx power optimizer and return the new tx power allocation.

GET/api/v1/optimizeTxPower

Query parameters

Response

200400

Tx power allocation

Body

application/json

dataobject

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/optimizeTxPower?mode=random&zone=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{}

Get RRM provider info

Returns the RRM provider info.

GET/api/v1/provider

Response

200

Success

Body

application/json

vendorstring

vendorShortnamestring

versionstring

aboutstring

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/provider', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "vendor": "text",
  "vendorShortname": "text",
  "version": "text",
  "about": "text"
}

Run RRM algorithm

Run a specific RRM algorithm now.

PUT/api/v1/runRRM

Query parameters

Response

200400

Success

Body

application/json

errorstring

channelMapobject

txPowerMapobject

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/runRRM?algorithm=text&venue=text', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

200

{
  "error": "text"
}

Set device AP configuration

Set the AP layer of the network configuration for the given AP.

POST/api/v1/setDeviceApConfig

Query parameters

Body

application/json

The device AP configuration

enableRRMboolean

scheduleRRMSchedule (object)

enableConfigboolean

enableWifiScanboolean

boundaryinteger (int32)

locationarray of integer (int32)

allowedChannelsobject

allowedChannelWidthsobject

autoChannelsobject

userChannelsobject

allowedTxPowersobject

autoTxPowersobject

userTxPowersobject

Response

200400

Success

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/setDeviceApConfig?serial=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Set device network configuration

Set the network layer of the device configuration.

POST/api/v1/setDeviceNetworkConfig

Body

application/json

The device network configuration

enableRRMboolean

scheduleRRMSchedule (object)

enableConfigboolean

enableWifiScanboolean

boundaryinteger (int32)

locationarray of integer (int32)

allowedChannelsobject

allowedChannelWidthsobject

autoChannelsobject

userChannelsobject

allowedTxPowersobject

autoTxPowersobject

userTxPowersobject

Response

200400

Success

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/setDeviceNetworkConfig', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Set device zone configuration

Set the zone layer of the network configuration for the given zone.

POST/api/v1/setDeviceZoneConfig

Query parameters

Body

application/json

The device zone configuration

enableRRMboolean

scheduleRRMSchedule (object)

enableConfigboolean

enableWifiScanboolean

boundaryinteger (int32)

locationarray of integer (int32)

allowedChannelsobject

allowedChannelWidthsobject

autoChannelsobject

userChannelsobject

allowedTxPowersobject

autoTxPowersobject

userTxPowersobject

Response

200400

Success

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/setDeviceZoneConfig?zone=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Get system info

Returns the system info from the running service.

GET/api/v1/system

Query parameters

Response

200400

Success

Body

application/json

versionstring

uptimeinteger (int64)

startinteger (int64)

osstring

processorsinteger (int32)

hostnamestring

certificatesarray of Certificate (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/system?command=info', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "version": "text",
  "uptime": 0,
  "start": 0,
  "os": "text",
  "processors": 0,
  "hostname": "text",
  "certificates": [
    {
      "filename": "text",
      "expires": 0
    }
  ]
}

Run system commands

Perform some system-wide commands.

POST/api/v1/system

Body

application/json

Command details

object

Response

200400

Successful command execution

Body

application/json

object

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/system', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Set device topology

Set the device topology.

POST/api/v1/setTopology

Body

application/json

The device topology

DeviceTopology (object)

Response

200400

Success

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/setTopology', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();