Represents basic information about Meraki access points.
Since Product Version: 3.6
-
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)
- Compliance Service (5)
- Configuration Archive Service (7)
- Credential Profile Management Service (5)
- Credentials Service (1)
- Device Details (9)
- Device Operations (9)
- Group Management Service (8)
- Group Summary Service (8)
- Guest User Management Service (8)
- Job Operations (6)
- MAC Filters Management Service (5)
- Manage and Monitor Info Service (5)
- Managed Servers Operations (for Operations Center) (6)
- Plug and Play (11)
- Rate Limits Management Service (2)
- Report Service (4)
- Site Map Service (3)
- 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
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.
This resource was introduced in API version 4.
This resource was introduced in API version 4.
This resource was introduced in API version 4.
Resource Information
Rate Limiting? |
Yes |
Sorting? |
Yes |
Paging? |
Yes |
Filtering? |
Yes |
Group Filtering? |
Yes |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
Resource URL
/webacs/api/v4/data/MerakiAccessPointsTo filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters
Response Parameters
Attribute | Description |
---|---|
clientCount int |
The number of clients currently associated with the device. |
contactedAt Date |
The last time the access point contacted the Cloud Controller. |
dashboardAddress InetAddress |
The Meraki dashboard address. |
deviceName String |
The name of the device. |
deviceType String |
The type of the device. |
ipAddress InetAddress |
The ip address of the device. |
macAddress MacAddress |
Device MAC address. |
meshStatus MerakiMeshStateEnum |
Whether the AP is currently acting as a gateway or a repeater. Allowed values:
|
networkName String |
The name of the network this device is in. |
productFamily String |
The product family of this device. |
reachability MerakiReachabilityStateEnum |
The status of the device's connection to the Meraki Cloud. Allowed values:
|
serialNumber String |
Device serial number. |
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/MerakiAccessPoints/15
<?xml version="1.0" ?>
<queryResponse type="MerakiAccessPoints" responseType="getEntity" requestUrl="https://localhost/webacs/api/v4/data/MerakiAccessPoints/15" rootUrl="https://localhost/webacs/api/v4/data">
<entity dtoType="merakiAccessPointsDTO" type="MerakiAccessPoints" url="https://localhost/webacs/api/v4/data/MerakiAccessPoints/15">
<merakiAccessPointsDTO displayName="String value" id="15" uuid="String value">
<clientCount>1</clientCount>
<contactedAt>2019-08-20T09:03:23.118Z</contactedAt>
<dashboardAddress>
<address>192.168.115.243</address>
</dashboardAddress>
<deviceName>String value</deviceName>
<deviceType>String value</deviceType>
<ipAddress>
<address>192.168.115.243</address>
</ipAddress>
<macAddress>
<octets>000a959d6816</octets>
</macAddress>
<meshStatus>GATEWAY</meshStatus>
<networkName>String value</networkName>
<productFamily>String value</productFamily>
<reachability>UNREACHABLE</reachability>
<serialNumber>String value</serialNumber>
</merakiAccessPointsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v4/data/MerakiAccessPoints/15.json
{
"queryResponse" : {
"@type" : "MerakiAccessPoints",
"@requestUrl" : "https://localhost/webacs/api/v4/data/MerakiAccessPoints/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v4/data",
"entity" : [ {
"@dtoType" : "merakiAccessPointsDTO",
"@type" : "MerakiAccessPoints",
"@url" : "https://localhost/webacs/api/v4/data/MerakiAccessPoints/15",
"merakiAccessPointsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"clientCount" : 1,
"contactedAt" : "2019-08-20T09:03:23.118Z",
"dashboardAddress" : {
"address" : "192.168.115.243"
},
"deviceName" : "String value",
"deviceType" : "String value",
"ipAddress" : {
"address" : "192.168.115.243"
},
"macAddress" : {
"octets" : "000a959d6816"
},
"meshStatus" : "GATEWAY",
"networkName" : "String value",
"productFamily" : "String value",
"reachability" : "UNREACHABLE",
"serialNumber" : "String value"
}
} ]
}
}