Reference

Enums

Periodicity

HTTPMethod

MonitorStatus

TimeRange

StatusReportStatus

OverallStatus

NotificationProvider

OpsgenieRegion

PageAccessType

PageTheme

PageComponentType

PageMetricType

PageBarType

NumberComparator

StringComparator

RecordComparator

ServingStatus

Regions

Monitor from 28 global locations across multiple providers.

import { Region } from "@openstatus/sdk-node";

regions: [Region.FLY_AMS, Region.FLY_IAD, Region.KOYEB_FRA];

Fly.io Regions (18)

Koyeb Regions (6)

Railway Regions (4)

Assertions

Status Code Assertions

Validate HTTP response status codes using NumberComparator.

import { NumberComparator } from "@openstatus/sdk-node";

statusCodeAssertions: [
  { comparator: NumberComparator.EQUAL, target: BigInt(200) },
  { comparator: NumberComparator.LESS_THAN, target: BigInt(400) },
];

Body Assertions

Validate response body content using StringComparator.

import { StringComparator } from "@openstatus/sdk-node";

bodyAssertions: [
  { comparator: StringComparator.CONTAINS, target: '"status":"ok"' },
  { comparator: StringComparator.NOT_EMPTY, target: "" },
];

Header Assertions

Validate response headers using StringComparator with a header key.

import { StringComparator } from "@openstatus/sdk-node";

headerAssertions: [
  {
    key: "content-type",
    comparator: StringComparator.CONTAINS,
    target: "application/json",
  },
];

DNS Record Assertions

Validate DNS records using RecordComparator. Supported record types: A, AAAA, CNAME, MX, TXT.

import { RecordComparator } from "@openstatus/sdk-node";

recordAssertions: [
  {
    record: "A",
    comparator: RecordComparator.EQUAL,
    target: "93.184.216.34",
  },
  {
    record: "CNAME",
    comparator: RecordComparator.CONTAINS,
    target: "cdn",
  },
];

TypeScript Type Exports

All types and enums exported from @openstatus/sdk-node:

Monitor Types

• HTTPMonitor, Headers, OpenTelemetryConfig — HTTP monitor configuration
• TCPMonitor — TCP monitor configuration
• DNSMonitor — DNS monitor configuration
• StatusCodeAssertion, BodyAssertion, HeaderAssertion, RecordAssertion — assertion types
• CreateHTTPMonitorRequest, CreateHTTPMonitorResponse — HTTP monitor CRUD
• CreateTCPMonitorRequest, CreateTCPMonitorResponse — TCP monitor CRUD
• CreateDNSMonitorRequest, CreateDNSMonitorResponse — DNS monitor CRUD
• UpdateHTTPMonitorRequest, UpdateHTTPMonitorResponse
• UpdateTCPMonitorRequest, UpdateTCPMonitorResponse
• UpdateDNSMonitorRequest, UpdateDNSMonitorResponse
• ListMonitorsRequest, ListMonitorsResponse
• DeleteMonitorRequest, DeleteMonitorResponse
• TriggerMonitorRequest, TriggerMonitorResponse
• GetMonitorStatusRequest, GetMonitorStatusResponse, RegionStatus
• GetMonitorSummaryRequest, GetMonitorSummaryResponse

Monitor Enums

• Periodicity — check interval
• Region — monitoring region
• MonitorStatus — active / degraded / error
• HTTPMethod — HTTP methods
• TimeRange — metrics time range
• NumberComparator, StringComparator, RecordComparator — assertion comparators

Health Types

• CheckRequest, CheckResponse
• ServingStatus — serving / not serving

Status Report Types

• StatusReport, StatusReportSummary, StatusReportUpdate
• CreateStatusReportRequest, CreateStatusReportResponse
• GetStatusReportRequest, GetStatusReportResponse
• ListStatusReportsRequest, ListStatusReportsResponse
• UpdateStatusReportRequest, UpdateStatusReportResponse
• DeleteStatusReportRequest, DeleteStatusReportResponse
• AddStatusReportUpdateRequest, AddStatusReportUpdateResponse
• StatusReportStatus — investigating / identified / monitoring / resolved

Status Page Types

• StatusPage, StatusPageSummary
• PageComponent, PageComponentGroup
• PageSubscriber
• CreateStatusPageRequest, CreateStatusPageResponse
• GetStatusPageRequest, GetStatusPageResponse
• ListStatusPagesRequest, ListStatusPagesResponse
• UpdateStatusPageRequest, UpdateStatusPageResponse
• DeleteStatusPageRequest, DeleteStatusPageResponse
• AddMonitorComponentRequest, AddMonitorComponentResponse
• AddStaticComponentRequest, AddStaticComponentResponse
• RemoveComponentRequest, RemoveComponentResponse
• UpdateComponentRequest, UpdateComponentResponse
• CreateComponentGroupRequest, CreateComponentGroupResponse
• DeleteComponentGroupRequest, DeleteComponentGroupResponse
• UpdateComponentGroupRequest, UpdateComponentGroupResponse
• SubscribeToPageRequest, SubscribeToPageResponse
• UnsubscribeFromPageRequest, UnsubscribeFromPageResponse
• ListSubscribersRequest, ListSubscribersResponse
• GetStatusPageContentRequest, GetStatusPageContentResponse
• GetOverallStatusRequest, GetOverallStatusResponse, ComponentStatus
• GetStatusPageOverviewRequest, GetStatusPageOverviewResponse, PageConfiguration
• OverallStatus, PageAccessType, PageTheme, PageComponentType, PageMetricType, PageBarType

Maintenance Types

• Maintenance, MaintenanceSummary
• CreateMaintenanceRequest, CreateMaintenanceResponse
• GetMaintenanceRequest, GetMaintenanceResponse
• ListMaintenancesRequest, ListMaintenancesResponse
• UpdateMaintenanceRequest, UpdateMaintenanceResponse
• DeleteMaintenanceRequest, DeleteMaintenanceResponse

Notification Types

• Notification, NotificationSummary
• NotificationData
• DiscordData, EmailData, GoogleChatData, GrafanaOncallData, NtfyData, OpsgenieData, PagerDutyData, SlackData, SmsData, TelegramData, WebhookData, WebhookHeader, WhatsappData
• CreateNotificationRequest, CreateNotificationResponse
• GetNotificationRequest, GetNotificationResponse
• ListNotificationsRequest, ListNotificationsResponse
• UpdateNotificationRequest, UpdateNotificationResponse
• DeleteNotificationRequest, DeleteNotificationResponse
• SendTestNotificationRequest, SendTestNotificationResponse
• CheckNotificationLimitRequest, CheckNotificationLimitResponse
• NotificationProvider, OpsgenieRegion

Client Types

• OpenStatusClient — client interface
• OpenStatusClientOptions — client configuration
• createOpenStatusClient — factory function
• openstatus — default client instance