Vantaj
Back to home
API

Monitoring API

Programmatic access to everything in Vantaj. Create monitors, manage incidents, pull metrics, and automate your entire monitoring infrastructure with a simple REST API.

Get started freeRead the API docs
$ curl -X POST https://api.vantaj.co/v1/monitors \
-H "Authorization: Bearer $VANTAJ_API_KEY" \
-d '{"project_id":"…","name":"API","url":"https://api.acme.com","type":"http"}'
201 Created
→ "status": "pending" first check queued
✓ Monitor live - app.vantaj.co/

API endpoints

Method Endpoint
GET/v1/monitors
POST/v1/monitors
PATCH/v1/monitors/:id
POST/v1/monitors/:id/pause
DELETE/v1/monitors/:id
GET/v1/incidents
POST/v1/heartbeats
POST/v1/domains
POST/v1/status-pages
GET/v1/projects

Built for developers

RESTful design

Clean, predictable endpoints that follow REST conventions. JSON in, JSON out, with a consistent { data } envelope and cursor pagination.

Scoped API keys

Bearer token auth with per-key scopes like monitors:write or incidents:read. Generate and revoke keys from the dashboard.

OpenAPI spec

A full OpenAPI 3.1 spec at api.vantaj.co/openapi.json - generate typed clients in any language, or explore the interactive reference.

Predictable quotas

Daily request quotas per API key: 1,000/day on Developer, 5,000-10,000/day on Team, unlimited on Enterprise. Quota headers on every response.

CI/CD integration

Create monitors on deploy, pause checks during releases with /pause and /resume, and tear down on branch cleanup.

Webhook alerts

Point alerts at your own endpoint and receive signed payloads when monitors go down, recover, or SSL certs near expiry.

What you can build

01

Infrastructure as Code

Define your monitoring configuration alongside your infrastructure. Create monitors automatically when you deploy a new service - tear them down when you decommission.

02

Custom dashboards

Every monitor resource includes its live status, uptime percentage, and last response time - pull them into Grafana, Datadog, or your own internal tools.

03

ChatOps & automation

Build Slack bots that create monitors, list open incidents, or pause checks during a release - all through the API.

04

Multi-tenant monitoring

Agencies and SaaS platforms can programmatically manage monitors for each client, organised into projects with separate status pages.

Frequently asked questions

What authentication does the API use?
Bearer token authentication. Generate API keys from your Vantaj dashboard under Settings → API Keys. Each key carries scopes (e.g. monitors:read, monitors:write, incidents:read), so you can issue read-only keys for dashboards and write keys for automation.
Is there a rate limit?
Yes - a daily request quota per API key: 1,000 requests/day on Developer, 5,000/day on Team 100, 10,000/day on Team 200, and unlimited on Enterprise. The quota resets at midnight UTC and quota headers are included in every response.
Can I create monitors via the API?
Yes. Full CRUD for uptime monitors (HTTP, TCP, SMTP, ping, SSL, DNS), heartbeat monitors, and domain tracking - plus pause/resume endpoints. Check intervals and probe region counts follow the same plan limits as the dashboard.
Does the API support webhooks?
Webhook alerts are configured as alert channels in the dashboard: point them at your endpoint and Vantaj sends signed payloads (X-Vantaj-Signature) when monitors go down, recover, or SSL certificates approach expiry.
Is there an SDK?
Not yet - the API is a straightforward REST interface, and a full OpenAPI 3.1 spec is published at api.vantaj.co/openapi.json, so you can generate a typed client for any language with your generator of choice. An interactive API reference lives in the docs.
Can I use the API on the free tier?
API access is included on all paid plans, starting with Developer (1,000 requests/day). The free tier does not include API access.

Start building with the Vantaj API

API access is included on every paid plan, starting at 1,000 requests/day. Create your first monitor programmatically in under a minute.

Get your API keyAPI docs