API Documentation

API Introduction

The Vantaj Uptime REST API lets you manage monitors, heartbeats, domains, status pages and projects, and read incidents - programmatically.

Base URL

https://api.vantaj.co

Authentication

Every request must include a Bearer API key generated in the Vantaj app under Settings → API Keys. API access requires a paid plan.

Authorization: Bearer <token>

Projects are required

Every list and create call is scoped to a project - pass project_id as a query parameter on lists and in the body on creates. Use List projects to look up IDs.

Pagination

List endpoints return pagination.next_cursor. Pass it back as the cursor query parameter to fetch the next page; has_more is false on the last page.

Errors

Errors return a consistent envelope with an HTTP status and a machine-readable code:

{
  "error": {
    "code": "validation_error",
    "message": "Invalid request."
  }
}