Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ilert/ilert-js
:zap::warning: The official iLert Javascript api bindings.
https://github.com/ilert/ilert-js
api bindings client http ilert js node rest
Last synced: about 1 month ago
JSON representation
:zap::warning: The official iLert Javascript api bindings.
- Host: GitHub
- URL: https://github.com/ilert/ilert-js
- Owner: iLert
- License: other
- Created: 2020-05-13T09:18:25.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-01-08T14:19:42.000Z (about 1 year ago)
- Last Synced: 2024-05-09T14:24:57.173Z (8 months ago)
- Topics: api, bindings, client, http, ilert, js, node, rest
- Language: JavaScript
- Homepage:
- Size: 147 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# ilert-js
**The official iLert api bindings.**
## Install
`npm install ilert`
## In action
```js
const { ILert } = require("ilert");
const ilert = new ILert({
apiKey: "123123" // optional
});// creating a new event
const { data } = await ilert.event().create(
"il1api0460d849fcdc753d4f",
ILert.EVENT_TYPES.ALERT,
"My test incident summary",
{ incidentKey: "123456" } // optional
);// resolving a pending alert
await ilert.alert(45678).resolve();// fetch an incident
await ilert.incident(12345).get();// ping a heartbeat
await ilert.heartbeat("il1hbt0460d849fcdc753").ping();
```Typescript definitions included.
## Getting help
We are happy to respond to [GitHub issues][issues] as well.
[issues]: https://github.com/iLert/ilert-js/issues/new
#### License
Licensed under either of Apache License, Version
2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in ilert-js by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.