/** * @module * * Official Node.js SDK for OpenStatus - the open-source monitoring platform. * * @example Basic usage (recommended) * ```typescript * import { createOpenStatusClient, Periodicity, Region } from "@openstatus/sdk-node"; * * // Create a client with your API key * const client = createOpenStatusClient({ * apiKey: process.env.OPENSTATUS_API_KEY, * }); * * // List all monitors - no need to pass headers * const { httpMonitors, tcpMonitors, dnsMonitors } = * await client.monitor.v1.MonitorService.listMonitors({}); * * // Create an HTTP monitor * const { monitor } = await client.monitor.v1.MonitorService.createHTTPMonitor({ * monitor: { * name: "My API", * url: "https://api.example.com/health", * periodicity: Periodicity.PERIODICITY_1M, * regions: [Region.FLY_AMS, Region.FLY_IAD, Region.FLY_SYD], * active: true, * }, * }); * ``` * * @example Alternative: Manual headers * ```typescript * import { openstatus, Periodicity } from "@openstatus/sdk-node"; * * const headers = { "x-openstatus-key": `${process.env.OPENSTATUS_API_KEY}` }; * const { monitor } = await openstatus.monitor.v1.MonitorService.createHTTPMonitor({ * monitor: { name: "My API", url: "https://api.example.com", periodicity: Periodicity.PERIODICITY_1M, active: true }, * }, { headers }); * ``` */ import type { Client, Interceptor, Transport } from "@connectrpc/connect"; import { MonitorService } from "./gen/openstatus/monitor/v1/service_pb.js"; import { HealthService } from "./gen/openstatus/health/v1/health_pb.js"; import { StatusReportService } from "./gen/openstatus/status_report/v1/service_pb.js"; import { StatusPageService } from "./gen/openstatus/status_page/v1/service_pb.js"; import { MaintenanceService } from "./gen/openstatus/maintenance/v1/service_pb.js"; import { NotificationService } from "./gen/openstatus/notification/v1/service_pb.js"; import { PrivateLocationService } from "./gen/openstatus/private_location/v1/service_pb.js"; export type { Client, Interceptor, Transport } from "@connectrpc/connect"; export { HealthService, MaintenanceService, MonitorService, NotificationService, PrivateLocationService, StatusPageService, StatusReportService, }; export type { Headers, HTTPMonitor, OpenTelemetryConfig, } from "./gen/openstatus/monitor/v1/http_monitor_pb.js"; export type { TCPMonitor } from "./gen/openstatus/monitor/v1/tcp_monitor_pb.js"; export type { DNSMonitor } from "./gen/openstatus/monitor/v1/dns_monitor_pb.js"; export type { BodyAssertion, HeaderAssertion, RecordAssertion, StatusCodeAssertion, } from "./gen/openstatus/monitor/v1/assertions_pb.js"; export { NumberComparator, RecordComparator, StringComparator, } from "./gen/openstatus/monitor/v1/assertions_pb.js"; export { HTTPMethod } from "./gen/openstatus/monitor/v1/http_monitor_pb.js"; export { Periodicity, Region } from "./gen/openstatus/monitor/v1/monitor_pb.js"; export { MonitorStatus } from "./gen/openstatus/monitor/v1/monitor_pb.js"; export type { CreateDNSMonitorRequest, CreateDNSMonitorResponse, CreateHTTPMonitorRequest, CreateHTTPMonitorResponse, CreateTCPMonitorRequest, CreateTCPMonitorResponse, DeleteMonitorRequest, DeleteMonitorResponse, GetMonitorHTTPResponseLogRequest, GetMonitorHTTPResponseLogResponse, GetMonitorRequest, GetMonitorResponse, GetMonitorStatusRequest, GetMonitorStatusResponse, GetMonitorSummaryRequest, GetMonitorSummaryResponse, HTTPResponseLogDetail, HTTPResponseLogListItem, HTTPResponseLogPagination, HTTPResponseLogTiming, ListMonitorHTTPResponseLogsRequest, ListMonitorHTTPResponseLogsResponse, ListMonitorsRequest, ListMonitorsResponse, MonitorConfig, RegionStatus, TriggerMonitorRequest, TriggerMonitorResponse, UpdateDNSMonitorRequest, UpdateDNSMonitorResponse, UpdateHTTPMonitorRequest, UpdateHTTPMonitorResponse, UpdateTCPMonitorRequest, UpdateTCPMonitorResponse, } from "./gen/openstatus/monitor/v1/service_pb.js"; export { HTTPResponseLogRequestStatus, HTTPResponseLogTrigger, TimeRange, } from "./gen/openstatus/monitor/v1/service_pb.js"; export type { CheckRequest, CheckResponse, } from "./gen/openstatus/health/v1/health_pb.js"; export { CheckResponse_ServingStatus as ServingStatus } from "./gen/openstatus/health/v1/health_pb.js"; export type { ComponentImpact, StatusReport, StatusReportSummary, StatusReportUpdate, } from "./gen/openstatus/status_report/v1/status_report_pb.js"; export { PageComponentImpact, StatusReportStatus, } from "./gen/openstatus/status_report/v1/status_report_pb.js"; export type { AddStatusReportUpdateRequest, AddStatusReportUpdateResponse, CreateStatusReportRequest, CreateStatusReportResponse, DeleteStatusReportRequest, DeleteStatusReportResponse, GetStatusReportRequest, GetStatusReportResponse, ListStatusReportsRequest, ListStatusReportsResponse, UpdateStatusReportRequest, UpdateStatusReportResponse, } from "./gen/openstatus/status_report/v1/service_pb.js"; export type { CustomTheme, PageConfiguration, StatusPage, StatusPageSummary, } from "./gen/openstatus/status_page/v1/status_page_pb.js"; export { Locale, OverallStatus, PageAccessType, PageBarType, PageMetricType, PageTheme, } from "./gen/openstatus/status_page/v1/status_page_pb.js"; export type { PageComponent, PageComponentGroup, } from "./gen/openstatus/status_page/v1/page_component_pb.js"; export { PageComponentType } from "./gen/openstatus/status_page/v1/page_component_pb.js"; export type { PageSubscriber } from "./gen/openstatus/status_page/v1/page_subscriber_pb.js"; export { SubscriberSource } from "./gen/openstatus/status_page/v1/page_subscriber_pb.js"; export type { AddMonitorComponentRequest, AddMonitorComponentResponse, AddStaticComponentRequest, AddStaticComponentResponse, ComponentDayBucket, ComponentEvent, ComponentStatus, CreateComponentGroupRequest, CreateComponentGroupResponse, CreatePageSubscriptionRequest, CreatePageSubscriptionResponse, CreateStatusPageRequest, CreateStatusPageResponse, DeleteComponentGroupRequest, DeleteComponentGroupResponse, DeleteStatusPageRequest, DeleteStatusPageResponse, EmailChannel, GetOverallStatusRequest, GetOverallStatusResponse, GetPageComponentDailySummaryRequest, GetPageComponentDailySummaryResponse, GetPageComponentRequest, GetPageComponentResponse, GetStatusPageContentRequest, GetStatusPageContentResponse, GetStatusPageOverviewRequest, GetStatusPageOverviewResponse, GetStatusPageRequest, GetStatusPageResponse, ListStatusPagesRequest, ListStatusPagesResponse, ListSubscribersRequest, ListSubscribersResponse, PageComponentDailySummary, RemoveComponentRequest, RemoveComponentResponse, SubscribeToPageRequest, SubscribeToPageResponse, UnsubscribeFromPageRequest, UnsubscribeFromPageResponse, UpdateComponentGroupRequest, UpdateComponentGroupResponse, UpdateComponentRequest, UpdateComponentResponse, UpdateStatusPageRequest, UpdateStatusPageResponse, WebhookChannel, WebhookChannelHeader, } from "./gen/openstatus/status_page/v1/service_pb.js"; export { ComponentDayStatus, ComponentEventStatus, ComponentEventType, } from "./gen/openstatus/status_page/v1/service_pb.js"; export type { Maintenance, MaintenanceSummary, } from "./gen/openstatus/maintenance/v1/maintenance_pb.js"; export type { CreateMaintenanceRequest, CreateMaintenanceResponse, DeleteMaintenanceRequest, DeleteMaintenanceResponse, GetMaintenanceRequest, GetMaintenanceResponse, ListMaintenancesRequest, ListMaintenancesResponse, UpdateMaintenanceRequest, UpdateMaintenanceResponse, } from "./gen/openstatus/maintenance/v1/service_pb.js"; export type { Notification, NotificationSummary, } from "./gen/openstatus/notification/v1/notification_pb.js"; export type { DiscordData, EmailData, GoogleChatData, GrafanaOncallData, MsTeamsData, NotificationData, NtfyData, OpsgenieData, PagerDutyData, SlackData, SmsData, TelegramData, WebhookData, WebhookHeader, WhatsappData, } from "./gen/openstatus/notification/v1/providers_pb.js"; export { NotificationProvider, OpsgenieRegion, } from "./gen/openstatus/notification/v1/providers_pb.js"; export type { CheckNotificationLimitRequest, CheckNotificationLimitResponse, CreateNotificationRequest, CreateNotificationResponse, DeleteNotificationRequest, DeleteNotificationResponse, GetNotificationRequest, GetNotificationResponse, ListNotificationsRequest, ListNotificationsResponse, SendTestNotificationRequest, SendTestNotificationResponse, UpdateNotificationRequest, UpdateNotificationResponse, } from "./gen/openstatus/notification/v1/service_pb.js"; export type { PrivateLocation, PrivateLocationSummary, } from "./gen/openstatus/private_location/v1/private_location_pb.js"; export { PrivateLocationStatus } from "./gen/openstatus/private_location/v1/private_location_pb.js"; export type { CreatePrivateLocationRequest, CreatePrivateLocationResponse, DeletePrivateLocationRequest, DeletePrivateLocationResponse, GetPrivateLocationRequest, GetPrivateLocationResponse, ListPrivateLocationsRequest, ListPrivateLocationsResponse, UpdatePrivateLocationRequest, UpdatePrivateLocationResponse, } from "./gen/openstatus/private_location/v1/service_pb.js"; /** * Configuration options for creating an OpenStatus client. */ export interface OpenStatusClientOptions { /** * Your OpenStatus API key. * If provided, it will be automatically included in all requests. */ apiKey?: string; /** * Custom API base URL. Defaults to the OpenStatus production API. */ baseUrl?: string; /** * Bring your own Connect transport — e.g. a `@connectrpc/connect-web` * transport with a custom `fetch` (Cloudflare Workers need one that * tolerates `redirect: "error"`). When set, `baseUrl` and `apiKey` are * ignored; configure auth on the transport via `createAuthInterceptor`. */ transport?: Transport; } /** * Creates an interceptor that adds the API key header to all requests. */ export declare function createAuthInterceptor(apiKey: string): Interceptor; /** * Creates a fetch-based Connect transport for the OpenStatus API. Works on any * runtime with a global `fetch` (Node 18+, Deno, Bun, edge/Workers). * Returns `options.transport` verbatim when one is provided. */ export declare function createOpenStatusTransport(options?: OpenStatusClientOptions): Transport; /** * OpenStatus API client interface. * * Provides access to Monitor and Health services. */ export interface OpenStatusClient { /** * Monitor service namespace (v1). */ monitor: { v1: { /** * MonitorService provides CRUD and operational commands for monitors. * * Methods: * - `createHTTPMonitor` - Create a new HTTP monitor * - `createTCPMonitor` - Create a new TCP monitor * - `createDNSMonitor` - Create a new DNS monitor * - `updateHTTPMonitor` - Update an existing HTTP monitor * - `updateTCPMonitor` - Update an existing TCP monitor * - `updateDNSMonitor` - Update an existing DNS monitor * - `listMonitors` - List all monitors * - `getMonitor` - Get a single monitor by ID * - `triggerMonitor` - Trigger an immediate check * - `deleteMonitor` - Delete a monitor * - `getMonitorStatus` - Get status of all regions for a monitor * - `getMonitorSummary` - Get aggregated metrics for a monitor * - `listMonitorHTTPResponseLogs` - List HTTP response logs for a monitor * - `getMonitorHTTPResponseLog` - Get a single HTTP response log with full details */ MonitorService: Client; }; }; /** * Health service namespace (v1). */ health: { v1: { /** * HealthService provides health check endpoints. * * Methods: * - `check` - Check API health status */ HealthService: Client; }; }; /** * Status report service namespace (v1). */ statusReport: { v1: { /** * StatusReportService provides CRUD operations for status reports. * * Methods: * - `createStatusReport` - Create a new status report * - `getStatusReport` - Get a status report by ID * - `listStatusReports` - List all status reports * - `updateStatusReport` - Update a status report * - `deleteStatusReport` - Delete a status report * - `addStatusReportUpdate` - Add an update to a status report */ StatusReportService: Client; }; }; /** * Status page service namespace (v1). */ statusPage: { v1: { /** * StatusPageService provides CRUD and management operations for status pages. * * Methods: * - `createStatusPage` - Create a new status page * - `getStatusPage` - Get a status page by ID * - `listStatusPages` - List all status pages * - `updateStatusPage` - Update a status page * - `deleteStatusPage` - Delete a status page * - `addMonitorComponent` - Add a monitor-based component * - `addStaticComponent` - Add a static component * - `removeComponent` - Remove a component * - `updateComponent` - Update a component * - `getPageComponent` - Get a single component by ID * - `createComponentGroup` - Create a component group * - `deleteComponentGroup` - Delete a component group * - `updateComponentGroup` - Update a component group * - `subscribeToPage` - Subscribe an email to a status page (double opt-in) * - `createPageSubscription` - Add a vendor-managed subscriber (email or webhook, no verification) * - `unsubscribeFromPage` - Unsubscribe from a status page * - `listSubscribers` - List all subscribers * - `getStatusPageContent` - Get full status page content * - `getOverallStatus` - Get aggregated status * - `getStatusPageOverview` - Get page, config, components, reports and statuses in one call * - `getPageComponentDailySummary` - Get per-component daily status buckets (status bars) */ StatusPageService: Client; }; }; /** * Maintenance service namespace (v1). */ maintenance: { v1: { /** * MaintenanceService provides CRUD operations for maintenance windows. * * Methods: * - `createMaintenance` - Create a new maintenance window * - `getMaintenance` - Get a maintenance window by ID * - `listMaintenances` - List all maintenance windows * - `updateMaintenance` - Update a maintenance window * - `deleteMaintenance` - Delete a maintenance window */ MaintenanceService: Client; }; }; /** * Notification service namespace (v1). */ notification: { v1: { /** * NotificationService provides CRUD operations for notification channels. * * Methods: * - `createNotification` - Create a new notification channel * - `getNotification` - Get a notification channel by ID * - `listNotifications` - List all notification channels * - `updateNotification` - Update a notification channel * - `deleteNotification` - Delete a notification channel * - `sendTestNotification` - Send a test notification * - `checkNotificationLimit` - Check notification limits */ NotificationService: Client; }; }; /** * Private location service namespace (v1). */ privateLocation: { v1: { /** * PrivateLocationService provides CRUD operations for private locations — * self-hosted checker agents that run monitors from your own network. * * Methods: * - `createPrivateLocation` - Create a private location and get its agent token * - `getPrivateLocation` - Get a private location by ID (includes the agent token) * - `listPrivateLocations` - List private location summaries (no tokens) * - `updatePrivateLocation` - Update a private location * - `deletePrivateLocation` - Delete a private location */ PrivateLocationService: Client; }; }; } /** * Creates a configured OpenStatus client with optional API key authentication. * * Use this factory function to create a client that automatically includes * your API key in all requests, eliminating the need to pass headers manually. * * @example * ```typescript * import { createOpenStatusClient, Periodicity, Region } from "@openstatus/sdk-node"; * * // Create a configured client * const client = createOpenStatusClient({ * apiKey: process.env.OPENSTATUS_API_KEY, * }); * * // No need to pass headers on each call * const { httpMonitors } = await client.monitor.v1.MonitorService.listMonitors({}); * * const { monitor } = await client.monitor.v1.MonitorService.createHTTPMonitor({ * monitor: { * name: "My API", * url: "https://api.example.com/health", * periodicity: Periodicity.PERIODICITY_1M, * regions: [Region.FLY_AMS, Region.FLY_IAD], * active: true, * }, * }); * ``` */ export declare function createOpenStatusClient(options?: OpenStatusClientOptions): OpenStatusClient; /** * Default OpenStatus SDK client (without pre-configured authentication). * * For authenticated requests, either: * 1. Use `createOpenStatusClient({ apiKey })` to create a pre-configured client (recommended) * 2. Pass headers manually on each call * * @example Using createOpenStatusClient (recommended) * ```typescript * import { createOpenStatusClient, Periodicity } from "@openstatus/sdk-node"; * * const client = createOpenStatusClient({ apiKey: process.env.OPENSTATUS_API_KEY }); * const { monitor } = await client.monitor.v1.MonitorService.createHTTPMonitor({ * monitor: { name: "My Website", url: "https://example.com", periodicity: Periodicity.PERIODICITY_1M, active: true }, * }); * ``` * * @example Using default client with manual headers * ```typescript * import { openstatus, Periodicity } from "@openstatus/sdk-node"; * * const headers = { "x-openstatus-key": `${process.env.OPENSTATUS_API_KEY}` }; * const { monitor } = await openstatus.monitor.v1.MonitorService.createHTTPMonitor({ * monitor: { name: "My Website", url: "https://example.com", periodicity: Periodicity.PERIODICITY_1M, active: true }, * }, { headers }); * ``` */ export declare const openstatus: OpenStatusClient; //# sourceMappingURL=mod.d.ts.map