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. Note: the API resource may return Meraki devices as access points. You can filter them out by adding "type=isNull()" query string.
Since Product Version: 1.2
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
Yes
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
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/AccessPoints
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
adminStatus
ApAdminStatusEnum
|
AP Admin Status
Allowed values:
|
bootVersion
String
|
|
clientCount
int
|
|
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
|
|
hreapEnabled
boolean
|
Displays whether OfficeExtend is enabled.
|
ipAddress
String
|
|
location
String
|
|
lwappUpTime
long
|
LWAPP uptime. Represents the time in hundredths of a second since the last time the AP joined the controller.
|
macAddress
String
|
|
model
String
|
|
name
String
|
|
serialNumber
String
|
|
softwareVersion
String
|
|
status
AlarmSeverityEnum
|
AP Alarm Status
Allowed values:
- CRITICAL
- MAJOR
- MINOR
- WARNING
- CLEARED
- INFORMATION
|
type
String
|
|
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>
<hreapEnabled>true</hreapEnabled>
<location>String value</location>
<lwappUpTime>2</lwappUpTime>
<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>
<ethernetMac>String value</ethernetMac>
<ipAddress>String value</ipAddress>
<macAddress>String value</macAddress>
</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",
"hreapEnabled" : true,
"location" : "String value",
"lwappUpTime" : 2,
"model" : "String value",
"name" : "String value",
"serialNumber" : "String value",
"softwareVersion" : "String value",
"status" : "CRITICAL",
"type" : "String value",
"upTime" : 15,
"ethernetMac" : "String value",
"ipAddress" : "String value",
"macAddress" : "String value"
}
}
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
Yes
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/data/AccessPoints
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
adminStatus
ApAdminStatusEnum
|
AP Admin Status
Allowed values:
|
bootVersion
String
|
|
clientCount
int
|
|
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
|
|
hreapEnabled
boolean
|
Displays whether OfficeExtend is enabled.
|
ipAddress
String
|
|
location
String
|
|
lwappUpTime
long
|
LWAPP uptime. Represents the time in hundredths of a second since the last time the AP joined the controller.
|
macAddress
String
|
|
model
String
|
|
name
String
|
|
serialNumber
String
|
|
softwareVersion
String
|
|
status
AlarmSeverityEnum
|
AP Alarm Status
Allowed values:
- CRITICAL
- MAJOR
- MINOR
- WARNING
- CLEARED
- INFORMATION
|
type
String
|
|
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/AccessPoints/15
<?xml version="1.0" ?>
<queryResponse type="AccessPoints" responseType="getEntity" requestUrl="https://localhost/webacs/api/v2/data/AccessPoints/15" rootUrl="https://localhost/webacs/api/v2/data">
<entity dtoType="accessPointsDTO" type="AccessPoints" url="https://localhost/webacs/api/v2/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>
<hreapEnabled>true</hreapEnabled>
<location>String value</location>
<lwappUpTime>2</lwappUpTime>
<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>
<ethernetMac>String value</ethernetMac>
<ipAddress>String value</ipAddress>
<macAddress>String value</macAddress>
</accessPointsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v2/data/AccessPoints/15.json
{
"queryResponse" : {
"@type" : "AccessPoints",
"@requestUrl" : "https://localhost/webacs/api/v2/data/AccessPoints/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v2/data",
"entity" : [ {
"@dtoType" : "accessPointsDTO",
"@type" : "AccessPoints",
"@url" : "https://localhost/webacs/api/v2/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
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
Yes
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/data/AccessPoints
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
adminStatus
ApAdminStatusEnum
|
AP Admin Status
Allowed values:
|
bootVersion
String
|
|
clientCount
int
|
|
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
|
|
hreapEnabled
boolean
|
Displays whether OfficeExtend is enabled.
|
ipAddress
String
|
|
location
String
|
|
lwappUpTime
long
|
LWAPP uptime. Represents the time in hundredths of a second since the last time the AP joined the controller.
|
macAddress
String
|
|
model
String
|
|
name
String
|
|
serialNumber
String
|
|
softwareVersion
String
|
|
status
AlarmSeverityEnum
|
AP Alarm Status
Allowed values:
- CRITICAL
- MAJOR
- MINOR
- WARNING
- CLEARED
- INFORMATION
|
type
String
|
|
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/AccessPoints/15
<?xml version="1.0" ?>
<queryResponse type="AccessPoints" responseType="getEntity" requestUrl="https://localhost/webacs/api/v3/data/AccessPoints/15" rootUrl="https://localhost/webacs/api/v3/data">
<entity dtoType="accessPointsDTO" type="AccessPoints" url="https://localhost/webacs/api/v3/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>
<hreapEnabled>true</hreapEnabled>
<location>String value</location>
<lwappUpTime>2</lwappUpTime>
<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>
<ethernetMac>String value</ethernetMac>
<ipAddress>String value</ipAddress>
<macAddress>String value</macAddress>
</accessPointsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v3/data/AccessPoints/15.json
{
"queryResponse" : {
"@type" : "AccessPoints",
"@requestUrl" : "https://localhost/webacs/api/v3/data/AccessPoints/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v3/data",
"entity" : [ {
"@dtoType" : "accessPointsDTO",
"@type" : "AccessPoints",
"@url" : "https://localhost/webacs/api/v3/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
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
Yes
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/data/AccessPoints
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 are changed in version 4.
Response Parameters
adminStatus
ApAdminStatusEnum
|
AP Admin Status
Allowed values:
|
bootVersion
String
|
|
clientCount
int
|
|
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
MacAddress
|
|
hreapEnabled
boolean
|
Displays whether OfficeExtend is enabled.
|
ipAddress
InetAddress
|
|
location
String
|
|
lwappUpTime
long
|
LWAPP uptime. Represents the time in hundredths of a second since the last time the AP joined the controller.
|
macAddress
MacAddress
|
|
model
String
|
|
name
String
|
|
serialNumber
String
|
|
softwareVersion
String
|
|
status
AlarmSeverityEnum
|
AP Alarm Status
Allowed values:
- CRITICAL
- MAJOR
- MINOR
- WARNING
- CLEARED
- INFORMATION
|
type
String
|
|
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/AccessPoints/15
<?xml version="1.0" ?>
<queryResponse type="AccessPoints" responseType="getEntity" requestUrl="https://localhost/webacs/api/v4/data/AccessPoints/15" rootUrl="https://localhost/webacs/api/v4/data">
<entity dtoType="accessPointsDTO" type="AccessPoints" url="https://localhost/webacs/api/v4/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>
<hreapEnabled>true</hreapEnabled>
<location>String value</location>
<lwappUpTime>2</lwappUpTime>
<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>
<ethernetMac>
<octets>000a959d6816</octets>
</ethernetMac>
<ipAddress>
<address>192.168.115.243</address>
</ipAddress>
<macAddress>
<octets>000a959d6816</octets>
</macAddress>
</accessPointsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v4/data/AccessPoints/15.json
{
"queryResponse" : {
"@type" : "AccessPoints",
"@requestUrl" : "https://localhost/webacs/api/v4/data/AccessPoints/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v4/data",
"entity" : [ {
"@dtoType" : "accessPointsDTO",
"@type" : "AccessPoints",
"@url" : "https://localhost/webacs/api/v4/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" : {
"octets" : "000a959d6816"
},
"hreapEnabled" : true,
"ipAddress" : {
"address" : "192.168.115.243"
},
"location" : "String value",
"lwappUpTime" : 2,
"macAddress" : {
"octets" : "000a959d6816"
},
"model" : "String value",
"name" : "String value",
"serialNumber" : "String value",
"softwareVersion" : "String value",
"status" : "CRITICAL",
"type" : "String value",
"upTime" : 15
}
} ]
}
}