REST API

Deprecated

The Extended Health Check module comes with a REST endpoint:

/.rest/health/v1/check

Returns the health check results with:

  • healthy - true if the instance considers itself healthy (HTTP 200) or false if the conditions of some health outcome were met (HTTP status of the health outcome)

  • description - the description of the health outcome or "Magnolia is healthy" if healthy

Returns an HTTP status of:

  • 200 - the instance is healthy

  • the HTTP status of the health outcome

Reset Magnolia health events

Get /.rest/health/v1/reset

Removes all Magnolia health events.

Resets may not change Magnolia health status if a health outcome uses health voters like ContextAvailableVoter, MagnoliaUpdateNeededVoter or QueryVoter that do not use health events.

Returns

200 - all health events removed

Retrieve Magnolia health events

Get /.rest/health/v1/dump

Retrieves all health events currently in the health log.

Returns

200 - all health events returned in the response body

Feedback

Incubators

×

Location

This widget lets you know where you are on the docs site.

You are currently perusing through the Extended Health Check module docs.

Main doc sections

DX Core Headless PaaS Legacy Cloud Incubator modules