Official documentation for
@openstatus/sdk-node —
the TypeScript SDK for the OpenStatus monitoring
platform.
- Getting Started
- Installation
- Quick Start
- Runtime Support
- Full Workflow Example
- Authentication
- createOpenStatusClient
- Manual Headers
- Environment Variables
- Custom Base URL
- Monitor Service
- HTTP Monitors
- TCP Monitors
- DNS Monitors
- List Monitors
- Get Monitor
- Trigger Monitor
- Delete Monitor
- Get Monitor Status
- Get Monitor Summary
- Status Page Service
- Status Page CRUD
- Components
- Component Groups
- Subscribers
- Get Status Page Content
- Get Overall Status
- Status Report Service
- Create Status Report
- Add Status Report Update
- List Status Reports
- Get / Update / Delete Status Reports
- Maintenance Service
- Create Maintenance Window
- List Maintenances
- Get / Update / Delete Maintenance Windows
- Notification Service
- Create Notification
- Provider Configurations
- Send Test Notification
- Check Notification Limits
- List / Get / Update / Delete Notifications
- Health Service
- Health Check
- Reference
- Enums
- Regions
- Assertions
- TypeScript Type Exports
- Error Handling
- ConnectError
- Common Error Codes
- Retry Strategy
- TypeScript Tips
- Working with bigint Fields
- Handling oneof Types
- Migrating from Default Client to createOpenStatusClient