README.old.md

node-meraki-dashboard

A modern now outdated node.js client library for using the Meraki Dashboard API (v0). Supports a minimum of node v6.

Documentation

• Official Documentation
• Postman Documentation
• Library docs

Getting started

Installing

npm install --save node-meraki-dashboard

Using Promises

const dashboard = require('node-meraki-dashboard')(apiKey);
dashboard.organizations.list()
  .then(data => console.log(data))
  .catch(error => console.log(error));

Using Async/Await

const dashboard = require('node-meraki-dashboard')(apiKey);

(async function() {
  try {
    const orgList = await dashboard.organizations.list();
    console.log(orgList);
  } catch (error) {
    console.log(error);
  }
})();

Development / Contributing

See the CONTRIBUTING guide for getting started with making modifications to this library.

Setup & Testing

git clone https://github.com/tejashah88/node-meraki-dashboard.git
cd node-meraki-dashboard
npm install
npm test

API coverage tool

The API coverage tool is used for reporting endpoints that are not implemented by this library. It fetches the endpoints from the official documentation and checks against the current codebase and finally generates a fancy table of the missing endpoints needed.

Usage

npm run api-coverage