---
title: "Get DHCP leases present in the DHCP pool"
method: GET
path: "/network-monitoring/v1/gateways/{serial-number}/dhcp-clients"
tags: ["Gateways"]
---

# Get DHCP leases present in the DHCP pool

`GET /network-monitoring/v1/gateways/{serial-number}/dhcp-clients`

## Request

- Base URL: `https://sso.common.cloud.hpe.com`
- URL: `https://sso.common.cloud.hpe.com/network-monitoring/v1/gateways/{serial-number}/dhcp-clients`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://sso.common.cloud.hpe.com/as/token.oauth2`

Retrieves DHCP leases that are configured in the gateway.

## Path parameters

- `serial-number` string, required: The gateway serial number.

## Query parameters

- `filter` string
- `sort` string
- `limit` integer
- `next` string: Specifies the pagination cursor for the next page of resources.

## Response `200`

Object containing information about the leases in the pool.

- GatewayDhcpLeaseListResponse
  - `items` object[], required
    - `poolName` string, required: The name of the DHCP pool.
    - `ipAddress` string, ipv4, required: The IP address of the client.
    - `macAddress` string, required: The MAC address of the client.
    - `clientSiteId` string, required: The site ID of the client device.
    - `clientSerial` string, required: The serial number of the client device.
    - `infraType` 'Access Point' | 'Switch' | 'Gateway', required: The infrastructure type of the client device.
    - `hostName` string, required: The host name of the client device.
    - `clientDeviceType` string, required: The device type of the client device.
    - `startTime` number, double, required: The lease start time in seconds. It will be '-' if the lease is reserved.
    - `expirationTime` number, double, required: The lease expiration time in seconds. It will be '-' if the lease is reserved.
    - `remainingTime` string, required: The remaining lease time in seconds. It will be 'Reservation' if the lease is reserved.
    - `reservation` 'Yes' | 'No', required: Indicates if the lease is a reservation.
  - `count` integer, required: The number of items in the response.
  - `total` integer: Specifies the total number of items available for a given filter query.
  - `next` string, int32, required: Indicates the next page number, or null if there are no further pages.

## 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)