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
- AAA/TACACS+ Servers Operations Service (4)
- AP Onboarding Profile Management Service (4)
- API Health Service (6)
- Access Point Operations (5)
- Alarms Management Service (5)
- Application Visibility and Control Service (1)
- CLI Template Configuration (12)
- Clients (7)
- Configuration Archive Service (7)
- Credential Profile Management Service (5)
- Credentials Service (1)
- Device Details (6)
- Device Operations (9)
- Group Management Service (8)
- Group Summary Service (8)
- Guest User Management Service (6)
- Job Operations (6)
- MAC Filters Management Service (5)
- Manage and Monitor Info Service (5)
- Plug and Play (11)
- Rate Limits Management Service (2)
- Report Service (4)
- Software Updates (2)
- Statistics (91)
- System Settings (26)
- Trap Receivers (4)
- User Defined Field Management (3)
- User Management Service (5)
- VNF Provisioning (16)
- Virtual Domains Management Service (10)
- Virtual Image Repository (8)
- WLAN Provisioning (16)
- Wireless Device Details (22)
- 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 |
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/AccessPointDetailsTo filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters
DeprecatedThis version has been deprecated. Please use v4.
Response Parameters
Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
adminStatus ApAdminStatusEnum |
AP Admin Status Allowed values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
apType String |
AP Type |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
contains attributes specific to autonomous AP |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
instanceOrigin InstanceOriginEnum |
Allowed values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
instanceTenantId Integer |
This is a tenant id for this instance. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
The VLAN ACL Mapping configuration |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
serialNumber String |
Serial Number |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
softwareVersion String |
Software Version |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status AlarmSeverityEnum |
AP alarm status Allowed values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type String |
AP Type (CAPWAP or Autonomous) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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" instanceTenantId="String value" 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",
"@instanceTenantId" : "String value",
"@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"
}
}
}
}
}
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/AccessPointDetailsTo filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters
UnmodifiedThis resource has not been modified since the previous API version.
DeprecatedThis version has been deprecated. Please use v4.
Response Parameters
Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
adminStatus ApAdminStatusEnum |
AP Admin Status Allowed values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
apType String |
AP Type |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
contains attributes specific to autonomous AP |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
instanceOrigin InstanceOriginEnum |
Allowed values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
instanceTenantId Integer |
This is a tenant id for this instance. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
The VLAN ACL Mapping configuration |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
serialNumber String |
Serial Number |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
softwareVersion String |
Software Version |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status AlarmSeverityEnum |
AP alarm status Allowed values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type String |
AP Type (CAPWAP or Autonomous) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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/v2/data/AccessPointDetails/15
<?xml version="1.0" ?>
<queryResponse type="AccessPointDetails" responseType="getEntity" requestUrl="https://localhost/webacs/api/v2/data/AccessPointDetails/15" rootUrl="https://localhost/webacs/api/v2/data">
<entity dtoType="accessPointDetailsDTO" type="AccessPointDetails" url="https://localhost/webacs/api/v2/data/AccessPointDetails/15">
<accessPointDetailsDTO displayName="String value" id="15" instanceTenantId="String value" 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/v2/data/AccessPointDetails/15.json
{
"queryResponse" : {
"@type" : "AccessPointDetails",
"@requestUrl" : "https://localhost/webacs/api/v2/data/AccessPointDetails/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v2/data",
"entity" : [ {
"@dtoType" : "accessPointDetailsDTO",
"@type" : "AccessPointDetails",
"@url" : "https://localhost/webacs/api/v2/data/AccessPointDetails/15",
"accessPointDetailsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@instanceTenantId" : "String value",
"@uuid" : "String value",
"adminStatus" : "UNKNOWN",
"apType" : "String value",
"autonomousAP" : {
"description" : "String value",
"reachable" : true,
"sysLocation" : "String value",
"sysObjectId" : "String value",
"wgbStatus" : true
},
"cdpNeighbors" : {
"cdpNeighbor" : [ {
"capabilities" : "String value",
"duplex" : "String value",
"interfaceSpeed" : "String value",
"localPort" : "String value",
"neighborIpAddress" : "String value",
"neighborName" : "String value",
"neighborPort" : "String value",
"platform" : "String value"
} ]
},
"clientCount" : "String value",
"clientCount_2_4GHz" : "String value",
"clientCount_5GHz" : 1,
"ethernetMac" : "String value",
"ipAddress" : "String value",
"locationHeirarchy" : "String value",
"macAddress" : "String value",
"mapLocation" : "String value",
"model" : "String value",
"name" : "String value",
"reachabilityStatus" : "UNKNOWN",
"reapApVlanAclMappings" : {
"reapApVlanAclMapping" : [ {
"reapEgressAcl" : "String value",
"reapIngressAcl" : "String value",
"reapVlanId" : 1
} ]
},
"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,
"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
} ]
}
},
"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/AccessPointDetailsTo filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters
UpdatedSince version 3 the field locationHeirarchy is renamed to locationHierarchy.
Response Parameters
Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
adminStatus ApAdminStatusEnum |
AP Admin Status Allowed values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
apType String |
AP Type |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
contains attributes specific to autonomous AP |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
instanceOrigin InstanceOriginEnum |
Allowed values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
instanceTenantId Integer |
This is a tenant id for this instance. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
The VLAN ACL Mapping configuration |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
serialNumber String |
Serial Number |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
softwareVersion String |
Software Version |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status AlarmSeverityEnum |
AP alarm status Allowed values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type String |
AP Type (CAPWAP or Autonomous) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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/v3/data/AccessPointDetails/15
<?xml version="1.0" ?>
<queryResponse type="AccessPointDetails" responseType="getEntity" requestUrl="https://localhost/webacs/api/v3/data/AccessPointDetails/15" rootUrl="https://localhost/webacs/api/v3/data">
<entity dtoType="accessPointDetailsDTO" type="AccessPointDetails" url="https://localhost/webacs/api/v3/data/AccessPointDetails/15">
<accessPointDetailsDTO displayName="String value" id="15" instanceTenantId="String value" 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>
<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://localhost/webacs/api/v3/data/AccessPointDetails/15.json
{
"queryResponse" : {
"@type" : "AccessPointDetails",
"@requestUrl" : "https://localhost/webacs/api/v3/data/AccessPointDetails/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v3/data",
"entity" : [ {
"@dtoType" : "accessPointDetailsDTO",
"@type" : "AccessPointDetails",
"@url" : "https://localhost/webacs/api/v3/data/AccessPointDetails/15",
"accessPointDetailsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@instanceTenantId" : "String value",
"@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,
"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/AccessPointDetailsTo filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters
UpdatedTypes 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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
apType String |
AP Type |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
contains attributes specific to autonomous AP |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CDP Neighbor Information |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
clientCount int |
total client count on both radio bands |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
clientCount_2_4GHz int |
client count on 2.4 GHz radio band |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
clientCount_5GHz int |
client count on 5 GHz radio band |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ethernetMac MacAddress |
AP Ethernet MAC Address |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
instanceOrigin InstanceOriginEnum |
Allowed values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
instanceTenantId Integer |
This is a tenant id for this instance. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
The VLAN ACL Mapping configuration |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
serialNumber String |
Serial Number |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
softwareVersion String |
Software Version |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status AlarmSeverityEnum |
AP alarm status Allowed values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type String |
AP Type (CAPWAP or Autonomous) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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/v4/data/AccessPointDetails/15
<?xml version="1.0" ?>
<queryResponse type="AccessPointDetails" responseType="getEntity" requestUrl="https://localhost/webacs/api/v4/data/AccessPointDetails/15" rootUrl="https://localhost/webacs/api/v4/data">
<entity dtoType="accessPointDetailsDTO" type="AccessPointDetails" url="https://localhost/webacs/api/v4/data/AccessPointDetails/15">
<accessPointDetailsDTO displayName="String value" id="15" instanceTenantId="String value" 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>
<ethernetMac>
<octets>000a959d6816</octets>
</ethernetMac>
<ipAddress>
<address>192.168.115.243</address>
</ipAddress>
<locationHierarchy>String value</locationHierarchy>
<macAddress>
<octets>000a959d6816</octets>
</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>
<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>
<WIPSEnabled>true</WIPSEnabled>
</unifiedApInfo>
</accessPointDetailsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v4/data/AccessPointDetails/15.json
{
"queryResponse" : {
"@type" : "AccessPointDetails",
"@requestUrl" : "https://localhost/webacs/api/v4/data/AccessPointDetails/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v4/data",
"entity" : [ {
"@dtoType" : "accessPointDetailsDTO",
"@type" : "AccessPointDetails",
"@url" : "https://localhost/webacs/api/v4/data/AccessPointDetails/15",
"accessPointDetailsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@instanceTenantId" : "String value",
"@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,
"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",
"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",
"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"
}, {
"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
}
} ]
}
}