Documentation
Everything you need to start monitoring APIs with VigilAPI — setup, alerts, and plans.
Getting started
Create a free account, open your dashboard, and click Add API. Enter a name and a public URL — that is all you need to start monitoring.
VigilAPI checks your endpoints on a schedule and records status codes, response times, and response changes.
Adding an API
Each monitored API needs a name, URL, and HTTP method (GET, POST, PUT, or DELETE).
For POST and PUT requests, you can optionally add a JSON request body if your endpoint requires one.
Headers and auth are optional — expand “Headers & auth” only when your API needs a Bearer token or custom key.
Slack alerts
VigilAPI sends alerts through Slack incoming webhooks. Add a webhook URL in Settings (default) or per API in the Alerts tab.
Create a webhook at api.slack.com → your app → Incoming Webhooks → Add to workspace → copy the URL.
Use “Send test webhook” on any API to confirm alerts arrive before you rely on them.
What we check
Every check records the HTTP status code, response time, and a hash of the response body.
If the status code changes, the API is slow, or the response payload changes, VigilAPI flags it and can alert you.
By default, down or degraded status requires 2 consecutive failures before an alert fires — reducing false alarms.
Free vs Pro
Free: 3 actively monitored APIs, checks every 24 hours, Slack webhooks, 7-day history.
Pro: 30 APIs, checks every 30 minutes, payload diff viewer, manual “Check now”, and 30-day history.
See the pricing page for full details or upgrade anytime from your dashboard.
What you can monitor
Any public HTTP or HTTPS URL — your own backend, a partner API, or a third-party service.
Endpoints must be reachable from the public internet. Localhost and private network URLs are not supported.