PingWise API

Getting started

Base URL: https://app.pingwise.com/api/v1. Make a key in Team → API keys (owners only), copy it once, and send it as a bearer token:

curl https://app.pingwise.com/api/v1/monitors \
  -H "Authorization: Bearer pw_…"

Add a monitor the same way the panel’s New monitor form would, with the same rules and the same messages when something is off:

curl https://app.pingwise.com/api/v1/monitors \
  -H "Authorization: Bearer pw_…" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com", "interval": 60}'

The answer is the new monitor, with its id, its state (pending until the first round comes back) and credits_per_month, what it costs at that interval.

Authentication

Every request carries Authorization: Bearer pw_…. A key belongs to one account and is either read only or read and write; pick the narrowest one that does the job, one key per integration, and revoke it from the same page when the integration goes. Keys are stored hashed; the panel shows the prefix only, and the full key exactly once.

• No key, or an unknown or revoked one: 401 unauthorized.
• A read-only key on a write: 403 forbidden. A frozen account (deletion requested): 403 account_frozen.
• No sessions, no cookies, no CSRF: the key is the whole story. Use HTTPS; plain HTTP is not served.

Conventions

• JSON in and out. Send Content-Type: application/json with a JSON object as the body. Unknown fields are refused, so a typo can’t pass silently.
• Times are ISO 8601 in UTC with a Z, e.g. 2026-10-31T08:18:44Z. Durations are seconds.
• Ids: monitors, channels and accounts have UUIDs; incidents, groups and status pages have integers.
• Lists come as {"data": […], "next_cursor": "…"}. Pass next_cursor back as ?cursor= until it is null. ?limit= is 1–100, 50 by default. Monitors list oldest first; incidents newest first.
• PATCH changes only the fields you send. Omitted fields stay; null clears a field that allows it.
• Secrets never come back. secret_headers and basic_password are write only; responses carry has_secret_headers and has_basic_password instead. Alert channels are listed without their addresses or tokens.
• Deleting answers 204 with no body.

Errors

Every error is a JSON object with an error code and usually a detail sentence. Validation errors add fields, a map from field name to a list of messages, the same messages the panel shows.

HTTP/1.1 422 Unprocessable Content
{"error": "invalid", "fields": {"url": ["Enter a valid URL."], "colour": ["Unknown field."]}}

Rate limits and cost

Per key, per minute: 120 reads, 20 writes (POST, PATCH, DELETE) and 10 “check now” calls. Every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix time) for the bucket it counted against. Over the limit you get 429 with Retry-After.

Reading costs nothing. A monitor costs the same credits whether it was made here or in the panel: credits_per_month on every monitor says how many at its interval, and GET /account shows the balance, this month’s use and how many days the credits last. “Check now” is one extra round by every healthy probe, charged like a scheduled round, and limited to once a minute per monitor and 30 an hour per account, shared with the panel.

Checks on hosts outside a domain you have verified keep the panel’s rules too: HTTP(S) and TLS on ports 80 and 443, at most once a minute, no request bodies or custom methods. Verify the domain in the panel to unlock 15-second checks, any port and TCP, SMTP and DNS checks.

Resellers

A reseller account’s key can act inside any of its customer accounts: send X-Account: <customer id or slug> and every endpoint under Reference reads and writes that account instead. Each change is written to the customer’s support log as API key “name”: …, exactly like a visit by one of your team. Customer accounts can also have keys of their own, made by their owner; those see only their account and cannot send X-Account.

The Reseller endpoints list, create and change customer accounts and send invitations. They are available to reseller accounts only and are not combined with X-Account.

Examples

Export every monitor

import requests

API = "https://app.pingwise.com/api/v1"
H = {"Authorization": "Bearer pw_…"}

monitors, cursor = [], None
while True:
    r = requests.get(f"{API}/monitors", headers=H, params={"limit": 100, "cursor": cursor})
    r.raise_for_status()
    page = r.json()
    monitors += page["data"]
    cursor = page["next_cursor"]
    if cursor is None:
        break
print(len(monitors), "monitors")

Add a monitor when a site is created, pause it when the site is suspended

r = requests.post(f"{API}/monitors", headers=H, json={
    "name": "Customer shop",
    "url": "https://shop.example.com",
    "interval": 60,
    "group": 12,
    "notes": "Hosted on web-03. Contact: Nikos, +30 69…",
})
if r.status_code == 422:
    print(r.json()["fields"])          # {"url": ["…"]} — the same messages as the panel
monitor_id = r.json()["id"]

requests.post(f"{API}/monitors/{monitor_id}/pause", headers=H)
requests.post(f"{API}/monitors/{monitor_id}/resume", headers=H)

What is down right now?

curl "https://app.pingwise.com/api/v1/incidents?status=open" -H "Authorization: Bearer pw_…"

A reseller creating a customer and its first monitor

acct = requests.post(f"{API}/accounts", headers=H, json={
    "name": "Bakery Nikos", "contact_email": "[email protected]", "monthly_cap": 50000,
}).json()

requests.post(f"{API}/monitors", headers={**H, "X-Account": acct["id"]},
              json={"url": "https://bakerynikos.gr", "interval": 300})

requests.post(f"{API}/accounts/{acct['id']}/invites", headers=H,
              json={"email": "[email protected]", "role": "owner"})

Reference

Generated from openapi.json, the same file the server is tested against: every route below exists, and every route that exists is below. Field details are under Objects.

Account

Monitors

Incidents

Groups

Channels

Status pages

Probes

Reseller

Meta

Objects

Error

MonitorInput

Monitor

Account

Incident

Group

GroupInput

Channel

StatusPage

Probe

Check

Customer

CustomerInput

InviteInput

Invite

Changes

v1 · October 2026: first release. We add fields and endpoints without changing what exists; anything that would break a client gets a new version path and notice in the panel.

Questions or a missing endpoint: hello@pingwise.com.