Skip to main content

Developer documentation

Build with the Visual Sentinel API

Automate the monitoring work your team already does in Visual Sentinel. Create monitors, inspect incidents, retrieve website-health evidence, generate client reports, and keep customer-facing status workflows connected to the same source of truth.

Open the API reference Get an API key

Authentication

Requests use organization API keys with scoped permissions. Keep keys server-side, rotate them when team access changes, and create separate keys for dashboards, scripts, and integrations.

Core resources

Work with monitors, incidents, status pages, maintenance windows, reports, notification channels, and account metadata from one OpenAPI-described surface.

Automation paths

Pair API calls with webhooks, MCP tools, and scheduled jobs to sync monitoring evidence into ticketing systems, customer reports, and deployment pipelines.

Find the endpoint you need before opening the full reference

Each area lists a few of its most-used endpoints. The full reference below covers every parameter, request body and response.

Monitors and measurements

Create monitors, trigger checks, and read uptime, response-time, DNS, content, and performance history.

  • GET /api/monitors
  • POST /api/monitors
  • GET /api/monitors/{id}/uptime

Visual monitoring

Capture screenshots, compare snapshots, manage baselines, and inspect monitored sub-pages.

  • GET /api/monitors/{id}/visual
  • POST /api/monitors/{id}/visual/capture
  • POST /api/monitors/{id}/visual/compare

Incidents and alerts

List active work, inspect incident evidence, update incident state, and connect notification channels.

  • GET /api/incidents
  • GET /api/incidents/{id}
  • GET /api/notification-channels

Client reports

Retrieve monitor report data and manage reporting preferences.

  • GET /api/monitors/{id}/report
  • PUT /api/settings/reports
  • GET /api/settings/reports

Status pages

Create public status pages, assign monitors, and manage verified customer-facing domains.

  • GET /api/status-pages
  • POST /api/status-pages
  • POST /api/status-pages/{id}/custom-domain

Server monitoring

Register infrastructure, read current server details, and retrieve time-series health metrics.

  • GET /api/servers
  • POST /api/servers
  • GET /api/servers/{id}/metrics

Authenticate safely

Create an API key under Workspace > Developer access. Give each integration only the scopes it needs, keep the key on your server, and rotate it without disrupting your other workflows.

Manage API keys

List your monitors

curl https://visualsentinel.com/api/monitors \
  --header "Authorization: Bearer vs_your_api_key"
Example response
[
  {
    "id": "00000000-0000-4000-8000-000000000001",
    "name": "Example shop",
    "url": "https://shop.example.com",
    "status": "operational",
    "uptime30d": 99.98
  },
  {
    "id": "00000000-0000-4000-8000-000000000002",
    "name": "Example blog",
    "url": "https://blog.example.com",
    "status": "down",
    "uptime30d": 97.4
  }
]

Use it from an AI assistant

Install the Visual Sentinel MCP server for 17 tools across the public API.

Set up the MCP server

OpenAPI 3.1

The machine-readable specification that powers this page is at docs.visualsentinel.com/openapi.json, mirrored on GitHub. Point code generators, API clients or AI agents at it.

Open openapi.json GitHub mirror

API reference

Every parameter, request body, response and required scope.