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.

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

These are the main API areas used by agencies, internal dashboards, deployment workflows, and reporting automations. The interactive reference below contains every parameter, request body, response, and required scope.

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

Generate client-facing reports, check generation status, and retrieve monitor report data.

POST /api/reports/generate
GET /api/reports/generate
GET /api/monitors/{id}/report

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

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

Authenticate safely

Create an API key under Settings > API keys. 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

Bearer authentication

curl https://visualsentinel.com/api/monitors \
  --header "Authorization: Bearer vs_your_api_key"

Want to use these endpoints from Claude, Cursor, Cline, or Continue? Install the Visual Sentinel MCP server for 16 tools across the public API. The machine-readable OpenAPI 3.1 specification powering this page is served at docs.visualsentinel.com/openapi.json (point code generators, API clients, or AI agents straight at it) and mirrored at github.com/VisualSentinel/openapi.