v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Gateways

Get DHCP pools configured on the gateway

Retrieves DHCP pools that are configured in the gateway.

get/network-monitoring/v1/gateways/{serial-number}/dhcp-pools

Path parameters

serial-numberstring required

The gateway serial number.

Example:GW00000001

Serial number of the gateway device.

Query parameters

sortstring

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

Supported fields are poolName, vlanId, subnet, leaseDuration, poolSize, utilization and availableAddresses.

limitinteger

Example:20

Denotes the maximum number of DHCP pools 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.

Minimum value: 1

Response

Object containing information about the DHCP pools configured in the gateway.

countinteger required

The number of items in the response.

totalinteger

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

nextstring int32 required

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

Example response

{
  "items": [
    {
      "poolName": "pool-1",
      "vlanId": 33,
      "vlanName": "Client-Vlan 1",
      "subnet": "192.168.3.0/24",
      "leaseDuration": 90061,
      "poolSize": 100,
      "currentLeases": 4,
      "utilization": 4,
      "availableAddresses": 96
    }
  ],
  "count": 1,
  "total": 1,
  "next": null
}