Radio Resource Management Service

Get RRM algorithms

get

Returns the RRM algorithm list.

Authorizations

Responses

get

HTTPcURLJavaScriptPython

GET /api/v1/algorithms HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

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

Get current RRM model

get

Returns the current RRM data model.

Authorizations

Responses

Responseobject

get

HTTPcURLJavaScriptPython

GET /api/v1/currentModel HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

get

HTTPcURLJavaScriptPython

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

Get device layered configuration

get

Returns the device layered configuration.

Authorizations

Responses

get

HTTPcURLJavaScriptPython

GET /api/v1/getDeviceLayeredConfig HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

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

Get device topology

get

Returns the device topology.

Authorizations

Responses

Responseobject

get

HTTPcURLJavaScriptPython

GET /api/v1/getTopology HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Device topology

{}