Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

node-statuspage

scoutforpets6ISC0.2.1

A library to interact with the statuspage.io API

npm, node, statuspage, client, monitoring, api

readme

Introduction

This is a simple promise-based library to interact with the statuspage.io API.

Usage

In your code, simply:

const StatusPage = require('node-statuspage')
const status = new StatusPage(apiKey, pageId)

Supported Operations

This ever-growing list, currently supports:

  • updateMetric(metricId, val)
  • updateComponentState(componentId, status, componentName)
  • getComponents()
  • createComponent(componentName)
  • deleteComponent(componentId)
  • createSubscriber(subscriberData) (see API docs for available fields)
  • deleteSubscriber(subscriberId)

All of these methods return a promise for you to handle, with the exception of getComponents that is marked as async and will return the response data.