CronBeatCronBeat

Ping API Reference

The Ping API is used for heartbeat monitoring. Your cron jobs and scheduled tasks send HTTP requests to these endpoints to report their status.

Active monitors (HTTP, TCP, Ping) don't use the Ping API — CronBeat checks those endpoints automatically. This API is only for heartbeat monitors.

Base URL

text

Endpoints

All endpoints support both GET and POST methods.

EndpointDescription
/p/{ping_key}Report successful completion

A simple GET or POST request to /p/{ping_key} registers a successful ping.

Response

Success

text

The ping was recorded successfully.

Error Codes

CodeDescription
200 OKPing received and recorded
404 Not FoundInvalid or unknown Ping Key
429 Too Many RequestsRate limit exceeded

Rate Limits

  • 60 requests per minute per Ping Key
  • Exceeding the limit returns 429 Too Many Requests
  • Normal cron jobs will never hit this limit; it exists to prevent abuse

Examples

Simple GET Ping

bash

With Retry for Resilience

bash

Crontab Integration

bash

Node.js

javascript

Python

python

curl Flags Reference

FlagPurpose
-fFail silently on HTTP errors (don't output error pages)
-sSilent mode (no progress bar)
-SShow errors even in silent mode
--retry 3Retry up to 3 times on transient failures
--max-time 10Timeout after 10 seconds

Recommended combination: curl -fsS --retry 3 --max-time 10