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

GET AccessPointDetails

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Represents detail information of a wireless access points. It includes basic attributes, inventory, CDP, client and other information.

Since Product Version: 1.2

Resource URL

/webacs/api/v1/data/AccessPointDetails

Response Parameters

Type Attribute Name Description

ApAdminStatusEnum

adminStatus

AP Admin Status

Allowed values:

  • UNKNOWN
  • ENABLE
  • DISABLE

String

apType

AP Type

AutonomousAp

autonomousAP

contains attributes specific to autonomous AP

ApCdp[]

cdpNeighbor

CDP Neighbor Information

String

clientCount

total client count on both radio bands

String

clientCount_2_4GHz

client count on 2.4 GHz radio band

int

clientCount_5GHz

client count on 5 GHz radio band

String

ethernetMac

AP Ethernet MAC Address

String

instanceUuid

This is a uuid for this instance.

String

ipAddress

AP IP Address

String

locationHeirarchy

The map location, expressed as the entire heirarchy

String

macAddress

Base Radio MAC address

String

mapLocation

SNMP location

String

model

AP Model

String

name

AP Name

ReachabilityStateEnum

reachabilityStatus

Indicates management availability or reachability of the managed network element. It can indicate the availability or reachability of the management agent serving as a proxy for the network element

Allowed values:

  • UNKNOWN
  • REACHABLE
  • UNREACHABLE
  • AGENT_UNREACHABLE
  • AGENT_UNLOADED
  • PING_REACHABLE
  • PING_UNREACHABLE

String

serialNumber

Serial Number

String

softwareVersion

Software Version

AlarmSeverityEnum

status

AP alarm status

Allowed values:

  • CRITICAL
  • MAJOR
  • MINOR
  • WARNING
  • CLEARED
  • INFORMATION

String

type

AP Type (CAPWAP or Autonomous)

UnifiedAp

unifiedApInfo

contains attributes specific to Unified (CAPWAP) AP

Long

upTime

AP Up Time in hundredths of a second

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://172.25.123.114/webacs/api/v1/data/AccessPointDetails/15

<?xml version="1.0" ?>
<queryResponse type="AccessPointDetails" responseType="getEntity" requestUrl="https://172.25.123.114/webacs/api/v1/data/AccessPointDetails/15" rootUrl="https://172.25.123.114/webacs/api/v1/data">
  <entity dtoType="accessPointDetailsDTO" type="AccessPointDetails" url="https://172.25.123.114/webacs/api/v1/data/AccessPointDetails/15">
    <accessPointDetailsDTO displayName="String value" id="15" uuid="String value">
      <adminStatus>UNKNOWN</adminStatus>
      <apType>String value</apType>
      <autonomousAP>
        <description>String value</description>
        <reachable>true</reachable>
        <sysLocation>String value</sysLocation>
        <sysObjectId>String value</sysObjectId>
        <wgbStatus>true</wgbStatus>
      </autonomousAP>
      <cdpNeighbors>
        <cdpNeighbor>
          <capabilities>String value</capabilities>
          <duplex>String value</duplex>
          <interfaceSpeed>String value</interfaceSpeed>
          <localPort>String value</localPort>
          <neighborIpAddress>String value</neighborIpAddress>
          <neighborName>String value</neighborName>
          <neighborPort>String value</neighborPort>
          <platform>String value</platform>
        </cdpNeighbor>
      </cdpNeighbors>
      <clientCount>String value</clientCount>
      <clientCount_2_4GHz>String value</clientCount_2_4GHz>
      <clientCount_5GHz>1</clientCount_5GHz>
      <ethernetMac>String value</ethernetMac>
      <ipAddress>String value</ipAddress>
      <locationHeirarchy>String value</locationHeirarchy>
      <macAddress>String value</macAddress>
      <mapLocation>String value</mapLocation>
      <model>String value</model>
      <name>String value</name>
      <reachabilityStatus>UNKNOWN</reachabilityStatus>
      <serialNumber>String value</serialNumber>
      <softwareVersion>String value</softwareVersion>
      <status>CRITICAL</status>
      <type>String value</type>
      <unifiedApInfo>
        <apCertType>15</apCertType>
        <apGroupName>String value</apGroupName>
        <apMode>String value</apMode>
        <apStaticEnabled>15</apStaticEnabled>
        <bootVersion>String value</bootVersion>
        <capwapJoinTakenTime>15</capwapJoinTakenTime>
        <capwapUpTime>15</capwapUpTime>
        <controllerIpAddress>String value</controllerIpAddress>
        <controllerName>String value</controllerName>
        <contryCode>String value</contryCode>
        <encryptionEnabled>true</encryptionEnabled>
        <flexConnectGroupName>String value</flexConnectGroupName>
        <flexConnectMode>true</flexConnectMode>
        <iosVersion>String value</iosVersion>
        <linkLatencyEnabled>true</linkLatencyEnabled>
        <poeStatus>String value</poeStatus>
        <poeStatusEnum>LOW</poeStatusEnum>
        <portNumber>15</portNumber>
        <powerInjectorState>15</powerInjectorState>
        <preStandardState>15</preStandardState>
        <primaryMwar>String value</primaryMwar>
        <rogueDetectionEnabled>true</rogueDetectionEnabled>
        <secondaryMwar>String value</secondaryMwar>
        <sshEnabled>true</sshEnabled>
        <statisticsTimer>15</statisticsTimer>
        <telnetEnabled>true</telnetEnabled>
        <tertiaryMwar>String value</tertiaryMwar>
        <vlanEnabled>true</vlanEnabled>
        <vlanNativeId>15</vlanNativeId>
        <WIPSEnabled>String value</WIPSEnabled>
        <wlanProfiles>
          <wlanProfile>
            <broadcastSsidEnabled>true</broadcastSsidEnabled>
            <profileName>String value</profileName>
            <ssid>String value</ssid>
          </wlanProfile>
        </wlanProfiles>
        <wlanVlanMappings>
          <wlanVlanMapping>
            <ssid>String value</ssid>
            <vlanId>2</vlanId>
            <wlanId>2</wlanId>
          </wlanVlanMapping>
        </wlanVlanMappings>
      </unifiedApInfo>
      <upTime>15</upTime>
    </accessPointDetailsDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://172.25.123.114/webacs/api/v1/data/AccessPointDetails/15.json

{
  "queryResponse" : {
    "@type" : "AccessPointDetails",
    "@responseType" : "getEntity",
    "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/AccessPointDetails\/15",
    "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data",
    "entity" : {
      "@dtoType" : "accessPointDetailsDTO",
      "@type" : "AccessPointDetails",
      "@url" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/AccessPointDetails\/15",
      "accessPointDetailsDTO" : {
        "@displayName" : "String value",
        "@id" : "15",
        "@uuid" : "String value",
        "adminStatus" : "UNKNOWN",
        "apType" : "String value",
        "autonomousAP" : {
          "description" : "String value",
          "reachable" : true,
          "sysLocation" : "String value",
          "sysObjectId" : "String value",
          "wgbStatus" : true
        },
        "cdpNeighbors" : {
          "cdpNeighbor" : {
            "capabilities" : "String value",
            "duplex" : "String value",
            "interfaceSpeed" : "String value",
            "localPort" : "String value",
            "neighborIpAddress" : "String value",
            "neighborName" : "String value",
            "neighborPort" : "String value",
            "platform" : "String value"
          }
        },
        "clientCount" : "String value",
        "clientCount_2_4GHz" : "String value",
        "clientCount_5GHz" : 1,
        "ethernetMac" : "String value",
        "ipAddress" : "String value",
        "locationHeirarchy" : "String value",
        "macAddress" : "String value",
        "mapLocation" : "String value",
        "model" : "String value",
        "name" : "String value",
        "reachabilityStatus" : "UNKNOWN",
        "serialNumber" : "String value",
        "softwareVersion" : "String value",
        "status" : "CRITICAL",
        "type" : "String value",
        "unifiedApInfo" : {
          "apCertType" : 15,
          "apGroupName" : "String value",
          "apMode" : "String value",
          "apStaticEnabled" : 15,
          "bootVersion" : "String value",
          "capwapJoinTakenTime" : 15,
          "capwapUpTime" : 15,
          "controllerIpAddress" : "String value",
          "controllerName" : "String value",
          "contryCode" : "String value",
          "encryptionEnabled" : true,
          "flexConnectGroupName" : "String value",
          "flexConnectMode" : true,
          "iosVersion" : "String value",
          "linkLatencyEnabled" : true,
          "poeStatus" : "String value",
          "poeStatusEnum" : "LOW",
          "portNumber" : 15,
          "powerInjectorState" : 15,
          "preStandardState" : 15,
          "primaryMwar" : "String value",
          "rogueDetectionEnabled" : true,
          "secondaryMwar" : "String value",
          "sshEnabled" : true,
          "statisticsTimer" : 15,
          "telnetEnabled" : true,
          "tertiaryMwar" : "String value",
          "vlanEnabled" : true,
          "vlanNativeId" : 15,
          "WIPSEnabled" : "String value",
          "wlanProfiles" : {
            "wlanProfile" : {
              "broadcastSsidEnabled" : true,
              "profileName" : "String value",
              "ssid" : "String value"
            }
          },
          "wlanVlanMappings" : {
            "wlanVlanMapping" : {
              "ssid" : "String value",
              "vlanId" : 2,
              "wlanId" : 2
            }
          }
        },
        "upTime" : 15
      }
    }
  }
}