Skip to content
Nightshift

Docs

Ping API

GET and POST /ping/<token>, plus /start and /fail. Optional tokens and cost_usd.

The token in the URL is the credential. Do not put it in a public repo. GitHub Actions and Vercel should read it from a secret or environment variable.

  • POST or GET /ping/<token> — success. Resets the schedule. If the monitor was down, this is a recovery.
  • POST or GET /ping/<token>/start — the run began. Does not reset the deadline and does not clear a down state.
  • POST or GET /ping/<token>/fail — explicit failure. Marks the monitor down immediately.

JSON body, all fields optional: tokens (integer), cost_usd (number), duration_ms (integer). The same fields can be query parameters on a GET with no body. Bodies over 8 KB are rejected. Unknown tokens return 404. More than the per-minute limit returns 429.

A paused monitor still returns 200 with ignored set to paused, and the schedule does not move. A monitor over the plan quota returns ignored set to over_quota.