Skip to main content
Version: 3.28.0

Backend.health()

info

This method is deprecated, use Backend.prototype.health instead.

The Backend.health() method returns a string representing the health of the given Backend instance.

Syntax​

Backend.health(backend)

Return value​

A string representing the health of the specified Backend value.

Possible values are:

  • "healthy" - The backend's health check has succeeded, indicating the backend is working as expected and should receive requests.
  • "unhealthy" - The backend's health check has failed, indicating the backend is not working as expected and should not receive requests.
  • "unknown" - The backend does not have a health check configured.