API

Full reference

Every endpoint, parameter and response is in the API reference, generated from our OpenAPI description at /openapi.yaml.

Tokens

Create a token under Team & API (or API tokens on a personal account). Choose Read only for dashboards and status checks, Read & write to make changes. Send it as a bearer token:

curl https://pingerer.com/api/v1/sites \
  -H "Authorization: Bearer YOUR-TOKEN"

Choosing the account

If you belong to several accounts, pick one with the Pingerer-Account header (the account's id) or an account_id parameter. Otherwise the token's own account is used, then your first team account.

What you can do

• Sites and monitors: list, add, change, pause, resume, test now, results, uptime.
• Incidents: list, acknowledge, add notes, resolve.
• Heartbeats and alert channels.
• Maintenance windows, status pages and updates, and monthly reports.
• GET /api/v1/status for a quick "is everything up?".

Members' tokens can read and acknowledge; changes need an admin's token.

Responses and errors

Responses are JSON shaped {"data": ..., "meta": ...}. Errors are {"error": "code", "message": "...", "details": ...}. Going over a plan limit returns 422 with plan_limit; a read-only token trying to write gets 403 read_only_token.

Rate limits

300 requests a minute per token. Over that you get 429; wait a moment and retry.