Node SDK

Overview

Interact with openstatus programmatically from your JavaScript and TypeScript applications

Getting Started

Install and start using the openstatus Node.js SDK

Authentication

Configure API key authentication for the openstatus Node.js SDK

Monitor Service

Create and manage HTTP, TCP, and DNS monitors with the openstatus Node.js SDK

Status Page Service

Manage status pages, components, groups, and subscribers with the openstatus Node.js SDK

Status Report Service

Manage incident reports and status updates with the openstatus Node.js SDK

Maintenance Service

Manage scheduled maintenance windows with the openstatus Node.js SDK

Incident Service

Declare and run incidents with the openstatus Node.js SDK: lifecycle, timeline, status report link and postmortem

Notification Service

Manage notification channels and providers with the openstatus Node.js SDK

Private Location Service

Manage private locations — self-hosted probes that run monitors from your own network — with the openstatus Node.js SDK

Health Service

Check the openstatus API health status using the Node.js SDK

Error Handling

Handle errors and implement retry strategies with the openstatus Node.js SDK

TypeScript Tips

Tips for working with bigint fields, oneof types, and migrating clients in the openstatus Node.js SDK

Reference

Complete reference for enums, regions, assertions, and TypeScript type exports in the openstatus Node.js SDK