
Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

# GET Radios

Retrieves radio interfaces of lightweight and autonomous access points. You should use RadioDetails API for retrieving only radio interfaces of lightweight APs and AutoApRadioDetails API for only radio interfaces of autonomous APs.

Since Product Version: 1.2

- Jump To

- v1
- v2
- v3
- v4

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

API version v1 is deprecated

This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.

## Resource URL

/webacs/api/v1/data/Radios

Deprecated

This version has been deprecated. Please use v4.

## Response Parameters

Attribute | Description
--- | ---
adminStatus RadioAdminStatusEnum | Administrative status of the radio interface Allowed values UNKNOWN ENABLE DISABLE
apIpAddress String | IP address of the access point
apName String | Name of the access point
apType String | Type of access point (CAPWAP or Autonomous)
baseRadioMac String | Base radio MAC address
channelNumber ChannelNumberEnum | Current operational channel number Allowed values UNKNOWN _1 _2 _3 _4 _5 _6 _7 _8 _9 _10 _11 _12 _13 _14 _20 _21 _22 _23 _24 _25 _26 _34 _36 _38 _40 _42 _44 _46 _48 _52 _56 _60 _64 _100 _104 _108 _112 _116 _120 _124 _128 _132 _136 _140 _144 _149 _153 _157 _161 _165 _169 _173
clientCount String | Client count connected to the radio interface
controllerIpAddress String | Registered controller IP address for CAPWAP AP only
ethernetMac String | MAC address of the ethernet interface on the AP
operStatus RadioOperStatusEnum | Operational status of the radio interface Allowed values DOWN UP NOTASSOCIATED UNKNOWN
powerLevel Integer | Power level of the radio
radioType String | Radio type of the interface. Allowed values: 802.11a, 802.11ac, 802.11a/n, 802.11a/n/ac, 802.11a/n/ac/ax, 802.11b/g, 802.11b/g/n, 802.11b/g/n/ax, 802.11a/b/g/n, 802.11a/b/g/n/ac, 802.11a/b/g/n/ac/ax, XOR (Monitor Mode), XOR (2.4GHz), XOR (5GHz), UWB, BLE, Unknown

## Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

### Sample XML Payload

https://10.64.88.203/webacs/api/v1/data/Radios/15

    <?xml version="1.0" ?>
    <queryResponse type="Radios" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v1/data/Radios/15" rootUrl="https://10.64.88.203/webacs/api/v1/data">
      <entity dtoType="radiosDTO" type="Radios" url="https://10.64.88.203/webacs/api/v1/data/Radios/15">
        <radiosDTO displayName="String value" id="15" uuid="String value">
          <adminStatus>UNKNOWN</adminStatus>
          <apName>String value</apName>
          <channelNumber>UNKNOWN</channelNumber>
          <operStatus>DOWN</operStatus>
          <powerLevel>15</powerLevel>
          <apIpAddress>String value</apIpAddress>
          <apType>String value</apType>
          <baseRadioMac>String value</baseRadioMac>
          <clientCount>String value</clientCount>
          <controllerIpAddress>String value</controllerIpAddress>
          <ethernetMac>String value</ethernetMac>
          <radioType>String value</radioType>
        </radiosDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v1/data/Radios/15.json

    {
      "queryResponse" : {
        "@type" : "Radios",
        "@responseType" : "getEntity",
        "@requestUrl" : "https : //10.64.88.203/webacs/api/v1/data/Radios/15",
        "@rootUrl" : "https : //10.64.88.203/webacs/api/v1/data",
        "entity" : {
          "@dtoType" : "radiosDTO",
          "@type" : "Radios",
          "@url" : "https : //10.64.88.203/webacs/api/v1/data/Radios/15",
          "radiosDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "adminStatus" : "UNKNOWN",
            "apName" : "String value",
            "channelNumber" : "UNKNOWN",
            "operStatus" : "DOWN",
            "powerLevel" : 15,
            "apIpAddress" : "String value",
            "apType" : "String value",
            "baseRadioMac" : "String value",
            "clientCount" : "String value",
            "controllerIpAddress" : "String value",
            "ethernetMac" : "String value",
            "radioType" : "String value"
          }
        }
      }
    }

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v2/data/Radios

Unmodified

This resource has not been modified since the previous API version.

Deprecated

This version has been deprecated. Please use v4.

## Response Parameters

Attribute | Description
--- | ---
adminStatus RadioAdminStatusEnum | Administrative status of the radio interface Allowed values UNKNOWN ENABLE DISABLE
apIpAddress String | IP address of the access point
apName String | Name of the access point
apType String | Type of access point (CAPWAP or Autonomous)
baseRadioMac String | Base radio MAC address
channelNumber ChannelNumberEnum | Current operational channel number Allowed values UNKNOWN _1 _2 _3 _4 _5 _6 _7 _8 _9 _10 _11 _12 _13 _14 _20 _21 _22 _23 _24 _25 _26 _34 _36 _38 _40 _42 _44 _46 _48 _52 _56 _60 _64 _100 _104 _108 _112 _116 _120 _124 _128 _132 _136 _140 _144 _149 _153 _157 _161 _165 _169 _173
clientCount String | Client count connected to the radio interface
controllerIpAddress String | Registered controller IP address for CAPWAP AP only
ethernetMac String | MAC address of the ethernet interface on the AP
operStatus RadioOperStatusEnum | Operational status of the radio interface Allowed values DOWN UP NOTASSOCIATED UNKNOWN
powerLevel Integer | Power level of the radio
radioType String | Radio type of the interface. Allowed values: 802.11a, 802.11ac, 802.11a/n, 802.11a/n/ac, 802.11a/n/ac/ax, 802.11b/g, 802.11b/g/n, 802.11b/g/n/ax, 802.11a/b/g/n, 802.11a/b/g/n/ac, 802.11a/b/g/n/ac/ax, XOR (Monitor Mode), XOR (2.4GHz), XOR (5GHz), UWB, BLE, Unknown

## Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

### Sample XML Payload

https://10.64.88.203/webacs/api/v2/data/Radios/15

    <?xml version="1.0" ?>
    <queryResponse type="Radios" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v2/data/Radios/15" rootUrl="https://10.64.88.203/webacs/api/v2/data">
      <entity dtoType="radiosDTO" type="Radios" url="https://10.64.88.203/webacs/api/v2/data/Radios/15">
        <radiosDTO displayName="String value" id="15" uuid="String value">
          <adminStatus>UNKNOWN</adminStatus>
          <apName>String value</apName>
          <channelNumber>UNKNOWN</channelNumber>
          <operStatus>DOWN</operStatus>
          <powerLevel>15</powerLevel>
          <apIpAddress>String value</apIpAddress>
          <apType>String value</apType>
          <baseRadioMac>String value</baseRadioMac>
          <clientCount>String value</clientCount>
          <controllerIpAddress>String value</controllerIpAddress>
          <ethernetMac>String value</ethernetMac>
          <radioType>String value</radioType>
        </radiosDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v2/data/Radios/15.json

    {
      "queryResponse" : {
        "@type" : "Radios",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v2/data/Radios/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v2/data",
        "entity" : [ {
          "@dtoType" : "radiosDTO",
          "@type" : "Radios",
          "@url" : "https://10.64.88.203/webacs/api/v2/data/Radios/15",
          "radiosDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "adminStatus" : "UNKNOWN",
            "apIpAddress" : "String value",
            "apName" : "String value",
            "apType" : "String value",
            "baseRadioMac" : "String value",
            "channelNumber" : "UNKNOWN",
            "clientCount" : "String value",
            "controllerIpAddress" : "String value",
            "ethernetMac" : "String value",
            "operStatus" : "DOWN",
            "powerLevel" : 15,
            "radioType" : "String value"
          }
        } ]
      }
    }

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v3/data/Radios

Unmodified

This resource has not been modified since the previous API version.

Deprecated

This version has been deprecated. Please use v4.

## Response Parameters

Attribute | Description
--- | ---
adminStatus RadioAdminStatusEnum | Administrative status of the radio interface Allowed values UNKNOWN ENABLE DISABLE
apIpAddress String | IP address of the access point
apName String | Name of the access point
apType String | Type of access point (CAPWAP or Autonomous)
baseRadioMac String | Base radio MAC address
channelNumber ChannelNumberEnum | Current operational channel number Allowed values UNKNOWN _1 _2 _3 _4 _5 _6 _7 _8 _9 _10 _11 _12 _13 _14 _20 _21 _22 _23 _24 _25 _26 _34 _36 _38 _40 _42 _44 _46 _48 _52 _56 _60 _64 _100 _104 _108 _112 _116 _120 _124 _128 _132 _136 _140 _144 _149 _153 _157 _161 _165 _169 _173
clientCount String | Client count connected to the radio interface
controllerIpAddress String | Registered controller IP address for CAPWAP AP only
ethernetMac String | MAC address of the ethernet interface on the AP
operStatus RadioOperStatusEnum | Operational status of the radio interface Allowed values DOWN UP NOTASSOCIATED UNKNOWN
powerLevel Integer | Power level of the radio
radioType String | Radio type of the interface. Allowed values: 802.11a, 802.11ac, 802.11a/n, 802.11a/n/ac, 802.11a/n/ac/ax, 802.11b/g, 802.11b/g/n, 802.11b/g/n/ax, 802.11a/b/g/n, 802.11a/b/g/n/ac, 802.11a/b/g/n/ac/ax, XOR (Monitor Mode), XOR (2.4GHz), XOR (5GHz), UWB, BLE, Unknown

## Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

### Sample XML Payload

https://10.64.88.203/webacs/api/v3/data/Radios/15

    <?xml version="1.0" ?>
    <queryResponse type="Radios" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v3/data/Radios/15" rootUrl="https://10.64.88.203/webacs/api/v3/data">
      <entity dtoType="radiosDTO" type="Radios" url="https://10.64.88.203/webacs/api/v3/data/Radios/15">
        <radiosDTO displayName="String value" id="15" uuid="String value">
          <adminStatus>UNKNOWN</adminStatus>
          <apName>String value</apName>
          <channelNumber>UNKNOWN</channelNumber>
          <operStatus>DOWN</operStatus>
          <powerLevel>15</powerLevel>
          <apIpAddress>String value</apIpAddress>
          <apType>String value</apType>
          <baseRadioMac>String value</baseRadioMac>
          <clientCount>String value</clientCount>
          <controllerIpAddress>String value</controllerIpAddress>
          <ethernetMac>String value</ethernetMac>
          <radioType>String value</radioType>
        </radiosDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v3/data/Radios/15.json

    {
      "queryResponse" : {
        "@type" : "Radios",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v3/data/Radios/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v3/data",
        "entity" : [ {
          "@dtoType" : "radiosDTO",
          "@type" : "Radios",
          "@url" : "https://10.64.88.203/webacs/api/v3/data/Radios/15",
          "radiosDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "adminStatus" : "UNKNOWN",
            "apIpAddress" : "String value",
            "apName" : "String value",
            "apType" : "String value",
            "baseRadioMac" : "String value",
            "channelNumber" : "UNKNOWN",
            "clientCount" : "String value",
            "controllerIpAddress" : "String value",
            "ethernetMac" : "String value",
            "operStatus" : "DOWN",
            "powerLevel" : 15,
            "radioType" : "String value"
          }
        } ]
      }
    }

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v4/data/Radios

Updated

Since version 4 types of attributes apType, apIpAddress, controllerIpAddress, clientCount have been changed.

## Response Parameters

Attribute | Description
--- | ---
adminStatus RadioAdminStatusEnum | Administrative status of the radio interface Allowed values UNKNOWN ENABLE DISABLE
apIpAddress InetAddress | IP address of the access point
apName String | Name of the access point
apType AccessPointTypeEnum | Type of access point Allowed values CAPWAP AUTONOMOUS
baseRadioMac MacAddress | Base radio MAC address
channelNumber ChannelNumberEnum | Current operational channel number Allowed values UNKNOWN _1 _2 _3 _4 _5 _6 _7 _8 _9 _10 _11 _12 _13 _14 _20 _21 _22 _23 _24 _25 _26 _34 _36 _38 _40 _42 _44 _46 _48 _52 _56 _60 _64 _100 _104 _108 _112 _116 _120 _124 _128 _132 _136 _140 _144 _149 _153 _157 _161 _165 _169 _173
clientCount int | Client count connected to the radio interface
controllerIpAddress InetAddress | Registered controller IP address for CAPWAP AP only
ethernetMac MacAddress | MAC address of the ethernet interface on the AP
operStatus RadioOperStatusEnum | Operational status of the radio interface Allowed values DOWN UP NOTASSOCIATED UNKNOWN
powerLevel Integer | Power level of the radio
radioType UnifiedRadioTypeEnum | Radio type ot the interface Allowed values 802.11a 802.11a/n 802.11ac 802.11a/n/ac 802.11a/n/ac/ax 802.11b/g 802.11b/g/n 802.11b/g/n/ax 802.11a/b/g/n 802.11a/b/g/n/ac 802.11a/b/g/n/ac/ax XOR (2.4GHz) XOR (5GHz) XOR (Monitor Mode) UWB BLE Unknown

## Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

### Sample XML Payload

https://10.64.88.203/webacs/api/v4/data/Radios/15

    <?xml version="1.0" ?>
    <queryResponse type="Radios" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v4/data/Radios/15" rootUrl="https://10.64.88.203/webacs/api/v4/data">
      <entity dtoType="radiosDTO" type="Radios" url="https://10.64.88.203/webacs/api/v4/data/Radios/15">
        <radiosDTO displayName="String value" id="15" uuid="String value">
          <adminStatus>UNKNOWN</adminStatus>
          <apName>String value</apName>
          <channelNumber>UNKNOWN</channelNumber>
          <operStatus>DOWN</operStatus>
          <powerLevel>15</powerLevel>
          <apIpAddress>
            <address>192.168.115.243</address>
          </apIpAddress>
          <apType>CAPWAP</apType>
          <baseRadioMac>
            <octets>000a959d6816</octets>
          </baseRadioMac>
          <clientCount>1</clientCount>
          <controllerIpAddress>
            <address>192.168.115.243</address>
          </controllerIpAddress>
          <ethernetMac>
            <octets>000a959d6816</octets>
          </ethernetMac>
          <radioType>802.11a</radioType>
        </radiosDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v4/data/Radios/15.json

    {
      "queryResponse" : {
        "@type" : "Radios",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v4/data/Radios/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v4/data",
        "entity" : [ {
          "@dtoType" : "radiosDTO",
          "@type" : "Radios",
          "@url" : "https://10.64.88.203/webacs/api/v4/data/Radios/15",
          "radiosDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "adminStatus" : "UNKNOWN",
            "apIpAddress" : {
              "address" : "192.168.115.243"
            },
            "apName" : "String value",
            "apType" : "CAPWAP",
            "baseRadioMac" : {
              "octets" : "000a959d6816"
            },
            "channelNumber" : "UNKNOWN",
            "clientCount" : 1,
            "controllerIpAddress" : {
              "address" : "192.168.115.243"
            },
            "ethernetMac" : {
              "octets" : "000a959d6816"
            },
            "operStatus" : "DOWN",
            "powerLevel" : 15,
            "radioType" : "802.11a"
          }
        } ]
      }
    }