Docvora Documentation
Docvora Website Features Pricing Contact Us
Get 50% off your first three months for a limited time! Find out more.
API & Integrations IconAPI & Integrations

Health Check Endpoint

By Docvora Assistant 1 mins 4

Every Docvora site has a health check address that uptime monitors and status pages can use to confirm the site is online. It's useful for teams that already monitor their other services and want their documentation included.

The health check endpoint is available on all Docvora plans. No setup or API key is required.


The endpoint

The health check is found at /health on the site's own domain, including custom domains. For example:

https://docs.example.com/health

When the site is running, the endpoint responds with:

  • Status: 200 OK

  • Body: the plain text OK

The response is never cached, so every check reaches the site itself.


Adding Docvora to an uptime monitor

Most uptime monitoring tools, such as UptimeRobot, Better Stack, Pingdom or Uptime Kuma, can watch the endpoint.

  1. Create a new HTTP or website monitor in the monitoring tool.

  2. Enter the site's health check address, such as https://docs.example.com/health.

  3. Set the monitor to expect a 200 status code. If the tool supports keyword checks, the keyword OK can also be used.

  4. Choose how often to check. Every one to five minutes suits most teams.

  5. Save the monitor.


What the health check covers

A successful response confirms that the site is reachable and responding to requests.

It doesn't check individual pages, spaces or integrations, and it doesn't return any information about the site's content or settings. If a specific page needs monitoring, a separate monitor can be pointed at that page's address.

If the health check reports the site as down but it loads normally in a browser, check that the monitor is using the correct domain and https://. Contact Docvora Support if the problem continues.