Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET AccessPoints

Represents a wireless access point including both unified and autonomous. It provides device attributes such as type, version, association controller, number of associated client, etc.

Since Product Version: 1.2

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

DevNet Discussions

Resource URL

/webacs/api/v1/data/AccessPoints

Response Parameters

Attribute Description

adminStatus ApAdminStatusEnum

AP Admin Status

Allowed values:

  • UNKNOWN
  • ENABLE
  • DISABLE

bootVersion String

AP Boot Version

clientCount int

Total Client Count

clientCount_2_4GHz int

Client Count on 2.4GHz Band

clientCount_5GHz int

Client Count on 5GHZ Band

controllerIpAddress String

Registered Controller IP Address

controllerName String

Registered Controller Name

countryCode String

Identifies the country in which the AP is operating. This value is the 3 letter country code.

ethernetMac String

AP Ethernet MAC Address

hreapEnabled boolean

Displays whether OfficeExtend is enabled.

ipAddress String

AP IP Address

location String

AP SNMP Location

lwappUpTime long

LWAPP uptime. Represents the time in hundredths of a second since the last time the AP joined the controller.

macAddress String

AP MAC Address

model String

AP Model

name String

AP Name

serialNumber String

AP Serial Number

softwareVersion String

AP Software Version

status AlarmSeverityEnum

AP Alarm Status

Allowed values:

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

type String

AP Type

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

<?xml version="1.0" ?>
<queryResponse type="AccessPoints" responseType="getEntity" requestUrl="https://localhost/webacs/api/v1/data/AccessPoints/15" rootUrl="https://localhost/webacs/api/v1/data">
  <entity dtoType="accessPointsDTO" type="AccessPoints" url="https://localhost/webacs/api/v1/data/AccessPoints/15">
    <accessPointsDTO displayName="String value" id="15" uuid="String value">
      <adminStatus>UNKNOWN</adminStatus>
      <bootVersion>String value</bootVersion>
      <clientCount>1</clientCount>
      <clientCount_2_4GHz>1</clientCount_2_4GHz>
      <clientCount_5GHz>1</clientCount_5GHz>
      <controllerIpAddress>String value</controllerIpAddress>
      <controllerName>String value</controllerName>
      <countryCode>String value</countryCode>
      <ethernetMac>String value</ethernetMac>
      <hreapEnabled>true</hreapEnabled>
      <ipAddress>String value</ipAddress>
      <location>String value</location>
      <lwappUpTime>2</lwappUpTime>
      <macAddress>String value</macAddress>
      <model>String value</model>
      <name>String value</name>
      <serialNumber>String value</serialNumber>
      <softwareVersion>String value</softwareVersion>
      <status>CRITICAL</status>
      <type>String value</type>
      <upTime>15</upTime>
    </accessPointsDTO>
  </entity>
</queryResponse>

Sample JSON Payload

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

{
  "queryResponse" : {
    "@type" : "AccessPoints",
    "@responseType" : "getEntity",
    "@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data\/AccessPoints\/15",
    "@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data",
    "entity" : {
      "@dtoType" : "accessPointsDTO",
      "@type" : "AccessPoints",
      "@url" : "https : \/\/localhost\/webacs\/api\/v1\/data\/AccessPoints\/15",
      "accessPointsDTO" : {
        "@displayName" : "String value",
        "@id" : "15",
        "@uuid" : "String value",
        "adminStatus" : "UNKNOWN",
        "bootVersion" : "String value",
        "clientCount" : 1,
        "clientCount_2_4GHz" : 1,
        "clientCount_5GHz" : 1,
        "controllerIpAddress" : "String value",
        "controllerName" : "String value",
        "countryCode" : "String value",
        "ethernetMac" : "String value",
        "hreapEnabled" : true,
        "ipAddress" : "String value",
        "location" : "String value",
        "lwappUpTime" : 2,
        "macAddress" : "String value",
        "model" : "String value",
        "name" : "String value",
        "serialNumber" : "String value",
        "softwareVersion" : "String value",
        "status" : "CRITICAL",
        "type" : "String value",
        "upTime" : 15
      }
    }
  }
}