Waiting for engine...
Skip to main content

HealthCheck

Health check configuration for backend services with endpoint path, method, and status validation.

type HealthCheck {
path: String!
method: HttpMethod!
validStatuses: [IntRange!]!
}

Fields

HealthCheck.path ● String! non-null scalar miscellaneous

The health check endpoint path for the backend Atom. If it is not configured, defaults to _admin/status.

HealthCheck.method ● HttpMethod! non-null enum catalog-service

The HTTP method for the health check endpoint path. It defaults to GET.

HealthCheck.validStatuses ● [IntRange!]! non-null object platform

A list of HTTP status code ranges that are considered successful.

On this Page