--- title: "Get an Access Point details" method: GET path: "/network-monitoring/v1/aps/{serial-number}" tags: ["Access Points"] --- # Get an Access Point details `GET /network-monitoring/v1/aps/{serial-number}` ## Request - Base URL: `https://sso.common.cloud.hpe.com` - URL: `https://sso.common.cloud.hpe.com/network-monitoring/v1/aps/{serial-number}` - Auth: OAuth 2 - Client credentials - Token URL: `https://sso.common.cloud.hpe.com/as/token.oauth2` - TypeScript: (a function with typed inputs; its response is checked against the schema) 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. ## Path parameters - `serial-number` string, const, required: The device serial number. ## Response `200` Object containing information about the access point, such as MAC address, name, status, radios, ports, modem, and WLANs. - AccessPointResponse - `serialNumber` string, const, required: The access point serial number. - `macAddress` string, const, required: The access point MAC address. - `siteId` string, const, required: The unique identifier of the site to which the access point has been assigned. - `deviceName` string, const, required: The access point name. - `ipv4` string, ipv4: IPv4 address of the access point. - `ipv6` string, ipv6: IPv6 address of the access point. - `model` string, const: Hardware model of the access point. - `firmwareVersion` string, const: Firmware version currently running on the access point. - `status` 'ONLINE' | 'OFFLINE': Status of the access point, which can be either ONLINE or OFFLINE. - `lastSeenAt` string, 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. - `uptimeInMillis` number, double: Elapsed time in milliseconds since the access point's last boot. This value will be null if the access point is offline. - `lastRebootReason` string, 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' - `manufacturer` string, 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. - `role` string, const: Role of the access point in the network-topology. - `deployment` string, const: The operating mode of the access point. - `bandSelection` string, 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. - `publicIpv4` string, ipv4: IP address logged by servers when the access point device is connected through internet connection. - `countryCode` string, const: Country code in which the access point operates. - `mode` string: The operational mode of the access point. The possible values are : 'Client Access', 'Air Monitor', 'Dedicated Spectrum' and 'Hybrid Spectrum' - `defaultGateway` string: The IP address and the source of default gateway. The possible values for source are 'DHCP' and 'Static' - `subnetMask` string, ipv4: Subnet mask assigned to the access point IPv4 interface. - `meshRole` string: Mesh role of the access point when mesh is configured. - `currentUplinkInUse` string: Identifier of the uplink interface currently used by the access point. - `notes` string: Notes or comments about the access point. - `apStats` AccessPointStats: Access point statistics including CPU utilization, memory utilization, and client count. - `cpuUtilization` number, float: CPU utilization percentage of the access point. - `memoryUtilization` number, float: Memory utilization percentage of the access point. - `clientCount` integer - `radios` AccessPointRadio[], required: List of access point radios - `macAddress` string, const, required: Radio MAC address. - `band` string, const, required: The radio band refers to a specified range of frequencies of electromagnetic radiation. Possible values are 2.4 GHz, 5 GHz, 5 GHz Lower Band, 5 GHz Upper Band and 6 GHz. - `status` 'UP' | 'DOWN' | 'DISABLED': The access point radio status. - `radioNumber` integer, required: The radio number within an access point - `mode` string, const: The type of mode for the radio. For example Client Access, Air Monitor, Mesh Portal, Unknown, and Spectrum Analysis. - `antenna` 'Internal' | 'External': The type of antennae. - `spatialStream` string, const: Displays the number of spatial streams. By default, the spatial stream value for Radio 5 GHz is 8x8. When tri-radio mode is enabled, the spatial stream value for both the lower 5 GHz and upper 5 GHz frequency bands is 4x4. - `bandwidth` string: Indicates the channel bandwidth. - `channel` integer: A channel identifier for a given frequency band. - `power` string: Specifies the power level in dBm at which the radio is operating. - `radioType` string: The type of wireless LAN used for the radios. - `radioStats` object: Radio statistics including channel utilization and noise floor. - `channelUtilization` number, float: Channel utilization percentage of the radio. - `noiseFloor` integer: Noise floor level in dBm. - `ports` AccessPointPort[], required: List of access point ports - `macAddress` string, const, required: Interface MAC address. - `name` string, const, required: The port name. - `portIndex` string, const: The access point port number. - `portStatus` 'UP' | 'DOWN' | 'DISABLED', const: The port status. - `vlanMode` string, const: The port VLAN mode. Access, trunk, and '-' are possible values for VLAN mode. - `allowedVlan` string, const: Allowed VLAN. - `nativeVlan` string, const: Native VLAN ID. - `accessVlan` string, const: Access VLAN ID. - `speed` string, const: The speed of the port is measured in Mbps. Possible values include 10 Mbps, 100 Mbps, 1 Gbps, 2.5 Gbps, 5 Gbps or Auto. - `duplex` string, const: This field indicates whether the network has a full-duplex, half-duplex or Auto communication. - `connector` 'USB' | 'RJ45', const: The port type. - `isUplink` boolean: Indicates whether the port is currently used as an uplink. - `modem` object, required: Access point modem attributes i.e. manufacturer, simState, status,state, model, imei, imsi, iccid, firmwareVersion, accessTechnology and bandwidth. - `manufacturer` string, const: Modem manufacturer information. - `simState` 'SIM_READY' | 'SIM_NOT_READY' | 'DISABLE' | 'SIM_ABSENT' | 'OTHER_STATE', const: The modem sim state. - `status` 'CONNECTED' | 'DISCONNECTED', const: The status of modem, that if it is online or offline. - `state` 'CONNECTED' | 'DISCONNECTED' | 'IN_STANDBY' | 'SIM_NOT_READY' | 'OTHER_STATE', const: The connection state of the modem, if it is in use or in standby. - `model` string, const: The model of the modem. - `imei` string: International Mobile Equipment Identity. - `imsi` string, const: International Mobile Subscriber Identity. - `iccid` string: Integrated Circuit Card Identification. - `firmwareVersion` string, const: The firmware version of the modem. - `accessTechnology` string, const: The access technology currently used by the modem. - `bandwidth` string, const: Cellular network bandwidth. - `band` string, const: Cellular network band. - `wlans` WlanInfo[]: List of WLANs associated with the access point - `wlanName` string, const, required: The name of the WLAN. - `securityLevel` 'Enterprise' | 'Personal' | 'Open' | 'Captive Portal', required: Type of the WLAN. - `security` string: Security type of the WLAN. - `band` string: Specifies the bands supported by WLAN. Possible values include '2.4 GHz', '5 GHz', '6 GHz', or combinations like '2.4 GHz, 5 GHz'. - `status` 'ENABLED' | 'DISABLED': The operational status of the WLAN. - `vlan` string: WLAN VLAN ID. - `id` string, const, required: Primary identifier of a WLAN. - `type` string, const, required: The type of the resource. - `id` string, const, required: Primary identifier for the resource. - `type` string, const, required: The type of the resource. ## Other responses - `400`: Invalid input received. - `401`: Unauthorized. Authentication credentials are required or invalid. - `403`: Forbidden: Access is denied. - `404`: Not Found error. - `429`: Too Many Requests. The user has sent too many requests in a given amount of time. - `500`: Internal Server Error. An unexpected error occurred on the server. --- [API](https://skmtc.dev/arubanetworks/apis/authorization.md) - [All operations](https://skmtc.dev/arubanetworks/apis/authorization/llms.txt) - [OpenAPI document](https://skmtc.dev/arubanetworks/apis/authorization/revisions/74c95058b11f?raw)