Health check endpoint

Upcoming release

You are reading the reference manual of an upcoming release. Read the current manual »

The health check endpoint is an HTTP server that returns ok and a 200 status code only if all ContainerSSH services are running. This can be used to integrate ContainerSSH with a load balancer. In any other case it'll return "not ok" and a 503 status code.

The health check endpoint has the following options:

health:
  enable: true
  listen: 0.0.0.0:7000

By default, the health check endpoint is disabled. The default listen port is 7000. Further configuration options can be found on the HTTP and TLS page.