v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Access Points

Get an Access Point details

This API retrieves detailed information about a specific access point linked to a particular site. It provides access point-related details such as MAC address, name, status, radios, ports, modem, and WLANs based on the access point's serial number associated with the site.

get/network-monitoring/v1/aps/{serial-number}

Path parameters

serial-numberstring const required

The device serial number.

Example:AP00000001

Serial number of an access point device.

Response

Object containing information about the access point, such as MAC address, name, status, radios, ports, modem, and WLANs.

serialNumberstring const required

The access point serial number.

macAddressstring const required

The access point MAC address.

siteIdstring const required

The unique identifier of the site to which the access point has been assigned.

deviceNamestring const required

The access point name.

ipv4string ipv4

IPv4 address of the access point.

ipv6string ipv6

IPv6 address of the access point.

modelstring const

Hardware model of the access point.

firmwareVersionstring const

Firmware version currently running on the access point.

status'ONLINE' | 'OFFLINE'

Status of the access point, which can be either ONLINE or OFFLINE.

lastSeenAtstring date-time

An RFC 3339 date-time indicating the last detected time of the access point in the system. If the access point is online, this value will be null.

uptimeInMillisnumber double

Elapsed time in milliseconds since the access point's last boot. This value will be null if the access point is offline.

lastRebootReasonstring const

last reboot reason description:

UNKNOWN: 'Unknown'
AP_RELOAD: 'Reload'
USER_REBOOT: 'User reboot'
WRITE_ERASE_REBOOT: 'Write erase reboot'
WRITE_ERASE_ALL_REBOOT: 'Write erase all reboot'
IMAGE_SYNC_FAILED: 'Image sync failed'
IMAGE_SYNC_SUCCESSFUL: 'Image sync successful'
IMAGE_UPGRADE: 'Image upgrade successful'
IMAGE_DOWNLOAD_FAILURE: 'Image download failure'
OUT_OF_MEMORY: 'Reboot caused by out of memory'
DOWN_UPLINK: 'Current uplink down, no useable uplink.'
CONDUCTOR_TO_LOCAL: 'Conductor transitioned to local'
NETWORK_DISCONNECT_USB_RESET: 'Internet connection lost, reset usb modem'
NETWORK_DISCONNECT: 'Internet connection lost'
UNREACHABLE_GATEWAY: 'Gateway unreachable'
FATAL_EXCEPTION: 'Reboot caused by kernel panic: fatal exception'
FATAL_EXCEPTION_IN_INTERRUPT: 'Reboot caused by kernel panic: fatal exception in interrupt'
SOFTLOCKUP: 'Reboot caused by kernel panic: softlockup: hung tasks'
NTP_SYNC: 'System clock is too far ahead of ntp sync result'
BAD_MESH_LINK: 'Mesh link bad. Rebooting mesh point by sapd'
MESH_TO_PORTAL: 'Mesh point transitioned to portal'
REBOOT_BY_AIRWAVE: 'Reboot by Airwave'
AMP_COMMAND: 'Amp'
VC_COMMAND: 'VC'
REBOOTED_BY_CENTRAL: 'Reboot by Central'
CLOUD_MANAGEMENT_COMMAND: 'Cloud management'
CLI_COMMAND: 'CLI'
CONDUCTOR_IP_FAILURE: 'Failed to get conductor-ip'
NON_FIPS: 'Non-fips --> fips'
FIPS: 'Fips --> non-fips'
TOPOLOGY_CHANGE: 'Rebooting AP due to topology change: hierarchy to flat'
AP_DISCONNECTED: 'AP disconnected from Aruba Central'
VC_DISCONNECTED: 'Virtual controller disconnected from Aruba Central'
COLD_HW_RESET: 'AP reboot caused by cold hw reset(power loss)'
POWER_LOSS: 'AP rebooted due to loss power'
THERMAL_MODE: 'Reboot due to trigger the cooldown event'
OVERHEAT_EVENT: 'Reboot due to trigger the overheat event'
PREEMPTED_BY_CONDUCTOR: 'Preempted by provisioned conductor'

manufacturerstring const

Manufacturer of the access point.

negotiatedPower'802.3bt' | '802.3af' | '802.3at' | 'DC power' | '-'

The power negotiated on the ethernet port of the access point.

rolestring const

Role of the access point in the network-topology.

deploymentstring const

The operating mode of the access point.

bandSelectionstring const

The operating band of the access point. Possible values are Dual band, Tri band, Dual 5 GHz, Tri radio, Flexible 5 GHz/6 GHz, or Flexible 2.4 GHz/6 GHz.

publicIpv4string ipv4

IP address logged by servers when the access point device is connected through internet connection.

countryCodestring const

Country code in which the access point operates.

modestring

The operational mode of the access point. The possible values are : 'Client Access', 'Air Monitor', 'Dedicated Spectrum' and 'Hybrid Spectrum'

defaultGatewaystring

The IP address and the source of default gateway. The possible values for source are 'DHCP' and 'Static'

subnetMaskstring ipv4

Subnet mask assigned to the access point IPv4 interface.

meshRolestring

Mesh role of the access point when mesh is configured.

currentUplinkInUsestring

Identifier of the uplink interface currently used by the access point.

notesstring

Notes or comments about the access point.

idstring const required

Primary identifier for the resource.

typestring const required

The type of the resource.

Example response

{
  "serialNumber": "AP00000001",
  "siteId": "24833497",
  "macAddress": "11:22:33:44:55:66",
  "deviceName": "ap_1",
  "ipv4": "198.51.100.42",
  "ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
  "model": "AP-275",
  "firmwareVersion": "8.5.2.0_59123",
  "status": "ONLINE",
  "lastSeenAt": null,
  "uptimeInMillis": 1702794777,
  "lastRebootReason": "AP_RELOAD",
  "manufacturer": "Aruba",
  "negotiatedPower": "802.3at",
  "role": "Conductor",
  "deployment": "Standalone",
  "bandSelection": "Dual band",
  "publicIpv4": "172.51.100.42",
  "countryCode": "US",
  "mode": "Client Access",
  "defaultGateway": "104.38.250.23 (DHCP)",
  "subnetMask": "255.255.255.0",
  "meshRole": "Portal",
  "currentUplinkInUse": "Ethernet",
  "notes": "Located in Building A, Floor 2",
  "apStats": {
    "cpuUtilization": 25.5,
    "memoryUtilization": 45.2,
    "clientCount": 20
  },
  "radios": [
    {
      "macAddress": "11:22:33:44:66:60",
      "band": "5 GHz",
      "status": "UP",
      "radioNumber": 0,
      "mode": "Client Access",
      "antenna": "Internal",
      "spatialStream": "3x3:3",
      "bandwidth": "40 MHz",
      "channel": "36+",
      "power": 13,
      "radioType": "802.11ax",
      "radioStats": {
        "channelUtilization": 35.5,
        "noiseFloor": -95
      }
    }
  ],
  "ports": [
    {
      "macAddress": "11:22:33:44:55:66",
      "name": "eth0",
      "portIndex": 0,
      "status": "UP",
      "vlanMode": "Trunk",
      "allowedVlan": "all",
      "nativeVlan": "1",
      "accessVlan": "1",
      "speed": "5 Gbps",
      "duplex": "Auto",
      "connector": "RJ45"
    }
  ],
  "modem": {
    "manufacturer": "Aruba",
    "simState": "SIM_READY",
    "status": "DISCONNECTED",
    "state": "DISCONNECTED",
    "model": "MDM-USB-LTE/R8F34A",
    "imei": "869710031619392",
    "imsi": "405861081571487",
    "iccid": "89918610400322214587",
    "firmwareVersion": "EM12GPAR01A20M4G",
    "accessTechnology": "TDD LTE",
    "bandwidth": "20 MHz",
    "band": "TDD B40"
  },
  "wlans": [
    {
      "wlanName": "wlan1",
      "securityLevel": "Captive Portal",
      "security": "Open",
      "band": "5 GHz",
      "status": "ENABLED",
      "vlan": "11"
    }
  ],
  "id": "AP00000001",
  "type": "network-monitoring/access-point-monitoring"
}