
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

- Jump To

- v1
- v2
- v3
- v4

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

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
Attribute | Description
--- | ---
description String | SNMP sysDescr
reachable Boolean | SNMP reachability of the AP
sysLocation String | SNMP sysLocation
sysObjectId String | SNMP sysObjectId
wgbStatus Boolean | Indicates whether the AP is in WGB mode
cdpNeighbor ApCdp[] | CDP Neighbor Information
Attribute | Description
--- | ---
capabilities String | Neighbor Capabilities
duplex String | Duplex Mode (Half Duplex or Full Duplex)
interfaceSpeed String | Interface Speed (10Mbps, 100Mbps, 1Gbps, 2.5Gbps, 5Gbps, Auto)
localPort String | Local Port Number
neighborIpAddress String | Neighbor IP Address
neighborName String | Neighbor Deice Name (ID)
neighborPort String | Neighbor Port Number
platform String | Neighbor Platform
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
Attribute | Description
--- | ---
reapEgressAcl String | Name of the Egress Access Control List for the vlan-acl mapping.
reapIngressAcl String | Name of the Ingress Access Control List for the vlan-acl mapping.
reapVlanId int | The VLAN ID mapped to the Acl for the Access Point. The VLAN ID range is 1 to 4095.
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
Attribute | Description
--- | ---
apCertType Integer | Certification Type
apGroupName String | The AP group this AP has been assigned to.
apMode String | AP Mode
apStaticEnabled Integer | AP Static IP Enabled
bootVersion String | Boot Version
capwapJoinTakenTime Long | CAPWAP Join Taken Time. Represents the time taken in hundredths of a second for the AP to join the controller. This could be a significant value in Mesh environments.
capwapUpTime Long | CAPWAP Up Time. Represents the time in hundredths of a second since the last time the AP joined the controller.
controllerIpAddress String | Registered Controller IP Address
controllerName String | Registered Controller Name
contryCode String | Identifies the country in which the AP is operating. This value is the 3 letter country code.
encryptionEnabled Boolean | Encryption Enabled
flexConnectGroupName String | FlexConnect group
flexConnectMode Boolean | Flex Connect Mode Supported
iosVersion String | IOS Version
linkLatencyEnabled Boolean | Link Latency Enabled
lradMeshNode LradMeshNodeDetails | The mesh node
Attribute | Description
--- | ---
meshRole MeshRoleEnum | The role of mesh AP which has joined the controller. Allowed values MAP RAP
maintenanceMode Boolean | Indicates the maintenance mode status. The maintenance mode is on if true and is off if false
poeStatus String | POE Status
poeStatusEnum PoeStatusEnum | Value of POE Status Allowed values LOW FIFTEENDOTFOUR SIXTEENDOTEIGHT NORMAL EXTERNAL TWENTYFIVEDOTFIVE MIXEDMODE
portNumber Integer | Port Number
powerInjectorState Integer | Power Injector State
preStandardState Integer | Pre-Standard 802.3af Switches
primaryMwar String | Primary Controller
rogueDetectionEnabled Boolean | Rogue Detection
secondaryMwar String | Secondary Controller
sshEnabled Boolean | SSH Enabled
statisticsTimer Integer | The time interval in secs after which bsnAPDot11Counters Stats is sent from AP to Switch. If not configured this value is 0 which means never send the stats.
tagInfo UnifiedApTagInfo | Tag info
Attribute | Description
--- | ---
policyTagName String | AP policy tag name
rfTagName String | AP RF tag name
siteTagName String | AP site tag name
tagSource UnifiedApTagSourceEnum | AP tag source Allowed values NONE STATIC FILTER AP DEFAULT LOCATION
telnetEnabled Boolean | Telnet Enabled
tertiaryMwar String | Tertiary Controller
vlanEnabled Boolean | VLAN enabled on FlexConnect access point
vlanNativeId Integer | VLAN native Id
wIPSEnabled String | Enhanced wIPS EngineEnabled
wlanProfiles WlanProfile[] | WLANs broadcasted by access point
Attribute | Description
--- | ---
broadcastSsidEnabled boolean | Is SSID broadcasting enabled?
profileName String | WLAN configuration profile name
ssid String | WLAN configuration SSID
wlanVlanMapping UnifiedApWlanVlanMapping[] | WLAN-VLAN Mappings
Attribute | Description
--- | ---
ssid String | WLAN SSID
vlanId int | VLAN id
wlanId int | WLAN id
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/v1/data/AccessPointDetails/15

    <?xml version="1.0" ?>
    <queryResponse type="AccessPointDetails" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v1/data/AccessPointDetails/15" rootUrl="https://10.64.88.203/webacs/api/v1/data">
      <entity dtoType="accessPointDetailsDTO" type="AccessPointDetails" url="https://10.64.88.203/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>
            <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>String value</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>Another 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>
            <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>String value</apMode>
            <poeStatus>String value</poeStatus>
            <WIPSEnabled>String value</WIPSEnabled>
          </unifiedApInfo>
        </accessPointDetailsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

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

    {
      "queryResponse" : {
        "@type" : "AccessPointDetails",
        "@responseType" : "getEntity",
        "@requestUrl" : "https : //10.64.88.203/webacs/api/v1/data/AccessPointDetails/15",
        "@rootUrl" : "https : //10.64.88.203/webacs/api/v1/data",
        "entity" : {
          "@dtoType" : "accessPointDetailsDTO",
          "@type" : "AccessPointDetails",
          "@url" : "https : //10.64.88.203/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
              },
              {
                "reapEgressAcl" : "Another string value",
                "reapIngressAcl" : "Another string value",
                "reapVlanId" : 11
              }]
            },
            "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"
              },
              {
                "capabilities" : "Another string value",
                "duplex" : "Another string value",
                "interfaceSpeed" : "Another string value",
                "localPort" : "Another string value",
                "neighborName" : "Another string value",
                "neighborPort" : "Another string value",
                "platform" : "Another string value",
                "neighborIpAddress" : "Another 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,
              "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
                }]
              },
              "apMode" : "String value",
              "poeStatus" : "String value",
              "WIPSEnabled" : "String value"
            }
          }
        }
      }
    }

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

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 ApAdminStatusEnum | AP Admin Status Allowed values UNKNOWN ENABLE DISABLE
apType String | AP Type
autonomousAP AutonomousAp | Contains attributes specific to autonomous AP
Attribute | Description
--- | ---
description String | SNMP sysDescr
reachable Boolean | SNMP reachability of the AP
sysLocation String | SNMP sysLocation
sysObjectId String | SNMP sysObjectId
wgbStatus Boolean | Indicates whether the AP is in WGB mode
cdpNeighbor ApCdp[] | CDP Neighbor Information
Attribute | Description
--- | ---
capabilities String | Neighbor Capabilities
duplex String | Duplex Mode (Half Duplex or Full Duplex)
interfaceSpeed String | Interface Speed (10Mbps, 100Mbps, 1Gbps, 2.5Gbps, 5Gbps, Auto)
localPort String | Local Port Number
neighborIpAddress String | Neighbor IP Address
neighborName String | Neighbor Deice Name (ID)
neighborPort String | Neighbor Port Number
platform String | Neighbor Platform
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
Attribute | Description
--- | ---
reapEgressAcl String | Name of the Egress Access Control List for the vlan-acl mapping.
reapIngressAcl String | Name of the Ingress Access Control List for the vlan-acl mapping.
reapVlanId int | The VLAN ID mapped to the Acl for the Access Point. The VLAN ID range is 1 to 4095.
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
Attribute | Description
--- | ---
apCertType Integer | Certification Type
apGroupName String | The AP group this AP has been assigned to.
apMode String | AP Mode
apStaticEnabled Integer | AP Static IP Enabled
bootVersion String | Boot Version
capwapJoinTakenTime Long | CAPWAP Join Taken Time. Represents the time taken in hundredths of a second for the AP to join the controller. This could be a significant value in Mesh environments.
capwapUpTime Long | CAPWAP Up Time. Represents the time in hundredths of a second since the last time the AP joined the controller.
controllerIpAddress String | Registered Controller IP Address
controllerName String | Registered Controller Name
contryCode String | Identifies the country in which the AP is operating. This value is the 3 letter country code.
encryptionEnabled Boolean | Encryption Enabled
flexConnectGroupName String | FlexConnect group
flexConnectMode Boolean | Flex Connect Mode Supported
iosVersion String | IOS Version
linkLatencyEnabled Boolean | Link Latency Enabled
lradMeshNode LradMeshNodeDetails | The mesh node
Attribute | Description
--- | ---
meshRole MeshRoleEnum | The role of mesh AP which has joined the controller. Allowed values MAP RAP
maintenanceMode Boolean | Indicates the maintenance mode status. The maintenance mode is on if true and is off if false
poeStatus String | POE Status
poeStatusEnum PoeStatusEnum | Value of POE Status Allowed values LOW FIFTEENDOTFOUR SIXTEENDOTEIGHT NORMAL EXTERNAL TWENTYFIVEDOTFIVE MIXEDMODE
portNumber Integer | Port Number
powerInjectorState Integer | Power Injector State
preStandardState Integer | Pre-Standard 802.3af Switches
primaryMwar String | Primary Controller
rogueDetectionEnabled Boolean | Rogue Detection
secondaryMwar String | Secondary Controller
sshEnabled Boolean | SSH Enabled
statisticsTimer Integer | The time interval in secs after which bsnAPDot11Counters Stats is sent from AP to Switch. If not configured this value is 0 which means never send the stats.
tagInfo UnifiedApTagInfo | Tag info
Attribute | Description
--- | ---
policyTagName String | AP policy tag name
rfTagName String | AP RF tag name
siteTagName String | AP site tag name
tagSource UnifiedApTagSourceEnum | AP tag source Allowed values NONE STATIC FILTER AP DEFAULT LOCATION
telnetEnabled Boolean | Telnet Enabled
tertiaryMwar String | Tertiary Controller
vlanEnabled Boolean | VLAN enabled on FlexConnect access point
vlanNativeId Integer | VLAN native Id
wIPSEnabled String | Enhanced wIPS EngineEnabled
wlanProfiles WlanProfile[] | WLANs broadcasted by access point
Attribute | Description
--- | ---
broadcastSsidEnabled boolean | Is SSID broadcasting enabled?
profileName String | WLAN configuration profile name
ssid String | WLAN configuration SSID
wlanVlanMapping UnifiedApWlanVlanMapping[] | WLAN-VLAN Mappings
Attribute | Description
--- | ---
ssid String | WLAN SSID
vlanId int | VLAN id
wlanId int | WLAN id
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/v2/data/AccessPointDetails/15

    <?xml version="1.0" ?>
    <queryResponse type="AccessPointDetails" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v2/data/AccessPointDetails/15" rootUrl="https://10.64.88.203/webacs/api/v2/data">
      <entity dtoType="accessPointDetailsDTO" type="AccessPointDetails" url="https://10.64.88.203/webacs/api/v2/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>String value</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>Another 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>
            <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>String value</apMode>
            <poeStatus>String value</poeStatus>
            <WIPSEnabled>String value</WIPSEnabled>
          </unifiedApInfo>
        </accessPointDetailsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

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

    {
      "queryResponse" : {
        "@type" : "AccessPointDetails",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v2/data/AccessPointDetails/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v2/data",
        "entity" : [ {
          "@dtoType" : "accessPointDetailsDTO",
          "@type" : "AccessPointDetails",
          "@url" : "https://10.64.88.203/webacs/api/v2/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"
              }, {
                "capabilities" : "Another string value",
                "duplex" : "Another string value",
                "interfaceSpeed" : "Another string value",
                "localPort" : "Another string value",
                "neighborIpAddress" : "Another string value",
                "neighborName" : "Another string value",
                "neighborPort" : "Another string value",
                "platform" : "Another 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",
            "reapApVlanAclMappings" : {
              "reapApVlanAclMapping" : [ {
                "reapEgressAcl" : "String value",
                "reapIngressAcl" : "String value",
                "reapVlanId" : 1
              }, {
                "reapEgressAcl" : "Another string value",
                "reapIngressAcl" : "Another string value",
                "reapVlanId" : 11
              } ]
            },
            "serialNumber" : "String value",
            "softwareVersion" : "String value",
            "status" : "CRITICAL",
            "type" : "String value",
            "unifiedApInfo" : {
              "WIPSEnabled" : "String value",
              "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,
              "lradMeshNode" : {
                "meshRole" : "MAP"
              },
              "maintenanceMode" : true,
              "poeStatus" : "String value",
              "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
          }
        } ]
      }
    }

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

Since version 3 the field locationHeirarchy is renamed to locationHierarchy.

## 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
Attribute | Description
--- | ---
description String | SNMP sysDescr
reachable Boolean | SNMP reachability of the AP
sysLocation String | SNMP sysLocation
sysObjectId String | SNMP sysObjectId
wgbStatus Boolean | Indicates whether the AP is in WGB mode
cdpNeighbor ApCdp[] | CDP Neighbor Information
Attribute | Description
--- | ---
capabilities String | Neighbor Capabilities
duplex String | Duplex Mode (Half Duplex or Full Duplex)
interfaceSpeed String | Interface Speed (10Mbps, 100Mbps, 1Gbps, 2.5Gbps, 5Gbps, Auto)
localPort String | Local Port Number
neighborIpAddress String | Neighbor IP Address
neighborName String | Neighbor Deice Name (ID)
neighborPort String | Neighbor Port Number
platform String | Neighbor Platform
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
locationHierarchy 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
Attribute | Description
--- | ---
reapEgressAcl String | Name of the Egress Access Control List for the vlan-acl mapping.
reapIngressAcl String | Name of the Ingress Access Control List for the vlan-acl mapping.
reapVlanId int | The VLAN ID mapped to the Acl for the Access Point. The VLAN ID range is 1 to 4095.
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
Attribute | Description
--- | ---
apCertType Integer | Certification Type
apGroupName String | The AP group this AP has been assigned to.
apMode String | AP Mode
apStaticEnabled Integer | AP Static IP Enabled
bootVersion String | Boot Version
capwapJoinTakenTime Long | CAPWAP Join Taken Time. Represents the time taken in hundredths of a second for the AP to join the controller. This could be a significant value in Mesh environments.
capwapUpTime Long | CAPWAP Up Time. Represents the time in hundredths of a second since the last time the AP joined the controller.
controllerIpAddress String | Registered Controller IP Address
controllerName String | Registered Controller Name
contryCode String | Identifies the country in which the AP is operating. This value is the 3 letter country code.
encryptionEnabled Boolean | Encryption Enabled
flexConnectGroupName String | FlexConnect group
flexConnectMode Boolean | Flex Connect Mode Supported
iosVersion String | IOS Version
linkLatencyEnabled Boolean | Link Latency Enabled
lradMeshNode LradMeshNodeDetails | The mesh node
Attribute | Description
--- | ---
meshRole MeshRoleEnum | The role of mesh AP which has joined the controller. Allowed values MAP RAP
maintenanceMode Boolean | Indicates the maintenance mode status. The maintenance mode is on if true and is off if false
poeStatus String | POE Status
poeStatusEnum PoeStatusEnum | Value of POE Status Allowed values LOW FIFTEENDOTFOUR SIXTEENDOTEIGHT NORMAL EXTERNAL TWENTYFIVEDOTFIVE MIXEDMODE
portNumber Integer | Port Number
powerInjectorState Integer | Power Injector State
preStandardState Integer | Pre-Standard 802.3af Switches
primaryMwar String | Primary Controller
rogueDetectionEnabled Boolean | Rogue Detection
secondaryMwar String | Secondary Controller
sshEnabled Boolean | SSH Enabled
statisticsTimer Integer | The time interval in secs after which bsnAPDot11Counters Stats is sent from AP to Switch. If not configured this value is 0 which means never send the stats.
tagInfo UnifiedApTagInfo | Tag info
Attribute | Description
--- | ---
policyTagName String | AP policy tag name
rfTagName String | AP RF tag name
siteTagName String | AP site tag name
tagSource UnifiedApTagSourceEnum | AP tag source Allowed values NONE STATIC FILTER AP DEFAULT LOCATION
telnetEnabled Boolean | Telnet Enabled
tertiaryMwar String | Tertiary Controller
vlanEnabled Boolean | VLAN enabled on FlexConnect access point
vlanNativeId Integer | VLAN native Id
wIPSEnabled String | Enhanced wIPS EngineEnabled
wlanProfiles WlanProfile[] | WLANs broadcasted by access point
Attribute | Description
--- | ---
broadcastSsidEnabled boolean | Is SSID broadcasting enabled?
profileName String | WLAN configuration profile name
ssid String | WLAN configuration SSID
wlanVlanMapping UnifiedApWlanVlanMapping[] | WLAN-VLAN Mappings
Attribute | Description
--- | ---
ssid String | WLAN SSID
vlanId int | VLAN id
wlanId int | WLAN id
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/v3/data/AccessPointDetails/15

    <?xml version="1.0" ?>
    <queryResponse type="AccessPointDetails" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v3/data/AccessPointDetails/15" rootUrl="https://10.64.88.203/webacs/api/v3/data">
      <entity dtoType="accessPointDetailsDTO" type="AccessPointDetails" url="https://10.64.88.203/webacs/api/v3/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>String value</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>Another 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>
          <locationHierarchy>String value</locationHierarchy>
          <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>
            <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>String value</apMode>
            <poeStatus>String value</poeStatus>
            <WIPSEnabled>String value</WIPSEnabled>
          </unifiedApInfo>
        </accessPointDetailsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

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

    {
      "queryResponse" : {
        "@type" : "AccessPointDetails",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v3/data/AccessPointDetails/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v3/data",
        "entity" : [ {
          "@dtoType" : "accessPointDetailsDTO",
          "@type" : "AccessPointDetails",
          "@url" : "https://10.64.88.203/webacs/api/v3/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"
              }, {
                "capabilities" : "Another string value",
                "duplex" : "Another string value",
                "interfaceSpeed" : "Another string value",
                "localPort" : "Another string value",
                "neighborIpAddress" : "Another string value",
                "neighborName" : "Another string value",
                "neighborPort" : "Another string value",
                "platform" : "Another string value"
              } ]
            },
            "clientCount" : "String value",
            "clientCount_2_4GHz" : "String value",
            "clientCount_5GHz" : 1,
            "ethernetMac" : "String value",
            "ipAddress" : "String value",
            "locationHierarchy" : "String value",
            "macAddress" : "String value",
            "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",
            "softwareVersion" : "String value",
            "status" : "CRITICAL",
            "type" : "String value",
            "unifiedApInfo" : {
              "WIPSEnabled" : "String value",
              "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,
              "lradMeshNode" : {
                "meshRole" : "MAP"
              },
              "maintenanceMode" : true,
              "poeStatus" : "String value",
              "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
          }
        } ]
      }
    }

### 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 Allowed values UNKNOWN ENABLE DISABLE
apType String | AP Type
autonomousAP AutonomousAp | Contains attributes specific to autonomous AP
Attribute | Description
--- | ---
description String | SNMP sysDescr
reachable Boolean | SNMP reachability of the AP
sysLocation String | SNMP sysLocation
sysObjectId String | SNMP sysObjectId
wgbStatus Boolean | Indicates whether the AP is in WGB mode
cdpNeighbor ApCdpV4[] | CDP Neighbor Information
Attribute | Description
--- | ---
capabilities String | Neighbor Capabilities
duplex String | Duplex Mode (Half Duplex or Full Duplex)
interfaceSpeed String | Interface Speed (10Mbps, 100Mbps, 1Gbps, 2.5Gbps, 5Gbps, Auto)
localPort String | Local Port Number
neighborIpAddress InetAddress | Neighbor IP Address
neighborName String | Neighbor Deice Name (ID)
neighborPort String | Neighbor Port Number
platform String | Neighbor Platform
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 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.
Attribute | Description
--- | ---
xCoordinate Float | X coordinate
yCoordinate Float | Y coordinate
zCoordinate Float | Z coordinate
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 Allowed values UNKNOWN REACHABLE UNREACHABLE AGENT_UNREACHABLE AGENT_UNLOADED PING_REACHABLE PING_UNREACHABLE
reapApVlanAclMapping ReapApVlanAclMapping[] | The VLAN ACL Mapping configuration
Attribute | Description
--- | ---
reapEgressAcl String | Name of the Egress Access Control List for the vlan-acl mapping.
reapIngressAcl String | Name of the Ingress Access Control List for the vlan-acl mapping.
reapVlanId int | The VLAN ID mapped to the Acl for the Access Point. The VLAN ID range is 1 to 4095.
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 Allowed values CRITICAL MAJOR MINOR WARNING CLEARED INFORMATION
type String | AP Type (CAPWAP or Autonomous)
unifiedApInfo UnifiedApV4 | Contains attributes specific to Unified (CAPWAP) AP
Attribute | Description
--- | ---
apCertType Integer | Certification Type
apGroupName String | The AP group this AP has been assigned to.
apMode MonitorOnlyModeEnum | AP Mode Allowed values LOCAL MONITOR REAP ROGUE_DETECTOR SNIFFER BRIDGE SE_CONNECT REMOTE_BRIDGE REMOTE_HYBRID SENSOR FLEX_LOCAL
apStaticEnabled Integer | AP Static IP Enabled
bootVersion String | Boot Version
capwapJoinTakenTime Long | CAPWAP Join Taken Time. Represents the time taken in hundredths of a second for the AP to join the controller. This could be a significant value in Mesh environments.
capwapUpTime Long | CAPWAP Up Time. Represents the time in hundredths of a second since the last time the AP joined the controller.
controllerIpAddress String | Registered Controller IP Address
controllerName String | Registered Controller Name
contryCode String | Identifies the country in which the AP is operating. This value is the 3 letter country code.
encryptionEnabled Boolean | Encryption Enabled
flexConnectGroupName String | FlexConnect group
flexConnectMode Boolean | Flex Connect Mode Supported
iosVersion String | IOS Version
lastAssociatedTime Date | AP last associated time
lastDissociatedTime Date | AP last dissociated time
linkLatencyEnabled Boolean | Link Latency Enabled
lradMeshNode LradMeshNodeDetails | The mesh node
Attribute | Description
--- | ---
meshRole MeshRoleEnum | The role of mesh AP which has joined the controller. Allowed values MAP RAP
maintenanceMode Boolean | Indicates the maintenance mode status. The maintenance mode is on if true and is off if false
poeStatusEnum PoeStatusEnum | Value of POE Status Allowed values LOW FIFTEENDOTFOUR SIXTEENDOTEIGHT NORMAL EXTERNAL TWENTYFIVEDOTFIVE MIXEDMODE
portNumber Integer | Port Number
powerInjectorState Integer | Power Injector State
preStandardState Integer | Pre-Standard 802.3af Switches
primaryMwar String | Primary Controller
rogueDetectionEnabled Boolean | Rogue Detection
secondaryMwar String | Secondary Controller
sshEnabled Boolean | SSH Enabled
statisticsTimer Integer | The time interval in secs after which bsnAPDot11Counters Stats is sent from AP to Switch. If not configured this value is 0 which means never send the stats.
tagInfo UnifiedApTagInfo | Tag info
Attribute | Description
--- | ---
policyTagName String | AP policy tag name
rfTagName String | AP RF tag name
siteTagName String | AP site tag name
tagSource UnifiedApTagSourceEnum | AP tag source Allowed values NONE STATIC FILTER AP DEFAULT LOCATION
telnetEnabled Boolean | Telnet Enabled
tertiaryMwar String | Tertiary Controller
vlanEnabled Boolean | VLAN enabled on FlexConnect access point
vlanNativeId Integer | VLAN native Id
wIPSEnabled Boolean | Enhanced wIPS EngineEnabled
wlanProfiles WlanProfile[] | WLANs broadcasted by access point
Attribute | Description
--- | ---
broadcastSsidEnabled boolean | Is SSID broadcasting enabled?
profileName String | WLAN configuration profile name
ssid String | WLAN configuration SSID
wlanVlanMapping UnifiedApWlanVlanMapping[] | WLAN-VLAN Mappings
Attribute | Description
--- | ---
ssid String | WLAN SSID
vlanId int | VLAN id
wlanId int | WLAN id
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
          }
        } ]
      }
    }