---
title: "Create a healthcheck"
method: POST
path: "/v1/healthchecks"
tags: ["Healthchecks"]
---

# Create a healthcheck

`POST /v1/healthchecks`

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

## Request body

- HealthcheckCreate
  - `name` string, required
  - `period_value` integer — Expected ping interval (simple mode)
  - `period_type` 'seconds' | 'minutes' | 'hours' | 'days'
  - `grace_period_value` integer, required
  - `grace_period_type` 'seconds' | 'minutes' | 'hours' | 'days', required
  - `cron` string — Cron expression (cron mode)
  - `timezone` string

## Response `201`

Healthcheck created

- object
  - `message` string
  - `healthcheck` Healthcheck
    - `uuid` string
    - `name` string
    - `pingUrl` string
    - `period` integer — Expected interval in seconds
    - `periodValue` integer, nullable
    - `periodType` 'seconds' | 'minutes' | 'hours' | 'days', nullable
    - `gracePeriod` integer — Grace period in seconds
    - `gracePeriodValue` integer
    - `gracePeriodType` 'seconds' | 'minutes' | 'hours' | 'days'
    - `cron` string, nullable
    - `timezone` string

---

[API](https://skmtc.dev/hyperping/apis/hyperping-api.md) · [All operations](https://skmtc.dev/hyperping/apis/hyperping-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hyperping/hyperping-api/revisions/953c52272fa8/schema)
