v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Access Points

Get a list of Access Points

This API endpoint retrieves a list of access points associated to a customer, based on the query parameters provided. Each access point in the returned list includes comprehensive details like serial number, name, MAC address, siteId, status and with latest stats. The query parameters allow you to narrow down the results to access points that meet specific criteria, ensuring you receive only the relevant data.

get/network-monitoring/v1/aps

Query parameters

filterstring const

OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction; ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.

Field	Operators
siteId	eq and in
siteName	eq and in
serialNumber	eq and in
deviceName	eq and in
status	eq and in
model	eq and in
firmwareVersion	eq and in
deployment	eq and in
clusterId	eq and in
clusterName	eq and in

The operators are implemented as follows:

eq: Only values exactly matching the given value are returned.
in: Only values present in the given list are returned.

sortstring const

Example:deviceName,deployment desc

A comma-separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator: asc (ascending) or desc (descending).

The first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted, then the default direction is ascending.

Supported fields are siteId, serialNumber, deviceName, model, status, and deployment.

limitinteger

Example:20

Specifies the maximum number of access points returned in the response.

nextstring

Specifies the pagination cursor for the next page of resources.

Example:1

Specifies the pagination cursor for the next page of resources.

The minimum value: 1

Response

List of access points, along with their details and associated pagination information.

countinteger required

Number of items in the response.

totalinteger

Specifies the total number of items available for a given filter query.

nextstring int32 required

Indicate the next page number, null if there are no further pages.

Example response

{
  "items": [
    {
      "serialNumber": "AP00000001",
      "macAddress": "bb:5d:11:85:c0:00",
      "deviceName": "ArubaAP",
      "model": "AP-115",
      "partNumber": "JZ336A",
      "deployment": "Standalone",
      "role": "Conductor",
      "deviceFunction": "Instant",
      "firmwareVersion": "8.5.2.0_59123",
      "ipv4": "114.191.59.254",
      "ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
      "publicIpv4": "192.170.12.150",
      "status": "ONLINE",
      "lastSeenAt": null,
      "siteId": "1120972196",
      "siteName": "site1",
      "clusterName": "cluster_1",
      "lastRebootReason": "AP_RELOAD",
      "deviceGroupId": "8100143262",
      "deviceGroupName": "DeviceGroup1",
      "clusterId": "00e6b9e8015c1e1dd8f32d83e39606377a205ba2317015ed76",
      "cpuUtilization": 25,
      "memoryUtilization": 11,
      "powerConsumption": 11.891,
      "clientCount": 8,
      "wlanCount": 4,
      "subnetMask": "255.255.255.0",
      "meshRole": "Portal",
      "uptimeInMillis": 1702794777,
      "buildingId": "b1d2bd91-de81-4097-8420-3ca7f87450fd",
      "floorId": "16a0aad7-4070-4a19-8a19-fd6b8e1ff012",
      "id": "AP00000001",
      "type": "network-monitoring/access-point-monitoring"
    }
  ],
  "count": 1,
  "total": 4,
  "next": "2"
}