Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET_AccessPoints

# GET AccessPoints

- Jump To

### Resource Information

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

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

## Resource URL

/webacs/api/v1/data/AccessPoints

Since : 1.2

## Response Parameters

Type | Attribute Name | Description
--- | --- | ---
ApAdminStatusEnum | adminStatus | AP Admin Status Allowed values: UNKNOWN ENABLE DISABLE
String | bootVersion | AP Boot Version
int | clientCount | Total Client Count
int | clientCount_2_4GHz | Client Count on 2.4GHz Band
int | clientCount_5GHz | Client Count on 5GHZ Band
String | controllerIpAddress | Registered Controller IP Address
String | controllerName | Registered Controller Name
String | countryCode |
String | ethernetMac | AP Ethernet MAC Address
boolean | hreapEnabled |
String | ipAddress | AP IP Address
String | location | AP Map Location
long | lwappUpTime |
String | macAddress | AP MAC Address
String | model | AP Model
String | name | AP Name
String | serialNumber | AP Serial Number
String | softwareVersion | AP Software Version
AlarmSeverityEnum | status | AP Alarm Status Allowed values: CRITICAL MAJOR MINOR WARNING CLEARED INFORMATION
ApTypeEnum | type | AP Type (CAPWAP or Autonomous) Allowed values: AP5212 AP5312 MIMO UNKNOWN AP1100 AP1130 AP1240 AP1200 AP1310 AP1500 AP1250 AP1505 AP3201 AP1520 AP801GN AP1140 AP801AGN AP3500I AP3500E AP1260 AP1040 AP1550 AP602I AP3500P AP802GN AP802AGN AP3600I AP3600E AP2600I AP2600E AP802HAGN AP1600I AP1600E AP702E AP702I ISR1801 ISR1802 ISR1803 ISR1811 ISR1812 ISR851 ISR857 ISR871 ISR876 ISR877 ISR878 BR1410 BR1430
long | upTime | AP Up Time

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

## Sample XML Payload

https://192.168.116.207/webacs/api/v1/data/AccessPoints/42

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <queryResponse rootUrl="/webacs/data" requestUrl="https://192.168.116.207/webacs/api/v1/data/AccessPoints/42" responseType="getEntity">
        <entity url="/webacs/data/className/15" type="className" dtoType="accessPointsDTO_$$_javassist_5961">
            <accessPointsDTO id="15" displayName="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>AP5212</type>
                <upTime>2</upTime>
            </accessPointsDTO>
        </entity>
    </queryResponse>

## Sample JSON Payload

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

    {
      "queryResponse" : {
        "@rootUrl" : "\/webacs\/data",
        "@requestUrl" : "https : \/\/192.168.116.207\/webacs\/api\/v1\/data\/AccessPoints\/42",
        "@responseType" : "getEntity",
        "entity" : {
          "@url" : "\/webacs\/data\/className\/15",
          "@type" : "className",
          "@dtoType" : "accessPointsDTO_$$_javassist_5961",
          "accessPointsDTO" : {
            "@id" : "15",
            "@displayName" : "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" : "AP5212",
            "upTime" : 2
          }
        }
      }
    }