The API reference isn't available right now
This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.
Back to the API reference
No such model
This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.
Back to the API reference
This reference may be out of date
This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-11-12 05:58 UTC.
API reference
/
Models
HealthCheckGroupedResponseA 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 components grouped by category.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
Field
Type
Description overall
required HealthCheckStatus
HealthCheckStatus Unhealthy when any component is unhealthy, otherwise degraded when any component is degraded,
otherwise healthy.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
UnknownThe check has not reported a result. HealthyThe component is working normally. DegradedThe component is working with reduced capacity or a non-critical fault. UnhealthyThe component is not working.
groups
required array of HealthCheckGroupDetail
array of HealthCheckGroupDetail One entry per category.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields of each HealthCheckGroupDetail:
Field
Type
Description group
required string
The category's name.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
status
required HealthCheckStatus
HealthCheckStatus The rolled-up status of the components in this category.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
UnknownThe check has not reported a result. HealthyThe component is working normally. DegradedThe component is working with reduced capacity or a non-critical fault. UnhealthyThe component is not working.
components
required array of HealthCheckComponentDetail
array of HealthCheckComponentDetail The components in this category.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
This body has no documented fields.
This model has no documented fields.
Next steps