HTTP health check
on the Headless WordPress platform is a check that runs at a high frequency at the environment startup - and then periodically while the environment is running to ensure it is operating correctly.Once set up, during every deployment the platform will wait for the health check to respond with a successful response (HTTP code
>=200
and <400
) before marking the deployment as successful. Then, if the environment starts failing while it’s already running (health check will start returning HTTP code
>=400
), the platform will restart the environment.A health check must be configured by the developer to be enabled for each of the environments that they wished to be monitored.
Behavior during the environment startup
By default (without the HTTP health check enabled) Headless WordPress platform checks if your environment has bound to a port (see more details in our documentation). Once it has done so successfully, the environment will be marked as healthy and the deployment as successful which means that your environment is ready to serve the traffic.
If the health check is enabled on your environment, it will instead wait for the environment to respond with an
200
response before marking it as healthy.Behavior during the environment runtime
By default (without the HTTP health check enabled), if the environment is bound to a port our platform will not treat it as unhealthy if it starts returning HTTP
5xx
responses.However, once the health check is configured, the environment will be restarted if it starts returning HTTP
5xx
responses.Additional details
For onboarding guide and additional details about this feature please visit our documentation.