meraki/frontend

Create a Meraki Frontend API wrapper. This is uses the same API as the Meraki webfrontend. So stuff can break

Source:
Example
const target = 'n12'
const baseUrl = 'https://account.meraki.com' (default)
const rateLimiter = {
  enabled: true
}
const meraki = require('./lib')({ target, baseUrl, rateLimiter })
Parameters:
Name Type Attributes Default Description
target string <optional>
'account'

The Meraki target

baseUrl string <optional>
'https://account.meraki.com'

The Meraki organization id

email string <optional>

The E-Mail address to login with

password string <optional>

The password for the login process

rateLimiter Object <optional>

The rate limiter (bottleneck) configuration

Properties
Name Type Attributes Default Description
enabled boolean <optional>

Whether use the rate limiter

maxConcurrent number <optional>
5

How many jobs can be running at the same time (null for unlimited)

minTime number <optional>
200

How long to wait after launching a job before launching another one

highWater number <optional>
1000

How long can the queue get? When the queue length exceeds that value, the selected strategy is executed to shed the load

strategy string <optional>
'LEAK'

Which strategy to use if the queue gets longer than the high water mark. Read about strategies.

Returns:

The initialized Meraki Frontend API wrapper

Type
Promise.<Object>

Members

(static, constant) authenticationEndpoints

Source:
See:

The authentication endpoints

(static, constant) organizationEndpoints

Source:
See:

The organization endpoints