# HealthCheckDetailedResponse

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

The overall platform status, with the status of each component behind it.

## Fields
- `overall` ([HealthCheckStatus](https://devportal.signapay-sbx.winkpg.io/docs/api/models/HealthCheckStatus.md)): Unhealthy when any component is unhealthy, otherwise degraded when any component is degraded, otherwise healthy.
  Values:
  - `Unknown`: The check has not reported a result.
  - `Healthy`: The component is working normally.
  - `Degraded`: The component is working with reduced capacity or a non-critical fault.
  - `Unhealthy`: The component is not working.
- `components` (array<[HealthCheckComponentDetail](https://devportal.signapay-sbx.winkpg.io/docs/api/models/HealthCheckComponentDetail.md)>): One entry per component. Omitted for a caller that is not signed in, which receives the overall status only. (nullable)
  Fields of each item:
  - `component` (string): The component's name, as the by-name health route accepts it. (nullable)
  - `category` (string): The category the component is grouped under, as the by-category health route accepts it. (nullable)
  - `status` ([HealthCheckStatus](https://devportal.signapay-sbx.winkpg.io/docs/api/models/HealthCheckStatus.md)): The component's current status.
    Values:
    - `Unknown`: The check has not reported a result.
    - `Healthy`: The component is working normally.
    - `Degraded`: The component is working with reduced capacity or a non-critical fault.
    - `Unhealthy`: The component is not working.
  - `description` (string): What the check verifies. (nullable)
  - `error` (string): The failure the check reported, when it did not pass. (nullable)
  - `duration` (string(date-span)): How long the check took to run. Written as [-][d.]hh:mm:ss[.fffffff], for example 00:00:01.2500000; the seven-digit fraction of a second appears only when it is non-zero. Not an ISO 8601 duration. (nullable, pattern ^-?(\d{1,8}\.)?([01]\d|2[0-3]):[0-5]\d:[0-5]\d(\.\d{7})?$)
  - `metadata` (object): Additional values the check reported about the component. (nullable)
  - `remediationHint` (string): A suggested next step when the component is not healthy. (nullable)

## See also

- [All documentation](https://devportal.signapay-sbx.winkpg.io/llms.txt): the machine-readable index of every public page on this site.