# circonusapi2

> Tiny library for interacting with Circonus' API v2

Latest version **0.1.7** (published 2016-03-02) · BSD license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.7 |
| Published | 2016-03-02 |
| First published | 2014-03-25 |
| Weekly downloads | 0 |
| License | BSD |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.8 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Brian Clapper |
| Maintainers | maier, neophenix, postwait |
| Keywords | circonus, monitoring, rest, api |

## Links

- npm: https://www.npmjs.com/package/circonusapi2
- Repository: https://github.com/circonus-labs/node-circonusapi2
- Issues: https://github.com/circonus-labs/node-circonusapi2/issues
- npm.io page: https://npm.io/package/circonusapi2

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 0.1.7 (latest) — 2016-03-02
- 0.1.6 — 2014-03-25

## README

node-circonusapi2
=================

Node lib for interacting with v2 of the Circonus API

Exported methods
----------------
 * setup:  inital setup function to give the API your auth token, app name, and options
 * get, post, put, delete: proxies for the various HTTP methods used for REST calls
 
Notes
-----
 * callback functions take 3 args (code, error, body)
    * code:   HTTP Response code, if null a non HTTP error occurred
    * error:  Error message from API, null on 200 responses
    * body:   Response body, i.e. the thing you probably want, if it wasn't null you will be handed an already parsed object

Usage
-----
    var api = require('circonusapi2'),
        auth_token = 'AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE',
        app_name = 'TEST APP';

    api.setup(auth_token, app_name);
    api.get("/check_bundle/12345", null, function(code, error, body) {
      if ( ! error ) {
        console.log(body)
      }
    ));

Options
-----
* protocol : "http" or "https", default https
* apihost : default "api.circonus.com"
* apiport : default 443
* apipath : default "/v2/"

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