---
title: "Get clients list"
method: GET
path: "/network-monitoring/v1/firewall-clients"
tags: ["Firewall Session"]
---

# Get clients list

`GET /network-monitoring/v1/firewall-clients`

## Request

- Base URL: `https://sso.common.cloud.hpe.com`
- URL: `https://sso.common.cloud.hpe.com/network-monitoring/v1/firewall-clients`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://sso.common.cloud.hpe.com/as/token.oauth2`
- TypeScript: <https://skmtc.dev/arubanetworks/apis/authorization/docs/network-monitoring/v1/firewall-clients/get.ts> (a function with typed inputs; its response is checked against the schema)

This API endpoint retrieves the list of clients from access points, CX switches, and/or gateways in a site based on the filter given.

## Query parameters

- `site-id` string, const, required
- `start-at` string, date-time, required
- `end-at` string, date-time, required
- `filter` string, const, required
- `limit` integer
- `next` string
- `offset` integer

## Response `200`

Successful operation

- ClientResponse: List of clients.
  - `items` ClientItems[], required
    - `type` string, const, required: Resource type.
    - `id` string, string, required: Resource ID: session_timestamp-src_ip-client_mac-dest_ip.
    - `clientUsername` string, const: The logged-in username of the client.
    - `clientMac` string, const: The MAC address of the client.
  - `next` string, required: Specifies the pagination cursor for the next page of resources.
  - `offset` integer
  - `count` integer, required: Number of items in the response.
  - `total` integer, required: Specifies the total number of items available for a given filter query.

## 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.
- `503`: Service unavailable.

---

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