Guides / API Reference

API Reference

The HealthyCron API is designed as a standard REST API. All endpoints are secured via HTTPS, and responses are formatted as JSON.

BASE URL

https://healthycron.io

Authentication

Pinging endpoints (/ping/*) explicitly do not require authentication so that they can be easily executed in constrained environments (e.g. bash scripts).

Management endpoints (/api/*) for creating or modifying monitors require an API key. Pass it in the standard Authorization header: Authorization: Bearer {api_key}

Pinging Endpoints

POST /ping/{uuid}

Record a successful run of your cron job. Resets the grace period timer. Accepts GET or POST.

POST /ping/{uuid}/start

Marks the cron job as executing. HealthyCron uses the time gap between this and the next success ping to calculate duration.

POST /ping/{uuid}/fail

Explicitly triggers a failure, immediately marking the monitor as Down and firing alerts to assigned integrations.

Management API (Auth Required)

GET /api/monitors

List all monitors in the project associated with the API key.

POST /api/monitors

Create a new monitor. Pass the name, schedule, and grace period in the JSON body.

REQUEST BODY

{
  "name": "New Monitor",
  "schedule": "0 * * * *",
  "grace_period": 5
}

PATCH /api/monitors/{id}

Update an existing monitor's configuration. You only need to send the fields you wish to change.

DELETE /api/monitors/{id}

Permanently delete a monitor and all its associated ping history logs.

← Cron Job Best Practices

Cron Expression Syntax →