List of sites with health overview

get

https://de1.api.central.arubanetworks.com/network-monitoring/v1/sites-health

This API endpoint provides a list of health information for each site, including devices, clients, critical alerts with count, along with their respective health and health reasons.

Tip: To retrieve the siteId for a known site name, use the filter query parameter (e.g., filter=siteName eq 'my-site') to look up the siteId.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

limit

int32

≤ 1000

Defaults to 100

Specifies the number of sites to be returned per request. Maximum limit per request is 1000.

offset

int32

Defaults to 0

Defines the starting point for the set of sites to be returned. Number of sites to skip before starting to collect the result set.

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
`siteId`	`eq` and `in`
`siteName`	`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

Defaults to siteName ASC

Sort field followed by a direction indicator ASC (ascending) or DESC (descending). Supported fields are siteName, siteHealth, deviceHealth, clientHealth

Responses

200Success

400Bad Request

401Unauthorized request.

403Forbidden: Access is denied.

429Too Many Requests. Rate limit exceeded.

500Internal server error.