You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
homepage/docs/widgets/services/healthchecks.md

813 B

title description
Health checks Health checks Widget Configuration

Health Checks

Specify a single check by including the uuid field or show the total 'up' and 'down' for all checks by leaving off the uuid field.

To use the Health Checks widget, you first need to generate an API key.

  1. In your project, go to project Settings on the navigation bar.
  2. Click on API key (read-only) and then click Create.
  3. Copy the API key that is generated for you.

Allowed fields: ["status", "last_ping"] for single checks, ["up", "down"] for total stats.

widget:
  type: healthchecks
  url: http://healthchecks.host.or.ip:port
  key: <YOUR_API_KEY>
  uuid: <CHECK_UUID> # optional, if not included total statistics for all checks is shown