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

GET AccessPointDetails

Represents detail information of a wireless access points. It includes basic attributes, inventory, CDP, client and other information. Note: the API resource may return Meraki devices as access points. You can filter them out by adding "type=ne(MerakiAccessPoint)" query string.

Since Product Version: 1.2

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Group Filtering?

Yes

Aggregation?

Yes

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Resource URL

/webacs/api/v4/data/AccessPointDetails

To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters

Updated

Types of fields macAddress, ipAddress, ethernetMac, clientCount_2_4GHz, clientCount, cdpNeighbor.neighborIpAddress, unifiedApInfo.apMode, unifiedApInfo.wIPSEnabled are changed and the field unifiedApInfo.poeStatus was removed in version 4.

Response Parameters

Attribute Description

adminStatus ApAdminStatusEnum

AP Admin Status

  • UNKNOWN
  • ENABLE
  • DISABLE

apType String

AP Type

autonomousAP Arrow image AutonomousAp

Contains attributes specific to autonomous AP

cdpNeighbor Arrow image ApCdpV4[]

CDP Neighbor Information

clientCount int

Total client count on both radio bands

clientCount_2_4GHz int

Client count on 2.4 GHz radio band

clientCount_5GHz int

Client count on 5 GHz radio band

coordinates Arrow image CoordinatesDTO

Coordinates relative to the upper left corner of site map in feets. This attribute is defined only if AP is added and positioned on a site map.

ethernetMac MacAddress

AP Ethernet MAC Address

ipAddress InetAddress

AP IP Address

locationHierarchy String

The map location, expressed as the entire hierarchy

macAddress MacAddress

Base Radio MAC address

mapLocation String

SNMP location

model String

AP Model

name String

AP Name

reachabilityStatus ReachabilityStateEnum

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

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

reapApVlanAclMapping Arrow image ReapApVlanAclMapping[]

The VLAN ACL Mapping configuration

serialNumber String

Serial Number

serviceDomainId Long

ID of the service domain which contains the access point

softwareVersion String

Software Version

status AlarmSeverityEnum

AP alarm status

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

type String

AP Type (CAPWAP or Autonomous)

unifiedApInfo Arrow image UnifiedApV4

Contains attributes specific to Unified (CAPWAP) AP

upTime Long

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://10.64.88.203/webacs/api/v4/data/AccessPointDetails/15

<?xml version="1.0" ?>
<queryResponse type="AccessPointDetails" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v4/data/AccessPointDetails/15" rootUrl="https://10.64.88.203/webacs/api/v4/data">
  <entity dtoType="accessPointDetailsDTO" type="AccessPointDetails" url="https://10.64.88.203/webacs/api/v4/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>
      <clientCount_5GHz>1</clientCount_5GHz>
      <mapLocation>String value</mapLocation>
      <model>String value</model>
      <name>String value</name>
      <reachabilityStatus>UNKNOWN</reachabilityStatus>
      <reapApVlanAclMappings>
        <reapApVlanAclMapping>
          <reapEgressAcl>String value</reapEgressAcl>
          <reapIngressAcl>String value</reapIngressAcl>
          <reapVlanId>1</reapVlanId>
        </reapApVlanAclMapping>
        <reapApVlanAclMapping>
          <reapEgressAcl>Another string value</reapEgressAcl>
          <reapIngressAcl>Another string value</reapIngressAcl>
          <reapVlanId>11</reapVlanId>
        </reapApVlanAclMapping>
      </reapApVlanAclMappings>
      <serialNumber>String value</serialNumber>
      <softwareVersion>String value</softwareVersion>
      <status>CRITICAL</status>
      <type>String value</type>
      <upTime>15</upTime>
      <cdpNeighbors>
        <cdpNeighbor>
          <capabilities>String value</capabilities>
          <duplex>String value</duplex>
          <interfaceSpeed>String value</interfaceSpeed>
          <localPort>String value</localPort>
          <neighborName>String value</neighborName>
          <neighborPort>String value</neighborPort>
          <platform>String value</platform>
          <neighborIpAddress>
            <address>192.168.115.243</address>
          </neighborIpAddress>
        </cdpNeighbor>
        <cdpNeighbor>
          <capabilities>Another string value</capabilities>
          <duplex>Another string value</duplex>
          <interfaceSpeed>Another string value</interfaceSpeed>
          <localPort>Another string value</localPort>
          <neighborName>Another string value</neighborName>
          <neighborPort>Another string value</neighborPort>
          <platform>Another string value</platform>
          <neighborIpAddress>
            <address>192.168.115.244</address>
          </neighborIpAddress>
        </cdpNeighbor>
      </cdpNeighbors>
      <clientCount>1</clientCount>
      <clientCount_2_4GHz>1</clientCount_2_4GHz>
      <coordinates>
        <XCoordinate>15.0</XCoordinate>
        <YCoordinate>15.0</YCoordinate>
        <ZCoordinate>15.0</ZCoordinate>
      </coordinates>
      <ethernetMac>
        <octets>000a959d6816</octets>
      </ethernetMac>
      <ipAddress>
        <address>192.168.115.243</address>
      </ipAddress>
      <locationHierarchy>String value</locationHierarchy>
      <macAddress>
        <octets>000a959d6816</octets>
      </macAddress>
      <serviceDomainId>15</serviceDomainId>
      <unifiedApInfo>
        <apCertType>15</apCertType>
        <apGroupName>String value</apGroupName>
        <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>
        <lradMeshNode>
          <meshRole>MAP</meshRole>
        </lradMeshNode>
        <maintenanceMode>true</maintenanceMode>
        <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>
        <tagInfo>
          <policyTagName>String value</policyTagName>
          <rfTagName>String value</rfTagName>
          <siteTagName>String value</siteTagName>
          <tagSource>NONE</tagSource>
        </tagInfo>
        <telnetEnabled>true</telnetEnabled>
        <tertiaryMwar>String value</tertiaryMwar>
        <vlanEnabled>true</vlanEnabled>
        <vlanNativeId>15</vlanNativeId>
        <wlanProfiles>
          <wlanProfile>
            <broadcastSsidEnabled>true</broadcastSsidEnabled>
            <profileName>String value</profileName>
            <ssid>String value</ssid>
          </wlanProfile>
          <wlanProfile>
            <broadcastSsidEnabled>false</broadcastSsidEnabled>
            <profileName>Another string value</profileName>
            <ssid>Another string value</ssid>
          </wlanProfile>
        </wlanProfiles>
        <wlanVlanMappings>
          <wlanVlanMapping>
            <ssid>String value</ssid>
            <vlanId>1</vlanId>
            <wlanId>1</wlanId>
          </wlanVlanMapping>
          <wlanVlanMapping>
            <ssid>Another string value</ssid>
            <vlanId>11</vlanId>
            <wlanId>11</wlanId>
          </wlanVlanMapping>
        </wlanVlanMappings>
        <apMode>LOCAL</apMode>
        <lastAssociatedTime>1986-07-24T00:00:00+05:30</lastAssociatedTime>
        <lastDissociatedTime>1986-07-24T00:00:00+05:30</lastDissociatedTime>
        <WIPSEnabled>true</WIPSEnabled>
      </unifiedApInfo>
    </accessPointDetailsDTO>
  </entity>
</queryResponse>

Sample JSON Payload

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

{
  "queryResponse" : {
    "@type" : "AccessPointDetails",
    "@requestUrl" : "https://10.64.88.203/webacs/api/v4/data/AccessPointDetails/15",
    "@responseType" : "getEntity",
    "@rootUrl" : "https://10.64.88.203/webacs/api/v4/data",
    "entity" : [ {
      "@dtoType" : "accessPointDetailsDTO",
      "@type" : "AccessPointDetails",
      "@url" : "https://10.64.88.203/webacs/api/v4/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" : {
              "address" : "192.168.115.243"
            },
            "neighborName" : "String value",
            "neighborPort" : "String value",
            "platform" : "String value"
          }, {
            "capabilities" : "Another string value",
            "duplex" : "Another string value",
            "interfaceSpeed" : "Another string value",
            "localPort" : "Another string value",
            "neighborIpAddress" : {
              "address" : "192.168.115.244"
            },
            "neighborName" : "Another string value",
            "neighborPort" : "Another string value",
            "platform" : "Another string value"
          } ]
        },
        "clientCount" : 1,
        "clientCount_2_4GHz" : 1,
        "clientCount_5GHz" : 1,
        "coordinates" : {
          "XCoordinate" : 15.0,
          "YCoordinate" : 15.0,
          "ZCoordinate" : 15.0
        },
        "ethernetMac" : {
          "octets" : "000a959d6816"
        },
        "ipAddress" : {
          "address" : "192.168.115.243"
        },
        "locationHierarchy" : "String value",
        "macAddress" : {
          "octets" : "000a959d6816"
        },
        "mapLocation" : "String value",
        "model" : "String value",
        "name" : "String value",
        "reachabilityStatus" : "UNKNOWN",
        "reapApVlanAclMappings" : {
          "reapApVlanAclMapping" : [ {
            "reapEgressAcl" : "String value",
            "reapIngressAcl" : "String value",
            "reapVlanId" : 1
          }, {
            "reapEgressAcl" : "Another string value",
            "reapIngressAcl" : "Another string value",
            "reapVlanId" : 11
          } ]
        },
        "serialNumber" : "String value",
        "serviceDomainId" : 15,
        "softwareVersion" : "String value",
        "status" : "CRITICAL",
        "type" : "String value",
        "unifiedApInfo" : {
          "WIPSEnabled" : true,
          "apCertType" : 15,
          "apGroupName" : "String value",
          "apMode" : "LOCAL",
          "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",
          "lastAssociatedTime" : "1986-07-23T18:30:00.000Z",
          "lastDissociatedTime" : "1986-07-23T18:30:00.000Z",
          "linkLatencyEnabled" : true,
          "lradMeshNode" : {
            "meshRole" : "MAP"
          },
          "maintenanceMode" : true,
          "poeStatusEnum" : "LOW",
          "portNumber" : 15,
          "powerInjectorState" : 15,
          "preStandardState" : 15,
          "primaryMwar" : "String value",
          "rogueDetectionEnabled" : true,
          "secondaryMwar" : "String value",
          "sshEnabled" : true,
          "statisticsTimer" : 15,
          "tagInfo" : {
            "policyTagName" : "String value",
            "rfTagName" : "String value",
            "siteTagName" : "String value",
            "tagSource" : "NONE"
          },
          "telnetEnabled" : true,
          "tertiaryMwar" : "String value",
          "vlanEnabled" : true,
          "vlanNativeId" : 15,
          "wlanProfiles" : {
            "wlanProfile" : [ {
              "broadcastSsidEnabled" : true,
              "profileName" : "String value",
              "ssid" : "String value"
            }, {
              "broadcastSsidEnabled" : false,
              "profileName" : "Another string value",
              "ssid" : "Another string value"
            } ]
          },
          "wlanVlanMappings" : {
            "wlanVlanMapping" : [ {
              "ssid" : "String value",
              "vlanId" : 1,
              "wlanId" : 1
            }, {
              "ssid" : "Another string value",
              "vlanId" : 11,
              "wlanId" : 11
            } ]
          }
        },
        "upTime" : 15
      }
    } ]
  }
}