WinkPG Docs
View as Markdown

llms.txt

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

HealthCheckGroupDetail

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

One category of components, with their rolled-up status.

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
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.
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 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.

Fields of each HealthCheckComponentDetail:

Field Type Description
component required string The component's name, as the by-name health route accepts it. 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.
category required string The category the component is grouped under, as the by-category health route accepts it. 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 component's current status.
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.
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 required string What the check verifies. 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.
error required string The failure the check reported, when it did not pass. 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.
duration required 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. nullablepattern ^-?(\d{1,8}\.)?([01]\d|2[0-3]):[0-5]\d:[0-5]\d(\.\d{7})?$
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.
metadata required object Additional values the check reported about the component. 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.
remediationHint required string A suggested next step when the component is not healthy. 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.

Reconnecting to the server

Could not reconnect

This session has ended

Attempt 1

Your work on this page is still here. Retrying keeps it; reloading starts the page again.

The server no longer holds this page's state, so it has to be loaded again.