Sign in

v1

latestOpenAPI 3.0.32026-07-13331437.0 KB
Healthchecks

Get a healthcheck

get/v1/healthchecks/{uuid}

Path parameters

uuidstring required

Healthcheck UUID

Response

Healthcheck details

uuidstring
namestring
pingUrlstring
periodinteger

Expected interval in seconds

periodValueinteger nullable
periodType'seconds' | 'minutes' | 'hours' | 'days' nullable
gracePeriodinteger

Grace period in seconds

gracePeriodValueinteger
gracePeriodType'seconds' | 'minutes' | 'hours' | 'days'
cronstring nullable
timezonestring

Example response

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