HomeGuidesAPI ReferenceChangelogDiscussions
Log In

Health Check

Healthcheck CLI

The healthcheck CLI command is used to verify that RegScale is available (both the web server and database). The Healthcheck can be pulsed programmatically via the CLI or tied to application monitoring solutions for general availability data (red light/green light).

How to Use

  • Ensure the domain variable is set in your init.yaml file to your RegScale instance's URL (i.e. https://mycompany.regscale.com )
  • Perform a health check with the command below
regscale healthcheck

The CLI will return system status information.