Monitors

Create a monitor

Create a monitor. The check interval and number of regions are subject to your plan limits.

POSThttps://api.vantaj.co/v1/monitors

Requires an API key with the monitors:write scope.

Authorizations

Authorizationstringheaderrequired

Bearer authentication using your API key: Authorization: Bearer <token>

Body

application/json

project_idstring<uuid>required

Project the monitor belongs to.

namestringrequired

Display name (1–200 characters).

urlstringrequired

Target URL or host. For non-HTTP types, a bare host.

typestringrequired

Monitor type. icmp is accepted as an alias for ping.

Allowed:httptcpsmtppingicmpssldns

interval_secondsinteger

Check frequency.

Allowed:3060180300600180036002160086400Default:300

regionsstring[]

Probe regions. Count is capped by your plan.

groupstring | null

Optional group label.

timeout_secondsinteger

Request timeout (1–120).

expected_status_codesinteger[]

HTTP status codes treated as healthy.

Create a monitor

cURL

curl --request POST \
  --url 'https://api.vantaj.co/v1/monitors' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "project_id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
  "name": "API Gateway",
  "url": "https://api.example.com/health",
  "type": "http",
  "interval_seconds": 60
}'

{
  "data": {
    "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "name": "API Gateway",
    "url": "https://api.example.com/health",
    "type": "http",
    "interval_seconds": 60,
    "status": "up",
    "paused": false,
    "last_checked_at": "2026-06-21T12:00:00Z",
    "response_ms": 142,
    "uptime_pct": 99.98,
    "regions": [
      "iad",
      "lhr"
    ],
    "group": "Production",
    "created_at": "2026-01-15T10:30:00Z"
  }
}