Get a list of AP DHCP Pools

get

https://de1.api.central.arubanetworks.com/network-monitoring/v1/aps/{serial-number}/dhcp-pools

This API endpoint retrieves a list of DHCP pools associated with a specific access point. Each DHCP pool in the returned list includes details like pool name, VLAN, subnet, lease duration in seconds, available addresses, pool size, and utilization.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

serial-number

string

required

length ≤ 16

Serial number of an access point device.

Query Params

filter

string

length ≤ 256

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
`poolName`	`eq` and `in`
`vlan`	`eq` and `in`
`subnet`	`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.

sort

string

length ≤ 256

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 the default direction is ascending.

Supported fields are poolName, vlan, subnet, leaseDurationInSecs, availableAddresses, poolSize, and utilization.

limit

int64

0 to 1000

Defaults to 20

Denotes the maximum number of DHCP pools returned in the response.

string

Specifies the pagination cursor for the next page of resources.

Minimum value: 1

Responses

200List of access point DHCP pools, along with their details and associated pagination information.

400Bad Request

401Unauthorized request.

403Forbidden: Access is denied.

429Too Many Requests. Rate limit exceeded.

500Internal server error.