Get clients list

get

https://de1.api.central.arubanetworks.com/network-monitoring/v1/firewall-clients

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

site-id

string

required

length ≤ 20

The ID of the site from which to retrieve the firewall session logs.

start-at

date-time

required

length ≤ 27

The start time for the query in RFC 3339 format, must be less than end-at.

end-at

date-time

required

length ≤ 27

The end time for the query in RFC 3339 format, must be greater than start-at.

filter

string

required

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	Required	Type	Default Value	Summary
`applicationCategory`	`eq`	`Yes`	`String`	`N\A`	`Format is string. Only applicationCategory or webCategory must be set but not both. Also cannot have both applicationCategory and webCategory empty.`
`webCategory`	`eq`	`Yes`	`String`	`N\A`	`Format is string. Only applicationCategory or webCategory must be set but not both. Also cannot have both applicationCategory and webCategory empty.`
`deviceType`	`eq` and `in`	`No`	`String`	`('DEVICE_TYPE_AP','DEVICE_TYPE_GATEWAY','DEVICE_TYPE_SWITCH')`	`Format is a tuple that contains string. Example: ('DEVICE_TYPE_AP','DEVICE_TYPE_GATEWAY','DEVICE_TYPE_SWITCH')`

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.

limit

int32

0 to 1000

Defaults to 1000

The maximum number of items to return.

string

Cursor for the next page of results. Use the value returned in the next response field to retrieve the next page. Providing both next and offset in the same request returns 400 Bad Request.

offset

int32

≥ 0

The offset of the item at which to begin the response. Providing both offset and next in the same request returns 400 Bad Request.

Responses

200Successful operation

400Bad Request

401Unauthorized request.

403Forbidden: Access is denied.

404Not Found error

429Too Many Requests. Rate limit exceeded.

500Internal server error.

503Service unavailable.