# Visual Sentinel API documentation > Build monitoring dashboards, client reports, status-page workflows, and incident-response automations with the Visual Sentinel REST API. Every link below points at the markdown copy of a page. The same address without .md also answers with markdown when the request sends Accept: text/markdown. API base URL: https://visualsentinel.com. Authenticate with an API key sent as Authorization: Bearer vs_xxxxx, kept server-side, one scoped key per integration. The OpenAPI 3.1 specification at https://docs.visualsentinel.com/openapi.json is the source every page here is generated from, and the source of truth for endpoint paths, methods, parameters, request bodies, responses, and required scopes. ## Overview - [Visual Sentinel API documentation](https://docs.visualsentinel.com/index.md): Overview of the REST API: authentication, the main resource areas, a first request, MCP and the OpenAPI specification. ## 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. ## API reference - [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. ## Data models - [ServiceDependencyCatalog data model](https://docs.visualsentinel.com/reference/models/service-dependency-catalog.md): Fields of the ServiceDependencyCatalog shape. - [ServiceDependencyStatus data model](https://docs.visualsentinel.com/reference/models/service-dependency-status.md): Fields of the ServiceDependencyStatus shape. - [ServiceDependencyNoFeed data model](https://docs.visualsentinel.com/reference/models/service-dependency-no-feed.md): Fields of the ServiceDependencyNoFeed shape. - [UpdateServiceDependencyComponentsRequest data model](https://docs.visualsentinel.com/reference/models/update-service-dependency-components-request.md): Fields of the UpdateServiceDependencyComponentsRequest shape. - [UpdateServiceDependencyComponentsResponse data model](https://docs.visualsentinel.com/reference/models/update-service-dependency-components-response.md): Fields of the UpdateServiceDependencyComponentsResponse shape. - [ErrorResponse data model](https://docs.visualsentinel.com/reference/models/error-response.md): Fields of the ErrorResponse shape. - [LoginRequest data model](https://docs.visualsentinel.com/reference/models/login-request.md): Fields of the LoginRequest shape. - [RegisterRequest data model](https://docs.visualsentinel.com/reference/models/register-request.md): Fields of the RegisterRequest shape. - [AuthResponse data model](https://docs.visualsentinel.com/reference/models/auth-response.md): Fields of the AuthResponse shape. - [User data model](https://docs.visualsentinel.com/reference/models/user.md): Fields of the User shape. - [Organization data model](https://docs.visualsentinel.com/reference/models/organization.md): Fields of the Organization shape. - [MonitorType data model](https://docs.visualsentinel.com/reference/models/monitor-type.md): Monitor types accepted when creating a monitor. - [MonitorStatus data model](https://docs.visualsentinel.com/reference/models/monitor-status.md): Fields of the MonitorStatus shape. - [MonitorResponseStatus data model](https://docs.visualsentinel.com/reference/models/monitor-response-status.md): Fields of the MonitorResponseStatus shape. - [HTTPMethod data model](https://docs.visualsentinel.com/reference/models/http-method.md): Fields of the HTTPMethod shape. - [PageSpeedFailure data model](https://docs.visualsentinel.com/reference/models/page-speed-failure.md): The latest failed test and consecutive failure count. - [Monitor data model](https://docs.visualsentinel.com/reference/models/monitor.md): Fields of the Monitor shape. - [CreateMonitorRequest data model](https://docs.visualsentinel.com/reference/models/create-monitor-request.md): Fields of the CreateMonitorRequest shape. - [UpdateMonitorRequest data model](https://docs.visualsentinel.com/reference/models/update-monitor-request.md): Fields of the UpdateMonitorRequest shape. - [MonitorListResponse data model](https://docs.visualsentinel.com/reference/models/monitor-list-response.md): Paginated monitor list envelope, returned only when the request sends Accept: application/json and a page query parameter. - [MonitorListSummary data model](https://docs.visualsentinel.com/reference/models/monitor-list-summary.md): Exact counts for the current scope/search/type/tags, independent of the selected status chip. - [CheckResult data model](https://docs.visualsentinel.com/reference/models/check-result.md): Fields of the CheckResult shape. - [UptimeResponse data model](https://docs.visualsentinel.com/reference/models/uptime-response.md): Fields of the UptimeResponse shape. - [ResponseTimeResponse data model](https://docs.visualsentinel.com/reference/models/response-time-response.md): Fields of the ResponseTimeResponse shape. - [VisualDataResponse data model](https://docs.visualsentinel.com/reference/models/visual-data-response.md): Fields of the VisualDataResponse shape. - [Server data model](https://docs.visualsentinel.com/reference/models/server.md): Fields of the Server shape. - [ServerListResponse data model](https://docs.visualsentinel.com/reference/models/server-list-response.md): Fields of the ServerListResponse shape. - [ServerMetricsResponse data model](https://docs.visualsentinel.com/reference/models/server-metrics-response.md): Fields of the ServerMetricsResponse shape. - [ServerAlertListResponse data model](https://docs.visualsentinel.com/reference/models/server-alert-list-response.md): Fields of the ServerAlertListResponse shape. - [Alert data model](https://docs.visualsentinel.com/reference/models/alert.md): Fields of the Alert shape. - [AlertListResponse data model](https://docs.visualsentinel.com/reference/models/alert-list-response.md): Fields of the AlertListResponse shape. - [AlertRule data model](https://docs.visualsentinel.com/reference/models/alert-rule.md): An alert rule. - [AlertRuleResponse data model](https://docs.visualsentinel.com/reference/models/alert-rule-response.md): Fields of the AlertRuleResponse shape. - [CreateAlertRuleRequest data model](https://docs.visualsentinel.com/reference/models/create-alert-rule-request.md): Fields of the CreateAlertRuleRequest shape. - [UpdateAlertRuleRequest data model](https://docs.visualsentinel.com/reference/models/update-alert-rule-request.md): Fields of the UpdateAlertRuleRequest shape. - [AlertRuleConditionNotSupportedResponse data model](https://docs.visualsentinel.com/reference/models/alert-rule-condition-not-supported-response.md): Returned with 400 when a request uses status_change, consecutive_failures or ssl_expiry. - [AlertRuleListResponse data model](https://docs.visualsentinel.com/reference/models/alert-rule-list-response.md): Fields of the AlertRuleListResponse shape. - [NotificationChannel data model](https://docs.visualsentinel.com/reference/models/notification-channel.md): Webhook notifications include other_address_failing and other_address_recovery events. - [CreateNotificationChannelRequest data model](https://docs.visualsentinel.com/reference/models/create-notification-channel-request.md): Fields of the CreateNotificationChannelRequest shape. - [Incident data model](https://docs.visualsentinel.com/reference/models/incident.md): Fields of the Incident shape. - [ApiKey data model](https://docs.visualsentinel.com/reference/models/api-key.md): Fields of the ApiKey shape. - [Pagination data model](https://docs.visualsentinel.com/reference/models/pagination.md): Fields of the Pagination shape. - [OtherAddress data model](https://docs.visualsentinel.com/reference/models/other-address.md): The www or bare-domain twin, independent of primary uptime. - [StoredMonitorType data model](https://docs.visualsentinel.com/reference/models/stored-monitor-type.md): Every monitor type value a stored monitor can carry. - [CheckRegion data model](https://docs.visualsentinel.com/reference/models/check-region.md): Check region: EU (Europe), US (United States), ASIA (Asia Pacific). - [ApiMonitorConfig data model](https://docs.visualsentinel.com/reference/models/api-monitor-config.md): Fields of the ApiMonitorConfig shape. - [MaintenanceWindow data model](https://docs.visualsentinel.com/reference/models/maintenance-window.md): Fields of the MaintenanceWindow shape. - [CreateMaintenanceWindowRequest data model](https://docs.visualsentinel.com/reference/models/create-maintenance-window-request.md): Fields of the CreateMaintenanceWindowRequest shape. - [UpdateMaintenanceWindowRequest data model](https://docs.visualsentinel.com/reference/models/update-maintenance-window-request.md): Fields of the UpdateMaintenanceWindowRequest shape. - [UpdateIncidentRequest data model](https://docs.visualsentinel.com/reference/models/update-incident-request.md): Fields of the UpdateIncidentRequest shape. - [MonitorAlertMuteRequest data model](https://docs.visualsentinel.com/reference/models/monitor-alert-mute-request.md): Fields of the MonitorAlertMuteRequest shape. - [MonitorAlertMuteResponse data model](https://docs.visualsentinel.com/reference/models/monitor-alert-mute-response.md): Fields of the MonitorAlertMuteResponse shape. - [MonitorServerMatch data model](https://docs.visualsentinel.com/reference/models/monitor-server-match.md): Fields of the MonitorServerMatch shape. - [MonitorServerResolveResponse data model](https://docs.visualsentinel.com/reference/models/monitor-server-resolve-response.md): Fields of the MonitorServerResolveResponse shape. - [MonitorServerSummary data model](https://docs.visualsentinel.com/reference/models/monitor-server-summary.md): Fields of the MonitorServerSummary shape. - [MonitorServerListEntry data model](https://docs.visualsentinel.com/reference/models/monitor-server-list-entry.md): Fields of the MonitorServerListEntry shape. - [MonitorServerListResponse data model](https://docs.visualsentinel.com/reference/models/monitor-server-list-response.md): Fields of the MonitorServerListResponse shape. - [MonitorServerLink data model](https://docs.visualsentinel.com/reference/models/monitor-server-link.md): Fields of the MonitorServerLink shape. - [MonitorBulkSkip data model](https://docs.visualsentinel.com/reference/models/monitor-bulk-skip.md): Fields of the MonitorBulkSkip shape. - [MonitorBulkResult data model](https://docs.visualsentinel.com/reference/models/monitor-bulk-result.md): Fields of the MonitorBulkResult shape. - [MonitorBulkRateLimitError data model](https://docs.visualsentinel.com/reference/models/monitor-bulk-rate-limit-error.md): Fields of the MonitorBulkRateLimitError shape. - [MonitorBulkSettings data model](https://docs.visualsentinel.com/reference/models/monitor-bulk-settings.md): Every field is optional; only the fields sent are changed. - [MonitorBulkLinkServerResponse data model](https://docs.visualsentinel.com/reference/models/monitor-bulk-link-server-response.md): Fields of the MonitorBulkLinkServerResponse shape. - [BulkUpdateAlertsRequest data model](https://docs.visualsentinel.com/reference/models/bulk-update-alerts-request.md): Send updates, channelAction, or both. - [IncidentContext data model](https://docs.visualsentinel.com/reference/models/incident-context.md): Everything the incident detail view shows, in one read. - [AlertDeliveryLog data model](https://docs.visualsentinel.com/reference/models/alert-delivery-log.md): Fields of the AlertDeliveryLog shape. - [AlertDeliveryLogEvent data model](https://docs.visualsentinel.com/reference/models/alert-delivery-log-event.md): Fields of the AlertDeliveryLogEvent shape. - [StatusPageGroup data model](https://docs.visualsentinel.com/reference/models/status-page-group.md): A named group of components on a status page - [StatusPageGroupSyncResult data model](https://docs.visualsentinel.com/reference/models/status-page-group-sync-result.md): What the tag sync changed. - [StatusPageMonitorListItem data model](https://docs.visualsentinel.com/reference/models/status-page-monitor-list-item.md): A monitor linked to a status page, as returned by the list endpoint - [StatusPageMonitorLink data model](https://docs.visualsentinel.com/reference/models/status-page-monitor-link.md): The link between a monitor and a status page, with its display options - [StatusPageServerListItem data model](https://docs.visualsentinel.com/reference/models/status-page-server-list-item.md): A server linked to a status page, as returned by the list endpoint - [StatusPageServerLink data model](https://docs.visualsentinel.com/reference/models/status-page-server-link.md): The link between a server and a status page, with its display options - [JsonValue data model](https://docs.visualsentinel.com/reference/models/json-value.md): Fields of the JsonValue shape. - [IncidentResolveOptions data model](https://docs.visualsentinel.com/reference/models/incident-resolve-options.md): The ways an incident can be closed. - [IncidentResolveRequest data model](https://docs.visualsentinel.com/reference/models/incident-resolve-request.md): Fields of the IncidentResolveRequest shape. ## MCP and AI agents - [MCP server](https://visualsentinel.com/mcp): Connect an AI assistant to Visual Sentinel: 106 tools across the public API. - [Agent setup guide](https://visualsentinel.com/agents/setup.md): Instructions an AI agent can follow from start to finish to connect to Visual Sentinel and use it.