PUT/v2/healthchecks/{healthcheck_uuid}

Update a healthcheck

Updates an existing healthcheck.

Request

Path Parameters

healthcheck_uuidstringrequired

The UUID of the healthcheck to update

Bodyapplication/json

namestringoptional

Name of the healthcheck

period_valuenumberoptional

Expected ping interval value. Must be provided together with period_type

period_typeenum<string>optional

Unit for the period value

Available options:

secondsminuteshoursdays

grace_period_valuenumberoptional

Grace period value. Must be provided together with grace_period_type

grace_period_typeenum<string>optional

Unit for the grace period value

Available options:

secondsminuteshoursdays

cronstringoptional

A cron expression. Set to null to switch from cron mode to simple mode

timezonestringoptional

Timezone for the cron expression

Response

Returns the updated healthcheck object.

RequestcURL

curl -X PUT https://api.hyperping.io/v2/healthchecks/tok_abc123def456 \
  -H "Authorization: Bearer ${API_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Backup Job",
    "grace_period_value": 15,
    "grace_period_type": "minutes"
  }'

200 OKJSON

{
  "message": "Healthcheck updated",
  "healthcheck": {
    "uuid": "tok_abc123def456",
    "name": "Updated Backup Job",
    "pingUrl": "https://hc.hyperping.io/tok_abc123def456",
    "cron": "0 2 * * *",
    "tz": "America/New_York",
    "period": 0,
    "periodValue": null,
    "periodType": null,
    "gracePeriod": 900,
    "gracePeriodValue": 15,
    "gracePeriodType": "minutes",
    "createdAt": "2026-01-15T10:00:00.000Z",
    "lastPing": "2026-01-23T02:00:15.000Z",
    "dueDate": "2026-01-24T02:15:00.000Z",
    "isDown": false
  }
}

← Create a healthcheck Delete a healthcheck →