Radio Resource Management Service

Get RRM algorithms

get

Returns the RRM algorithm list.

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

get

Returns the current RRM data model.

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

get

Returns the device configuration by applying all configuration layers.

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

get

Returns the device layered configuration.

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

get

Returns the device topology.

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

post

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

Authorizations

Query parameters

serialstringrequired

The device serial number

Body

enableRRMbooleanoptional

scheduleobjectoptional

enableConfigbooleanoptional

enableWifiScanbooleanoptional

boundaryinteger · int32optional

locationinteger · int32[]optional

allowedChannelsobjectoptional

allowedChannelWidthsobjectoptional

autoChannelsobjectoptional

userChannelsobjectoptional

allowedTxPowersobjectoptional

autoTxPowersobjectoptional

userTxPowersobjectoptional

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

get

Run channel optimizer and return the new channel allocation.

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

Available options:

zonestringrequired

The RF zone

dry_runbooleanoptional

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

get

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

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

Available options:

zonestringrequired

The RF zone

dry_runbooleanoptional

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

get

Returns the RRM provider info.

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

put

Run a specific RRM algorithm now.

Authorizations

Query parameters

algorithmstringrequired

The algorithm name

argsstringoptional

The algorithm arguments

venuestringrequired

The RF zone

mockbooleanoptional

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

post

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

Authorizations

Query parameters

serialstringrequired

The device serial number

Body

enableRRMbooleanoptional

scheduleobjectoptional

enableConfigbooleanoptional

enableWifiScanbooleanoptional

boundaryinteger · int32optional

locationinteger · int32[]optional

allowedChannelsobjectoptional

allowedChannelWidthsobjectoptional

autoChannelsobjectoptional

userChannelsobjectoptional

allowedTxPowersobjectoptional

autoTxPowersobjectoptional

userTxPowersobjectoptional

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

post

Set the network layer of the device configuration.

Authorizations

Body

enableRRMbooleanoptional

scheduleobjectoptional

enableConfigbooleanoptional

enableWifiScanbooleanoptional

boundaryinteger · int32optional

locationinteger · int32[]optional

allowedChannelsobjectoptional

allowedChannelWidthsobjectoptional

autoChannelsobjectoptional

userChannelsobjectoptional

allowedTxPowersobjectoptional

autoTxPowersobjectoptional

userTxPowersobjectoptional

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

post

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

Authorizations

Query parameters

zonestringrequired

The RF zone

Body

enableRRMbooleanoptional

scheduleobjectoptional

enableConfigbooleanoptional

enableWifiScanbooleanoptional

boundaryinteger · int32optional

locationinteger · int32[]optional

allowedChannelsobjectoptional

allowedChannelWidthsobjectoptional

autoChannelsobjectoptional

userChannelsobjectoptional

allowedTxPowersobjectoptional

autoTxPowersobjectoptional

userTxPowersobjectoptional

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

get

Returns the system info from the running service.

Authorizations

Query parameters

commandstring · enumrequired

Get a value

Available options:

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

post

Perform some system-wide commands.

Authorizations

Body

objectoptional

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

post

Set the device topology.

Authorizations

Body

objectoptional

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