Getting started

The Cisco Meraki Dashboard API is a modern REST API based on the OpenAPI specification.

What can the API be used for?

The Dashboard API can be used for many purposes. It's meant to be an open-ended tool. Here are some examples of use cases:

• Add new organizations, admins, networks, devices, VLANs, and more
• Configure networks at scale
• Automatically on-board and off-board new employees' teleworker setups
• Build your own dashboard for store managers, field techs, or unique use cases

Enabling the Dashboard API

1. Begin by logging into Meraki Dashboard and navigating to Organization > Settings

2. Locate the section titled Dashboard API access and select Enable Access, then Save your changes

3. After enabling the API, choose your username at the top-right of the Meraki Dashboard and select my profile

4. Locate the section titled Dashboard API access and select Generate new API key

Note: The API key is associated with a Dashboard administrator account. You can generate, revoke, and regenerate your API key on your profile.

Keep your API key safe as it provides authentication to all of your organizations with the API enabled. If your API key is shared, you can regenerate your API key at any time. This will revoke the existing API key.

Copy and store your API key in a safe place. Dashboard does not store API keys in plaintext for security reasons, so this is the only time you will be able to record it. If you lose or forget your API key, you will have to revoke it and generate a new one.

Every request must specify an API key via a request header.

The API key must be specified in the URL header. The API will return a 404 (rather than a 403) in response to a request with a missing or incorrect API key in order to prevent leaking the existence of resources to unauthorized users.

X-Cisco-Meraki-API-Key: <secret key>

Read more about API authorization

Versioning

Once an API version is released, we will make only backwards-compatible changes to it. Backwards-compatible changes include:

• Adding new API resources

• Adding new optional request parameters to existing API methods

• Adding new properties to existing API responses

• Changing the order of properties in existing API responses

Rate Limit

• The Dashboard API is limited to 5 calls per second, per organization.
• A burst of 5 additional calls are allowed in the first second, so a maximum of 15 calls in the first 2 seconds.
• The rate limiting technique is based off of the token bucket model.
• An error with a 429 status code will be returned when the rate limit has been exceeded.
• Expect to backoff for 1 - 2 seconds if the limit has been exceeded. You may have to wait potentially longer if a large number of requests were made within this timeframe.

Additional Details

Identifiers in the API are opaque strings. A {networkId}, for example, might be the string "126043", whereas an {orderId} might contain characters, such as "4S1234567". Client applications must not try to parse them as numbers. Even identifiers that look like numbers might be too long to encode without loss of precision in Javascript, where the only numeric type is IEEE 754 floating point.

Verbs in the API follow the usual REST conventions:

GET returns the value of a resource or a list of resources, depending on whether an identifier is specified. For example, a GET of /organizations returns a list of organizations, whereas a GET of /organizations/{organizationId} returns a particular organization.

POST adds a new resource, as in a POST to /organizations/{organizationId}/admins, or performs some other non-idempotent change.

PUT updates a resource. PUTs are idempotent; they update a resource, creating it first if it does not already exist. A PUT should specify all the fields of a resource; the API will revert omitted fields to their default value.

DELETE removes a resource.

How to Build

The generated SDK relies on Node Package Manager (NPM) being available to resolve dependencies. If you don't already have NPM installed, please go ahead and follow instructions to install NPM from here. The SDK also requires Node to be installed. If Node isn't already installed, please install it from here

NPM is installed by default when Node is installed

To check if node and npm have been successfully installed, write the following commands in command prompt:

• node --version
• npm -version

Now use npm to resolve all dependencies by running the following command in the root directory (of the SDK folder):

npm install

This will install all dependencies in the node_modules folder.

Once dependencies are resolved, you will need to move the folder Meraki in to your node_modules folder.

How to Use

The following section explains how to use the library in a new project.

1. Open Project Folder

Open an IDE/Text Editor for JavaScript like Sublime Text. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.

Click on File and select Open Folder.

Select the folder of your SDK and click on Select Folder to open it up in Sublime Text. The folder will become visible in the bar on the left.

2. Creating a Test File

Now right click on the folder name and select the New File option to create a new test file. Save it as index.js Now import the generated NodeJS library using the following lines of code:

var lib = require('lib');

Save changes.

3. Running The Test File

To run the index.js file, open up the command prompt and navigate to the Path where the SDK folder resides. Type the following command to run the file:

node index.js

How to Test

These tests use Mocha framework for testing, coupled with Chai for assertions. These dependencies need to be installed for tests to run. Tests can be run in a number of ways:

Method 1 (Run all tests)

1. Navigate to the root directory of the SDK folder from command prompt.
2. Type mocha --recursive to run all the tests.

Method 2 (Run all tests)

1. Navigate to the ../test/Controllers/ directory from command prompt.
2. Type mocha * to run all the tests.

Method 3 (Run specific controller's tests)

1. Navigate to the ../test/Controllers/ directory from command prompt.
2. Type mocha Meraki Dashboard APIController to run all the tests in that controller file.

To increase mocha's default timeout, you can change the TEST_TIMEOUT parameter's value in TestBootstrap.js.

Initialization

Authentication

In order to setup authentication in the API client, you need the following information.

| Parameter | Description | |-----------|-------------| | xCiscoMerakiAPIKey | TODO: add a description |

API client can be initialized as following:

const lib = require('lib');

// Configuration parameters and credentials
lib.Configuration.xCiscoMerakiAPIKey = "xCiscoMerakiAPIKey";

Class Reference

List of Controllers

• APIUsageController
• ActionBatchesController
• AdminsController
• AlertSettingsController
• BluetoothClientsController
• CamerasController
• ClientsController
• ConfigTemplatesController
• ConnectivityMonitoringDestinationsController
• ContentFilteringCategoriesController
• ContentFilteringRulesController
• DashboardBrandingPoliciesController
• DevicesController
• EventsController
• FirewalledServicesController
• FloorplansController
• GroupPoliciesController
• HTTPServersController
• IntrusionSettingsController
• MRL3FirewallController
• MVSenseController
• MX11NATRulesController
• MX1ManyNATRulesController
• MXL3FirewallController
• MXL7ApplicationCategoriesController
• MXL7FirewallController
• MXVLANPortsController
• MXVPNFirewallController
• MXCellularFirewallController
• MXPortForwardingRulesController
• MXStaticRoutesController
• MXWarmSpareSettingsController
• MalwareSettingsController
• ManagementInterfaceSettingsController
• MerakiAuthUsersController
• NamedTagScopeController
• NetflowSettingsController
• NetworksController
• OpenAPISpecController
• OrganizationsController
• PIIController
• RadioSettingsController
• SAMLRolesController
• SMController
• SNMPSettingsController
• SsidsController
• SecurityEventsController
• SplashLoginAttemptsController
• SplashSettingsController
• SwitchPortSchedulesController
• SwitchPortsController
• SwitchProfilesController
• SwitchSettingsController
• SwitchStacksController
• SyslogServersController
• TrafficAnalysisSettingsController
• TrafficShapingController
• UplinkSettingsController
• VlansController
• WebhookLogsController
• WirelessHealthController
• WirelessSettingsController

APIUsageController

Get singleton instance

The singleton instance of the APIUsageController class can be accessed from the API Client.

var controller = lib.APIUsageController;

getOrganizationApiRequests

List the API requests made by an organization

function getOrganizationApiRequests(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | organizationId | Required | TODO: Add a parameter description | | t0 | Optional | The beginning of the timespan for the data. The maximum lookback period is 31 days from today. | | t1 | Optional | The end of the timespan for the data. t1 can be a maximum of 31 days after t0. | | timespan | Optional | The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 31 days. | | perPage | Optional | The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50. | | startingAfter | Optional | A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. | | endingBefore | Optional | A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. | | adminId | Optional | Filter the results by the ID of the admin who made the API requests | | path | Optional | Filter the results by the path of the API requests | | method | Optional | Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE') | | responseCode | Optional | Filter the results by the response code of the API requests |

Example Usage

    var input = [];
        input['organizationId'] = 'organizationId';
        input['t0'] = 't0';
        input['t1'] = 't1';
        input['timespan'] = 217.617439666119;
        input['perPage'] = 217;
        input['startingAfter'] = 'startingAfter';
        input['endingBefore'] = 'endingBefore';
        input['adminId'] = 'adminId';
        input['path'] = 'path';
        input['method'] = 'method';
        input['responseCode'] = 217;

    controller.getOrganizationApiRequests(input, function(error, response, context) {

    
    });

Back to List of Controllers

ActionBatchesController

Get singleton instance

The singleton instance of the ActionBatchesController class can be accessed from the API Client.

var controller = lib.ActionBatchesController;

createOrganizationActionBatch

Create an action batch

function createOrganizationActionBatch(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | organizationId | Required | TODO: Add a parameter description | | createOrganizationActionBatch | Required | TODO: Add a parameter description |

Example Usage

    var input = [];
        input['organizationId'] = 'organizationId';
        input['createOrganizationActionBatch'] = new CreateOrganizationActionBatchModel({"key":"value"});

    controller.createOrganizationActionBatch(input, function(error, response, context) {

    
    });

getOrganizationActionBatches

Return the list of action batches in the organization

function getOrganizationActionBatches(organizationId, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | organizationId | Required | TODO: Add a parameter description |

Example Usage

    var organizationId = 'organizationId';

    controller.getOrganizationActionBatches(organizationId, function(error, response, context) {

    
    });

getOrganizationActionBatch

Return an action batch

function getOrganizationActionBatch(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | organizationId | Required | TODO: Add a parameter description | | actionBatchId | Required | TODO: Add a parameter description |

Example Usage

    var input = [];
        input['organizationId'] = 'organizationId';
        input['actionBatchId'] = 'actionBatchId';

    controller.getOrganizationActionBatch(input, function(error, response, context) {

    
    });

deleteOrganizationActionBatch

Delete an action batch

function deleteOrganizationActionBatch(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | organizationId | Required | TODO: Add a parameter description | | actionBatchId | Required | TODO: Add a parameter description |

Example Usage

    var input = [];
        input['organizationId'] = 'organizationId';
        input['actionBatchId'] = 'actionBatchId';

    controller.deleteOrganizationActionBatch(input, function(error, response, context) {

    
    });

updateOrganizationActionBatch

Update an action batch

function updateOrganizationActionBatch(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | organizationId | Required | TODO: Add a parameter description | | actionBatchId | Required | TODO: Add a parameter description | | updateOrganizationActionBatch | Optional | TODO: Add a parameter description |

Example Usage

    var input = [];
        input['organizationId'] = 'organizationId';
        input['actionBatchId'] = 'actionBatchId';
        input['updateOrganizationActionBatch'] = new UpdateOrganizationActionBatchModel({"key":"value"});

    controller.updateOrganizationActionBatch(input, function(error, response, context) {

    
    });

Back to List of Controllers

AdminsController

Get singleton instance

The singleton instance of the AdminsController class can be accessed from the API Client.

var controller = lib.AdminsController;

getOrganizationAdmins

List the dashboard administrators in this organization

function getOrganizationAdmins(organizationId, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | organizationId | Required | TODO: Add a parameter description |

Example Usage

    var organizationId = 'organizationId';

    controller.getOrganizationAdmins(organizationId, function(error, response, context) {

    
    });

createOrganizationAdmin

Create a new dashboard administrator

function createOrganizationAdmin(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | organizationId | Required | TODO: Add a parameter description | | createOrganizationAdmin | Required | TODO: Add a parameter description |

Example Usage

    var input = [];
        input['organizationId'] = 'organizationId';
        input['createOrganizationAdmin'] = new CreateOrganizationAdminModel({"key":"value"});

    controller.createOrganizationAdmin(input, function(error, response, context) {

    
    });

updateOrganizationAdmin

Update an administrator

function updateOrganizationAdmin(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | organizationId | Required | TODO: Add a parameter description | | id | Required | TODO: Add a parameter description | | updateOrganizationAdmin | Optional | TODO: Add a parameter description |

Example Usage

    var input = [];
        input['organizationId'] = 'organizationId';
        input['id'] = 'id';
        input['updateOrganizationAdmin'] = new UpdateOrganizationAdminModel({"key":"value"});

    controller.updateOrganizationAdmin(input, function(error, response, context) {

    
    });

deleteOrganizationAdmin

Revoke all access for a dashboard administrator within this organization

function deleteOrganizationAdmin(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | organizationId | Required | TODO: Add a parameter description | | id | Required | TODO: Add a parameter description |

Example Usage

    var input = [];
        input['organizationId'] = 'organizationId';
        input['id'] = 'id';

    controller.deleteOrganizationAdmin(input, function(error, response, context) {

    
    });

Back to List of Controllers

AlertSettingsController

Get singleton instance

The singleton instance of the AlertSettingsController class can be accessed from the API Client.

var controller = lib.AlertSettingsController;

getNetworkAlertSettings

Return the alert configuration for this network

function getNetworkAlertSettings(networkId, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | networkId | Required | TODO: Add a parameter description |

Example Usage

    var networkId = 'networkId';

    controller.getNetworkAlertSettings(networkId, function(error, response, context) {

    
    });

updateNetworkAlertSettings

Update the alert configuration for this network

function updateNetworkAlertSettings(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | networkId | Required | TODO: Add a parameter description | | updateNetworkAlertSettings | Optional | TODO: Add a parameter description |

Example Usage

    var input = [];
        input['networkId'] = 'networkId';
        input['updateNetworkAlertSettings'] = new UpdateNetworkAlertSettingsModel({"key":"value"});

    controller.updateNetworkAlertSettings(input, function(error, response, context) {

    
    });

Back to List of Controllers

BluetoothClientsController

Get singleton instance

The singleton instance of the BluetoothClientsController class can be accessed from the API Client.

var controller = lib.BluetoothClientsController;

getNetworkBluetoothClients

List the Bluetooth clients seen by APs in this network

function getNetworkBluetoothClients(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | networkId | Required | TODO: Add a parameter description | | t0 | Optional | The beginning of the timespan for the data. The maximum lookback period is 7 days from today. | | timespan | Optional | The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 7 days. The default is 1 day. | | perPage | Optional | The number of entries per page returned. Acceptable range is 5 - 1000. Default is 10. | | startingAfter | Optional | A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. | | endingBefore | Optional | A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. | | includeConnectivityHistory | Optional | Include the connectivity history for this client |

Example Usage

    var input = [];
        input['networkId'] = 'networkId';
        input['t0'] = 't0';
        input['timespan'] = 126.122157774457;
        input['perPage'] = 126;
        input['startingAfter'] = 'startingAfter';
        input['endingBefore'] = 'endingBefore';
        input['includeConnectivityHistory'] = false;

    controller.getNetworkBluetoothClients(input, function(error, response, context) {

    
    });

getNetworkBluetoothClient

Return a Bluetooth client. Bluetooth clients can be identified by their ID or their MAC.

function getNetworkBluetoothClient(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | networkId | Required | TODO: Add a parameter description | | bluetoothClientId | Required | TODO: Add a parameter description | | includeConnectivityHistory | Optional | Include the connectivity history for this client | | connectivityHistoryTimespan | Optional | The timespan, in seconds, for the connectivityHistory data. By default 1 day, 86400, will be used. |

Example Usage

    var input = [];
        input['networkId'] = 'networkId';
        input['bluetoothClientId'] = 'bluetoothClientId';
        input['includeConnectivityHistory'] = false;
        input['connectivityHistoryTimespan'] = 126;

    controller.getNetworkBluetoothClient(input, function(error, response, context) {

    
    });

Back to List of Controllers

CamerasController

Get singleton instance

The singleton instance of the CamerasController class can be accessed from the API Client.

var controller = lib.CamerasController;

generateNetworkCameraSnapshot

Generate a snapshot of what the camera sees at the specified time and return a link to that image.

function generateNetworkCameraSnapshot(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | networkId | Required | TODO: Add a parameter description | | serial | Required | TODO: Add a parameter description | | generateNetworkCameraSnapshot | Optional | TODO: Add a parameter description |

Example Usage

    var input = [];
        input['networkId'] = 'networkId';
        input['serial'] = 'serial';
        input['generateNetworkCameraSnapshot'] = new GenerateNetworkCameraSnapshotModel({"key":"value"});

    controller.generateNetworkCameraSnapshot(input, function(error, response, context) {

    
    });

getNetworkCameraVideoLink

Returns video link to the specified camera. If a timestamp is supplied, it links to that timestamp.

function getNetworkCameraVideoLink(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | networkId | Required | TODO: Add a parameter description | | serial | Required | TODO: Add a parameter description | | timestamp | Optional | [optional] The video link will start at this timestamp. The timestamp is in UNIX Epoch time (milliseconds). If no timestamp is specified, we will assume current time. |

Example Usage

    var input = [];
        input['networkId'] = 'networkId';
        input['serial'] = 'serial';
        input['timestamp'] = 'timestamp';

    controller.getNetworkCameraVideoLink(input, function(error, response, context) {

    
    });

Back to List of Controllers

ClientsController

Get singleton instance

The singleton instance of the ClientsController class can be accessed from the API Client.

var controller = lib.ClientsController;

getDeviceClients

List the clients of a device, up to a maximum of a month ago. The usage of each client is returned in kilobytes. If the device is a switch, the switchport is returned; otherwise the switchport field is null.

function getDeviceClients(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | serial | Required | TODO: Add a parameter description | | t0 | Optional | The beginning of the timespan for the data. The maximum lookback period is 31 days from today. | | timespan | Optional | The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 31 days. The default is 1 day. |

Example Usage

    var input = [];
        input['serial'] = 'serial';
        input['t0'] = 't0';
        input['timespan'] = 126.122157774457;

    controller.getDeviceClients(input, function(error, response, context) {

    
    });

getNetworkClients

List the clients that have used this network in the timespan

function getNetworkClients(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | networkId | Required | TODO: Add a parameter description | | t0 | Optional | The beginning of the timespan for the data. The maximum lookback period is 31 days from today. | | timespan | Optional | The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 31 days. The default is 1 day. | | perPage | Optional | The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10. | | startingAfter | Optional | A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. | | endingBefore | Optional | A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. |

Example Usage

    var input = [];
        input['networkId'] = 'networkId';
        input['t0'] = 't0';
        input['timespan'] = 126.122157774457;
        input['perPage'] = 126;
        input['startingAfter'] = 'startingAfter';
        input['endingBefore'] = 'endingBefore';

    controller.getNetworkClients(input, function(error, response, context) {

    
    });

provisionNetworkClients

Provisions a client with a name and policy. Clients can be provisioned before they associate to the network.

function provisionNetworkClients(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | networkId | Required | TODO: Add a parameter description | | provisionNetworkClients | Optional | TODO: Add a parameter description |

Example Usage

    var input = [];
        input['networkId'] = 'networkId';
        input['provisionNetworkClients'] = new ProvisionNetworkClientsModel({"key":"value"});

    controller.provisionNetworkClients(input, function(error, response, context) {

    
    });

getNetworkClient

Return the client associated with the given identifier. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.

function getNetworkClient(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | networkId | Required | TODO: Add a parameter description | | clientId | Required | TODO: Add a parameter description |

Example Usage

    var input = [];
        input['networkId'] = 'networkId';
        input['clientId'] = 'clientId';

    controller.getNetworkClient(input, function(error, response, context) {

    
    });

getNetworkClientEvents

Return the events associated with this client. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.

function getNetworkClientEvents(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | networkId | Required | TODO: Add a parameter description | | clientId | Required | TODO: Add a parameter description | | perPage | Optional | The number of entries per page returned. Acceptable range is 3 - 100. Default is 100. | | startingAfter | Optional | A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. | | endingBefore | Optional | A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. |

Example Usage

    var input = [];
        input['networkId'] = 'networkId';
        input['clientId'] = 'clientId';
        input['perPage'] = 126;
        input['startingAfter'] = 'startingAfter';
        input['endingBefore'] = 'endingBefore';

    controller.getNetworkClientEvents(input, function(error, response, context) {

    
    });

getNetworkClientLatencyHistory

Return the latency history for a client. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP. The latency data is from a sample of 2% of packets and is grouped into 4 traffic categories: background, best effort, video, voice. Within these categories the sampled packet counters are bucketed by latency in milliseconds.

function getNetworkClientLatencyHistory(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | networkId | Required | TODO: Add a parameter description | | clientId | Required | TODO: Add a parameter description | | t0 | Optional | The beginning of the timespan for the data. The maximum lookback period is 791 days from today. | | t1 | Optional | The end of the timespan for the data. t1 can be a maximum of 791 days after t0. | | timespan | Optional | The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 791 days. The default is 1 day. | | resolution | Optional | The time resolution in seconds for returned data. The valid resolutions are: 86400. The default is 86400. |

Example Usage

    var input = [];
        input['networkId'] = 'networkId';
        input['clientId'] = 'clientId';
        input['t0'] = 't0';
        input['t1'] = 't1';
        input['timespan'] = 126.122157774457;
        input['resolution'] = 126;

    controller.getNetworkClientLatencyHistory(input, function(error, response, context) {

    
    });

getNetworkClientPolicy

Return the policy assigned to a client on the network. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.

function getNetworkClientPolicy(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | networkId | Required | TODO: Add a parameter description | | clientId | Required | TODO: Add a parameter description |

Example Usage

    var input = [];
        input['networkId'] = 'networkId';
        input['clientId'] = 'clientId';

    controller.getNetworkClientPolicy(input, function(error, response, context) {

    
    });

updateNetworkClientPolicy

Update the policy assigned to a client on the network. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.

function updateNetworkClientPolicy(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | networkId | Required | TODO: Add a parameter description | | clientId | Required | TODO: Add a parameter description | | updateNetworkClientPolicy | Optional | TODO: Add a parameter description |

Example Usage

    var input = [];
        input['networkId'] = 'networkId';
        input['clientId'] = 'clientId';
        input['updateNetworkClientPolicy'] = new UpdateNetworkClientPolicyModel({"key":"value"});

    controller.updateNetworkClientPolicy(input, function(error, response, context) {

    
    });

getNetworkClientSplashAuthorizationStatus

Return the splash authorization for a client, for each SSID they've associated with through splash. Only enabled SSIDs with Click-through splash enabled will be included. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.

function getNetworkClientSplashAuthorizationStatus(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | networkId | Required | TODO: Add a parameter description | | clientId | Required | TODO: Add a parameter description |

Example Usage

    var input = [];
        input['networkId'] = 'networkId';
        input['clientId'] = 'clientId';

    controller.getNetworkClientSplashAuthorizationStatus(input, function(error, response, context) {

    
    });

updateNetworkClientSplashAuthorizationStatus

Update a client's splash authorization. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.

function updateNetworkClientSplashAuthorizationStatus(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | networkId | Required | TODO: Add a parameter description | | clientId | Required | TODO: Add a parameter description | | updateNetworkClientSplashAuthorizationStatus | Optional | TODO: Add a parameter description |

Example Usage

    var input = [];
        input['networkId'] = 'networkId';
        input['clientId'] = 'clientId';
        input['updateNetworkClientSplashAuthorizationStatus'] = new UpdateNetworkClientSplashAuthorizationStatusModel({"key":"value"});

    controller.updateNetworkClientSplashAuthorizationStatus(input, function(error, response, context) {

    
    });

getNetworkClientTrafficHistory

Return the client's network traffic data over time. Usage data is in kilobytes. This endpoint requires detailed traffic analysis to be enabled on the Network-wide > General page. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.

function getNetworkClientTrafficHistory(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | networkId | Required | TODO: Add a parameter description | | clientId | Required | TODO: Add a parameter description | | perPage | Optional | The number of entries per page returned. Acceptable range is 3 - 1000. | | startingAfter | Optional | A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. | | endingBefore | Optional | A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. |

Example Usage

    var input = [];
        input['networkId'] = 'networkId';
        input['clientId'] = 'clientId';
        input['perPage'] = 126;
        input['startingAfter'] = 'startingAfter';
        input['endingBefore'] = 'endingBefore';

    controller.getNetworkClientTrafficHistory(input, function(error, response, context) {

    
    });

getNetworkClientUsageHistory

Return the client's daily usage history. Usage data is in kilobytes. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.

function getNetworkClientUsageHistory(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | networkId | Required | TODO: Add a parameter description | | clientId | Required | TODO: Add a parameter description |

Example Usage

    var input = [];
        input['networkId'] = 'networkId';
        input['clientId'] = 'clientId';

    controller.getNetworkClientUsageHistory(input, function(error, response, context) {

    
    });

Back to List of Controllers

ConfigTemplatesController

Get singleton instance

The singleton instance of the ConfigTemplatesController class can be accessed from the API Client.

var controller = lib.ConfigTemplatesController;

getOrganizationConfigTemplates

List the configuration templates for this organization

function getOrganizationConfigTemplates(organizationId, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | organizationId | Required | TODO: Add a parameter description |

Example Usage

    var organizationId = 'organizationId';

    controller.getOrganizationConfigTemplates(organizationId, function(error, response, context) {

    
    });

deleteOrganizationConfigTemplate

Remove a configuration template

function deleteOrganizationConfigTemplate(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | organizationId | Required | TODO: Add a parameter description | | configTemplateId | Required | TODO: Add a parameter description |

Example Usage

    var input = [];
        input['organizationId'] = 'organizationId';
        input['configTemplateId'] = 'configTemplateId';

    controller.deleteOrganizationConfigTemplate(input, function(error, response, context) {

    
    });

Back to List of Controllers

ConnectivityMonitoringDestinationsController

Get singleton instance

The singleton instance of the ConnectivityMonitoringDestinationsController class can be accessed from the API Client.

var controller = lib.ConnectivityMonitoringDestinationsController;

getNetworkConnectivityMonitoringDestinations

Return the connectivity testing destinations for an MX network

function getNetworkConnectivityMonitoringDestinations(networkId, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | networkId | Required | TODO: Add a parameter description |

Example Usage

    var networkId = 'networkId';

    controller.getNetworkConnectivityMonitoringDestinations(networkId, function(error, response, context) {

    
    });

updateNetworkConnectivityMonitoringDestinations

Update the connectivity testing destinations for an MX network

function updateNetworkConnectivityMonitoringDestinations(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | networkId | Required | TODO: Add a parameter description | | updateNetworkConnectivityMonitoringDestinations | Optional | TODO: Add a parameter description |

Example Usage

    var input = [];
        input['networkId'] = 'networkId';
        input['updateNetworkConnectivityMonitoringDestinations'] = new UpdateNetworkConnectivityMonitoringDestinationsModel({"key":"value"});

    controller.updateNetworkConnectivityMonitoringDestinations(input, function(error, response, context) {

    
    });

Back to List of Controllers

ContentFilteringCategoriesController

Get singleton instance

The singleton instance of the ContentFilteringCategoriesController class can be accessed from the API Client.

var controller = lib.ContentFilteringCategoriesController;

getNetworkContentFilteringCategories

List all available content filtering categories for an MX network

function getNetworkContentFilteringCategories(networkId, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | networkId | Required | TODO: Add a parameter description |

Example Usage

    var networkId = 'networkId';

    controller.getNetworkContentFilteringCategories(networkId, function(error, response, context) {

    
    });

Back to List of Controllers

ContentFilteringRulesController

Get singleton instance

The singleton instance of the ContentFilteringRulesController class can be accessed from the API Client.

var controller = lib.ContentFilteringRulesController;

getNetworkContentFiltering

Return the content filtering settings for an MX network

function getNetworkContentFiltering(networkId, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | networkId | Required | TODO: Add a parameter description |

Example Usage

    var networkId = 'networkId';

    controller.getNetworkContentFiltering(networkId, function(error, response, context) {

    
    });

updateNetworkContentFiltering

Update the content filtering settings for an MX network

function updateNetworkContentFiltering(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | networkId | Required | TODO: Add a parameter description | | updateNetworkContentFiltering | Optional | TODO: Add a parameter description |

Example Usage

    var input = [];
        input['networkId'] = 'networkId';
        input['updateNetworkContentFiltering'] = new UpdateNetworkContentFilteringModel({"key":"value"});

    controller.updateNetworkContentFiltering(input, function(error, response, context) {

    
    });

Back to List of Controllers

DashboardBrandingPoliciesController

Get singleton instance

The singleton instance of the DashboardBrandingPoliciesController class can be accessed from the API Client.

var controller = lib.DashboardBrandingPoliciesController;

getOrganizationBrandingPolicies

List the branding policies of an organization

function getOrganizationBrandingPolicies(organizationId, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | organizationId | Required | TODO: Add a parameter description |

Example Usage

    var organizationId = 'organizationId';

    controller.getOrganizationBrandingPolicies(organizationId, function(error, response, context) {

    
    });

createOrganizationBrandingPolicy

Add a new branding policy to an organization

function createOrganizationBrandingPolicy(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | organizationId | Required | TODO: Add a parameter description | | createOrganizationBrandingPolicy | Required | TODO: Add a parameter description |

Example Usage

    var input = [];
        input['organizationId'] = 'organizationId';
        input['createOrganizationBrandingPolicy'] = new CreateOrganizationBrandingPolicyModel({"key":"value"});

    controller.createOrganizationBrandingPolicy(input, function(error, response, context) {

    
    });

getOrganizationBrandingPoliciesPriorities

Return the branding policy IDs of an organization in priority order. IDs are ordered in ascending order of priority (IDs later in the array have higher priority).

function getOrganizationBrandingPoliciesPriorities(organizationId, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | organizationId | Required | TODO: Add a parameter description |

Example Usage

    var organizationId = 'organizationId';

    controller.getOrganizationBrandingPoliciesPriorities(organizationId, function(error, response, context) {

    
    });

updateOrganizationBrandingPoliciesPriorities

Update the priority ordering of an organization's branding policies.

function updateOrganizationBrandingPoliciesPriorities(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | organizationId | Required | TODO: Add a parameter description | | updateOrganizationBrandingPoliciesPriorities | Required | TODO: Add a parameter description |

Example Usage

    var input = [];
        input['organizationId'] = 'organizationId';
        input['updateOrganizationBrandingPoliciesPriorities'] = new UpdateOrganizationBrandingPoliciesPrioritiesModel({"key":"value"});

    controller.updateOrganizationBrandingPoliciesPriorities(input, function(error, response, context) {

    
    });

getOrganizationBrandingPolicy

Return a branding policy

function getOrganizationBrandingPolicy(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | organizationId | Required | TODO: Add a parameter description | | brandingPolicyId | Required | TODO: Add a parameter description |

Example Usage

    var input = [];
        input['organizationId'] = 'organizationId';
        input['brandingPolicyId'] = 'brandingPolicyId';

    controller.getOrganizationBrandingPolicy(input, function(error, response, context) {

    
    });

updateOrganizationBrandingPolicy

Update a branding policy

function updateOrganizationBrandingPolicy(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | organizationId | Required | TODO: Add a parameter description | | brandingPolicyId | Required | TODO: Add a parameter description | | updateOrganizationBrandingPolicy | Optional | TODO: Add a parameter description |

Example Usage

    var input = [];
        input['organizationId'] = 'organizationId';
        input['brandingPolicyId'] = 'brandingPolicyId';
        input['updateOrganizationBrandingPolicy'] = new UpdateOrganizationBrandingPolicyModel({"key":"value"});

    controller.updateOrganizationBrandingPolicy(input, function(error, response, context) {

    
    });

deleteOrganizationBrandingPolicy

Delete a branding policy

function deleteOrganizationBrandingPolicy(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | organizationId | Required | TODO: Add a parameter description | | brandingPolicyId | Required | TODO: Add a parameter description |

Example Usage

    var input = [];
        input['organizationId'] = 'organizationId';
        input['brandingPolicyId'] = 'brandingPolicyId';

    controller.deleteOrganizationBrandingPolicy(input, function(error, response, context) {

    
    });

Back to List of Controllers

DevicesController

Get singleton instance

The singleton instance of the DevicesController class can be accessed from the API Client.

var controller = lib.DevicesController;

getNetworkDevices

List the devices in a network

function getNetworkDevices(networkId, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | networkId | Required | TODO: Add a parameter description |

Example Usage

    var networkId = 'networkId';

    controller.getNetworkDevices(networkId, function(error, response, context) {

    
    });

claimNetworkDevices

Claim a device into a network

function claimNetworkDevices(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | networkId | Required | TODO: Add a parameter description | | claimNetworkDevices | Required | TODO: Add a parameter description |

Example Usage

    var input = [];
        input['networkId'] = 'networkId';
        input['claimNetworkDevices'] = new ClaimNetworkDevicesModel({"key":"value"});

    controller.claimNetworkDevices(input, function(error, response, context) {

    
    });

getNetworkDevice

Return a single device

function getNetworkDevice(input, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | networkId | Required | TODO: Add a parameter description | | serial | Required | TODO: Add a parameter description |

Example Usage

    var input = [];
        input['networkId'] = 'networkId';
        input['serial'] = 'serial';

    controller.getNetworkDevice(input, function(error, response, context) {

    
    });

updateNetworkDevice

Update the attributes of a device