Radio Resource Management Service

Get RRM algorithms

Returns the RRM algorithm list.

GET/api/v1/algorithms

Response

Success

Body

namestring

descriptionstring

shortNamestring

parameterFormatstring

parameterSamplesarray of string

helperstring

Request

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

Response

[
  {
    "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

Data model

Body

object

Request

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

Device configuration

Body

enableRRMboolean

scheduleRRMSchedule (object)

enableConfigboolean

enableWifiScanboolean

boundaryinteger (int32)

locationarray of integer (int32)

allowedChannelsobject

allowedChannelWidthsobject

autoChannelsobject

userChannelsobject

allowedTxPowersobject

autoTxPowersobject

userTxPowersobject

Request

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

Response

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

Get device layered configuration

Returns the device layered configuration.

GET/api/v1/getDeviceLayeredConfig

Response

Device layered configuration

Body

apConfigobject

zoneConfigobject

networkConfigDeviceConfig (object)

Request

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

Response

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

Get device topology

Returns the device topology.

GET/api/v1/getTopology

Response

Device topology

Body

DeviceTopology (object)

Request

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

The device AP configuration

enableRRMboolean

scheduleRRMSchedule (object)

enableConfigboolean

enableWifiScanboolean

boundaryinteger (int32)

locationarray of integer (int32)

allowedChannelsobject

allowedChannelWidthsobject

autoChannelsobject

userChannelsobject

allowedTxPowersobject

autoTxPowersobject

userTxPowersobject

Response

Success

Request

const response = await fetch('/api/v1/modifyDeviceApConfig', {
    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

Channel allocation

Body

dataobject

Request

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

Response

{}

Optimize tx power configuration

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

GET/api/v1/optimizeTxPower

Query parameters

Response

Tx power allocation

Body

dataobject

Request

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

Response

{}

Get RRM provider info

Returns the RRM provider info.

GET/api/v1/provider

Response

Success

Body

vendorstring

vendorShortnamestring

versionstring

aboutstring

Request

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

Response

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

Run RRM algorithm

Run a specific RRM algorithm now.

PUT/api/v1/runRRM

Query parameters

Response

Success

Body

errorstring

channelMapobject

txPowerMapobject

Request

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

Response

{
  "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

The device AP configuration

enableRRMboolean

scheduleRRMSchedule (object)

enableConfigboolean

enableWifiScanboolean

boundaryinteger (int32)

locationarray of integer (int32)

allowedChannelsobject

allowedChannelWidthsobject

autoChannelsobject

userChannelsobject

allowedTxPowersobject

autoTxPowersobject

userTxPowersobject

Response

Success

Request

const response = await fetch('/api/v1/setDeviceApConfig', {
    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

The device network configuration

enableRRMboolean

scheduleRRMSchedule (object)

enableConfigboolean

enableWifiScanboolean

boundaryinteger (int32)

locationarray of integer (int32)

allowedChannelsobject

allowedChannelWidthsobject

autoChannelsobject

userChannelsobject

allowedTxPowersobject

autoTxPowersobject

userTxPowersobject

Response

Success

Request

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

The device zone configuration

enableRRMboolean

scheduleRRMSchedule (object)

enableConfigboolean

enableWifiScanboolean

boundaryinteger (int32)

locationarray of integer (int32)

allowedChannelsobject

allowedChannelWidthsobject

autoChannelsobject

userChannelsobject

allowedTxPowersobject

autoTxPowersobject

userTxPowersobject

Response

Success

Request

const response = await fetch('/api/v1/setDeviceZoneConfig', {
    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

Success

Body

versionstring

uptimeinteger (int64)

startinteger (int64)

osstring

processorsinteger (int32)

hostnamestring

certificatesarray of Certificate (object)

Request

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

Response

{
  "version": "text",
  "os": "text",
  "hostname": "text",
  "certificates": [
    {
      "filename": "text"
    }
  ]
}

Run system commands

Perform some system-wide commands.

POST/api/v1/system

Body

Command details

object

Response

Successful command execution

Body

object

Request

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

The device topology

DeviceTopology (object)

Response

Success

Request

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