Sign in

v1

latestOpenAPI 3.0.32026-07-13331437.0 KB
Healthchecks

Create a healthcheck

Creates a new healthcheck. Supports simple (periodic interval) and cron (cron expression) modes.

post/v1/healthchecks

Request body

namestring required
period_valueinteger

Expected ping interval (simple mode)

period_type'seconds' | 'minutes' | 'hours' | 'days'
grace_period_valueinteger required
grace_period_type'seconds' | 'minutes' | 'hours' | 'days' required
cronstring

Cron expression (cron mode)

timezonestring

Example request

{
  "name": "Daily Backup Job",
  "grace_period_value": 5,
  "cron": "0 2 * * *"
}

Response

Healthcheck created

messagestring

Example response

{
  "healthcheck": {
    "uuid": "tok_abc123def456",
    "name": "Daily Backup Job",
    "pingUrl": "https://hc.hyperping.io/tok_abc123def456",
    "cron": "0 2 * * *",
    "timezone": "America/New_York"
  }
}