Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET ThirdpartyAccessPoints

Represents a third party access point. It provides device attributes such as type, version, associated controller, number of associated clients, etc.

Since Product Version: 3.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/v3/data/ThirdpartyAccessPoints

Unmodified

This resource has not been modified since the previous API version.

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 Third Party Controller IP address

controllerName String

Registered Third Party Controller name

displayName String

This is the displayName for this instance.

ethernetMac String

AP Ethernet MAC Address

instanceUuid String

This is a uuid for this instance.

ipAddress String

AP IP Address

location String

AP SNMP Location

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

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

<?xml version="1.0" ?>
<queryResponse type="ThirdpartyAccessPoints" responseType="getEntity" requestUrl="https://localhost/webacs/api/v3/data/ThirdpartyAccessPoints/15" rootUrl="https://localhost/webacs/api/v3/data">
  <entity dtoType="thirdpartyAccessPointsDTO" type="ThirdpartyAccessPoints" url="https://localhost/webacs/api/v3/data/ThirdpartyAccessPoints/15">
    <thirdpartyAccessPointsDTO 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>
      <ethernetMac>String value</ethernetMac>
      <ipAddress>String value</ipAddress>
      <location>String value</location>
      <macAddress>String value</macAddress>
      <model>String value</model>
      <name>String value</name>
      <serialNumber>String value</serialNumber>
      <softwareVersion>String value</softwareVersion>
      <status>CRITICAL</status>
    </thirdpartyAccessPointsDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://localhost/webacs/api/v3/data/ThirdpartyAccessPoints/15.json

{
  "queryResponse" : {
    "@type" : "ThirdpartyAccessPoints",
    "@requestUrl" : "https://localhost/webacs/api/v3/data/ThirdpartyAccessPoints/15",
    "@responseType" : "getEntity",
    "@rootUrl" : "https://localhost/webacs/api/v3/data",
    "entity" : [ {
      "@dtoType" : "thirdpartyAccessPointsDTO",
      "@type" : "ThirdpartyAccessPoints",
      "@url" : "https://localhost/webacs/api/v3/data/ThirdpartyAccessPoints/15",
      "thirdpartyAccessPointsDTO" : {
        "@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",
        "ethernetMac" : "String value",
        "ipAddress" : "String value",
        "location" : "String value",
        "macAddress" : "String value",
        "model" : "String value",
        "name" : "String value",
        "serialNumber" : "String value",
        "softwareVersion" : "String value",
        "status" : "CRITICAL"
      }
    } ]
  }
}