v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Site Health

Site information

This API endpoint provides the detailed health information for the requested site, including site Id, health of the site, and poor health reasons for the site. The response includes the count of devices, clients, VMs, and hosts categorized by performance as poor, fair or good.

get/network-monitoring/v1/site-health/{site-id}

Path parameters

site-idstring uuid required

Identifier of the Site for which site information is requested.

Example:00001

Identifier of the Site for which site information is requested.

Response

Success

idstring required

Primary identifier for the resource.

typestring required

The type of the resource.

Example response

{
  "id": "00001",
  "type": "network-monitoring/site-health",
  "response": {
    "status": "SUCCESS",
    "code": "SITE-HEALTH-SUCCESS-001",
    "message": "Sites details fetched successfully"
  },
  "reasons": [
    {
      "health": "Poor",
      "reason": "CLIENT_HEALTH_POOR",
      "data": {
        "count": 5
      }
    }
  ],
  "health": {
    "groups": [
      {
        "name": "Poor",
        "value": 40
      }
    ]
  },
  "deviceTypes": [
    {
      "name": "Switches",
      "health": {
        "groups": [
          {
            "name": "Poor",
            "value": 40
          }
        ]
      }
    }
  ],
  "clientTypes": [
    {
      "name": "Wired",
      "health": {
        "groups": [
          {
            "name": "Poor",
            "value": 40
          }
        ]
      }
    }
  ],
  "compute": [
    {
      "name": "VM",
      "health": {
        "groups": [
          {
            "name": "Poor",
            "value": 40
          }
        ]
      }
    }
  ]
}