| HTTP | URL | Parameters | Description | Response |
|---|---|---|---|---|
| GET | /api/public/ system_health /systems | (none) | Provides a list of the installed SSL certificates | Array containing the list of SSL certificates installed |
| GET | /api/public/ system_health/ systems/{system_id} | Path Variable system_id: The id of the system Optional Parameter time: Timestamp to indicate point in time for when system health data must be provided. Defaults to the current time. |
Provides the system health overview for a single system | SystemHealthWs object |
| GET | /api/public/ system_hyealth/ systems/{system_id} /descriptions | Path Variable system_id: The id of the system |
Provides a list of the configured system health descriptions for a single system | Array of DescriptionWs objects |
| GET | /api/public/ system_health/ systems/{system_id} /down_components | Path Variable system_id: The id of the system Optional Parameter time: Timestamp to indicate point in time for when system health data must be provided. Defaults to the current time. |
Provides a list of the down components or services for a single system | Array of DownComponentsWs objects |
| GET | /api/public/ system_health/ systems/{system_id} /metrics | Path Variable system_id: The id of the system Optional Parameters start_time: Timestamp to indicate start time of range for which system health data must be provided end_time: Timestamp to indicate end time of range for which system health data must be provided. If neither parameter is provided, the current data point for each metric is returned. If both parameters are provided, the data points within the range will be returned. Specifying only one parameter or the other is not supported and an error is returned. |
Provides the metric data for a single system | Array of SystemHealthMetricsWs object |
| GET | /api/public/ system_health/ systems/{system_id} /thresholds | Path Variablesystem_id: The id of the system | Provides a list of the configured thresholds for a single system | Array of MetricThresholdWs objects |