Radio Resource Management Service

Get RRM algorithms

Returns the RRM algorithm list.

get

/api/v1/algorithms

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/algorithms' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

Success

Get current RRM model

Returns the current RRM data model.

get

/api/v1/currentModel

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/currentModel' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{}

Data model

Get device configuration

Returns the device configuration by applying all configuration layers.

get

/api/v1/getDeviceConfig

Authorizations

Query parameters

serialstringrequired

The device serial number

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/getDeviceConfig?serial=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

200

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

Device configuration

Get device layered configuration

Returns the device layered configuration.

get

/api/v1/getDeviceLayeredConfig

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/getDeviceLayeredConfig' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

Device layered configuration

Get device topology

Returns the device topology.

get

/api/v1/getTopology

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/getTopology' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{}

Device topology

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

Authorizations

Query parameters

serialstringrequired

The device serial number

Body

enableRRMboolean

scheduleobject

enableConfigboolean

enableWifiScanboolean

boundaryinteger · int32

locationinteger · int32[]

allowedChannelsobject

allowedChannelWidthsobject

autoChannelsobject

userChannelsobject

allowedTxPowersobject

autoTxPowersobject

userTxPowersobject

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/modifyDeviceApConfig?serial=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "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
    }
  }'

200

400

200

No body

Success

Optimize channel configuration

Run channel optimizer and return the new channel allocation.

get

/api/v1/optimizeChannel

Authorizations

Query parameters

modestring · enumrequired

The assignment algorithm to use:

• random: random channel initialization
• least_used: least used channel assignment
• unmanaged_aware: unmanaged AP aware least used channel assignment

Options: random, least_used, unmanaged_aware

zonestringrequired

The RF zone

dry_runboolean

Do not apply changes

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/optimizeChannel?mode=random&zone=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

200

{
  "data": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": 1
    }
  }
}

Channel allocation

Optimize tx power configuration

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

get

/api/v1/optimizeTxPower

Authorizations

Query parameters

modestring · enumrequired

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

Options: random, measure_ap_client, measure_ap_ap, location_optimal

zonestringrequired

The RF zone

dry_runboolean

Do not apply changes

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/optimizeTxPower?mode=random&zone=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

200

{
  "data": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": 1
    }
  }
}

Tx power allocation

Get RRM provider info

Returns the RRM provider info.

get

/api/v1/provider

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/provider' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

Success

Run RRM algorithm

Run a specific RRM algorithm now.

put

/api/v1/runRRM

Authorizations

Query parameters

algorithmstringrequired

The algorithm name

argsstring

The algorithm arguments

venuestringrequired

The RF zone

mockboolean

Do not apply changes

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/v1/runRRM?algorithm=text&venue=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

200

{
  "error": "text",
  "channelMap": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": 1
    }
  },
  "txPowerMap": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": 1
    }
  }
}

Success

Set device AP configuration

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

post

/api/v1/setDeviceApConfig

Authorizations

Query parameters

serialstringrequired

The device serial number

Body

enableRRMboolean

scheduleobject

enableConfigboolean

enableWifiScanboolean

boundaryinteger · int32

locationinteger · int32[]

allowedChannelsobject

allowedChannelWidthsobject

autoChannelsobject

userChannelsobject

allowedTxPowersobject

autoTxPowersobject

userTxPowersobject

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/setDeviceApConfig?serial=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "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
    }
  }'

200

400

200

No body

Success

Set device network configuration

Set the network layer of the device configuration.

post

/api/v1/setDeviceNetworkConfig

Authorizations

Body

enableRRMboolean

scheduleobject

enableConfigboolean

enableWifiScanboolean

boundaryinteger · int32

locationinteger · int32[]

allowedChannelsobject

allowedChannelWidthsobject

autoChannelsobject

userChannelsobject

allowedTxPowersobject

autoTxPowersobject

userTxPowersobject

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/setDeviceNetworkConfig' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "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
    }
  }'

200

400

200

No body

Success

Set device zone configuration

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

post

/api/v1/setDeviceZoneConfig

Authorizations

Query parameters

zonestringrequired

The RF zone

Body

enableRRMboolean

scheduleobject

enableConfigboolean

enableWifiScanboolean

boundaryinteger · int32

locationinteger · int32[]

allowedChannelsobject

allowedChannelWidthsobject

autoChannelsobject

userChannelsobject

allowedTxPowersobject

autoTxPowersobject

userTxPowersobject

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/setDeviceZoneConfig?zone=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "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
    }
  }'

200

400

200

No body

Success

Get system info

Returns the system info from the running service.

get

/api/v1/system

Authorizations

Query parameters

commandstring · enumrequired

Get a value

Options: info

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/system?command=info' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

200

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

Success

Run system commands

Perform some system-wide commands.

post

/api/v1/system

Authorizations

Body

object

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/system' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{}'

200

400

200

{}

Successful command execution

Set device topology

Set the device topology.

post

/api/v1/setTopology

Authorizations

Body

object

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/setTopology' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{}'

200

400

200

No body

Success