Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET AccessPointDetails

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

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

DevNet Discussions

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

Deprecated

This version has been deprecated. Please use v4.

Response Parameters

Attribute Description

adminStatus ApAdminStatusEnum

AP Admin Status

Allowed values:

  • UNKNOWN
  • ENABLE
  • DISABLE

apType String

AP Type

autonomousAP AutonomousAp

contains attributes specific to autonomous AP

cdpNeighbor ApCdp[]

CDP Neighbor Information

clientCount String

total client count on both radio bands

clientCount_2_4GHz String

client count on 2.4 GHz radio band

clientCount_5GHz int

client count on 5 GHz radio band

ethernetMac String

AP Ethernet MAC Address

ipAddress String

AP IP Address

locationHeirarchy String

The map location, expressed as the entire hierarchy

macAddress String

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

Allowed values:

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

reapApVlanAclMapping ReapApVlanAclMapping[]

The VLAN ACL Mapping configuration

serialNumber String

Serial Number

softwareVersion String

Software Version

status AlarmSeverityEnum

AP alarm status

Allowed values:

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

type String

AP Type (CAPWAP or Autonomous)

unifiedApInfo UnifiedAp

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

<?xml version="1.0" ?>
<queryResponse type="AccessPointDetails" responseType="getEntity" requestUrl="https://localhost/webacs/api/v1/data/AccessPointDetails/15" rootUrl="https://localhost/webacs/api/v1/data">
  <entity dtoType="accessPointDetailsDTO" type="AccessPointDetails" url="https://localhost/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>
      <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>
      </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>String value</neighborIpAddress>
        </cdpNeighbor>
      </cdpNeighbors>
      <clientCount>String value</clientCount>
      <clientCount_2_4GHz>String value</clientCount_2_4GHz>
      <ethernetMac>String value</ethernetMac>
      <ipAddress>String value</ipAddress>
      <locationHeirarchy>String value</locationHeirarchy>
      <macAddress>String value</macAddress>
      <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>
        <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>
        </wlanProfiles>
        <wlanVlanMappings>
          <wlanVlanMapping>
            <ssid>String value</ssid>
            <vlanId>1</vlanId>
            <wlanId>1</wlanId>
          </wlanVlanMapping>
        </wlanVlanMappings>
        <apMode>String value</apMode>
        <poeStatus>String value</poeStatus>
        <WIPSEnabled>String value</WIPSEnabled>
      </unifiedApInfo>
    </accessPointDetailsDTO>
  </entity>
</queryResponse>

Sample JSON Payload

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

{
  "queryResponse" : {
    "@type" : "AccessPointDetails",
    "@responseType" : "getEntity",
    "@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data\/AccessPointDetails\/15",
    "@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data",
    "entity" : {
      "@dtoType" : "accessPointDetailsDTO",
      "@type" : "AccessPointDetails",
      "@url" : "https : \/\/localhost\/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
        },
        "clientCount_5GHz" : 1,
        "mapLocation" : "String value",
        "model" : "String value",
        "name" : "String value",
        "reachabilityStatus" : "UNKNOWN",
        "reapApVlanAclMappings" : {
          "reapApVlanAclMapping" : {
            "reapEgressAcl" : "String value",
            "reapIngressAcl" : "String value",
            "reapVlanId" : 1
          }
        },
        "serialNumber" : "String value",
        "softwareVersion" : "String value",
        "status" : "CRITICAL",
        "type" : "String value",
        "upTime" : 15,
        "cdpNeighbors" : {
          "cdpNeighbor" : {
            "capabilities" : "String value",
            "duplex" : "String value",
            "interfaceSpeed" : "String value",
            "localPort" : "String value",
            "neighborName" : "String value",
            "neighborPort" : "String value",
            "platform" : "String value",
            "neighborIpAddress" : "String value"
          }
        },
        "clientCount" : "String value",
        "clientCount_2_4GHz" : "String value",
        "ethernetMac" : "String value",
        "ipAddress" : "String value",
        "locationHeirarchy" : "String value",
        "macAddress" : "String value",
        "unifiedApInfo" : {
          "apCertType" : 15,
          "apGroupName" : "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,
          "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,
          "telnetEnabled" : true,
          "tertiaryMwar" : "String value",
          "vlanEnabled" : true,
          "vlanNativeId" : 15,
          "wlanProfiles" : {
            "wlanProfile" : {
              "broadcastSsidEnabled" : true,
              "profileName" : "String value",
              "ssid" : "String value"
            }
          },
          "wlanVlanMappings" : {
            "wlanVlanMapping" : {
              "ssid" : "String value",
              "vlanId" : 1,
              "wlanId" : 1
            }
          },
          "apMode" : "String value",
          "poeStatus" : "String value",
          "WIPSEnabled" : "String value"
        }
      }
    }
  }
}