Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET_AccessPointDetails

# GET AccessPointDetails

- Jump To

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Response Formats | xml json
HTTP Methods | GET

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

## Resource URL

/webacs/api/v1/data/AccessPointDetails

Since : 1.2

## Response Parameters

Type | Attribute Name | Description
--- | --- | ---
ApAdminStatusEnum | adminStatus | AP Admin Status Allowed values: UNKNOWN ENABLE DISABLE
ApTypeEnum | apType | AP Type Allowed values: AP5212 AP5312 MIMO UNKNOWN AP1100 AP1130 AP1240 AP1200 AP1310 AP1500 AP1250 AP1505 AP3201 AP1520 AP801GN AP1140 AP801AGN AP3500I AP3500E AP1260 AP1040 AP1550 AP602I AP3500P AP802GN AP802AGN AP3600I AP3600E AP2600I AP2600E AP802HAGN AP1600I AP1600E AP702E AP702I ISR1801 ISR1802 ISR1803 ISR1811 ISR1812 ISR851 ISR857 ISR871 ISR876 ISR877 ISR878 BR1410 BR1430
AutonomousAp | autonomousAP | contains attributes specific to autonomous AP
Type | Attribute Name | Description
--- | --- | ---
String | description | SNMP sysDescr
boolean | reachable | SNMP reachability of the AP
String | sysLocation | SNMP sysLocation
String | sysObjectId | SNMP sysObjectId
boolean | wgbStatus | indicates whether the AP is in WGB mode
ApCdp | cdp | CDP Neighbor Information
Type | Attribute Name | Description
--- | --- | ---
String | capabilities | Neighbor Capabilities
String | duplex | Duplex Mode (Half Duplex or Full Duplex)
String | interfaceSpeed | Interface Speed (10Mbps, 100Mbps, 1Gbps, Auto)
String | localPort | Local Port Number
String | neighborIpAddress | Neighbor IP Address
String | neighborName | Neighbor Deice Name (ID)
String | neighborPort | Neighbor Port Number
String | platform | Neighbor Platform
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 | ipAddress | AP IP Address
String | macAddress | Base Radio MAC address
String | mapLocation | Map Location
String | model | AP Model
String | name | AP Name
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 (CAPWEP or Autonomous)
UnifiedAp | unifiedApInfo | contains attributes specific to Unified (CAPWAP) AP
Type | Attribute Name | Description
--- | --- | ---
int | apCertType | Certification Type
String | apGroupName | The AP group this AP has been assigned to.
String | apMode | AP Mode
int | apStaticEnabled | AP Static IP Enabled
String | bootVersion | Boot Version
long | capwapJoinTakenTime | CAPWAP Join Taken Time
long | capwapUpTime | CAPWAP Up Time
String | controllerIpAddress | Registered Controller IP Address
String | controllerName | Registered Controller Name
String | contryCode | Selected Contry Code
boolean | encryptionEnabled | Encryption Enabled
boolean | flexConnectMode | Flex Connect Mode Supported
String | iosVersion | IOS Version
boolean | linkLatencyEnabled | Link Latency Enabled
String | poeStatus | POE Status
int | portNumber | Port Number
int | powerInjectorState | Power Injector State
int | preStandardState | Pre-Standard 802.3af Switches
String | primaryMwar | Primary Controller
boolean | rogueDetectionEnabled | Rogue Detection
String | secondaryMwar | Secondary Controller
boolean | sshEnabled | SSH Enabled
int | statisticsTimer | Statistics Timer
boolean | telnetEnabled | Telnet Enabled
String | tertiaryMwar | Tertiary Controller
String | wIPSEnabled | Enhanced wIPS EngineEnabled
long | upTime | AP Up Time in milliseconds

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://192.168.116.207/webacs/api/v1/data/AccessPointDetails/42

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <queryResponse rootUrl="/webacs/data" requestUrl="https://192.168.116.207/webacs/api/v1/data/AccessPointDetails/42" responseType="getEntity">
        <entity url="/webacs/data/className/15" type="className" dtoType="accessPointDetailsDTO_$$_javassist_5963">
            <accessPointDetailsDTO id="15" displayName="String value">
                <adminStatus>UNKNOWN</adminStatus>
                <apType>AP5212</apType>
                <autonomousAP>
                    <description>String value</description>
                    <reachable>true</reachable>
                    <sysLocation>String value</sysLocation>
                    <sysObjectId>String value</sysObjectId>
                    <wgbStatus>true</wgbStatus>
                </autonomousAP>
                <cdp>
                    <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>
                </cdp>
                <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>
                <macAddress>String value</macAddress>
                <mapLocation>String value</mapLocation>
                <model>String value</model>
                <name>String value</name>
                <serialNumber>String value</serialNumber>
                <softwareVersion>String value</softwareVersion>
                <status>CRITICAL</status>
                <type>String value</type>
                <unifiedApInfo>
                    <apCertType>1</apCertType>
                    <apGroupName>String value</apGroupName>
                    <apMode>String value</apMode>
                    <apStaticEnabled>1</apStaticEnabled>
                    <bootVersion>String value</bootVersion>
                    <capwapJoinTakenTime>2</capwapJoinTakenTime>
                    <capwapUpTime>2</capwapUpTime>
                    <controllerIpAddress>String value</controllerIpAddress>
                    <controllerName>String value</controllerName>
                    <contryCode>String value</contryCode>
                    <encryptionEnabled>true</encryptionEnabled>
                    <flexConnectMode>true</flexConnectMode>
                    <iosVersion>String value</iosVersion>
                    <linkLatencyEnabled>true</linkLatencyEnabled>
                    <poeStatus>String value</poeStatus>
                    <portNumber>1</portNumber>
                    <powerInjectorState>1</powerInjectorState>
                    <preStandardState>1</preStandardState>
                    <primaryMwar>String value</primaryMwar>
                    <rogueDetectionEnabled>true</rogueDetectionEnabled>
                    <secondaryMwar>String value</secondaryMwar>
                    <sshEnabled>true</sshEnabled>
                    <statisticsTimer>1</statisticsTimer>
                    <telnetEnabled>true</telnetEnabled>
                    <tertiaryMwar>String value</tertiaryMwar>
                    <WIPSEnabled>String value</WIPSEnabled>
                </unifiedApInfo>
                <upTime>2</upTime>
            </accessPointDetailsDTO>
        </entity>
    </queryResponse>

## Sample JSON Payload

https://192.168.116.207/webacs/api/v1/data/AccessPointDetails/42.json

    {
      "queryResponse" : {
        "@rootUrl" : "\/webacs\/data",
        "@requestUrl" : "https : \/\/192.168.116.207\/webacs\/api\/v1\/data\/AccessPointDetails\/42",
        "@responseType" : "getEntity",
        "entity" : {
          "@url" : "\/webacs\/data\/className\/15",
          "@type" : "className",
          "@dtoType" : "accessPointDetailsDTO_$$_javassist_5963",
          "accessPointDetailsDTO" : {
            "@id" : "15",
            "@displayName" : "String value",
            "adminStatus" : "UNKNOWN",
            "apType" : "AP5212",
            "autonomousAP" : {
              "description" : "String value",
              "reachable" : true,
              "sysLocation" : "String value",
              "sysObjectId" : "String value",
              "wgbStatus" : true
            },
            "cdp" : {
              "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",
            "macAddress" : "String value",
            "mapLocation" : "String value",
            "model" : "String value",
            "name" : "String value",
            "serialNumber" : "String value",
            "softwareVersion" : "String value",
            "status" : "CRITICAL",
            "type" : "String value",
            "unifiedApInfo" : {
              "apCertType" : 1,
              "apGroupName" : "String value",
              "apMode" : "String value",
              "apStaticEnabled" : 1,
              "bootVersion" : "String value",
              "capwapJoinTakenTime" : 2,
              "capwapUpTime" : 2,
              "controllerIpAddress" : "String value",
              "controllerName" : "String value",
              "contryCode" : "String value",
              "encryptionEnabled" : true,
              "flexConnectMode" : true,
              "iosVersion" : "String value",
              "linkLatencyEnabled" : true,
              "poeStatus" : "String value",
              "portNumber" : 1,
              "powerInjectorState" : 1,
              "preStandardState" : 1,
              "primaryMwar" : "String value",
              "rogueDetectionEnabled" : true,
              "secondaryMwar" : "String value",
              "sshEnabled" : true,
              "statisticsTimer" : 1,
              "telnetEnabled" : true,
              "tertiaryMwar" : "String value",
              "WIPSEnabled" : "String value"
            },
            "upTime" : 2
          }
        }
      }
    }