---
title: "List of sites with health overview"
method: GET
path: "/network-monitoring/v1/sites-health"
tags: ["Site Health"]
---

# List of sites with health overview

`GET /network-monitoring/v1/sites-health`

## Request

- Base URL: `https://sso.common.cloud.hpe.com`
- URL: `https://sso.common.cloud.hpe.com/network-monitoring/v1/sites-health`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://sso.common.cloud.hpe.com/as/token.oauth2`

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.

## Query parameters

- `limit` integer: Specifies the number of sites to be returned per request. Maximum limit per request is 1000.
- `offset` integer: 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, const
- `sort` string, const

## Response `200`

Success

- SitesHealth
  - `items` object[], required
    - `id` string, required: Primary identifier for the resource.
    - `type` string, required: The type of the resource.
    - `siteName` string, required: Name of the Site.
    - `address` Address, required
      - `country` string
      - `address` string
      - `city` string
      - `zipCode` string
      - `state` string
    - `alerts` object, required
      - `totalCount` integer
      - `groups` AlertGroup[]
        - `name` string
        - `count` integer
    - `reasons` HealthReason[], required
      - `health` string
      - `reason` string
      - `data` object
        - `count` integer
    - `health` Health, required
      - `groups` GroupValue[]
        - `name` string
        - `value` integer
    - `devices` EntityCountHealth, required
      - `count` integer
      - `health` Health
        - `groups` GroupValue[]
          - `name` string
          - `value` integer
    - `clients` EntityCountHealth, required
      - `count` integer
      - `health` Health
        - `groups` GroupValue[]
          - `name` string
          - `value` integer
  - `count` integer, required: Number of items in the response.
  - `total` integer, required: Specifies the total number of sites available for a given customer.
  - `response` Responsesite, required
    - `status` string: The status of the API response, indicating success or failure.
    - `code` string
    - `message` string: A message providing details about the result of the API request.
  - `offset` integer, required: Defines the starting point for the set of sites to be returned. Number of sites to skip before starting to collect the result set.

## Other responses

- `400`: Invalid input received.
- `401`: Unauthorized. Authentication credentials are required or invalid.
- `403`: Forbidden: Access is denied.
- `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)