• Public
  • Public/Protected
  • All


OpenNMS Javascript API CircleCI

A client API for accessing the OpenNMS network monitoring platform.

Getting Started

Information on getting started and how to use the API is in the HOWTO document.

The complete API list is available at docs.opennms.org.


The CHANGELOG will be updated as releases occur, and should always be accessible here.


To build this project, first install yarn:

npm install -g yarn

Then run yarn to fetch all dependencies:


Then you can run yarn to build or test the project:

  • yarn dist - run tests and lint, and build the complete tree in dist/
  • yarn dev - build a development version of the API in dist/opennms.js
  • yarn build - build a production version of the API in dist/opennms.min.js
  • yarn watch - continuously build the development version in dist/opennms.js
  • yarn test - run the tests
  • yarn watch-test - continuously run the tests
  • yarn cli -- <arguments> - run the CLI test tool (try --help for options)

Generated using TypeDoc