> For the complete documentation index, see [llms.txt](https://docs.visualsentinel.com/llms.txt) Developer documentation # Build with the Visual Sentinel API Automate the [website monitoring](https://visualsentinel.com/website-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. [Get an API key](https://visualsentinel.com/auth?mode=signup). Have an account? [Sign in](https://visualsentinel.com/auth?mode=login&redirect=%2Forganization%2Fsettings%23developer). ## Authentication Requests use organization API keys with scoped permissions, included with every paid plan. 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](https://visualsentinel.com/organization/settings#developer). ### List your monitors ```bash curl https://visualsentinel.com/api/monitors \ --header "Authorization: Bearer vs_your_api_key" ``` Example response: ```json [ { "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 106 tools across the public API. [Set up the MCP server](https://visualsentinel.com/mcp), or hand your agent the [setup guide](https://visualsentinel.com/agents/setup.md). ## 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](https://docs.visualsentinel.com/openapi.json), [GitHub mirror](https://github.com/VisualSentinel/openapi). ## API reference Every parameter, request body, response and required scope. Base URL: `https://visualsentinel.com`. Each area below has its own page, also available as markdown. - [System API](https://docs.visualsentinel.com/reference/system.md): Health checks, metrics, and system status. 3 endpoints. - [Authentication API](https://docs.visualsentinel.com/reference/authentication.md): User authentication, sessions, OAuth, and 2FA. 23 endpoints. - [Monitors API](https://docs.visualsentinel.com/reference/monitors.md): Website and endpoint monitoring CRUD and operations. 51 endpoints. - [Visual Monitoring API](https://docs.visualsentinel.com/reference/visual-monitoring.md): Screenshot-based visual regression detection. 9 endpoints. - [Servers API](https://docs.visualsentinel.com/reference/servers.md): Server infrastructure monitoring via agent. 8 endpoints. - [Server Alerts API](https://docs.visualsentinel.com/reference/server-alerts.md): Server alert history and configuration. One endpoint. - [Notification Channels API](https://docs.visualsentinel.com/reference/notification-channels.md): Manage notification destinations (email, Slack, Discord, etc.). 12 endpoints. - [Alerts API](https://docs.visualsentinel.com/reference/alerts.md): Alert management, acknowledgment, and resolution. 8 endpoints. - [Alert Rules API](https://docs.visualsentinel.com/reference/alert-rules.md): Configure alerting conditions and thresholds. 5 endpoints. - [Alert Groups API](https://docs.visualsentinel.com/reference/alert-groups.md): Grouped alert management. 6 endpoints. - [Incidents API](https://docs.visualsentinel.com/reference/incidents.md): Incident tracking and management. 12 endpoints. - [Status Pages API](https://docs.visualsentinel.com/reference/status-pages.md): Public status page management. 26 endpoints. - [Organization API](https://docs.visualsentinel.com/reference/organization.md): Organization settings, members, invitations, and branding. 24 endpoints. - [Maintenance API](https://docs.visualsentinel.com/reference/maintenance.md): Scheduled maintenance windows. 6 endpoints. - [Billing API](https://docs.visualsentinel.com/reference/billing.md): Subscription management and checkout. 2 endpoints. - [Integrations API](https://docs.visualsentinel.com/reference/integrations.md): Third-party integrations (Slack, Discord, PagerDuty, webhooks, Google). 5 endpoints. - [Tools API](https://docs.visualsentinel.com/reference/tools.md): Free public website checking tools. 4 endpoints. - [Reports API](https://docs.visualsentinel.com/reference/reports.md): Report generation and digest emails. Workspace digest email AI summaries are optional, off by default, and added only when sending an opted-in digest on an eligible plan. One endpoint. - [Analytics API](https://docs.visualsentinel.com/reference/analytics.md): Analytics, journeys, and subscription events. 4 endpoints. - [Notifications API](https://docs.visualsentinel.com/reference/notifications.md): In-app notification management. 4 endpoints. - [User API](https://docs.visualsentinel.com/reference/user.md): User profile and preferences. 8 endpoints. - [Chat API](https://docs.visualsentinel.com/reference/chat.md): AI chat support system. 12 endpoints. - [Onboarding API](https://docs.visualsentinel.com/reference/onboarding.md): User onboarding flow. 4 endpoints. - [Settings API](https://docs.visualsentinel.com/reference/settings.md): Application settings (deduplication, reports). 5 endpoints. - [Public API](https://docs.visualsentinel.com/reference/public.md): Unauthenticated public endpoints (blog, status pages). 9 endpoints. - [API Keys API](https://docs.visualsentinel.com/reference/api-keys.md): API key management. 3 endpoints. - [Free Tools API](https://docs.visualsentinel.com/reference/free-tools.md): Endpoints for free tools. One endpoint. ## Guides - [Plans and limits](https://docs.visualsentinel.com/guides/plans-and-limits.md): Prices, monitors, check intervals, the Free plan, the trial and refunds for every Visual Sentinel plan. - [Authentication](https://docs.visualsentinel.com/guides/authentication.md): Endpoints accept either of two credentials unless an operation says otherwise. - [Errors](https://docs.visualsentinel.com/guides/errors.md): Status codes, the ErrorResponse body and the machine-readable error codes the API returns. - [Check regions](https://docs.visualsentinel.com/guides/check-regions.md): Uptime checks for HTTP, HTTPS, KEYWORD, API and GRAPHQL monitors can run from EU (Europe), US (United States) and ASIA (Asia Pacific); other monitor types run from EU. - [Mobile apps (iOS, Android, Mac)](https://docs.visualsentinel.com/guides/mobile-apps.md): Native apps can use the same login flow: POST /api/auth/login returns a JWT. - [Rate limits](https://docs.visualsentinel.com/guides/rate-limits.md): API keys: 1,000 requests per minute per key. Every data model (a request or response shape) has its own page. [llms.txt](https://docs.visualsentinel.com/llms.txt) lists them all.