# sentry-api

> A client for the Sentry API

Latest version **0.2.0** (published 2020-07-24) · ISC license · 0 weekly downloads

## Install

```sh
npm install sentry-api
pnpm add sentry-api
yarn add sentry-api
bun add sentry-api
```

## 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.2.0 |
| Published | 2020-07-24 |
| First published | 2015-11-10 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 47.9 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Aaron Forsander |
| Maintainers | pifantastic |
| Keywords | sentry |

## Links

- npm: https://www.npmjs.com/package/sentry-api
- npm.io page: https://npm.io/package/sentry-api

## Dependencies (2)

- [debug](https://npm.io/package/debug.md) ^4.1.1
- [request](https://npm.io/package/request.md) ^2.65.0

## Alternatives

- [@sentry/react-native](https://npm.io/package/@sentry/react-native.md) — 2.6M weekly downloads
- [@ardatan/aggregate-error](https://npm.io/package/@ardatan/aggregate-error.md) — 708.1K weekly downloads
- [custom-error-generator](https://npm.io/package/custom-error-generator.md) — 2.0K weekly downloads
- [@technik-sde/prosemirror-recreate-transform](https://npm.io/package/@technik-sde/prosemirror-recreate-transform.md) — 1.5K weekly downloads
- [@suchipi/error-utils](https://npm.io/package/@suchipi/error-utils.md) — 78 weekly downloads

## Recent versions

- 0.2.0 (latest) — 2020-07-24
- 0.1.1 — 2016-08-19
- 0.1.0 — 2016-04-18
- 0.0.7 — 2015-11-18
- 0.0.6 — 2015-11-17
- 0.0.5 — 2015-11-11
- 0.0.4 — 2015-11-11
- 0.0.3 — 2015-11-11
- 0.0.2 — 2015-11-11
- 0.0.1 — 2015-11-10

## README

# sentry-api

A node client for the [Sentry API](https://docs.sentry.io/api/).  This is distinct from the reporting API, for which Sentry itself publishes useful libraries.

This library is in *maintenance mode*: bug-fixes and version-bumps will be applied, but new functionality will not be developed.

## Installation

```bash
npm install sentry-api
```

## Documentation

[http://taskcluster.github.io/node-sentry-api/](http://taskcluster.github.io/node-sentry-api/)

## Example

```javascript
var Sentry = require('sentry-api').Client;

// Create a new client using your Sentry DSN.
var sentry = new Sentry('https://abc123:@app.getsentry.com');

// If you're using authentication tokens, you'll want to pass the token as
// a configuration option.
var sentry = new Sentry('https://abc123:@app.getsentry.com', {
  token: 'mytoken'
});

// You can also leave off the DSN if you're using token authentication and
// hosted sentry.
var sentry = new Sentry({
  token: 'mytoken'
});

// Retrieve a project using the callback style.
sentry.projects.get('org-slug', 'project-slug', function(error, project) {
  console.log(project.name);
});

// Retrieve a project using the promise style.
sentry.projects.get('org-slug', 'project-slug').then(function(project) {
  console.log(project.name);
})
```

A more complete example:

```javascript
const fs = require('fs');
const Promise = require('promise');
const Sentry = require('sentry-api').Client;

const sentry = new Sentry('https://abc123:@app.getsentry.com');
const organization = 'acme-org';
const project = 'top-secret';
const version = '1.0.0';

// Check that a release hasn't already been created.
sentry.releases.get(organization, project, version).then(function(release) {
  console.log('Release', version, 'already exists!');
}).catch(function() {
  // Create a new release.
  sentry.releases.create(organization, project, {
    version: version,
    ref: version,
  }).then(function(release) {
    console.log('Created release:', release);

    var files = ['app.min.js', 'app.min.js.map'];

    // Add files to the release.
    var uploads = files.map(function(file) {
      return sentry.releases.createFile(organization, project, version, {
        name: file,
        file: fs.createReadStream(file)
      }).then(function(newFile) {
        console.log('Created file:', newFile.name);
      });
    });

    return Promise.all(uploads);
  })
  .then(function() {
    console.log('Uploaded all files.');
  })
  .catch(function(error) {
    // More than likely the release already exists.
    console.error('Error creating Sentry release', error);
  });
});
```

## Tests

To run the tests:

```bash
npm test
```

## License

```
Copyright (c) 2015(s), Aaron Forsander
Permission to use, copy, modify, and/or distribute this software for any purpose
with or without fee is hereby granted, provided that the above copyright notice
and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
THIS SOFTWARE.
```

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