homepage/docs/widgets/services/healthchecks.md
shamoon 19c25713c4 Run pre-commit hooks over existing codebase
Co-Authored-By: Ben Phelps <ben@phelps.io>
2023-10-18 09:49:33 -07:00

507 B

title, description
title description
Health checks Health checks Widget Configuration

To use the Health Checks widget, you first need to generate an API key. To do this, follow these steps:

  1. Go to Settings in your check dashboard.
  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"].

widget:
  type: healthchecks
  url: http://healthchecks.host.or.ip:port
  key: <YOUR_API_KEY>
  uuid: <YOUR_CHECK_UUID>