# statusio

> Status.io API Library

Latest version **1.0.3** (published 2021-05-17) · 0 weekly downloads

## Install

```sh
npm install statusio
pnpm add statusio
yarn add statusio
bun add statusio
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2021-05-17 |
| First published | 2016-01-05 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | * |
| Dependencies | 1 |
| Unpacked size | 29.8 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Status.io |
| Maintainers | joet3ch |

## Links

- npm: https://www.npmjs.com/package/statusio
- Repository: https://github.com/statusio/statusio-node
- Homepage: https://github.com/statusio/statusio-node#readme
- Issues: https://github.com/statusio/statusio-node/issues
- npm.io page: https://npm.io/package/statusio

## Dependencies (1)

- [request](https://npm.io/package/request.md) ^2.67.0

## Recent versions

- 1.0.3 (latest) — 2021-05-17
- 1.0.2 — 2018-02-10
- 0.0.9 — 2017-12-20
- 0.0.8 — 2017-12-14
- 0.0.7 — 2016-01-05
- 0.0.5 — 2016-01-05
- 0.0.4 — 2016-01-05
- 0.0.3 — 2016-01-05

## README

# Node.js Status.io

Node.js package for [Status.io](https://status.io)


## Installation

```
$ npm install statusio
```


## Usage

```javascript
var StatusIOApi = require('statusio').StatusIOApi;

var api = new StatusIOApi('<api_id>', '<api_key>')

api.status.summary('<statuspage_id>', function(error, data) {
    if (error) {
        console.error(data);
    } else {
        console.log(data);
    }
});
```


The `callback` function takes two arguments - `error` and `data`. If `error` is `true` then `data` will contain the error message. In other cases `data` contains the `result` content. The `callback` functions are optional.

## Supported Methods

View the full API documentation at: http://developers.status.io/

### Components

- api.components.list (statusPageId, callback)
- api.components.statusUpdate (status, callback)

### Incidents

- api.incidents.list (statusPageId, callback)
- api.incidents.listbyid (statusPageId, callback)
- api.incidents.message (statusPageId, messageId, callback)
- api.incidents.create (incident, callback)
- api.incidents.update (incident, callback)
- api.incidents.resolve (incident, callback)
- api.incidents.delete (incident, callback)

### Maintenance

- api.maintenance.list (statusPageId, callback)
- api.maintenance.listbyid (statusPageId, callback)
- api.maintenance.message (statusPageId, messageId, callback)
- api.maintenance.schedule (maintenance, callback)
- api.maintenance.start (maintenance, callback)
- api.maintenance.update (maintenance, callback)
- api.maintenance.finish (maintenance, callback)
- api.maintenance.delete (maintenance, callback)

### Metrics

- api.metrics.update (metric, callback)

### Status

- api.status.summary (statusPageId, callback)

### Subscribers

- api.subscribers.list (statusPageId, callback)
- api.subscribers.add (subscriber, callback)
- api.subscribers.update (subscriber, callback)
- api.subscribers.remove (statusPageId, subscriberId, callback)

### Unsupported Methods

If there is a new method which is not implemented in this library yet, you can call it directly:

```javascript
api.request('get', 'new/get_method', {}, function(error, data) {
    if (error) {
        console.error(data);
    } else {
        console.log(data);
    }
});

api.request('post', 'new/post_method', {'data': 'test'}, function(error, data) {
    if (error) {
        console.error(data);
    } else {
        console.log(data);
    }
});
```

---
_Source: https://npm.io/package/statusio · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._