Get health summary for appliances over a time range

post

http://127.0.0.1:8080/health

Retrieves aggregated health summary for specified appliances over a time range. Returns hourly health status data including alarm states, loss, latency, jitter, MOS, and bandwidth utilization metrics. Response keys are appliance IDs mapping to arrays of hourly health entries.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Health fetch parameters specifying time range, appliances, overlay, and health metrics to retrieve

Parameters for fetching health summary data for appliances over a specified time range

from

int64

required

Start time in seconds since EPOCH (Unix timestamp). Defines the beginning of the data time range.

int64

required

End time in seconds since EPOCH (Unix timestamp). Defines the end of the data time range.

nePks

array of objects

required

List of appliance identifiers (nePks).

nePks*

overlayId

integer

required

Overlay ID to filter results. Use -1 to query all overlays.

verticals

array of objects

required

length ≥ 1

List of health metric types to include in the response.

verticals*

Health metric categories for monitoring appliance and network health

Responses

401

Unauthorized - Authentication required or invalid credentials

403

Forbidden - User does not have READ or READ_WRITE permissions

500

Internal Server Error - Database or service unavailable

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Health summary data organized by appliance ID with hourly health status entries

400Bad Request - Invalid parameters. Occurs when required fields are missing or have invalid values.