Adapter
Adapter for Integration to Cisco Meraki
Overview
This adapter is used to integrate the Itential Automation Platform (IAP) with the Meraki System. The API that was used to build the adapter for Meraki is usually available in the report directory of this adapter. The adapter utilizes the Meraki API to provide the integrations that are deemed pertinent to IAP. The ReadMe file is intended to provide information on this adapter it is generated from various other Markdown files.
Details
The Cisco Meraki adapter from Itential is used to integrate the Itential Automation Platform (IAP) with Cisco Meraki. With this adapter you have the ability to perform operations such as:
- Configure and Manage Cisco Meraki Devices.
For further technical details on how to install and use this adapter, please click the Technical Documentation tab.
Cisco Meraki
Table of Contents
Getting Started
These instructions will help you get a copy of the project on your local machine for development and testing. Reading this section is also helpful for deployments as it provides you with pertinent information on prerequisites and properties.
Helpful Background Information
There is Adapter documentation available on the Itential Documentation Site. This documentation includes information and examples that are helpful for:
Authentication
IAP Service Instance Configuration
Code Files
Endpoint Configuration (Action & Schema)
Mock Data
Adapter Generic Methods
Headers
Security
Linting and Testing
Build an Adapter
Troubleshooting an Adapter
Others will be added over time. Want to build a new adapter? Use the Itential Adapter Builder
Prerequisites
The following is a list of required packages for installation on the system the adapter will run on:
Node.js
npm
Git
The following list of packages are required for Itential opensource adapters or custom adapters that have been built utilizing the Itential Adapter Builder. You can install these packages by running npm install inside the adapter directory.
Package | Description |
---|---|
@itentialopensource/adapter-utils | Runtime library classes for all adapters; includes request handling, connection, authentication throttling, and translation. |
ajv | Required for validation of adapter properties to integrate with Meraki. |
axios | Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality. |
commander | Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality. |
dns-lookup-promise | Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality. |
fs-extra | Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality. |
mocha | Testing library that is utilized by some of the node scripts that are included with the adapter. |
mocha-param | Testing library that is utilized by some of the node scripts that are included with the adapter. |
mongodb | Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality. |
nyc | Testing coverage library that is utilized by some of the node scripts that are included with the adapter. |
ping | Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality. |
readline-sync | Utilized by the node script that comes with the adapter; helps to test unit and integration functionality. |
semver | Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality. |
winston | Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality. |
If you are developing and testing a custom adapter, or have testing capabilities on an Itential opensource adapter, you will need to install these packages as well.
chai
eslint
eslint-config-airbnb-base
eslint-plugin-import
eslint-plugin-json
testdouble
How to Install
- Set up the name space location in your IAP node_modules.
cd /opt/pronghorn/current/node_modules (* could be in a different place)
if the @itentialopensource directory does not exist, create it:
mkdir @itentialopensource
- Clone/unzip/tar the adapter into your IAP environment.
cd \@itentialopensource
git clone git@gitlab.com:\@itentialopensource/adapters/adapter-meraki
or
unzip adapter-meraki.zip
or
tar -xvf adapter-meraki.tar
- Run the adapter install script.
cd adapter-meraki
npm install
npm run lint:errors
npm run test
- Restart IAP
systemctl restart pronghorn
Create an adapter service instance configuration in IAP Admin Essentials GUI
Copy the properties from the sampleProperties.json and paste them into the service instance configuration in the inner/second properties field.
Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI
For an easier install of the adapter use npm run adapter:install, it will install the adapter in IAP. Please note that it can be dependent on where the adapter is installed and on the version of IAP so it is subject to fail. If using this, you can replace step 3-5 above with these:
- Install adapter dependencies and check the adapter.
cd adapter-meraki
npm run adapter:install
- Restart IAP
systemctl restart pronghorn
- Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI
Testing
Mocha is generally used to test all Itential Opensource Adapters. There are unit tests as well as integration tests performed. Integration tests can generally be run as standalone using mock data and running the adapter in stub mode, or as integrated. When running integrated, every effort is made to prevent environmental failures, however there is still a possibility.
Unit Testing
Unit Testing includes testing basic adapter functionality as well as error conditions that are triggered in the adapter prior to any integration. There are two ways to run unit tests. The prefered method is to use the testRunner script; however, both methods are provided here.
node utils/testRunner --unit
npm run test:unit
npm run test:baseunit
To add new unit tests, edit the test/unit/adapterTestUnit.js
file. The tests that are already in this file should provide guidance for adding additional tests.
Integration Testing - Standalone
Standalone Integration Testing requires mock data to be provided with the entities. If this data is not provided, standalone integration testing will fail. When the adapter is set to run in stub mode (setting the stub property to true), the adapter will run through its code up to the point of making the request. It will then retrieve the mock data and return that as if it had received that data as the response from Meraki. It will then translate the data so that the adapter can return the expected response to the rest of the Itential software. Standalone is the default integration test.
Similar to unit testing, there are two ways to run integration tests. Using the testRunner script is better because it prevents you from having to edit the test script; it will also resets information after testing is complete so that credentials are not saved in the file.
node utils/testRunner
answer no at the first prompt
npm run test:integration
To add new integration tests, edit the test/integration/adapterTestIntegration.js
file. The tests that are already in this file should provide guidance for adding additional tests.
Integration Testing
Integration Testing requires connectivity to Meraki. By using the testRunner script it prevents you from having to edit the integration test. It also resets the integration test after the test is complete so that credentials are not saved in the file.
Note: These tests have been written as a best effort to make them work in most environments. However, the Adapter Builder often does not have the necessary information that is required to set up valid integration tests. For example, the order of the requests can be very important and data is often required for
creates
andupdates
. Hence, integration tests may have to be enhanced before they will work (integrate) with Meraki. Even after tests have been set up properly, it is possible there are environmental constraints that could result in test failures. Some examples of possible environmental issues are customizations that have been made within Meraki which change order dependencies or required data.
node utils/testRunner
answer yes at the first prompt
answer all other questions on connectivity and credentials
Test should also be written to clean up after themselves. However, it is important to understand that in some cases this may not be possible. In addition, whenever exceptions occur, test execution may be stopped, which will prevent cleanup actions from running. It is recommended that tests be utilized in dev and test labs only.
Reminder: Do not check in code with actual credentials to systems.
Configuration
This section defines all the properties that are available for the adapter, including detailed information on what each property is for. If you are not using certain capabilities with this adapter, you do not need to define all of the properties. An example of how the properties for this adapter can be used with tests or IAP are provided in the sampleProperties.
Example Properties
"properties": {
"host": "api.meraki.com",
"port": 443,
"choosepath": "",
"base_path": "/api",
"version": "v1",
"cache_location": "none",
"encode_pathvars": true,
"encode_queryvars": true,
"save_metric": false,
"stub": true,
"protocol": "https",
"orgID": "1076949",
"authentication": {
"auth_method": "static_token",
"username": "username",
"password": "password",
"token": "<token>",
"token_timeout": 1800000,
"token_cache": "local",
"invalid_token_error": 401,
"auth_field": "header.headers.X-Cisco-Meraki-API-Key",
"auth_field_format": "{token}",
"auth_logging": false,
"client_id": "",
"client_secret": "",
"grant_type": "",
"sensitive": [],
"sso": {
"protocol": "",
"host": "",
"port": 0
},
"multiStepAuthCalls": [
{
"name": "",
"requestFields": {},
"responseFields": {},
"successfullResponseCode": 200
}
]
},
"healthcheck": {
"type": "none",
"frequency": 300000,
"query_object": {},
"addlHeaders": {}
},
"throttle": {
"throttle_enabled": false,
"number_pronghorns": 1,
"sync_async": "sync",
"max_in_queue": 1000,
"concurrent_max": 1,
"expire_timeout": 0,
"avg_runtime": 200,
"priorities": [
{
"value": 0,
"percent": 100
}
]
},
"request": {
"number_redirects": 0,
"number_retries": 3,
"limit_retry_error": 401,
"failover_codes": [],
"attempt_timeout": 5000,
"global_request": {
"payload": {},
"uriOptions": {},
"addlHeaders": {},
"authData": {}
},
"healthcheck_on_timeout": true,
"return_raw": false,
"archiving": false,
"return_request": false
},
"proxy": {
"enabled": false,
"host": "",
"port": 1,
"protocol": "http",
"username": "",
"password": ""
},
"ssl": {
"ecdhCurve": "",
"enabled": false,
"accept_invalid_cert": true,
"ca_file": "",
"key_file": "",
"cert_file": "",
"secure_protocol": "",
"ciphers": ""
},
"mongo": {
"host": "",
"port": 0,
"database": "",
"username": "",
"password": "",
"replSet": "",
"db_ssl": {
"enabled": false,
"accept_invalid_cert": false,
"ca_file": "",
"key_file": "",
"cert_file": ""
}
},
"devicebroker": {
"enabled": true,
"getDevice": [
{
"path": "/organizations/{orgID}/networks/{networkId}/devices/{serial}",
"method": "GET",
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {
"networkID": "{port}",
"serial": "{serial}"
},
"responseDatakey": "",
"responseFields": {
"name": "{name}{||}{serial}",
"ostype": "{model}",
"ostypePrefix": "meraki-",
"port": "{networkId}",
"ipaddress": "{mac}",
"serial": "{serial}"
}
}
],
"getDevicesFiltered": [
{
"path": "/organizations/{orgID}/devices",
"method": "GET",
"pagination": {
"offsetVar": "",
"limitVar": "",
"incrementBy": "limit",
"requestLocation": "query"
},
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {},
"responseDatakey": "",
"responseFields": {
"name": "{name}{||}{serial}",
"ostype": "{model}",
"ostypePrefix": "meraki-",
"port": "{networkId}",
"ipaddress": "{mac}",
"serial": "{serial}",
"orgID": "{orgID}"
}
}
],
"isAlive": [
{
"path": "/organizations/{orgID}/networks/{networkID}/devices/{serial}",
"method": "GET",
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {
"networkID": "{port}",
"serial": "{serial}"
},
"responseDatakey": "",
"responseFields": {
"status": "return2xx",
"statusValue": "AD.200"
}
}
],
"getConfig": [
{
"path": "/organizations/{orgID}/networks/{networkID}/devices/{serial}",
"method": "GET",
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {
"networkID": "{port}",
"serial": "{serial}"
},
"responseDatakey": "",
"responseFields": {}
}
],
"getCount": [
{
"path": "/organizations/{orgID}/devices",
"method": "GET",
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {},
"responseDatakey": "",
"responseFields": {}
}
]
},
"cache": {
"enabled": false,
"entities": [
{
"entityType": "device",
"frequency": 3600,
"flushOnFail": false,
"limit": 10000,
"retryAttempts": 5,
"sort": true,
"populate": [
{
"path": "/organizations/{orgID}/devices",
"method": "GET",
"pagination": {
"offsetVar": "",
"limitVar": "",
"incrementBy": "limit",
"requestLocation": "query"
},
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {},
"responseDatakey": "",
"responseFields": {
"name": "{name}{||}{serial}",
"ostype": "{model}",
"ostypePrefix": "meraki-",
"port": "{networkId}",
"ipaddress": "{mac}",
"serial": "{serial}",
"orgID": "{orgID}"
}
}
],
"cachedTasks": [
{
"name": "",
"filterField": "",
"filterLoc": ""
}
]
}
]
}
}
Connection Properties
These base properties are used to connect to Meraki upon the adapter initially coming up. It is important to set these properties appropriately.
Property | Description |
---|---|
host | Required. A fully qualified domain name or IP address. |
port | Required. Used to connect to the server. |
base_path | Optional. Used to define part of a path that is consistent for all or most endpoints. It makes the URIs easier to use and maintain but can be overridden on individual calls. An example **base_path** might be `/rest/api`. Default is ``. |
version | Optional. Used to set a global version for action endpoints. This makes it faster to update the adapter when endpoints change. As with the base-path, version can be overridden on individual endpoints. Default is ``. |
cache_location | Optional. Used to define where the adapter cache is located. The cache is used to maintain an entity list to improve performance. Storage locally is lost when the adapter is restarted. Storage in Redis is preserved upon adapter restart. Default is none which means no caching of the entity list. |
encode_pathvars | Optional. Used to tell the adapter to encode path variables or not. The default behavior is to encode them so this property can be used to stop that behavior. |
encode_queryvars | Optional. Used to tell the adapter to encode query parameters or not. The default behavior is to encode them so this property can be used to stop that behavior. |
save_metric | Optional. Used to tell the adapter to save metric information (this does not impact metrics returned on calls). This allows the adapter to gather metrics over time. Metric data can be stored in a database or on the file system. |
stub | Optional. Indicates whether the stub should run instead of making calls to Meraki (very useful during basic testing). Default is false (which means connect to Meraki). |
protocol | Optional. Notifies the adapter whether to use HTTP or HTTPS. Default is HTTP. |
A connectivity check tells IAP the adapter has loaded successfully.
Authentication Properties
The following properties are used to define the authentication process to Meraki.
Note: Depending on the method that is used to authenticate with Meraki, you may not need to set all of the authentication properties.
Property | Description |
---|---|
auth_method | Required. Used to define the type of authentication currently supported. Authentication methods currently supported are: `basic user_password`, `static_token`, `request_token`, and `no_authentication`. |
username | Used to authenticate with Meraki on every request or when pulling a token that will be used in subsequent requests. |
password | Used to authenticate with Meraki on every request or when pulling a token that will be used in subsequent requests. |
token | Defines a static token that can be used on all requests. Only used with `static_token` as an authentication method (auth\_method). |
invalid_token_error | Defines the HTTP error that is received when the token is invalid. Notifies the adapter to pull a new token and retry the request. Default is 401. |
token_timeout | Defines how long a token is valid. Measured in milliseconds. Once a dynamic token is no longer valid, the adapter has to pull a new token. If the token_timeout is set to -1, the adapter will pull a token on every request to Meraki. If the timeout_token is 0, the adapter will use the expiration from the token response to determine when the token is no longer valid. |
token_cache | Used to determine where the token should be stored (local memory or in Redis). |
auth_field | Defines the request field the authentication (e.g., token are basic auth credentials) needs to be placed in order for the calls to work. |
auth_field_format | Defines the format of the auth\_field. See examples below. Items enclosed in {} inform the adapter to perofrm an action prior to sending the data. It may be to replace the item with a value or it may be to encode the item. |
auth_logging | Setting this true will add some additional logs but this should only be done when trying to debug an issue as certain credential information may be logged out when this is true. |
client_id | Provide a client id when needed, this is common on some types of OAuth. |
client_secret | Provide a client secret when needed, this is common on some types of OAuth. |
grant_type | Provide a grant type when needed, this is common on some types of OAuth. |
Examples of authentication field format
"{token}"
"Token {token}"
"{username}:{password}"
"Basic {b64}{username}:{password}{/b64}"
Healthcheck Properties
The healthcheck properties defines the API that runs the healthcheck to tell the adapter that it can reach Meraki. There are currently three types of healthchecks.
- None - Not recommended. Adapter will not run a healthcheck. Consequently, unable to determine before making a request if the adapter can reach Meraki.
- Startup - Adapter will check for connectivity when the adapter initially comes up, but it will not check afterwards.
- Intermittent - Adapter will check connectivity to Meraki at a frequency defined in the
frequency
property.
Property | Description |
---|---|
type | Required. The type of health check to run. |
frequency | Required if intermittent. Defines how often the health check should run. Measured in milliseconds. Default is 300000. |
query_object | Query parameters to be added to the adapter healthcheck call. |
Request Properties
The request section defines properties to help handle requests.
Property | Description |
---|---|
number_redirects | Optional. Tells the adapter that the request may be redirected and gives it a maximum number of redirects to allow before returning an error. Default is 0 - no redirects. |
number_retries | Tells the adapter how many times to retry a request that has either aborted or reached a limit error before giving up and returning an error. |
limit_retry_error | Optional. Can be either an integer or an array. Indicates the http error status number to define that no capacity was available and, after waiting a short interval, the adapter can retry the request. If an array is provvided, the array can contain integers or strings. Strings in the array are used to define ranges (e.g. "502-506"). Default is [0]. |
failover_codes | An array of error codes for which the adapter will send back a failover flag to IAP so that the Platform can attempt the action in another adapter. |
attempt_timeout | Optional. Tells how long the adapter should wait before aborting the attempt. On abort, the adapter will do one of two things: 1) return the error; or 2) if **healthcheck\_on\_timeout** is set to true, it will abort the request and run a Healthcheck until it re-establishes connectivity to Meraki, and then will re-attempt the request that aborted. Default is 5000 milliseconds. |
global_request | Optional. This is information that the adapter can include in all requests to the other system. This is easier to define and maintain than adding this information in either the code (adapter.js) or the action files. |
global_request -> payload | Optional. Defines any information that should be included on all requests sent to the other system that have a payload/body. |
global_request -> uriOptions | Optional. Defines any information that should be sent as untranslated query options (e.g. page, size) on all requests to the other system. |
global_request -> addlHeaders | Optioonal. Defines any headers that should be sent on all requests to the other system. |
global_request -> authData | Optional. Defines any additional authentication data used to authentice with the other system. This authData needs to be consistent on every request. |
healthcheck_on_timeout | Required. Defines if the adapter should run a health check on timeout. If set to true, the adapter will abort the request and run a health check until it re-establishes connectivity and then it will re-attempt the request. |
return_raw | Optional. Tells the adapter whether the raw response should be returned as well as the IAP response. This is helpful when running integration tests to save mock data. It does add overhead to the response object so it is not ideal from production. |
archiving | Optional flag. Default is false. It archives the request, the results and the various times (wait time, Meraki time and overall time) in the `adapterid_results` collection in MongoDB. Although archiving might be desirable, be sure to develop a strategy before enabling this capability. Consider how much to archive and what strategy to use for cleaning up the collection in the database so that it does not become too large, especially if the responses are large. |
return_request | Optional flag. Default is false. Will return the actual request that is made including headers. This should only be used during debugging issues as there could be credentials in the actual request. |
SSL Properties
The SSL section defines the properties utilized for ssl authentication with Meraki. SSL can work two different ways: set the accept\_invalid\_certs
flag to true (only recommended for lab environments), or provide a ca\_file
.
Property | Description |
---|---|
enabled | If SSL is required, set to true. |
accept_invalid_certs | Defines if the adapter should accept invalid certificates (only recommended for lab environments). Required if SSL is enabled. Default is false. |
ca_file | Defines the path name to the CA file used for SSL. If SSL is enabled and the accept invalid certifications is false, then ca_file is required. |
key_file | Defines the path name to the Key file used for SSL. The key_file may be needed for some systems but it is not required for SSL. |
cert_file | Defines the path name to the Certificate file used for SSL. The cert_file may be needed for some systems but it is not required for SSL. |
secure_protocol | Defines the protocol (e.g., SSLv3_method) to use on the SSL request. |
ciphers | Required if SSL enabled. Specifies a list of SSL ciphers to use. |
ecdhCurve | During testing on some Node 8 environments, you need to set `ecdhCurve` to auto. If you do not, you will receive PROTO errors when attempting the calls. This is the only usage of this property and to our knowledge it only impacts Node 8 and 9. |
Throttle Properties
The throttle section is used when requests to Meraki must be queued (throttled). All of the properties in this section are optional.
Property | Description |
---|---|
throttle_enabled | Default is false. Defines if the adapter should use throttling or not. |
number_pronghorns | Default is 1. Defines if throttling is done in a single Itential instance or whether requests are being throttled across multiple Itential instances (minimum = 1, maximum = 20). Throttling in a single Itential instance uses an in-memory queue so there is less overhead. Throttling across multiple Itential instances requires placing the request and queue information into a shared resource (e.g. database) so that each instance can determine what is running and what is next to run. Throttling across multiple instances requires additional I/O overhead. |
sync-async | This property is not used at the current time (it is for future expansion of the throttling engine). |
max_in_queue | Represents the maximum number of requests the adapter should allow into the queue before rejecting requests (minimum = 1, maximum = 5000). This is not a limit on what the adapter can handle but more about timely responses to requests. The default is currently 1000. |
concurrent_max | Defines the number of requests the adapter can send to Meraki at one time (minimum = 1, maximum = 1000). The default is 1 meaning each request must be sent to Meraki in a serial manner. |
expire_timeout | Default is 0. Defines a graceful timeout of the request session. After a request has completed, the adapter will wait additional time prior to sending the next request. Measured in milliseconds (minimum = 0, maximum = 60000). |
average_runtime | Represents the approximate average of how long it takes Meraki to handle each request. Measured in milliseconds (minimum = 50, maximum = 60000). Default is 200. This metric has performance implications. If the runtime number is set too low, it puts extra burden on the CPU and memory as the requests will continually try to run. If the runtime number is set too high, requests may wait longer than they need to before running. The number does not need to be exact but your throttling strategy depends heavily on this number being within reason. If averages range from 50 to 250 milliseconds you might pick an average run-time somewhere in the middle so that when Meraki performance is exceptional you might run a little slower than you might like, but when it is poor you still run efficiently. |
priorities | An array of priorities and how to handle them in relation to the throttle queue. Array of objects that include priority value and percent of queue to put the item ex { value: 1, percent: 10 } |
Proxy Properties
The proxy section defines the properties to utilize when Meraki is behind a proxy server.
Property | Description |
---|---|
enabled | Required. Default is false. If Meraki is behind a proxy server, set enabled flag to true. |
host | Host information for the proxy server. Required if `enabled` is true. |
port | Port information for the proxy server. Required if `enabled` is true. |
protocol | The protocol (i.e., http, https, etc.) used to connect to the proxy. Default is http. |
username | If there is authentication for the proxy, provide the username here. |
password | If there is authentication for the proxy, provide the password here. |
Mongo Properties
The mongo section defines the properties used to connect to a Mongo database. Mongo can be used for throttling as well as to persist metric data. If not provided, metrics will be stored in the file system.
Property | Description |
---|---|
host | Optional. Host information for the mongo server. |
port | Optional. Port information for the mongo server. |
database | Optional. The database for the adapter to use for its data. |
username | Optional. If credentials are required to access mongo, this is the user to login as. |
password | Optional. If credentials are required to access mongo, this is the password to login with. |
replSet | Optional. If the database is set up to use replica sets, define it here so it can be added to the database connection. |
db_ssl | Optional. Contains information for SSL connectivity to the database. |
db_ssl -> enabled | If SSL is required, set to true. |
db_ssl -> accept_invalid_cert | Defines if the adapter should accept invalid certificates (only recommended for lab environments). Required if SSL is enabled. Default is false. |
db_ssl -> ca_file | Defines the path name to the CA file used for SSL. If SSL is enabled and the accept invalid certifications is false, then ca_file is required. |
db_ssl -> key_file | Defines the path name to the Key file used for SSL. The key_file may be needed for some systems but it is not required for SSL. |
db_ssl -> cert_file | Defines the path name to the Certificate file used for SSL. The cert_file may be needed for some systems but it is not required for SSL. |
Device Broker Properties
The device broker section defines the properties used integrate Meraki to the device broker. Each broker call is represented and has an array of calls that can be used to build the response. This describes the calls and then the fields which are available in the calls.
Property | Description |
---|---|
getDevice | The array of calls used to get device details for the broker |
getDevicesFiltered | The array of calls used to get devices for the broker |
isAlive | The array of calls used to get device status for the broker |
getConfig | The array of calls used to get device configuration for the broker |
getCount | The array of calls used to get device configuration for the broker |
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> path | The path, not including the base_path and version, for making this call |
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> method | The rest method for making this call |
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> query | Query object containing and query parameters and their values for this call |
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> body | Body object containing the payload for this call |
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> headers | Header object containing the headers for this call. |
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> handleFailure | Tells the adapter whether to "fail" or "ignore" failures if they occur. |
isAlive -> statusValue | Tells the adapter what value to look for in the status field to determine if the device is alive. |
getDevice/getDevicesFiltered/isAlive/getConfig -> requestFields | Object containing fields the adapter should send on the request and where it should get the data. The where can be from a response to a getDevicesFiltered or a static value. |
getDevice/getDevicesFiltered/isAlive/getConfig -> responseFields | Object containing fields the adapter should set to send back to iap and where the value should come from in the response or request data. |
Using this Adapter
The adapter.js
file contains the calls the adapter makes available to the rest of the Itential Platform. The API detailed for these calls should be available through JSDOC. The following is a brief summary of the calls.
Generic Adapter Calls
These are adapter methods that IAP or you might use. There are some other methods not shown here that might be used for internal adapter functionality.
Method Signature | Description | Workflow? |
---|---|---|
connect() | This call is run when the Adapter is first loaded by he Itential Platform. It validates the properties have been provided correctly. | No |
healthCheck(callback) | This call ensures that the adapter can communicate with Adapter for Meraki. The actual call that is used is defined in the adapter properties and .system entities action.json file. | No |
refreshProperties(properties) | This call provides the adapter the ability to accept property changes without having to restart the adapter. | No |
encryptProperty(property, technique, callback) | This call will take the provided property and technique, and return the property encrypted with the technique. This allows the property to be used in the adapterProps section for the credential password so that the password does not have to be in clear text. The adapter will decrypt the property as needed for communications with Adapter for Meraki. | No |
iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, callback) | This call provides the ability to update the adapter configuration from IAP - includes actions, schema, mockdata and other configurations. | Yes |
iapSuspendAdapter(mode, callback) | This call provides the ability to suspend the adapter and either have requests rejected or put into a queue to be processed after the adapter is resumed. | Yes |
iapUnsuspendAdapter(callback) | This call provides the ability to resume a suspended adapter. Any requests in queue will be processed before new requests. | Yes |
iapGetAdapterQueue(callback) | This call will return the requests that are waiting in the queue if throttling is enabled. | Yes |
iapFindAdapterPath(apiPath, callback) | This call provides the ability to see if a particular API path is supported by the adapter. | Yes |
iapTroubleshootAdapter(props, persistFlag, adapter, callback) | This call can be used to check on the performance of the adapter - it checks connectivity, healthcheck and basic get calls. | Yes |
iapRunAdapterHealthcheck(adapter, callback) | This call will return the results of a healthcheck. | Yes |
iapRunAdapterConnectivity(callback) | This call will return the results of a connectivity check. | Yes |
iapRunAdapterBasicGet(callback) | This call will return the results of running basic get API calls. | Yes |
iapMoveAdapterEntitiesToDB(callback) | This call will push the adapter configuration from the entities directory into the Adapter or IAP Database. | Yes |
iapDeactivateTasks(tasks, callback) | This call provides the ability to remove tasks from the adapter. | Yes |
iapActivateTasks(tasks, callback) | This call provides the ability to add deactivated tasks back into the adapter. | Yes |
iapExpandedGenericAdapterRequest(metadata, uriPath, restMethod, pathVars, queryData, requestBody, addlHeaders, callback) | This is an expanded Generic Call. The metadata object allows us to provide many new capabilities within the generic request. | Yes |
genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback) | This call allows you to provide the path to have the adapter call. It is an easy way to incorporate paths that have not been built into the adapter yet. | Yes |
genericAdapterRequestNoBasePath(uriPath, restMethod, queryData, requestBody, addlHeaders, callback) | This call is the same as the genericAdapterRequest only it does not add a base_path or version to the call. | Yes |
iapRunAdapterLint(callback) | Runs lint on the addapter and provides the information back. | Yes |
iapRunAdapterTests(callback) | Runs baseunit and unit tests on the adapter and provides the information back. | Yes |
iapGetAdapterInventory(callback) | This call provides some inventory related information about the adapter. | Yes |
Adapter Cache Calls
These are adapter methods that are used for adapter caching. If configured, the adapter will cache based on the interval provided. However, you can force a population of the cache manually as well.
Method Signature | Description | Workflow? |
---|---|---|
iapPopulateEntityCache(entityTypes, callback) | This call populates the adapter cache. | Yes |
iapRetrieveEntitiesCache(entityType, options, callback) | This call retrieves the specific items from the adapter cache. | Yes |
Adapter Broker Calls
These are adapter methods that are used to integrate to IAP Brokers. This adapter currently supports the following broker calls.
Method Signature | Description | Workflow? |
---|---|---|
hasEntities(entityType, entityList, callback) | This call is utilized by the IAP Device Broker to determine if the adapter has a specific entity and item of the entity. | No |
getDevice(deviceName, callback) | This call returns the details of the requested device. | No |
getDevicesFiltered(options, callback) | This call returns the list of devices that match the criteria provided in the options filter. | No |
isAlive(deviceName, callback) | This call returns whether the device status is active | No |
getConfig(deviceName, format, callback) | This call returns the configuration for the selected device. | No |
iapGetDeviceCount(callback) | This call returns the count of devices. | No |
Specific Adapter Calls
Specific adapter calls are built based on the API of the Meraki. The Adapter Builder creates the proper method comments for generating JS-DOC for the adapter. This is the best way to get information on the calls.
Method Signature | Description | Path | Workflow? |
---|---|---|---|
createOrganizationActionBatch(organizationId, createOrganizationActionBatch, callback) | Create an action batch | {base_path}/{version}/organizations/{pathv1}/actionBatches?{query} | Yes |
getOrganizationActionBatches(organizationId, callback) | Return the list of action batches in the organization | {base_path}/{version}/organizations/{pathv1}/actionBatches?{query} | Yes |
getOrganizationActionBatch(organizationId, id, callback) | Return an action batch | {base_path}/{version}/organizations/{pathv1}/actionBatches/{pathv2}?{query} | Yes |
deleteOrganizationActionBatch(organizationId, id, callback) | Delete an action batch | {base_path}/{version}/organizations/{pathv1}/actionBatches/{pathv2}?{query} | Yes |
updateOrganizationActionBatch(organizationId, id, updateOrganizationActionBatch, callback) | Update an action batch | {base_path}/{version}/organizations/{pathv1}/actionBatches/{pathv2}?{query} | Yes |
getOrganizationAdmins(organizationId, callback) | List the dashboard administrators in this organization | {base_path}/{version}/organizations/{pathv1}/admins?{query} | Yes |
createOrganizationAdmin(organizationId, createOrganizationAdmin, callback) | Create a new dashboard administrator | {base_path}/{version}/organizations/{pathv1}/admins?{query} | Yes |
updateOrganizationAdmin(organizationId, id, updateOrganizationAdmin, callback) | Update an administrator | {base_path}/{version}/organizations/{pathv1}/admins/{pathv2}?{query} | Yes |
deleteOrganizationAdmin(organizationId, id, callback) | Revoke all access for a dashboard administrator within this organization | {base_path}/{version}/organizations/{pathv1}/admins/{pathv2}?{query} | Yes |
getNetworkAlertSettings(networkId, callback) | Return the alert configuration for this network | v0:{base_path}/{version}/networks/{pathv1}/alertSettings?{query} v1:{base_path}/{version}/networks/{pathv1}/alerts/Settings?{query} | Yes |
updateNetworkAlertSettings(networkId, updateNetworkAlertSettings, callback) | Update the alert configuration for this network | v0:{base_path}/{version}/networks/{pathv1}/alertSettings?{query} v1:{base_path}/{version}/networks/{pathv1}/alerts/Settings?{query} | Yes |
getDeviceCameraAnalyticsOverview(serial, t0, t1, timespan, callback) | Returns an overview of aggregate analytics data for a timespan | {base_path}/{version}/devices/{pathv1}/camera/analytics/overview?{query} | Yes |
getDeviceCameraAnalyticsOverviewV2(serial, queryVars, callback) | Returns an overview of aggregate analytics data for a timespan | {base_path}/{version}/devices/{pathv1}/camera/analytics/overview?{query} | Yes |
getDeviceCameraAnalyticsZones(serial, callback) | Returns all configured analytic zones for this camera | {base_path}/{version}/devices/{pathv1}/camera/analytics/zones?{query} | Yes |
getDeviceCameraAnalyticsZoneHistory(serial, zoneId, t0, t1, timespan, resolution, callback) | Return historical records for analytic zones | {base_path}/{version}/devices/{pathv1}/camera/analytics/zones/{pathv2}/history?{query} | Yes |
getDeviceCameraAnalyticsZoneHistoryV2(serial, zoneId, queryVars, callback) | Return historical records for analytic zones | {base_path}/{version}/devices/{pathv1}/camera/analytics/zones/{pathv2}/history?{query} | Yes |
getDeviceCameraAnalyticsRecent(serial, callback) | Returns most recent record for analytics zones | {base_path}/{version}/devices/{pathv1}/camera/analytics/recent?{query} | Yes |
getDeviceCameraAnalyticsRecentV2(serial, queryVars, callback) | Returns most recent record for analytics zones | {base_path}/{version}/devices/{pathv1}/camera/analytics/recent?{query} | Yes |
getDeviceCameraAnalyticsLive(serial, callback) | Returns live state from camera of analytics zones | {base_path}/{version}/devices/{pathv1}/camera/analytics/live?{query} | Yes |
getOrganizationApiRequests(organizationId, t0, t1, timespan, perPage, startingAfter, endingBefore, adminId, pathParam, method, callback) | List the API requests made by an organization | {base_path}/{version}/organizations/{pathv1}/apiRequests?{query} | Yes |
getOrganizationApiRequestsV2(organizationId, queryVars, callback) | List the API requests made by an organization | {base_path}/{version}/organizations/{pathv1}/apiRequests?{query} | Yes |
getNetworkBluetoothClient(networkId, bluetoothClientId, includeConnectivityHistory, connectivityHistoryTimespan, callback) | Return a Bluetooth client. Bluetooth clients can be identified by their ID or their MAC. | {base_path}/{version}/networks/{pathv1}/bluetoothClients/{pathv2}?{query} | Yes |
getNetworkBluetoothClients(networkId, perPage, startingAfter, endingBefore, timespan, includeConnectivityHistory, callback) | List the Bluetooth clients seen by APs in this network | {base_path}/{version}/networks/{pathv1}/bluetoothClients?{query} | Yes |
getNetworkBluetoothClientsV2(networkId, queryVars, callback) | List the Bluetooth clients seen by APs in this network | {base_path}/{version}/networks/{pathv1}/bluetoothClients?{query} | Yes |
getNetworkBluetoothSettings(networkId, callback) | Return the Bluetooth settings for a network. Bluetooth settings must be enabled on the network. | {base_path}/{version}/networks/{pathv1}/bluetoothSettings?{query} | Yes |
updateNetworkBluetoothSettings(networkId, updateNetworkBluetoothSettings, callback) | Update the Bluetooth settings for a network. See the docs page for Bluetooth settings . | {base_path}/{version}/networks/{pathv1}/bluetoothSettings?{query} | Yes |
getOrganizationNetworks(organizationId, configTemplateId, callback) | List the networks in an organization | {base_path}/{version}/organizations/{pathv1}/networks?{query} | Yes |
createOrganizationNetwork(organizationId, createOrganizationNetwork, callback) | Create a network | {base_path}/{version}/organizations/{pathv1}/networks?{query} | Yes |
getNetwork(networkId, callback) | Return a network | {base_path}/{version}/networks/{pathv1}?{query} | Yes |
updateNetwork(networkId, updateNetwork, callback) | Update a network | {base_path}/{version}/networks/{pathv1}?{query} | Yes |
deleteNetwork(networkId, callback) | Delete a network | {base_path}/{version}/networks/{pathv1}?{query} | Yes |
bindNetwork(networkId, bindNetwork, callback) | Bind a network to a template. | {base_path}/{version}/networks/{pathv1}/bind?{query} | Yes |
unbindNetwork(networkId, callback) | Unbind a network from a template. | {base_path}/{version}/networks/{pathv1}/unbind?{query} | Yes |
getNetworkTraffic(networkId, timespan, deviceType, callback) | The traffic analysis data for this network. Traffic Analysis with Hostname Visibility must be enabled on the network. | {base_path}/{version}/networks/{pathv1}/traffic?{query} | Yes |
getNetworkTrafficV2(networkId, queryVars, callback) | The traffic analysis data for this network. Traffic Analysis with Hostname Visibility must be enabled on the network. | {base_path}/{version}/networks/{pathv1}/traffic?{query} | Yes |
getNetworkAccessPolicies(networkId, callback) | List the access policies for this network. Only valid for MS networks. | {base_path}/{version}/networks/{pathv1}/accessPolicies?{query} | Yes |
returnTheSSIDStatusesOfAnAccessPoint(networkId, serial, callback) | Return the SSID statuses of an access point | {base_path}/{version}/networks/{pathv1}/devices/{pathv2}/wireless/status?{query} | Yes |
returnTheSSIDStatusesOfAnAccessPointV1(serial, callback) | Return the SSID statuses of an access point | {base_path}/{version}/devices/{pathv1}/wireless/status?{query} | Yes |
getNetworkAirMarshal(networkId, t0, timespan, callback) | List Air Marshal scan results from a network | v0:{base_path}/{version}/networks/{pathv1}/airMarshal?{query} v1:{base_path}/{version}/networks/{pathv1}/wireless/airMarshal?{query} | Yes |
combineOrganizationNetworks(organizationId, combineOrganizationNetworks, callback) | Combine multiple networks into a single network | {base_path}/{version}/organizations/{pathv1}/networks/combine?{query} | Yes |
splitNetwork(networkId, callback) | Split a combined network into individual networks for each type of device | {base_path}/{version}/networks/{pathv1}/split?{query} | Yes |
getNetworkSiteToSiteVpn(networkId, callback) | Return the site-to-site VPN settings of a network. Only valid for MX networks. | v0:{base_path}/{version}/networks/{pathv1}/siteToSiteVpn?{query} v1:{base_path}/{version}/networks/{pathv1}/aplpiance/vpn/siteToSiteVpn?{query} | Yes |
updateNetworkSiteToSiteVpn(networkId, updateNetworkSiteToSiteVpn, callback) | Update the site-to-site VPN settings of a network. Only valid for MX networks in NAT mode. | v0:{base_path}/{version}/networks/{pathv1}/siteToSiteVpn?{query} v1:{base_path}/{version}/networks/{pathv1}/aplpiance/vpn/siteToSiteVpn?{query} | Yes |
getNetworkCameraVideoLink(networkId, serial, timestamp, callback) | Returns video link for the specified camera. If a timestamp supplied, it links to that time. | {base_path}/{version}/networks/{pathv1}/cameras/{pathv2}/videoLink?{query} | Yes |
generateNetworkCameraSnapshot(networkId, serial, generateNetworkCameraSnapshot, callback) | Generate a snapshot of what the camera sees at the specified time and return a link to that image. | {base_path}/{version}/networks/{pathv1}/cameras/{pathv2}/snapshot?{query} | Yes |
getNetworkClient(networkId, clientId, callback) | 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. | {base_path}/{version}/networks/{pathv1}/clients/{pathv2}?{query} | Yes |
provisionNetworkClients(networkId, provisionNetworkClients, callback) | Provisions a client with a name and policy. Clients can be provisioned before they associate to the network. | {base_path}/{version}/networks/{pathv1}/clients/provision?{query} | Yes |
getNetworkClientUsageHistory(networkId, clientId, callback) | 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. | {base_path}/{version}/networks/{pathv1}/clients/{pathv2}/usageHistory?{query} | Yes |
getNetworkClientPolicy(networkId, clientId, callback) | 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. | {base_path}/{version}/networks/{pathv1}/clients/{pathv2}/policy?{query} | Yes |
updateNetworkClientPolicy(networkId, clientId, updateNetworkClientPolicy, callback) | 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. | {base_path}/{version}/networks/{pathv1}/clients/{pathv2}/policy?{query} | Yes |
getNetworkClientSplashAuthorizationStatus(networkId, clientId, callback) | Return the splash authorization for a client, for each SSID they've associated with through splash. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP. | {base_path}/{version}/networks/{pathv1}/clients/{pathv2}/splashAuthorizationStatus?{query} | Yes |
updateNetworkClientSplashAuthorizationStatus(networkId, clientId, updateNetworkClientSplashAuthorizationStatus, callback) | 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. | {base_path}/{version}/networks/{pathv1}/clients/{pathv2}/splashAuthorizationStatus?{query} | Yes |
getNetworkClients(networkId, t0, timespan, perPage, startingAfter, endingBefore, callback) | List the clients that have used this network in the timespan | {base_path}/{version}/networks/{pathv1}/clients?{query} | Yes |
getDeviceClients(serial, t0, timespan, callback) | 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. | {base_path}/{version}/devices/{pathv1}/clients?{query} | Yes |
getNetworkClientTrafficHistory(networkId, clientId, perPage, startingAfter, endingBefore, callback) | 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. | {base_path}/{version}/networks/{pathv1}/clients/{pathv2}/trafficHistory?{query} | Yes |
getNetworkClientEvents(networkId, clientId, perPage, startingAfter, endingBefore, callback) | 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. | {base_path}/{version}/networks/{pathv1}/clients/{pathv2}/events?{query} | Yes |
getNetworkClientLatencyHistory(networkId, clientId, t0, t1, timespan, resolution, callback) | 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. | {base_path}/{version}/networks/{pathv1}/clients/{pathv2}/latencyHistory?{query} | Yes |
getOrganizationConfigTemplates(organizationId, callback) | List the configuration templates for this organization | {base_path}/{version}/organizations/{pathv1}/configTemplates?{query} | Yes |
deleteOrganizationConfigTemplate(organizationId, id, callback) | Remove a configuration template | {base_path}/{version}/organizations/{pathv1}/configTemplates/{pathv2}?{query} | Yes |
getNetworkDeviceLldpCdp(networkId, serial, timespan, callback) | List LLDP and CDP information for a device | {base_path}/{version}/networks/{pathv1}/devices/{pathv2}/lldp_cdp?{query} | Yes |
getNetworkDeviceLldpCdpV1(serial, timespan, callback) | List LLDP and CDP information for a device | {base_path}/{version}/devices/{pathv1}/lldp_cdp?{query} | Yes |
getOrganizationDevices(organizationId, perPage, startingAfter, endingBefore, callback) | List the devices in an organization | {base_path}/{version}/organizations/{pathv1}/devices?{query} | Yes |
getNetworkDevices(networkId, callback) | List the devices in a network | {base_path}/{version}/networks/{pathv1}/devices?{query} | Yes |
getNetworkDevice(networkId, serial, callback) | Return a single device | {base_path}/{version}/networks/{pathv1}/devices/{pathv2}?{query} | Yes |
getNetworkDeviceV1(serial, callback) | Return a single device | {base_path}/{version}/devices/{pathv1}?{query} | Yes |
updateNetworkDevice(networkId, serial, updateNetworkDevice, callback) | Update the attributes of a device | {base_path}/{version}/networks/{pathv1}/devices/{pathv2}?{query} | Yes |
getNetworkDevicePerformance(networkId, serial, callback) | Return the performance score for a single device. Only primary MX devices supported. If no data is available, a 204 error code is returned. | {base_path}/{version}/networks/{pathv1}/devices/{pathv2}/performance?{query} | Yes |
getNetworkDevicePerformanceV1(serial, callback) | Return the performance score for a single device. Only primary MX devices supported. If no data is available, a 204 error code is returned. | {base_path}/{version}/devices/{pathv1}/appliance/performance?{query} | Yes |
getNetworkDeviceUplink(networkId, serial, callback) | Return the uplink information for a device. | {base_path}/{version}/networks/{pathv1}/devices/{pathv2}/uplink?{query} | Yes |
claimNetworkDevices(networkId, claimNetworkDevices, callback) | Claim a device into a network | {base_path}/{version}/networks/{pathv1}/devices/claim?{query} | Yes |
removeNetworkDevice(networkId, serial, callback) | Remove a single device | v0:{base_path}/{version}/networks/{pathv1}/devices/{pathv2}/remove?{query} v1:{base_path}/{version}/networks/{pathv1}/devices/remove?{query} | Yes |
getNetworkDeviceLossAndLatencyHistory(networkId, serial, t0, t1, timespan, resolution, uplink, ip, callback) | Get the uplink loss percentage and latency in milliseconds for a wired network device. | {base_path}/{version}/networks/{pathv1}/devices/{pathv2}/lossAndLatencyHistory?{query} | Yes |
getNetworkDeviceLossAndLatencyHistoryV1(serial, t0, t1, timespan, resolution, uplink, ip, callback) | Get the uplink loss percentage and latency in milliseconds for a wired network device. | {base_path}/{version}/devices/{pathv1}/lossAndLatencyHistory?{query} | Yes |
rebootNetworkDevice(networkId, serial, callback) | Reboot a device | {base_path}/{version}/networks/{pathv1}/devices/{pathv2}/reboot?{query} | Yes |
rebootNetworkDeviceV1(serial, callback) | Reboot a device | {base_path}/{version}/devices/{pathv1}/reboot?{query} | Yes |
blinkNetworkDeviceLeds(networkId, serial, blinkNetworkDeviceLeds, callback) | Blink the LEDs on a device | {base_path}/{version}/networks/{pathv1}/devices/{pathv2}/blinkLeds?{query} | Yes |
blinkNetworkDeviceLedsV1(serial, blinkNetworkDeviceLeds, callback) | Blink the LEDs on a device | {base_path}/{version}/devices/{pathv1}/blinkLeds?{query} | Yes |
getNetworkCellularFirewallRules(networkId, callback) | Return the cellular firewall rules for an MX network | v0:{base_path}/{version}/networks/{pathv1}/cellularFirewallRules?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/firewall/cellularFirewallRules?{query} | Yes |
updateNetworkCellularFirewallRules(networkId, updateNetworkCellularFirewallRules, callback) | Update the cellular firewall rules of an MX network | v0:{base_path}/{version}/networks/{pathv1}/cellularFirewallRules?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/firewall/cellularFirewallRules?{query} | Yes |
getNetworkL3FirewallRules(networkId, callback) | Return the L3 firewall rules for an MX network | v0:{base_path}/{version}/networks/{pathv1}/l3FirewallRules?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/firewall/l3FirewallRules?{query} | Yes |
updateNetworkL3FirewallRules(networkId, updateNetworkL3FirewallRules, callback) | Update the L3 firewall rules of an MX network | v0:{base_path}/{version}/networks/{pathv1}/l3FirewallRules?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/firewall/l3FirewallRules?{query} | Yes |
getNetworkL7FirewallRulesApplicationCategories(networkId, callback) | Return the L7 firewall application categories and their associated applications for an MX network | v0:{base_path}/{version}/networks/{pathv1}/l7FirewallRules/applicationCategories?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/firewall/l7FirewallRules/applicationCategories?{query} | Yes |
getNetworkL7FirewallRules(networkId, callback) | List the MX L7 firewall rules for an MX network | v0:{base_path}/{version}/networks/{pathv1}/l7FirewallRules?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/firewall/l7FirewallRules?{query} | Yes |
updateNetworkL7FirewallRules(networkId, updateNetworkL7FirewallRules, callback) | Update the MX L7 firewall rules for an MX network | v0:{base_path}/{version}/networks/{pathv1}/l7FirewallRules?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/firewall/l7FirewallRules?{query} | Yes |
getOrganizationVpnFirewallRules(organizationId, callback) | Return the firewall rules for an organization's site-to-site VPN | v0:{base_path}/{version}/organizations/{pathv1}/vpnFirewallRules?{query} v1:{base_path}/{version}/organizations/{pathv1}/appliance/vpn/vpnFirewallRules?{query} | Yes |
updateOrganizationVpnFirewallRules(organizationId, updateOrganizationVpnFirewallRules, callback) | Update the firewall rules of an organization's site-to-site VPN | v0:{base_path}/{version}/organizations/{pathv1}/vpnFirewallRules?{query} v1:{base_path}/{version}/organizations/{pathv1}/appliance/vpn/vpnFirewallRules?{query} | Yes |
getNetworkSsidL3FirewallRules(networkId, number, callback) | Return the L3 firewall rules for an SSID on an MR network | v0:{base_path}/{version}/networks/{pathv1}/ssids/{pathv2}/l3FirewallRules?{query} v1:{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/firewall/l3FirewallRules?{query} | Yes |
updateNetworkSsidL3FirewallRules(networkId, number, updateNetworkSsidL3FirewallRules, callback) | Update the L3 firewall rules of an SSID on an MR network | v0:{base_path}/{version}/networks/{pathv1}/ssids/{pathv2}/l3FirewallRules?{query} v1:{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/firewall/l3FirewallRules?{query} | Yes |
getNetworkGroupPolicies(networkId, callback) | List the group policies in a network | {base_path}/{version}/networks/{pathv1}/groupPolicies?{query} | Yes |
createNetworkGroupPolicy(networkId, createNetworkGroupPolicy, callback) | Create a group policy | {base_path}/{version}/networks/{pathv1}/groupPolicies?{query} | Yes |
getNetworkGroupPolicy(networkId, groupPolicyId, callback) | Display a group policy | {base_path}/{version}/networks/{pathv1}/groupPolicies/{pathv2}?{query} | Yes |
updateNetworkGroupPolicy(networkId, groupPolicyId, updateNetworkGroupPolicy, callback) | Update a group policy | {base_path}/{version}/networks/{pathv1}/groupPolicies/{pathv2}?{query} | Yes |
deleteNetworkGroupPolicy(networkId, groupPolicyId, callback) | Delete a group policy | {base_path}/{version}/networks/{pathv1}/groupPolicies/{pathv2}?{query} | Yes |
getNetworkSsidHotspot20(networkId, number, callback) | Return the Hotspot 2.0 settings for an SSID | v0:{base_path}/{version}/networks/{pathv1}/ssids/{pathv2}/hotspot20?{query} v1:{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/hotspot20?{query} | Yes |
updateNetworkSsidHotspot20(networkId, number, updateNetworkSsidHotspot20, callback) | Update the Hotspot 2.0 settings of an SSID | v0:{base_path}/{version}/networks/{pathv1}/ssids/{pathv2}/hotspot20?{query} v1:{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/hotspot20?{query} | Yes |
getNetworkHttpServers(networkId, callback) | List the HTTP servers for a network | {base_path}/{version}/networks/{pathv1}/httpServers?{query} | Yes |
createNetworkHttpServer(networkId, createNetworkHttpServer, callback) | Add an HTTP server | {base_path}/{version}/networks/{pathv1}/httpServers?{query} | Yes |
getNetworkHttpServer(networkId, id, callback) | Return an HTTP server | {base_path}/{version}/networks/{pathv1}/httpServers/{pathv2}?{query} | Yes |
updateNetworkHttpServer(networkId, id, updateNetworkHttpServer, callback) | Update an HTTP server | {base_path}/{version}/networks/{pathv1}/httpServers/{pathv2}?{query} | Yes |
deleteNetworkHttpServer(networkId, id, callback) | Delete an HTTP server | {base_path}/{version}/networks/{pathv1}/httpServers/{pathv2}?{query} | Yes |
createNetworkHttpServersWebhookTest(networkId, createNetworkHttpServersWebhookTest, callback) | Send a test webhook | {base_path}/{version}/networks/{pathv1}/httpServers/webhookTests?{query} | Yes |
getNetworkHttpServersWebhookTest(networkId, id, callback) | Return the status of a webhook test | {base_path}/{version}/networks/{pathv1}/httpServers/webhookTests/{pathv2}?{query} | Yes |
getNetworkDeviceManagementInterfaceSettings(networkId, serial, callback) | Return the management interface settings for a device | {base_path}/{version}/networks/{pathv1}/devices/{pathv2}/managementInterfaceSettings?{query} | Yes |
getNetworkDeviceManagementInterfaceSettingsV1(serial, callback) | Return the management interface settings for a device | {base_path}/{version}/devices/{pathv1}/managementInterfaceSettings?{query} | Yes |
updateNetworkDeviceManagementInterfaceSettings(networkId, serial, updateNetworkDeviceManagementInterfaceSettings, callback) | Update the management interface settings for a device | {base_path}/{version}/networks/{pathv1}/devices/{pathv2}/managementInterfaceSettings?{query} | Yes |
updateNetworkDeviceManagementInterfaceSettingsV1(serial, updateNetworkDeviceManagementInterfaceSettings, callback) | Update the management interface settings for a device | {base_path}/{version}/devices/{pathv1}/managementInterfaceSettings?{query} | Yes |
getNetworkMerakiAuthUsers(networkId, callback) | List the splash or RADIUS users configured under Meraki Authentication for a network | {base_path}/{version}/networks/{pathv1}/merakiAuthUsers?{query} | Yes |
getNetworkMerakiAuthUser(networkId, id, callback) | Return the Meraki Auth splash or RADIUS user | {base_path}/{version}/networks/{pathv1}/merakiAuthUsers/{pathv2}?{query} | Yes |
getOrganizationOpenapiSpec(organizationId, callback) | Return the OpenAPI 2.0 Specification of the organization's API documentation in JSON | {base_path}/{version}/organizations/{pathv1}/openapiSpec?{query} | Yes |
getOrganizations(callback) | List the organizations that the user has privileges on | {base_path}/{version}/organizations?{query} | Yes |
createOrganization(createOrganization, callback) | Create a new organization | {base_path}/{version}/organizations?{query} | Yes |
getOrganization(id, callback) | Return an organization | {base_path}/{version}/organizations/{pathv1}?{query} | Yes |
updateOrganization(id, updateOrganization, callback) | Update an organization | {base_path}/{version}/organizations/{pathv1}?{query} | Yes |
cloneOrganization(id, cloneOrganization, callback) | Create a new organization by cloning the addressed organization | {base_path}/{version}/organizations/{pathv1}/clone?{query} | Yes |
getOrganizationLicenseState(id, callback) | Return the license state for an organization | {base_path}/{version}/organizations/{pathv1}/licenseState?{query} | Yes |
getOrganizationInventory(id, callback) | Return the inventory for an organization | v0:{base_path}/{version}/organizations/{pathv1}/inventory?{query} v1:{base_path}/{version}/organizations/{pathv1}/inventory/devices?{query} | Yes |
getOrganizationInventoryV2(id, queryVars, callback) | Return the inventory for an organization | v0:{base_path}/{version}/organizations/{pathv1}/inventory?{query} v1:{base_path}/{version}/organizations/{pathv1}/inventory/devices?{query} | Yes |
getOrganizationDeviceStatuses(id, callback) | List the status of every Meraki device in the organization | {base_path}/{version}/organizations/{pathv1}/deviceStatuses?{query} | Yes |
getOrganizationSnmp(id, callback) | Return the SNMP settings for an organization | {base_path}/{version}/organizations/{pathv1}/snmp?{query} | Yes |
updateOrganizationSnmp(id, updateOrganizationSnmp, callback) | Update the SNMP settings for an organization | {base_path}/{version}/organizations/{pathv1}/snmp?{query} | Yes |
claimOrganization(organizationId, claimOrganization, callback) | Claim a device, license key, or order into an organization. When claiming by order, all devices and licenses in the order will be claimed; licenses will be added to the organization and devices will be placed in the organization's inventory. These three types of claims are mutually exclusive and cannot be performed in one request. | {base_path}/{version}/organizations/{pathv1}/claim?{query} | Yes |
getOrganizationUplinksLossAndLatency(organizationId, uplink, ip, callback) | Return the uplink loss and latency for every MX in the organization from 2 - 7 minutes ago | v0:{base_path}/{version}/organizations/{pathv1}/uplinksLossAndLatency?{query} v1:{base_path}/{version}/organizations/{pathv1}/devices/uplinksLossAndLatency?{query} | Yes |
getOrganizationUplinksLossAndLatencyV2(organizationId, queryVars, callback) | Return the uplink loss and latency for every MX in the organization from 2 - 7 minutes ago | v0:{base_path}/{version}/organizations/{pathv1}/uplinksLossAndLatency?{query} v1:{base_path}/{version}/organizations/{pathv1}/devices/uplinksLossAndLatency?{query} | Yes |
getOrganizationThirdPartyVPNPeers(organizationId, callback) | Return the third party VPN peers for an organization | v0:{base_path}/{version}/organizations/{pathv1}/thirdPartyVPNPeers?{query} v1:{base_path}/{version}/organizations/{pathv1}/appliance/vpn/thirdPartyVPNPeers?{query} | Yes |
updateOrganizationThirdPartyVPNPeers(organizationId, updateOrganizationThirdPartyVPNPeers, callback) | Update the third party VPN peers for an organization | v0:{base_path}/{version}/organizations/{pathv1}/thirdPartyVPNPeers?{query} v1:{base_path}/{version}/organizations/{pathv1}/appliance/vpn/thirdPartyVPNPeers?{query} | Yes |
getNetworkPiiPiiKeys(networkId, username, email, mac, serial, imei, bluetoothMac, callback) | List the keys required to access Personally Identifiable Information (PII) for a given identifier. Exactly one identifier will be accepted. If the organization contains org-wide Systems Manager users matching the key provided then there will be an entry with the key "0" containing the applicable keys. | {base_path}/{version}/networks/{pathv1}/pii/piiKeys?{query} | Yes |
getNetworkPiiSmDevicesForKey(networkId, username, email, mac, serial, imei, bluetoothMac, callback) | Given a piece of Personally Identifiable Information (PII), return the Systems Manager device ID(s) associated with that identifier. These device IDs can be used with the Systems Manager API endpoints to retrieve device details. Exactly one identifier will be accepted. | {base_path}/{version}/networks/{pathv1}/pii/smDevicesForKey?{query} | Yes |
getNetworkPiiSmOwnersForKey(networkId, username, email, mac, serial, imei, bluetoothMac, callback) | Given a piece of Personally Identifiable Information (PII), return the Systems Manager owner ID(s) associated with that identifier. These owner IDs can be used with the Systems Manager API endpoints to retrieve owner details. Exactly one identifier will be accepted. | {base_path}/{version}/networks/{pathv1}/pii/smOwnersForKey?{query} | Yes |
getNetworkPiiRequests(networkId, callback) | List the PII requests for this network or organization | {base_path}/{version}/networks/{pathv1}/pii/requests?{query} | Yes |
createNetworkPiiRequest(networkId, createNetworkPiiRequest, callback) | Submit a new delete or restrict processing PII request | {base_path}/{version}/networks/{pathv1}/pii/requests?{query} | Yes |
getNetworkPiiRequest(networkId, requestId, callback) | Return a PII request | {base_path}/{version}/networks/{pathv1}/pii/requests/{pathv2}?{query} | Yes |
deleteNetworkPiiRequest(networkId, requestId, callback) | Delete a restrict processing PII request | {base_path}/{version}/networks/{pathv1}/pii/requests/{pathv2}?{query} | Yes |
returnTheSNMPSettingsForANetwork(networkId, callback) | Return The SNMP Settings For A Network | v0:{base_path}/{version}/networks/{pathv1}/snmpSettings?{query} v1:{base_path}/{version}/networks/{pathv1}/snmp?{query} | Yes |
updateTheSNMPSettingsForANetwork(networkId, body, callback) | Update The SNMP Settings For A Network | v0:{base_path}/{version}/networks/{pathv1}/snmpSettings?{query} v1:{base_path}/{version}/networks/{pathv1}/snmp?{query} | Yes |
returnTheSNMPSettingsForAnOrganization(organizationId, callback) | Return The SNMP Settings For An Organization | {base_path}/{version}/organizations/{pathv1}/snmp?{query} | Yes |
updateTheSNMPSettingsForAnOrganization(organizationId, body, callback) | Update The SNMP Settings For An Organization | {base_path}/{version}/organizations/{pathv1}/snmp?{query} | Yes |
getNetworkDeviceWirelessRadioSettings(networkId, serial, callback) | Return the radio settings of a device | {base_path}/{version}/networks/{pathv1}/devices/{pathv2}/wireless/radioSettings?{query} | Yes |
getNetworkDeviceWirelessRadioSettingsV1(serial, callback) | Return the radio settings of a device | {base_path}/{version}/devices/{pathv1}/wireless/radio/settings?{query} | Yes |
updateNetworkDeviceWirelessRadioSettings(networkId, serial, updateNetworkDeviceWirelessRadioSettings, callback) | Update the radio settings of a device | {base_path}/{version}/networks/{pathv1}/devices/{pathv2}/wireless/radioSettings?{query} | Yes |
updateNetworkDeviceWirelessRadioSettingsV1(serial, updateNetworkDeviceWirelessRadioSettings, callback) | Update the radio settings of a device | {base_path}/{version}/devices/{pathv1}/wireless/radio/settings?{query} | Yes |
getNetworkWirelessRfProfiles(networkId, includeTemplateProfiles, callback) | List the non-basic RF profiles for this network | {base_path}/{version}/networks/{pathv1}/wireless/rfProfiles?{query} | Yes |
getOrganizationSamlRoles(organizationId, callback) | List the SAML roles for this organization | {base_path}/{version}/organizations/{pathv1}/samlRoles?{query} | Yes |
createOrganizationSamlRole(organizationId, createOrganizationSamlRole, callback) | Create a SAML role | {base_path}/{version}/organizations/{pathv1}/samlRoles?{query} | Yes |
getOrganizationSamlRole(organizationId, id, callback) | Return a SAML role | {base_path}/{version}/organizations/{pathv1}/samlRoles/{pathv2}?{query} | Yes |
updateOrganizationSamlRole(organizationId, id, updateOrganizationSamlRole, callback) | Update a SAML role | {base_path}/{version}/organizations/{pathv1}/samlRoles/{pathv2}?{query} | Yes |
deleteOrganizationSamlRole(organizationId, id, callback) | Remove a SAML role | {base_path}/{version}/organizations/{pathv1}/samlRoles/{pathv2}?{query} | Yes |
getNetworkClientSecurityEvents(networkId, clientId, t0, t1, timespan, perPage, startingAfter, endingBefore, callback) | List the security events 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. | v0:{base_path}/{version}/networks/{pathv1}/clients/{pathv2}/securityEvents?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/clients/{pathv2}/security/events?{query} | Yes |
getNetworkSecurityEvents(networkId, t0, t1, timespan, perPage, startingAfter, endingBefore, callback) | List the security events for a network | v0:{base_path}/{version}/networks/{pathv1}/securityEvents?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/security/events?{query} | Yes |
getOrganizationSecurityEvents(organizationId, t0, t1, timespan, perPage, startingAfter, endingBefore, callback) | List the security events for an organization | v0:{base_path}/{version}/organizations/{pathv1}/securityEvents?{query} v1:{base_path}/{version}/organizations/{pathv1}/appliance/security/events?{query} | Yes |
getNetworkSecurityIntrusionSettings(networkId, callback) | Returns all supported intrusion settings for an MX network | v0:{base_path}/{version}/networks/{pathv1}/security/intrusionSettings?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/security/intrusionSettings?{query} | Yes |
updateNetworkSecurityIntrusionSettings(networkId, updateNetworkSecurityIntrusionSettings, callback) | Set the supported instrusion settings for an MX network | v0:{base_path}/{version}/networks/{pathv1}/security/intrusionSettings?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/security/intrusionSettings?{query} | Yes |
getOrganizationSecurityIntrusionSettings(organizationId, callback) | Returns all supported intrusion settings for an organization | v0:{base_path}/{version}/organizations/{pathv1}/security/intrusionSettings?{query} v1:{base_path}/{version}/organizations/{pathv1}/appliance/security/intrusionSettings?{query} | Yes |
updateOrganizationSecurityIntrusionSettings(organizationId, updateOrganizationSecurityIntrusionSettings, callback) | Sets supported intrusion settings for an organization | v0:{base_path}/{version}/organizations/{pathv1}/security/intrusionSettings?{query} v1:{base_path}/{version}/organizations/{pathv1}/appliance/security/intrusion?{query} | Yes |
getNetworkSecurityMalwareSettings(networkId, callback) | Returns all supported malware settings for an MX network | v0:{base_path}/{version}/networks/{pathv1}/security/malwareSettings?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/security/malware?{query} | Yes |
updateNetworkSecurityMalwareSettings(networkId, updateNetworkSecurityMalwareSettings, callback) | Set the supported malware settings for an MX network | v0:{base_path}/{version}/networks/{pathv1}/security/malwareSettings?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/security/malware?{query} | Yes |
getNetworkSmTargetGroups(networkId, withDetails, callback) | List the target groups in this network | {base_path}/{version}/networks/{pathv1}/sm/targetGroups?{query} | Yes |
createNetworkSmTargetGroup(networkId, createNetworkSmTargetGroup, callback) | Add a target group | {base_path}/{version}/networks/{pathv1}/sm/targetGroups?{query} | Yes |
getNetworkSmTargetGroup(networkId, targetGroupId, withDetails, callback) | Return a target group | {base_path}/{version}/networks/{pathv1}/sm/targetGroups/{pathv2}?{query} | Yes |
updateNetworkSmTargetGroup(networkId, targetGroupId, updateNetworkSmTargetGroup, callback) | Update a target group | {base_path}/{version}/networks/{pathv1}/sm/targetGroups/{pathv2}?{query} | Yes |
deleteNetworkSmTargetGroup(networkId, targetGroupId, callback) | Delete a target group from a network | {base_path}/{version}/networks/{pathv1}/sm/targetGroups/{pathv2}?{query} | Yes |
createNetworkSmProfileClarity(networkId, createNetworkSmProfileClarity, callback) | Create a new profile containing a Cisco Clarity payload | {base_path}/{version}/networks/{pathv1}/sm/profile/clarity?{query} | Yes |
updateNetworkSmProfileClarity(networkId, profileId, updateNetworkSmProfileClarity, callback) | Update an existing profile containing a Cisco Clarity payload | {base_path}/{version}/networks/{pathv1}/sm/profile/clarity/{pathv2}?{query} | Yes |
addNetworkSmProfileClarity(networkId, profileId, addNetworkSmProfileClarity, callback) | Add a Cisco Clarity payload to an existing profile | {base_path}/{version}/networks/{pathv1}/sm/profile/clarity/{pathv2}?{query} | Yes |
getNetworkSmProfileClarity(networkId, profileId, callback) | Get details for a Cisco Clarity payload | {base_path}/{version}/networks/{pathv1}/sm/profile/clarity/{pathv2}?{query} | Yes |
deleteNetworkSmProfileClarity(networkId, profileId, callback) | Delete a Cisco Clarity payload. Deletes the entire profile if it's empty after removing the payload. | {base_path}/{version}/networks/{pathv1}/sm/profile/clarity/{pathv2}?{query} | Yes |
createNetworkSmProfileUmbrella(networkId, createNetworkSmProfileUmbrella, callback) | Create a new profile containing a Cisco Umbrella payload | {base_path}/{version}/networks/{pathv1}/sm/profile/umbrella?{query} | Yes |
updateNetworkSmProfileUmbrella(networkId, profileId, updateNetworkSmProfileUmbrella, callback) | Update an existing profile containing a Cisco Umbrella payload | {base_path}/{version}/networks/{pathv1}/sm/profile/umbrella/{pathv2}?{query} | Yes |
addNetworkSmProfileUmbrella(networkId, profileId, addNetworkSmProfileUmbrella, callback) | Add a Cisco Umbrella payload to an existing profile | {base_path}/{version}/networks/{pathv1}/sm/profile/umbrella/{pathv2}?{query} | Yes |
getNetworkSmProfileUmbrella(networkId, profileId, callback) | Get details for a Cisco Umbrella payload | {base_path}/{version}/networks/{pathv1}/sm/profile/umbrella/{pathv2}?{query} | Yes |
deleteNetworkSmProfileUmbrella(networkId, profileId, callback) | Delete a Cisco Umbrella payload. Deletes the entire profile if it's empty after removing the payload | {base_path}/{version}/networks/{pathv1}/sm/profile/umbrella/{pathv2}?{query} | Yes |
createNetworkSmAppPolaris(networkId, createNetworkSmAppPolaris, callback) | Create a new Polaris app | {base_path}/{version}/networks/{pathv1}/sm/app/polaris?{query} | Yes |
getNetworkSmAppPolaris(networkId, bundleId, callback) | Get details for a Cisco Polaris app if it exists | {base_path}/{version}/networks/{pathv1}/sm/app/polaris?{query} | Yes |
updateNetworkSmAppPolaris(networkId, appId, updateNetworkSmAppPolaris, callback) | Update an existing Polaris app | {base_path}/{version}/networks/{pathv1}/sm/app/polaris/{pathv2}?{query} | Yes |
deleteNetworkSmAppPolaris(networkId, appId, callback) | Delete a Cisco Polaris app | {base_path}/{version}/networks/{pathv1}/sm/app/polaris/{pathv2}?{query} | Yes |
getNetworkSmDevices(networkId, fields, wifiMacs, serials, ids, scope, batchToken, callback) | List the devices enrolled in an SM network with various specified fields and filters | {base_path}/{version}/networks/{pathv1}/sm/devices?{query} | Yes |
getNetworkSmDevicesV2(networkId, queryVars, callback) | List the devices enrolled in an SM network with various specified fields and filters | {base_path}/{version}/networks/{pathv1}/sm/devices?{query} | Yes |
getNetworkSmUsers(networkId, usernames, emails, ids, scope, callback) | List the owners in an SM network with various specified fields and filters | {base_path}/{version}/networks/{pathv1}/sm/users?{query} | Yes |
getNetworkSmUserDeviceProfiles(networkId, id, callback) | Get the profiles associated with a user | v0:{base_path}/{version}/networks/{pathv1}/sm/user/{pathv2}/deviceProfiles?{query} v1:{base_path}/{version}/networks/{pathv1}/sm/users/{pathv2}/deviceProfiles?{query} | Yes |
getNetworkSmDeviceProfiles(networkId, id, callback) | Get the profiles associated with a device | {base_path}/{version}/networks/{pathv1}/sm/{pathv2}/deviceProfiles?{query} | Yes |
getNetworkSmUserSoftwares(networkId, id, callback) | Get a list of softwares associated with a user | v0:{base_path}/{version}/networks/{pathv1}/sm/user/{pathv2}/softwares?{query} v1:{base_path}/{version}/networks/{pathv1}/sm/users/{pathv2}/softwares?{query} | Yes |
getNetworkSmSoftwares(networkId, id, callback) | Get a list of softwares associated with a device | v0:{base_path}/{version}/networks/{pathv1}/sm/{pathv2}/softwares?{query} v1:{base_path}/{version}/networks/{pathv1}/sm/devices/{pathv2}/softwares?{query} | Yes |
getNetworkSmNetworkAdapters(networkId, id, callback) | List the network adapters of a device | v0:{base_path}/{version}/networks/{pathv1}/sm/{pathv2}/networkAdapters?{query} v1:{base_path}/{version}/networks/{pathv1}/sm/devices/{pathv2}/networkAdapters?{query} | Yes |
getNetworkSmWlanLists(networkId, id, callback) | List the saved SSID names on a device | v0:{base_path}/{version}/networks/{pathv1}/sm/{pathv2}/wlanLists?{query} v1:{base_path}/{version}/networks/{pathv1}/sm/devices/{pathv2}/wlanLists?{query} | Yes |
getNetworkSmSecurityCenters(networkId, id, callback) | List the security centers on a device | v0:{base_path}/{version}/networks/{pathv1}/sm/{pathv2}/securityCenters?{query} v1:{base_path}/{version}/networks/{pathv1}/sm/devices/{pathv2}/securityCenters?{query} | Yes |
getNetworkSmRestrictions(networkId, id, callback) | List the restrictions on a device | v0:{base_path}/{version}/networks/{pathv1}/sm/{pathv2}/restrictions?{query} v1:{base_path}/{version}/networks/{pathv1}/sm/devices/{pathv2}/restrictions?{query} | Yes |
getNetworkSmCerts(networkId, id, callback) | List the certs on a device | v0:{base_path}/{version}/networks/{pathv1}/sm/{pathv2}/certs?{query} v1:{base_path}/{version}/networks/{pathv1}/sm/devices/{pathv2}/certs?{query} | Yes |
updateNetworkSmDevicesTags(networkId, updateNetworkSmDevicesTags, callback) | Add, delete, or update the tags of a set of devices | {base_path}/{version}/networks/{pathv1}/sm/devices/tags?{query} | Yes |
updateNetworkSmDevicesTagsV1(networkId, updateNetworkSmDevicesTags, callback) | Add, delete, or update the tags of a set of devices | {base_path}/{version}/networks/{pathv1}/sm/devices/modifyTags?{query} | Yes |
updateNetworkSmDeviceFields(networkId, updateNetworkSmDeviceFields, callback) | Modify the fields of a device | v0:{base_path}/{version}/networks/{pathv1}/sm/device/fields?{query} v1:{base_path}/{version}/networks/{pathv1}/sm/devices/fields?{query} | Yes |
lockNetworkSmDevices(networkId, lockNetworkSmDevices, callback) | Lock a set of devices | {base_path}/{version}/networks/{pathv1}/sm/devices/lock?{query} | Yes |
wipeNetworkSmDevice(networkId, wipeNetworkSmDevice, callback) | Wipe a device | {base_path}/{version}/networks/{pathv1}/sm/device/wipe?{query} | Yes |
wipeNetworkSmDeviceV1(networkId, wipeNetworkSmDevice, callback) | Wipe a device | {base_path}/{version}/networks/{pathv1}/sm/devices/wipe?{query} | Yes |
checkinNetworkSmDevices(networkId, checkinNetworkSmDevices, callback) | Force check-in a set of devices | {base_path}/{version}/networks/{pathv1}/sm/devices/checkin?{query} | Yes |
checkinNetworkSmDevicesV1(networkId, checkinNetworkSmDevices, callback) | Force check-in a set of devices | {base_path}/{version}/networks/{pathv1}/sm/devices/checkin?{query} | Yes |
moveNetworkSmDevices(networkId, moveNetworkSmDevices, callback) | Move a set of devices to a new network | {base_path}/{version}/networks/{pathv1}/sm/devices/move?{query} | Yes |
moveNetworkSmDevicesV1(networkId, moveNetworkSmDevices, callback) | Move a set of devices to a new network | {base_path}/{version}/networks/{pathv1}/sm/devices/move?{query} | Yes |
unenrollNetworkSmDevice(networkId, deviceId, callback) | Unenroll a device | {base_path}/{version}/networks/{pathv1}/sm/devices/{pathv2}/unenroll?{query} | Yes |
updateNetworkSmProfileReinstall(networkId, updateNetworkSmProfileReinstall, callback) | Force reinstall a profile on a given device | {base_path}/{version}/networks/{pathv1}/sm/profile/reinstall?{query} | Yes |
getNetworkSmProfiles(networkId, callback) | List all the profiles in the network | {base_path}/{version}/networks/{pathv1}/sm/profiles?{query} | Yes |
deleteNetworkSmProfile(networkId, deleteNetworkSmProfile, callback) | Delete a specified profile in the network | {base_path}/{version}/networks/{pathv1}/sm/profile/delete?{query} | Yes |
createNetworkSmProfileCreate(networkId, createNetworkSmProfileCreate, callback) | Create a profile in the given network | {base_path}/{version}/networks/{pathv1}/sm/profile/create?{query} | Yes |
getNetworkSmCellularUsageHistory(networkId, id, callback) | Return the client's daily cellular data usage history. Usage data is in kilobytes. | v0:{base_path}/{version}/networks/{pathv1}/sm/{pathv2}/cellularUsageHistory?{query} v1:{base_path}/{version}/networks/{pathv1}/sm/devices/{pathv2}/cellularUsageHistory?{query} | Yes |
getNetworkSmPerformanceHistory(networkId, id, perPage, startingAfter, endingBefore, callback) | Return historical records of various Systems Manager client metrics for desktop devices. | v0:{base_path}/{version}/networks/{pathv1}/sm/{pathv2}/performanceHistory?{query} v1:{base_path}/{version}/networks/{pathv1}/sm/devices/{pathv2}/performanceHistory?{query} | Yes |
getNetworkSmDesktopLogs(networkId, id, perPage, startingAfter, endingBefore, callback) | Return historical records of various Systems Manager network connection details for desktop devices. | {base_path}/{version}/networks/{pathv1}/sm/{pathv2}/desktopLogs?{query} | Yes |
getNetworkSmDeviceCommandLogs(networkId, id, perPage, startingAfter, endingBefore, callback) | Return historical records of commands sent to Systems Manager devices. Note that this will include the name of the Dashboard user who initiated the command if it was generated by a Dashboard admin rather than the automatic behavior of the system; you may wish to filter this out of any reports. | v0:{base_path}/{version}/networks/{pathv1}/sm/{pathv2}/deviceCommandLogs?{query} v1:{base_path}/{version}/networks/{pathv1}/sm/devices/{pathv2}/deviceCommandLogs?{query} | Yes |
getNetworkSmConnectivity(networkId, id, perPage, startingAfter, endingBefore, callback) | Returns historical connectivity data (whether a device is regularly checking in to Dashboard). | v0:{base_path}/{version}/networks/{pathv1}/sm/{pathv2}/connectivity?{query} v1:{base_path}/{version}/networks/{pathv1}/sm/devices/{pathv2}/connectivity?{query} | Yes |
getNetworkSplashLoginAttempts(id, ssidNumber, loginIdentifier, timespan, callback) | List the splash login attempts for a network | {base_path}/{version}/networks/{pathv1}/splashLoginAttempts?{query} | Yes |
getNetworkSsidSplashSettings(networkId, number, callback) | Display the splash page settings for the given SSID | v0:{base_path}/{version}/networks/{pathv1}/ssids/{pathv2}/splashSettings?{query} v1:{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/splash/settings?{query} | Yes |
updateNetworkSsidSplashSettings(networkId, number, updateNetworkSsidSplashSettings, callback) | Modify the splash page settings for the given SSID | v0:{base_path}/{version}/networks/{pathv1}/ssids/{pathv2}/splashSettings?{query} v1:{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/splash/settings?{query} | Yes |
getNetworkSsids(networkId, callback) | List the SSIDs in a network. Supports networks with access points or wireless-enabled security appliances and teleworker gateways. | v0:{base_path}/{version}/networks/{pathv1}/ssids?{query} v1:{base_path}/{version}/networks/{pathv1}/wireless/ssids?{query} | Yes |
getNetworkSsid(networkId, number, callback) | Return a single SSID | v0:{base_path}/{version}/networks/{pathv1}/ssids/{pathv2}?{query} v1:{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}?{query} | Yes |
updateNetworkSsid(networkId, number, updateNetworkSsid, callback) | Update the attributes of an SSID | v0:{base_path}/{version}/networks/{pathv1}/ssids/{pathv2}?{query} v1:{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}?{query} | Yes |
getNetworkSwitchSettings(networkId, callback) | Returns the switch network settings | {base_path}/{version}/networks/{pathv1}/switch/settings?{query} | Yes |
updateNetworkSwitchSettings(networkId, updateNetworkSwitchSettings, callback) | Update switch network settings | {base_path}/{version}/networks/{pathv1}/switch/settings?{query} | Yes |
getDeviceSwitchPorts(serial, callback) | List the switch ports for a switch | v0:{base_path}/{version}/devices/{pathv1}/switchPorts?{query} v1:{base_path}/{version}/devices/{pathv1}/switch/ports?{query} | Yes |
getDeviceSwitchPort(serial, number, callback) | Return a switch port | v0:{base_path}/{version}/devices/{pathv1}/switchPorts/{pathv2}?{query} v1:{base_path}/{version}/devices/{pathv1}/switch/ports/{pathv2}?{query} | Yes |
updateDeviceSwitchPort(serial, number, updateDeviceSwitchPort, callback) | Update a switch port | v0:{base_path}/{version}/devices/{pathv1}/switchPorts/{pathv2}?{query} v1:{base_path}/{version}/devices/{pathv1}/switch/ports/{pathv2}?{query} | Yes |
getOrganizationConfigTemplateSwitchProfiles(organizationId, configTemplateId, callback) | List the switch profiles for your switch template configuration | {base_path}/{version}/organizations/{pathv1}/configTemplates/{pathv2}/switchProfiles?{query} | Yes |
getNetworkSwitchStacks(networkId, callback) | List the switch stacks in a network | v0:{base_path}/{version}/networks/{pathv1}/switchStacks?{query} v1:{base_path}/{version}/networks/{pathv1}/switch/stacks?{query} | Yes |
createNetworkSwitchStack(networkId, createNetworkSwitchStack, callback) | Create a stack | v0:{base_path}/{version}/networks/{pathv1}/switchStacks?{query} v1:{base_path}/{version}/networks/{pathv1}/switch/stacks?{query} | Yes |
getNetworkSwitchStack(networkId, switchStackId, callback) | Show a switch stack | v0:{base_path}/{version}/networks/{pathv1}/switchStacks/{pathv2}?{query} v1:{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}?{query} | Yes |
deleteNetworkSwitchStack(networkId, switchStackId, callback) | Delete a stack | v0:{base_path}/{version}/networks/{pathv1}/switchStacks/{pathv2}?{query} v1:{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}?{query} | Yes |
addNetworkSwitchStack(networkId, switchStackId, addNetworkSwitchStack, callback) | Add a switch to a stack | v0:{base_path}/{version}/networks/{pathv1}/switchStacks/{pathv2}/add?{query} v1:{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/add?{query} | Yes |
removeNetworkSwitchStack(networkID, switchStackId, removeNetworkSwitchStack, callback) | Remove a switch from a stack | v0:{base_path}/{version}/networks/{pathv1}/switchStacks/{pathv2}/remove?{query} v1:{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/remove?{query} | Yes |
getNetworkSyslogServers(networkId, callback) | List the syslog servers for a network | {base_path}/{version}/networks/{pathv1}/syslogServers?{query} | Yes |
updateNetworkSyslogServers(networkId, updateNetworkSyslogServers, callback) | Update the syslog servers for a network | {base_path}/{version}/networks/{pathv1}/syslogServers?{query} | Yes |
updateNetworkTrafficShaping(networkId, updateNetworkTrafficShaping, callback) | Update the traffic shaping settings for an MX network | v0:{base_path}/{version}/networks/{pathv1}/trafficShaping?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/trafficShaping?{query} | Yes |
getNetworkTrafficShaping(networkId, callback) | Display the traffic shaping settings for an MX network | v0:{base_path}/{version}/networks/{pathv1}/trafficShaping?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/trafficShaping?{query} | Yes |
updateNetworkSsidTrafficShaping(networkId, number, updateNetworkSsidTrafficShaping, callback) | Update the traffic shaping settings for an SSID on an MR network | v0:{base_path}/{version}/networks/{pathv1}/ssids/{pathv2}/trafficShaping?{query} v1:{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/trafficShaping/rules?{query} | Yes |
getNetworkSsidTrafficShaping(networkId, number, callback) | Display the traffic shaping settings for a SSID on an MR network | v0:{base_path}/{version}/networks/{pathv1}/ssids/{pathv2}/trafficShaping?{query} v1:{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/trafficShaping/rules?{query} | Yes |
getNetworkTrafficShapingDscpTaggingOptions(networkId, callback) | Returns the available DSCP tagging options for your traffic shaping rules. | {base_path}/{version}/networks/{pathv1}/trafficShaping/dscpTaggingOptions?{query} | Yes |
getNetworkTrafficShapingApplicationCategories(networkId, callback) | Returns the application categories for traffic shaping rules. | {base_path}/{version}/networks/{pathv1}/trafficShaping/applicationCategories?{query} | Yes |
getNetworkContentFilteringCategories(networkId, callback) | List all available content filtering categories for an MX network | v0:{base_path}/{version}/networks/{pathv1}/contentFiltering/categories?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/contentFiltering/categories?{query} | Yes |
getNetworkContentFiltering(networkId, callback) | Return the content filtering settings for an MX network | v0:{base_path}/{version}/networks/{pathv1}/contentFiltering?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/contentFiltering?{query} | Yes |
updateNetworkContentFiltering(networkId, updateNetworkContentFiltering, callback) | Update the content filtering settings for an MX network | v0:{base_path}/{version}/networks/{pathv1}/contentFiltering?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/contentFiltering?{query} | Yes |
getNetworkFirewalledServices(networkId, callback) | List the appliance services and their accessibility rules | v0:{base_path}/{version}/networks/{pathv1}/firewalledServices?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/firewall/firewalledServices?{query} | Yes |
getNetworkFirewalledService(networkId, service, callback) | Return the accessibility settings of the given service ('ICMP', 'web', or 'SNMP') | v0:{base_path}/{version}/networks/{pathv1}/firewalledServices/{pathv2}?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/firewall/firewalledServices/{pathv2}?{query} | Yes |
updateNetworkFirewalledService(networkId, service, updateNetworkFirewalledService, callback) | Updates the accessibility settings for the given service ('ICMP', 'web', or 'SNMP') | v0:{base_path}/{version}/networks/{pathv1}/firewalledServices/{pathv2}?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/firewall/firewalledServices/{pathv2}?{query} | Yes |
getNetworkOneToManyNatRules(networkId, callback) | Return the 1:Many NAT mapping rules for an MX network | v0:{base_path}/{version}/networks/{pathv1}/oneToManyNatRules?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/firewall/oneToManyNatRules?{query} | Yes |
updateNetworkOneToManyNatRules(networkId, updateNetworkOneToManyNatRules, callback) | Set the 1:Many NAT mapping rules for an MX network | v0:{base_path}/{version}/networks/{pathv1}/oneToManyNatRules?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/firewall/oneToManyNatRules?{query} | Yes |
getNetworkOneToOneNatRules(networkId, callback) | Return the 1:1 NAT mapping rules for an MX network | v0:{base_path}/{version}/networks/{pathv1}/oneToOneNatRules?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/firewall/oneToOneNatRules?{query} | Yes |
updateNetworkOneToOneNatRules(networkId, updateNetworkOneToOneNatRules, callback) | Set the 1:1 NAT mapping rules for an MX network | v0:{base_path}/{version}/networks/{pathv1}/oneToOneNatRules?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/firewall/oneToOneNatRules?{query} | Yes |
getNetworkPortForwardingRules(networkId, callback) | Return the port forwarding rules for an MX network | v0:{base_path}/{version}/networks/{pathv1}/portForwardingRules?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/firewall/portForwardingRules?{query} | Yes |
updateNetworkPortForwardingRules(networkId, updateNetworkPortForwardingRules, callback) | Update the port forwarding rules for an MX network | v0:{base_path}/{version}/networks/{pathv1}/portForwardingRules?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/firewall/portForwardingRules?{query} | Yes |
getNetworkStaticRoutes(networkId, callback) | List the static routes for this network | v0:{base_path}/{version}/networks/{pathv1}/staticRoutes?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/staticRoutes?{query} | Yes |
createNetworkStaticRoute(networkId, createNetworkStaticRoute, callback) | Add a static route | v0:{base_path}/{version}/networks/{pathv1}/staticRoutes?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/staticRoutes?{query} | Yes |
getNetworkStaticRoute(networkId, srId, callback) | Return a static route | v0:{base_path}/{version}/networks/{pathv1}/staticRoutes/{pathv2}?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/staticRoutes/{pathv2}?{query} | Yes |
updateNetworkStaticRoute(networkId, srId, updateNetworkStaticRoute, callback) | Update a static route | v0:{base_path}/{version}/networks/{pathv1}/staticRoutes/{pathv2}?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/staticRoutes/{pathv2}?{query} | Yes |
deleteNetworkStaticRoute(networkId, srId, callback) | Delete a static route from a network | v0:{base_path}/{version}/networks/{pathv1}/staticRoutes/{pathv2}?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/staticRoutes/{pathv2}?{query} | Yes |
getNetworkUplinkSettings(networkId, callback) | Returns the uplink settings for your MX network. | {base_path}/{version}/networks/{pathv1}/uplinkSettings?{query} | Yes |
updateNetworkUplinkSettings(networkId, updateNetworkUplinkSettings, callback) | Updates the uplink settings for your MX network. | {base_path}/{version}/networks/{pathv1}/uplinkSettings?{query} | Yes |
getNetworkVlans(networkId, callback) | List the VLANs for an MX network | v0:{base_path}/{version}/networks/{pathv1}/vlans?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/vlans?{query} | Yes |
createNetworkVlan(networkId, createNetworkVlan, callback) | Add a VLAN | v0:{base_path}/{version}/networks/{pathv1}/vlans?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/vlans?{query} | Yes |
getNetworkVlan(networkId, vlanId, callback) | Return a VLAN | v0:{base_path}/{version}/networks/{pathv1}/vlans/{pathv2}?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/vlans/{pathv2}?{query} | Yes |
updateNetworkVlan(networkId, vlanId, updateNetworkVlan, callback) | Update a VLAN | v0:{base_path}/{version}/networks/{pathv1}/vlans/{pathv2}?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/vlans/{pathv2}?{query} | Yes |
deleteNetworkVlan(networkId, vlanId, callback) | Delete a VLAN from a network | v0:{base_path}/{version}/networks/{pathv1}/vlans/{pathv2}?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/vlans/{pathv2}?{query} | Yes |
getNetworkVlansEnabledState(networkId, callback) | Returns the enabled status of VLANs for the network | {base_path}/{version}/networks/{pathv1}/vlansEnabledState?{query} | Yes |
updateNetworkVlansEnabledState(networkId, updateNetworkVlansEnabledState, callback) | Enable/Disable VLANs for the given network | {base_path}/{version}/networks/{pathv1}/vlansEnabledState?{query} | Yes |
getNetworkConnectionStats(networkId, t0, t1, timespan, ssid, vlan, apTag, callback) | Aggregated connectivity info for this network | v0:{base_path}/{version}/networks/{pathv1}/connectionStats?{query} v1:{base_path}/{version}/networks/{pathv1}/wireless/connectionStats?{query} | Yes |
getNetworkDevicesConnectionStats(networkId, t0, t1, timespan, ssid, vlan, apTag, callback) | Aggregated connectivity info for this network, grouped by node | v0:{base_path}/{version}/networks/{pathv1}/devices/connectionStats?{query} v1:{base_path}/{version}/networks/{pathv1}/wireless/devices/connectionStats?{query} | Yes |
getNetworkDeviceConnectionStats(networkId, serial, t0, t1, timespan, ssid, vlan, apTag, callback) | Aggregated connectivity info for a given AP on this network | {base_path}/{version}/networks/{pathv1}/devices/{pathv2}/connectionStats?{query} | Yes |
getNetworkDeviceConnectionStatsV1(serial, t0, t1, timespan, ssid, vlan, apTag, callback) | Aggregated connectivity info for a given AP on this network | {base_path}/{version}/devices/{pathv1}/wireless/connectionStats?{query} | Yes |
getNetworkClientsConnectionStats(networkId, t0, t1, timespan, ssid, vlan, apTag, callback) | Aggregated connectivity info for this network, grouped by clients | v0:{base_path}/{version}/networks/{pathv1}/clients/connectionStats?{query} v1:{base_path}/{version}/networks/{pathv1}/wireless/clients/connectionStats?{query} | Yes |
getNetworkClientConnectionStats(networkId, clientId, t0, t1, timespan, ssid, vlan, apTag, callback) | Aggregated connectivity info for a given client on this network. Clients are identified by their MAC. | v0:{base_path}/{version}/networks/{pathv1}/clients/{pathv2}/connectionStats?{query} v1:{base_path}/{version}/networks/{pathv1}/wireless/clients/{pathv2}/connectionStats?{query} | Yes |
getNetworkLatencyStats(networkId, t0, t1, timespan, ssid, vlan, apTag, fields, callback) | Aggregated latency info for this network | v0:{base_path}/{version}/networks/{pathv1}/latencyStats?{query} v1:{base_path}/{version}/networks/{pathv1}/wireless/latencyStats?{query} | Yes |
getNetworkDevicesLatencyStats(networkId, t0, t1, timespan, ssid, vlan, apTag, fields, callback) | Aggregated latency info for this network, grouped by node | v0:{base_path}/{version}/networks/{pathv1}/devices/latencyStats?{query} v1:{base_path}/{version}/networks/{pathv1}/wireless/devices/latencyStats?{query} | Yes |
getNetworkDeviceLatencyStats(networkId, serial, t0, t1, timespan, ssid, vlan, apTag, fields, callback) | Aggregated latency info for a given AP on this network | {base_path}/{version}/networks/{pathv1}/devices/{pathv2}/latencyStats?{query} | Yes |
getNetworkDeviceLatencyStatsV1(serial, t0, t1, timespan, ssid, vlan, apTag, fields, callback) | Aggregated latency info for a given AP on this network | {base_path}/{version}/devices/{pathv1}/wireless/latencyStats?{query} | Yes |
getNetworkClientsLatencyStats(networkId, t0, t1, timespan, ssid, vlan, apTag, fields, callback) | Aggregated latency info for this network, grouped by clients | v0:{base_path}/{version}/networks/{pathv1}/clients/latencyStats?{query} v1:{base_path}/{version}/networks/{pathv1}/wireless/clients/latencyStats?{query} | Yes |
getNetworkClientLatencyStats(networkId, clientId, t0, t1, timespan, ssid, vlan, apTag, fields, callback) | Aggregated latency info for a given client on this network. Clients are identified by their MAC. | v0:{base_path}/{version}/networks/{pathv1}/clients/{pathv2}/latencyStats?{query} v1:{base_path}/{version}/networks/{pathv1}/wireless/clients/{pathv2}/latencyStats?{query} | Yes |
getNetworkFailedConnections(networkId, t0, t1, timespan, ssid, vlan, apTag, serial, clientId, callback) | List of all failed client connection events on this network in a given time range | v0:{base_path}/{version}/networks/{pathv1}/failedConnections?{query} v1:{base_path}/{version}/networks/{pathv1}/wireless/failedConnections?{query} | Yes |
getNetworkCameraQualityRetentionProfiles(networkId, callback) | List the quality retention profiles for this network | {base_path}/{version}/networks/{pathv1}/camera/qualityRetentionProfiles?{query} | Yes |
createNetworkCameraQualityRetentionProfile(body, networkId, callback) | Creates new quality retention profile for this network. | {base_path}/{version}/networks/{pathv1}/camera/qualityRetentionProfiles?{query} | Yes |
getNetworkCameraQualityRetentionProfile(networkId, qualityRetentionProfileId, callback) | Retrieve a single quality retention profile | {base_path}/{version}/networks/{pathv1}/camera/qualityRetentionProfiles/{pathv2}?{query} | Yes |
updateNetworkCameraQualityRetentionProfile(body, networkId, qualityRetentionProfileId, callback) | Update an existing quality retention profile for this network. | {base_path}/{version}/networks/{pathv1}/camera/qualityRetentionProfiles/{pathv2}?{query} | Yes |
deleteNetworkCameraQualityRetentionProfile(networkId, qualityRetentionProfileId, callback) | Delete an existing quality retention profile for this network. | {base_path}/{version}/networks/{pathv1}/camera/qualityRetentionProfiles/{pathv2}?{query} | Yes |
getNetworkCellularGatewaySettingsConnectivityMonitoringDestinations(networkId, callback) | Return the connectivity testing destinations for an MG network | v0:{base_path}/{version}/networks/{pathv1}/cellularGateway/settings/connectivityMonitoringDestinations?{query} v1:{base_path}/{version}/networks/{pathv1}/cellularGateway/connectivityMonitoringDestinations?{query} | Yes |
updateNetworkCellularGatewaySettingsConnectivityMonitoringDestinations(networkId, body, callback) | Update the connectivity testing destinations for an MG network | v0:{base_path}/{version}/networks/{pathv1}/cellularGateway/settings/connectivityMonitoringDestinations?{query} v1:{base_path}/{version}/networks/{pathv1}/cellularGateway/connectivityMonitoringDestinations?{query} | Yes |
getNetworkCellularGatewaySettingsDhcp(networkId, callback) | List common DHCP settings of MGs | v0:{base_path}/{version}/networks/{pathv1}/cellularGateway/settings/dhcp?{query} v1:{base_path}/{version}/networks/{pathv1}/cellularGateway/dhcp?{query} | Yes |
updateNetworkCellularGatewaySettingsDhcp(networkId, body, callback) | Update common DHCP settings of MGs | v0:{base_path}/{version}/networks/{pathv1}/cellularGateway/settings/dhcp?{query} v1:{base_path}/{version}/networks/{pathv1}/cellularGateway/dhcp?{query} | Yes |
getDeviceCellularGatewaySettings(serial, callback) | Show the LAN Settings of a MG | v0:{base_path}/{version}/devices/{pathv1}/cellularGateway/settings?{query} v1:{base_path}/{version}/devices/{pathv1}/cellularGateway/lan?{query} | Yes |
returnTheEAPOverriddenParametersForAnSSID(networkId, number, callback) | Return The EAP Overridden Parameters For An SSID | v0:{base_path}/{version}/networks/{pathv1}/ssids/{pathv2}/eap_override?{query} v1:{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/eapOverride?{query} | Yes |
updateTheEAPOverriddenParametersForAnSSID(networkId, number, body, callback) | Update The EAP Overridden Parameters For An SSID | v0:{base_path}/{version}/networks/{pathv1}/ssids/{pathv2}/eap_override?{query} v1:{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/eapOverride?{query} | Yes |
updateDeviceCellularGatewaySettings(serial, body, callback) | Update the LAN Settings for a single MG. | v0:{base_path}/{version}/devices/{pathv1}/cellularGateway/settings?{query} v1:{base_path}/{version}/devices/{pathv1}/cellularGateway/lan?{query} | Yes |
getDeviceCellularGatewaySettingsPortForwardingRules(serial, callback) | Returns the port forwarding rules for a single MG. | v0:{base_path}/{version}/devices/{pathv1}/cellularGateway/settings/portForwardingRules?{query} v1:{base_path}/{version}/devices/{pathv1}/cellularGateway/portForwardingRules?{query} | Yes |
updateDeviceCellularGatewaySettingsPortForwardingRules(serial, body, callback) | Updates the port forwarding rules for a single MG. | v0:{base_path}/{version}/devices/{pathv1}/cellularGateway/settings/portForwardingRules?{query} v1:{base_path}/{version}/devices/{pathv1}/cellularGateway/portForwardingRules?{query} | Yes |
getNetworkCellularGatewaySettingsSubnetPool(networkId, callback) | Return the subnet pool and mask configured for MGs in the network. | v0:{base_path}/{version}/networks/{pathv1}/cellularGateway/settings/subnetPool?{query} v1:{base_path}/{version}/networks/{pathv1}/cellularGateway/subnetPool?{query} | Yes |
updateNetworkCellularGatewaySettingsSubnetPool(networkId, body, callback) | Update the subnet pool and mask configuration for MGs in the network. | v0:{base_path}/{version}/networks/{pathv1}/cellularGateway/settings/subnetPool?{query} v1:{base_path}/{version}/networks/{pathv1}/cellularGateway/subnetPool?{query} | Yes |
getNetworkCellularGatewaySettingsUplink(networkId, callback) | Returns the uplink settings for your MG network. | v0:{base_path}/{version}/networks/{pathv1}/cellularGateway/settings/uplink?{query} v1:{base_path}/{version}/networks/{pathv1}/cellularGateway/uplink?{query} | Yes |
updateNetworkCellularGatewaySettingsUplink(networkId, body, callback) | Updates the uplink settings for your MG network. | v0:{base_path}/{version}/networks/{pathv1}/cellularGateway/settings/uplink?{query} v1:{base_path}/{version}/networks/{pathv1}/cellularGateway/uplink?{query} | Yes |
getNetworkSwitchAccessControlLists(networkId, callback) | Return the access control lists for a MS network | {base_path}/{version}/networks/{pathv1}/switch/accessControlLists?{query} | Yes |
updateNetworkSwitchAccessControlLists(body, networkId, callback) | Update the access control lists for a MS network | {base_path}/{version}/networks/{pathv1}/switch/accessControlLists?{query} | Yes |
listTheAccessPoliciesForASwitchNetwork(networkId, callback) | List The Access Policies For A Switch Network | v0:{base_path}/{version}/networks/{pathv1}/accessPolicies?{query} v1:{base_path}/{version}/networks/{pathv1}/switch/accessPolicies?{query} | Yes |
createAnAccessPolicyForASwitchNetwork(networkId, body, callback) | Create An Access Policy For A Switch Network | {base_path}/{version}/networks/{pathv1}/switch/accessPolicies?{query} | Yes |
returnASpecificAccessPolicyForASwitchNetwork(networkId, accessPolicyNumber, callback) | Return A Specific Access Policy For A Switch Network | {base_path}/{version}/networks/{pathv1}/switch/accessPolicies/{pathv2}?{query} | Yes |
updateAnAccessPolicyForASwitchNetwork(networkId, accessPolicyNumber, body, callback) | Update An Access Policy For A Switch Network | {base_path}/{version}/networks/{pathv1}/switch/accessPolicies/{pathv2}?{query} | Yes |
deleteAnAccessPolicyForASwitchNetwork(networkId, accessPolicyNumber, callback) | Delete An Access Policy For A Switch Network | {base_path}/{version}/networks/{pathv1}/switch/accessPolicies/{pathv2}?{query} | Yes |
returnTheStatusForAllThePortsOfASwitch(serial, callback) | Return The Status For All The Ports Of A Switch | v0:{base_path}/{version}/devices/{pathv1}/switchPortStatuses?{query} v1:{base_path}/{version}/devices/{pathv1}/switch/ports/statuses?{query} | Yes |
returnThePacketCountersForAllThePortsOfASwitch(serial, callback) | Return the packet counters for all the ports of a switch | v0:{base_path}/{version}/devices/{pathv1}/switchPortStatuses/packets?{query} v1:{base_path}/{version}/devices/{pathv1}/switch/ports/statuses/packets?{query} | Yes |
returnsTheUplinkBandwidthSettingsForYourMXNetwork(networkId, callback) | Returns The Uplink Bandwidth Settings For Your MX Network | {base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/uplinkBandwidth?{query} | Yes |
updatesTheUplinkBandwidthSettingsForYourMXNetwork(networkId, body, callback) | Updates The Uplink Bandwidth Settings For Your MX Network | {base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/uplinkBandwidth?{query} | Yes |
refreshTheDetailsOfADevice(networkId, deviceId, callback) | Refresh The Details Of A Device | v0:{base_path}/{version}/networks/{pathv1}/sm/device/{pathv2}/refreshDetails?{query} v1:{base_path}/{version}/networks/{pathv1}/sm/devices/{pathv2}/refreshDetails?{query} | Yes |
getNetworkSwitchPortSchedules(networkId, callback) | List switch port schedules | {base_path}/{version}/networks/{pathv1}/switch/portSchedules?{query} | Yes |
createNetworkSwitchPortSchedule(networkId, body, callback) | Add a switch port schedule | {base_path}/{version}/networks/{pathv1}/switch/portSchedules?{query} | Yes |
updateNetworkSwitchPortSchedule(networkId, portScheduleId, body, callback) | Update the access control lists for a MS network | {base_path}/{version}/networks/{pathv1}/switch/portSchedules/{pathv2}?{query} | Yes |
deleteNetworkSwitchPortSchedule(networkId, portScheduleId, callback) | Delete a switch port schedule | {base_path}/{version}/networks/{pathv1}/switch/portSchedules/{pathv2}?{query} | Yes |
getNetworkAppliancePorts(networkId, callback) | List per-port VLAN settings for all ports of a MX. | v0:{base_path}/{version}/networks/{pathv1}/appliancePorts?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/ports?{query} | Yes |
getNetworkAppliancePort(networkId, appliancePortId, callback) | Return per-port VLAN settings for a single MX port. | v0:{base_path}/{version}/networks/{pathv1}/appliancePorts/{pathv2}?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/ports/{pathv2}?{query} | Yes |
updateNetworkAppliancePort(body, networkId, appliancePortId, callback) | Update the per-port VLAN settings for a single MX port. | v0:{base_path}/{version}/networks/{pathv1}/appliancePorts/{pathv2}?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/ports/{pathv2}?{query} | Yes |
swapNetworkWarmspare(networkId, body, callback) | Swap MX primary and warm spare appliances | v0:{base_path}/{version}/networks/{pathv1}/swapWarmSpare?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/WarmSpare/swap?{query} | Yes |
getNetworkWarmSpareSettings(networkId, callback) | Return MX warm spare settings | v0:{base_path}/{version}/networks/{pathv1}/warmSpareSettings?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/warmSpare?{query} | Yes |
updateNetworkWarmSpareSettings(networkId, body, callback) | Update MX warm spare settings | v0:{base_path}/{version}/networks/{pathv1}/warmSpareSettings?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/warmSpare?{query} | Yes |
getOrganizationLicenses(perPage, startingAfter, endingBefore, deviceSerial, networkId, state, organizationId, callback) | List the licenses for an organization | {base_path}/{version}/organizations/{pathv1}/licenses?{query} | Yes |
getOrganizationLicense(organizationId, licenseId, callback) | Display a license | {base_path}/{version}/organizations/{pathv1}/licenses/{pathv2}?{query} | Yes |
updateOrganizationLicense(body, organizationId, licenseId, callback) | Update a license | {base_path}/{version}/organizations/{pathv1}/licenses/{pathv2}?{query} | Yes |
assignOrganizationLicensesSeats(organizationId, body, callback) | Assign SM seats to a network. | {base_path}/{version}/organizations/{pathv1}/licenses/assignSeats?{query} | Yes |
moveOrganizationLicenses(organizationId, body, callback) | Move licenses to another organization. | {base_path}/{version}/organizations/{pathv1}/licenses/move?{query} | Yes |
moveOrganizationLicensesSeats(body, organizationId, callback) | Move SM seats to another organization | {base_path}/{version}/organizations/{pathv1}/licenses/moveSeats?{query} | Yes |
renewOrganizationLicensesSeats(body, organizationId, callback) | Renew SM seats of a license. | {base_path}/{version}/organizations/{pathv1}/licenses/renewSeats?{query} | Yes |
getNetworkSwitchSettingsDhcpServerPolicy(networkId, callback) | Return the DHCP server policy | v0:{base_path}/{version}/networks/{pathv1}/switch/settings/dhcpServerPolicy?{query} v1:{base_path}/{version}/networks/{pathv1}/switch/dhcpServerPolicy?{query} | Yes |
updateNetworkSwitchSettingsDhcpServerPolicy(body, networkId, callback) | Update the DHCP server policy | v0:{base_path}/{version}/networks/{pathv1}/switch/settings/dhcpServerPolicy?{query} v1:{base_path}/{version}/networks/{pathv1}/switch/dhcpServerPolicy?{query} | Yes |
getNetworkSwitchSettingsDscpToCosMappings(networkId, callback) | Return the DSCP to CoS mappings | v0:{base_path}/{version}/networks/{pathv1}/switch/settings/dscpToCosMappings?{query} v1:{base_path}/{version}/networks/{pathv1}/switch/dscpToCosMappings?{query} | Yes |
updateNetworkSwitchSettingsDscpToCosMappings(body, networkId, callback) | Update the DSCP to CoS mappings | v0:{base_path}/{version}/networks/{pathv1}/switch/settings/dscpToCosMappings?{query} v1:{base_path}/{version}/networks/{pathv1}/switch/dscpToCosMappings?{query} | Yes |
getNetworkSwitchSettingsMtu(networkId, callback) | Return the MTU configuration | v0:{base_path}/{version}/networks/{pathv1}/switch/settings/mtu?{query} v1:{base_path}/{version}/networks/{pathv1}/switch/mtu?{query} | Yes |
updateNetworkSwitchSettingsMtu(body, networkId, callback) | Update the MTU configuration | v0:{base_path}/{version}/networks/{pathv1}/switch/settings/mtu?{query} v1:{base_path}/{version}/networks/{pathv1}/switch/mtu?{query} | Yes |
getNetworkSwitchSettingsQosRules(networkId, callback) | List quality of service rules | v0:{base_path}/{version}/networks/{pathv1}/switch/settings/qosRules?{query} v1:{base_path}/{version}/networks/{pathv1}/switch/qosRules?{query} | Yes |
createNetworkSwitchSettingsQosRule(body, networkId, callback) | Add a quality of service rule | v0:{base_path}/{version}/networks/{pathv1}/switch/settings/qosRules?{query} v1:{base_path}/{version}/networks/{pathv1}/switch/qosRules?{query} | Yes |
getNetworkSwitchSettingsQosRulesOrder(networkId, callback) | Return the quality of service rule IDs by order in which they will be processed by the switch | v0:{base_path}/{version}/networks/{pathv1}/switch/settings/qosRules/order?{query} v1:{base_path}/{version}/networks/{pathv1}/switch/qosRules/order?{query} | Yes |
updateNetworkSwitchSettingsQosRulesOrder(body, networkId, callback) | Update the order in which the rules should be processed by the switch | v0:{base_path}/{version}/networks/{pathv1}/switch/settings/qosRules/order?{query} v1:{base_path}/{version}/networks/{pathv1}/switch/qosRules/order?{query} | Yes |
getNetworkSwitchSettingsQosRule(networkId, qosRuleId, callback) | Return a quality of service rule | v0:{base_path}/{version}/networks/{pathv1}/switch/settings/qosRules/{pathv2}?{query} v1:{base_path}/{version}/networks/{pathv1}/switch/qosRules/{pathv2}?{query} | Yes |
deleteNetworkSwitchSettingsQosRule(networkId, qosRuleId, callback) | Delete a quality of service rule | v0:{base_path}/{version}/networks/{pathv1}/switch/settings/qosRules/{pathv2}?{query} v1:{base_path}/{version}/networks/{pathv1}/switch/qosRules/{pathv2}?{query} | Yes |
updateNetworkSwitchSettingsQosRule(networkId, qosRuleId, body, callback) | Update a quality of service rule | v0:{base_path}/{version}/networks/{pathv1}/switch/settings/qosRules/{pathv2}?{query} v1:{base_path}/{version}/networks/{pathv1}/switch/qosRules/{pathv2}?{query} | Yes |
getNetworkSwitchSettingsStormControl(networkId, callback) | Return the storm control configuration for a switch network | v0:{base_path}/{version}/networks/{pathv1}/switch/settings/stormControl?{query} v1:{base_path}/{version}/networks/{pathv1}/switch/stormControl?{query} | Yes |
updateNetworkSwitchSettingsStormControl(networkId, body, callback) | Update the storm control configuration for a switch network | v0:{base_path}/{version}/networks/{pathv1}/switch/settings/stormControl?{query} v1:{base_path}/{version}/networks/{pathv1}/switch/stormControl?{query} | Yes |
getNetworkSwitchSettingsStp(networkId, callback) | Returns STP settings | v0:{base_path}/{version}/networks/{pathv1}/switch/settings/stp?{query} v1:{base_path}/{version}/networks/{pathv1}/switch/stp?{query} | Yes |
updateNetworkSwitchSettingsStp(body, networkId, callback) | Updates STP settings | v0:{base_path}/{version}/networks/{pathv1}/switch/settings/stp?{query} v1:{base_path}/{version}/networks/{pathv1}/switch/stp?{query} | Yes |
getNetworkConnectivityMonitoringDestinations(networkId, callback) | Return the connectivity testing destinations for an MX network | v0:{base_path}/{version}/networks/{pathv1}/connectivityMonitoringDestinations?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/connectivityMonitoringDestinations?{query} | Yes |
updateNetworkConnectivityMonitoringDestinations(networkId, body, callback) | Update the connectivity testing destinations for an MX network | v0:{base_path}/{version}/networks/{pathv1}/connectivityMonitoringDestinations?{query} v1:{base_path}/{version}/networks/{pathv1}/appliance/connectivityMonitoringDestinations?{query} | Yes |
getOrganizationBrandingPolicies(organizationId, callback) | List the branding policies of an organization | {base_path}/{version}/organizations/{pathv1}/brandingPolicies?{query} | Yes |
createOrganizationBrandingPolicy(organizationId, body, callback) | Add a new branding policy to an organization | {base_path}/{version}/organizations/{pathv1}/brandingPolicies?{query} | Yes |
getOrganizationBrandingPoliciesPriorities(organizationId, callback) | Return the branding policy IDs of an organization in priority order. | {base_path}/{version}/organizations/{pathv1}/brandingPolicies/priorities?{query} | Yes |
updateOrganizationBrandingPoliciesPriorities(organizationId, body, callback) | Update the priority ordering of an organization's branding policies. | {base_path}/{version}/organizations/{pathv1}/brandingPolicies/priorities?{query} | Yes |
getOrganizationBrandingPolicy(organizationId, callback) | Return a branding policy | {base_path}/{version}/organizations/{pathv1}/brandingPolicies/:brandingPolicyId?{query} | Yes |
updateOrganizationBrandingPolicy(organizationId, brandingPolicyId, body, callback) | Update a branding policy | {base_path}/{version}/organizations/{pathv1}/brandingPolicies/{pathv2}?{query} | Yes |
deleteOrganizationBrandingPolicy(organizationId, brandingPolicyId, callback) | Delete a branding policy | {base_path}/{version}/organizations/{pathv1}/brandingPolicies/{pathv2}?{query} | Yes |
getNetworkEvents(productType, includedEventTypes, excludedEventTypes, deviceMac, deviceSerial, deviceName, clientIp, clientMac, clientName, smDeviceMac, smDeviceName, perPage, startingAfter, endingBefore, networkId, callback) | List the events for the network | {base_path}/{version}/networks/{pathv1}/events?{query} | Yes |
getNetworkEventsEventTypes(networkId, callback) | List the event type to human-readable description | {base_path}/{version}/networks/{pathv1}/events/eventTypes?{query} | Yes |
getNetworkFloorPlans(networkId, callback) | List the floor plans that belong to your network | {base_path}/{version}/networks/{pathv1}/floorPlans?{query} | Yes |
createNetworkFloorPlan(networkId, body, callback) | Upload a floor plan | {base_path}/{version}/networks/{pathv1}/floorPlans?{query} | Yes |
getNetworkFloorPlan(networkId, floorPlanId, callback) | Find a floor plan by ID | {base_path}/{version}/networks/{pathv1}/floorPlans/{pathv2}?{query} | Yes |
updateNetworkFloorPlan(networkId, floorPlanId, body, callback) | Update a floor plan's geolocation and other meta data | {base_path}/{version}/networks/{pathv1}/floorPlans/{pathv2}?{query} | Yes |
deleteNetworkFloorPlan(networkId, floorPlanId, callback) | Destroy a floor plan | {base_path}/{version}/networks/{pathv1}/floorPlans/{pathv2}?{query} | Yes |
getNetworkSwitchLinkAggregations(networkId, callback) | List link aggregation groups | {base_path}/{version}/networks/{pathv1}/switch/linkAggregations?{query} | Yes |
createNetworkSwitchLinkAggregation(networkId, body, callback) | Create a link aggregation group | {base_path}/{version}/networks/{pathv1}/switch/linkAggregations?{query} | Yes |
updateNetworkSwitchLinkAggregation(networkId, linkAggregationId, body, callback) | Update a link aggregation group | {base_path}/{version}/networks/{pathv1}/switch/linkAggregations/{pathv2}?{query} | Yes |
deleteNetworkSwitchLinkAggregation(networkId, linkAggregationId, callback) | Split a link aggregation group into separate ports | {base_path}/{version}/networks/{pathv1}/switch/linkAggregations/{pathv2}?{query} | Yes |
getNetworkNetflowSettings(networkId, callback) | Return the NetFlow traffic reporting settings for a network | v0:{base_path}/{version}/networks/{pathv1}/netflowSettings?{query} v1:{base_path}/{version}/networks/{pathv1}/netflow?{query} | Yes |
updateNetworkNetflowSettings(networkId, body, callback) | Update the NetFlow traffic reporting settings for a network | v0:{base_path}/{version}/networks/{pathv1}/netflowSettings?{query} v1:{base_path}/{version}/networks/{pathv1}/netflow?{query} | Yes |
getNetworkTrafficAnalysisSettings(networkId, callback) | Return the traffic analysis settings for a network | v0:{base_path}/{version}/networks/{pathv1}/trafficAnalysisSettings?{query} v1:{base_path}/{version}/networks/{pathv1}/trafficAnalysis?{query} | Yes |
updateNetworkTrafficAnalysisSettings(networkId, callback) | Update the traffic analysis settings for a network | v0:{base_path}/{version}/networks/{pathv1}/trafficAnalysisSettings?{query} v1:{base_path}/{version}/networks/{pathv1}/trafficAnalysis?{query} | Yes |
getOrganizationWebhookLogs(t0, t1, timespan, perPage, startingAfter, endingBefore, url, organizationId, callback) | Return the log of webhook POSTs sent | v0:{base_path}/{version}/organizations/{pathv1}/webhookLogs?{query} v1:{base_path}/{version}/organizations/{pathv1}/webhooks/logs?{query} | Yes |
getNetworkWirelessSettings(networkId, callback) | Return the wireless settings for a network | {base_path}/{version}/networks/{pathv1}/wireless/settings?{query} | Yes |
updateNetworkWirelessSettings(networkId, body, callback) | Update the wireless settings for a network | {base_path}/{version}/networks/{pathv1}/wireless/settings?{query} | Yes |
returnstheidentityofthecurrentuser(callback) | Returns the identity of the current user. | {base_path}/{version}/administered/identities/me?{query} | Yes |
returntheDHCPsubnetinformationforanappliance(serial, callback) | Return the DHCP subnet information for an appliance | {base_path}/{version}/devices/{pathv1}/appliance/dhcp/subnets?{query} | Yes |
getthesentandreceivedbytesforeachuplinkofanetwork(networkId, callback) | Get the sent and received bytes for each uplink of a network. | {base_path}/{version}/networks/{pathv1}/appliance/uplinks/usageHistory?{query} | Yes |
returnAPusageovertimeforadeviceornetworkclient(networkId, callback) | Return AP usage over time for a device or network client | {base_path}/{version}/networks/{pathv1}/wireless/usageHistory?{query} | Yes |
listtheuplinkstatusofeveryMerakiMXandZseriesappliancesintheorganization(organizationId, callback) | List the uplink status of every Meraki MX and Z series appliances in the organization | {base_path}/{version}/organizations/{pathv1}/appliance/uplink/statuses?{query} | Yes |
fetchOnboardingStatusOfCameras(organizationId, callback) | Fetch Onboarding Status Of Cameras | {base_path}/{version}/organizations/{pathv1}/camera/onboarding/statuses?{query} | Yes |
notifyThatCredentialHandoffToCameraHasCompleted(organizationId, body, callback) | Notify That Credential Handoff To Camera Has Completed | {base_path}/{version}/organizations/{pathv1}/camera/onboarding/statuses?{query} | Yes |
listtheuplinkstatusofeveryMerakiMGcellulargatewayintheorganization(organizationId, callback) | List the uplink status of every Meraki MG cellular gateway in the organization | {base_path}/{version}/organizations/{pathv1}/cellularGateway/uplink/statuses?{query} | Yes |
listtheuplinkstatusofeveryMerakiMXMGandZseriesdevicesintheorganization(organizationId, callback) | List the uplink status of every Meraki MX, MG and Z series devices in the organization | {base_path}/{version}/organizations/{pathv1}/uplinks/statuses?{query} | Yes |
showVPNstatusfornetworksinanorganization(organizationId, callback) | Show VPN status for networks in an organization | {base_path}/{version}/organizations/{pathv1}/appliance/vpn/statuses?{query} | Yes |
listTheStatusOfEveryMerakiDeviceInTheOrganization(organizationId, callback) | List The Status Of Every Meraki Device In The Organization | {base_path}/{version}/organizations/{pathv1}/devices/statuses?{query} | Yes |
showVPNhistorystatfornetworksinanorganization(organizationId, callback) | Show VPN history stat for networks in an organization | {base_path}/{version}/organizations/{pathv1}/appliance/vpn/stats?{query} | Yes |
returnTheFirewallSettingsForThisNetwork(networkId, callback) | Return The Firewall Settings For This Network | {base_path}/{version}/networks/{pathv1}/appliance/firewall/settings?{query} | Yes |
updateTheFirewallSettingsForThisNetwork(networkId, body, callback) | Update The Firewall Settings For This Network | {base_path}/{version}/networks/{pathv1}/appliance/firewall/settings?{query} | Yes |
returnTheApplianceSettingsForANetwork(networkId, callback) | Return The Appliance Settings For A Network | {base_path}/{version}/networks/{pathv1}/appliance/settings?{query} | Yes |
updateTheApplianceSettingsForANetwork(networkId, body, callback) | Update The Appliance Settings For A Network | {base_path}/{version}/networks/{pathv1}/appliance/settings?{query} | Yes |
returnsTheEnabledStatusOfVLANsForTheNetwork(networkId, callback) | Returns The Enabled Status Of VLA Ns For The Network | {base_path}/{version}/networks/{pathv1}/appliance/vlans/settings?{query} | Yes |
enableDisableVLANsForTheGivenNetwork(networkId, body, callback) | Enable Disable VLA Ns For The Given Network | {base_path}/{version}/networks/{pathv1}/appliance/vlans/settings?{query} | Yes |
returnTheSettingsForANetwork(networkId, callback) | Return The Settings For A Network | {base_path}/{version}/networks/{pathv1}/settings?{query} | Yes |
updateTheSettingsForANetwork(networkId, body, callback) | Update The Settings For A Network | {base_path}/{version}/networks/{pathv1}/settings?{query} | Yes |
returnsGlobalAdaptivePolicySettingsInAnOrganization(organizationId, callback) | Returns Global Adaptive Policy Settings In An Organization | {base_path}/{version}/organizations/{pathv1}/adaptivePolicy/settings?{query} | Yes |
updateGlobalAdaptivePolicySettings(organizationId, body, callback) | Update Global Adaptive Policy Settings | {base_path}/{version}/organizations/{pathv1}/adaptivePolicy/settings?{query} | Yes |
returnTheBluetoothSettingsForAWirelessDevice(serial, callback) | Return The Bluetooth Settings For A Wireless Device | {base_path}/{version}/devices/{pathv1}/wireless/bluetooth/settings?{query} | Yes |
updateTheBluetoothSettingsForAWirelessDevice(serial, body, callback) | Update The Bluetooth Settings For A Wireless Device | {base_path}/{version}/devices/{pathv1}/wireless/bluetooth/settings?{query} | Yes |
returnTheBluetoothSettingsForANetworkAHrefHttpsDocumentationMerakiComMRBluetoothBluetoothLowEnergyBLEBluetoothSettingsAMustBeEnabledOnTheNetwork(networkId, callback) | Return The Bluetooth Settings For A Network A Href Https Documentation Meraki Com MR Bluetooth Blue | {base_path}/{version}/networks/{pathv1}/wireless/bluetooth/settings?{query} | Yes |
updateTheBluetoothSettingsForANetwork(networkId, body, callback) | Update The Bluetooth Settings For A Network | {base_path}/{version}/networks/{pathv1}/wireless/bluetooth/settings?{query} | Yes |
returnAllThePortsOfASwitchProfile(organizationId, configTemplateId, profileId, callback) | Return All The Ports Of A Switch Profile | {base_path}/{version}/organizations/{pathv1}/configTemplates/{pathv2}/switch/profiles/{pathv3}/ports?{query} | Yes |
returnASwitchProfilePort(organizationId, configTemplateId, profileId, portId, callback) | Return A Switch Profile Port | {base_path}/{version}/organizations/{pathv1}/configTemplates/{pathv2}/switch/profiles/{pathv3}/ports/{pathv4}?{query} | Yes |
updateASwitchProfilePort(organizationId, configTemplateId, profileId, portId, body, callback) | Update A Switch Profile Port | {base_path}/{version}/organizations/{pathv1}/configTemplates/{pathv2}/switch/profiles/{pathv3}/ports/{pathv4}?{query} | Yes |
returnSingleLANConfiguration(networkId, callback) | Return Single LAN Configuration | {base_path}/{version}/networks/{pathv1}/appliance/singleLan?{query} | Yes |
updateSingleLANConfiguration(networkId, body, callback) | Update Single LAN Configuration | {base_path}/{version}/networks/{pathv1}/appliance/singleLan?{query} | Yes |
listLayer3StaticRoutesForASwitch(serial, callback) | List Layer 3 Static Routes For A Switch | {base_path}/{version}/devices/{pathv1}/switch/routing/staticRoutes?{query} | Yes |
createALayer3StaticRouteForASwitch(serial, body, callback) | Create A Layer 3 Static Route For A Switch | {base_path}/{version}/devices/{pathv1}/switch/routing/staticRoutes?{query} | Yes |
returnALayer3StaticRouteForASwitch(serial, staticRouteId, callback) | Return A Layer 3 Static Route For A Switch | {base_path}/{version}/devices/{pathv1}/switch/routing/staticRoutes/{pathv2}?{query} | Yes |
updateALayer3StaticRouteForASwitch(serial, staticRouteId, body, callback) | Update A Layer 3 Static Route For A Switch | {base_path}/{version}/devices/{pathv1}/switch/routing/staticRoutes/{pathv2}?{query} | Yes |
deleteALayer3StaticRouteForASwitch(serial, staticRouteId, callback) | Delete A Layer 3 Static Route For A Switch | {base_path}/{version}/devices/{pathv1}/switch/routing/staticRoutes/{pathv2}?{query} | Yes |
listLayer3StaticRoutesForASwitchStack(networkId, switchStackId, callback) | List Layer 3 Static Routes For A Switch Stack | {base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/staticRoutes?{query} | Yes |
createALayer3StaticRouteForASwitchStack(networkId, switchStackId, body, callback) | Create A Layer 3 Static Route For A Switch Stack | {base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/staticRoutes?{query} | Yes |
returnALayer3StaticRouteForASwitchStack(networkId, switchStackId, staticRouteId, callback) | Return A Layer 3 Static Route For A Switch Stack | {base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/staticRoutes/{pathv3}?{query} | Yes |
updateALayer3StaticRouteForASwitchStack(networkId, switchStackId, staticRouteId, body, callback) | Update A Layer 3 Static Route For A Switch Stack | {base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/staticRoutes/{pathv3}?{query} | Yes |
deleteALayer3StaticRouteForASwitchStack(networkId, switchStackId, staticRouteId, callback) | Delete A Layer 3 Static Route For A Switch Stack | {base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/staticRoutes/{pathv3}?{query} | Yes |
listAllCustomPerformanceClassesForAnMXNetwork(networkId, callback) | List All Custom Performance Classes For An MX Network | {base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/customPerformanceClasses?{query} | Yes |
addACustomPerformanceClassForAnMXNetwork(networkId, body, callback) | Add A Custom Performance Class For An MX Network | {base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/customPerformanceClasses?{query} | Yes |
returnACustomPerformanceClassForAnMXNetwork(networkId, customPerformanceClassId, callback) | Return A Custom Performance Class For An MX Network | {base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/customPerformanceClasses/{pathv2}?{query} | Yes |
updateACustomPerformanceClassForAnMXNetwork(networkId, customPerformanceClassId, body, callback) | Update A Custom Performance Class For An MX Network | {base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/customPerformanceClasses/{pathv2}?{query} | Yes |
deleteACustomPerformanceClassFromAnMXNetwork(networkId, customPerformanceClassId, callback) | Delete A Custom Performance Class From An MX Network | {base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/customPerformanceClasses/{pathv2}?{query} | Yes |
updateTheTrafficShapingSettingsRulesForAnMXNetwork(networkId, body, callback) | Update The Traffic Shaping Settings Rules For An MX Network | {base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/rules?{query} | Yes |
displayTheTrafficShapingSettingsRulesForAnMXNetwork(networkId, callback) | Display The Traffic Shaping Settings Rules For An MX Network | {base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/rules?{query} | Yes |
showUplinkSelectionSettingsForAnMXNetwork(networkId, callback) | Show Uplink Selection Settings For An MX Network | {base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/uplinkSelection?{query} | Yes |
updateUplinkSelectionSettingsForAnMXNetwork(networkId, body, callback) | Update Uplink Selection Settings For An MX Network | {base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/uplinkSelection?{query} | Yes |
returnAHubBGPConfiguration(networkId, callback) | Return A Hub BGP Configuration | {base_path}/{version}/networks/{pathv1}/appliance/vpn/bgp?{query} | Yes |
updateAHubBGPConfiguration(networkId, body, callback) | Update A Hub BGP Configuration | {base_path}/{version}/networks/{pathv1}/appliance/vpn/bgp?{query} | Yes |
returnWarmSpareConfigurationForASwitch(serial, callback) | Return Warm Spare Configuration For A Switch | {base_path}/{version}/devices/{pathv1}/switch/warmSpare?{query} | Yes |
updateWarmSpareConfigurationForASwitch(serial, body, callback) | Update Warm Spare Configuration For A Switch | {base_path}/{version}/devices/{pathv1}/switch/warmSpare?{query} | Yes |
returnoverviewstatisticsfornetworkclients(networkId, callback) | Return overview statistics for network clients | {base_path}/{version}/networks/{pathv1}/clients/overview?{query} | Yes |
returnsummaryinformationaroundclientdatausageInmbAcrossthegivenorganization(organizationId, callback) | Return summary information around client data usage (in mb) across the given organization. | {base_path}/{version}/organizations/{pathv1}/clients/overview?{query} | Yes |
returnanoverviewofcurrentdevicestatuses(organizationId, callback) | Return an overview of current device statuses | {base_path}/{version}/organizations/{pathv1}/devices/statuses/overview?{query} | Yes |
returnsadaptivepolicyaggregatestatisticsforanorganization(organizationId, callback) | Returns adaptive policy aggregate statistics for an organization | {base_path}/{version}/organizations/{pathv1}/adaptivePolicy/overview?{query} | Yes |
returnanoverviewofthelicensestateforanorganization(organizationId, callback) | Return an overview of the license state for an organization | {base_path}/{version}/organizations/{pathv1}/licenses/overview?{query} | Yes |
returnallreportedreadingsfromsensorsinagiventimespanSortedbytimestamp(organizationId, callback) | Return all reported readings from sensors in a given timespan, sorted by timestamp | {base_path}/{version}/organizations/{pathv1}/sensor/readings/history?{query} | Yes |
listCustomAnalyticsArtifacts(organizationId, callback) | List Custom Analytics Artifacts | {base_path}/{version}/organizations/{pathv1}/camera/customAnalytics/artifacts?{query} | Yes |
createCustomAnalyticsArtifact(organizationId, body, callback) | Create Custom Analytics Artifact | {base_path}/{version}/organizations/{pathv1}/camera/customAnalytics/artifacts?{query} | Yes |
getCustomAnalyticsArtifact(organizationId, artifactId, callback) | Get Custom Analytics Artifact | {base_path}/{version}/organizations/{pathv1}/camera/customAnalytics/artifacts/{pathv2}?{query} | Yes |
deleteCustomAnalyticsArtifact(organizationId, artifactId, callback) | Delete Custom Analytics Artifact | {base_path}/{version}/organizations/{pathv1}/camera/customAnalytics/artifacts/{pathv2}?{query} | Yes |
returnCustomAnalyticsSettingsForACamera(serial, callback) | Return Custom Analytics Settings For A Camera | {base_path}/{version}/devices/{pathv1}/camera/customAnalytics?{query} | Yes |
updateCustomAnalyticsSettingsForACamera(serial, body, callback) | Update Custom Analytics Settings For A Camera | {base_path}/{version}/devices/{pathv1}/camera/customAnalytics?{query} | Yes |
returnstheMVSenseobjectdetectionmodellistforthegivencamera(serial, callback) | Returns the MV Sense object detection model list for the given camera | {base_path}/{version}/devices/{pathv1}/camera/sense/objectDetectionModels?{query} | Yes |
returnsSenseSettingsForAGivenCamera(serial, callback) | Returns Sense Settings For A Given Camera | {base_path}/{version}/devices/{pathv1}/camera/sense?{query} | Yes |
updateSenseSettingsForTheGivenCamera(serial, body, callback) | Update Sense Settings For The Given Camera | {base_path}/{version}/devices/{pathv1}/camera/sense?{query} | Yes |
returnsWirelessProfileAssignedToTheGivenCamera(serial, callback) | Returns Wireless Profile Assigned To The Given Camera | {base_path}/{version}/devices/{pathv1}/camera/wirelessProfiles?{query} | Yes |
assignWirelessProfilesToTheGivenCamera(serial, body, callback) | Assign Wireless Profiles To The Given Camera | {base_path}/{version}/devices/{pathv1}/camera/wirelessProfiles?{query} | Yes |
createsANewCameraWirelessProfileForThisNetwork(networkId, body, callback) | Creates A New Camera Wireless Profile For This Network | {base_path}/{version}/networks/{pathv1}/camera/wirelessProfiles?{query} | Yes |
listTheCameraWirelessProfilesForThisNetwork(networkId, callback) | List The Camera Wireless Profiles For This Network | {base_path}/{version}/networks/{pathv1}/camera/wirelessProfiles?{query} | Yes |
retrieveASingleCameraWirelessProfile(networkId, wirelessProfileId, callback) | Retrieve A Single Camera Wireless Profile | {base_path}/{version}/networks/{pathv1}/camera/wirelessProfiles/{pathv2}?{query} | Yes |
updateAnExistingCameraWirelessProfileInThisNetwork(networkId, wirelessProfileId, body, callback) | Update An Existing Camera Wireless Profile In This Network | {base_path}/{version}/networks/{pathv1}/camera/wirelessProfiles/{pathv2}?{query} | Yes |
deleteAnExistingCameraWirelessProfileForThisNetwork(networkId, wirelessProfileId, callback) | Delete An Existing Camera Wireless Profile For This Network | {base_path}/{version}/networks/{pathv1}/camera/wirelessProfiles/{pathv2}?{query} | Yes |
listTheOutageScheduleForTheSSID(networkId, number, callback) | List The Outage Schedule For The SSID | {base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/schedules?{query} | Yes |
updateTheOutageScheduleForTheSSID(networkId, number, body, callback) | Update The Outage Schedule For The SSID | {base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/schedules?{query} | Yes |
returnALayer3InterfaceDHCPConfigurationForASwitch(serial, interfaceId, callback) | Return A Layer 3 Interface DHCP Configuration For A Switch | {base_path}/{version}/devices/{pathv1}/switch/routing/interfaces/{pathv2}/dhcp?{query} | Yes |
updateALayer3InterfaceDHCPConfigurationForASwitch(serial, interfaceId, body, callback) | Update A Layer 3 Interface DHCP Configuration For A Switch | {base_path}/{version}/devices/{pathv1}/switch/routing/interfaces/{pathv2}/dhcp?{query} | Yes |
returnALayer3InterfaceDHCPConfigurationForASwitchStack(networkId, switchStackId, interfaceId, callback) | Return A Layer 3 Interface DHCP Configuration For A Switch Stack | {base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/interfaces/{pathv3}/dhcp?{query} | Yes |
updateALayer3InterfaceDHCPConfigurationForASwitchStack(networkId, switchStackId, interfaceId, body, callback) | Update A Layer 3 Interface DHCP Configuration For A Switch Stack | {base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/interfaces/{pathv3}/dhcp?{query} | Yes |
listtheSwitchPortProfilesinanetwork(networkId, callback) | List the Switch Port Profiles in a network | {base_path}/{version}/networks/{pathv1}/switch/ports/profiles?{query} | Yes |
listallprofilesinanetwork(networkId, callback) | List all profiles in a network | {base_path}/{version}/networks/{pathv1}/sm/profiles?{query} | Yes |
createAnOrganizationWideAlertConfiguration(organizationId, body, callback) | Create An Organization Wide Alert Configuration | {base_path}/{version}/organizations/{pathv1}/alerts/profiles?{query} | Yes |
listAllOrganizationWideAlertConfigurations(organizationId, callback) | List All Organization Wide Alert Configurations | {base_path}/{version}/organizations/{pathv1}/alerts/profiles?{query} | Yes |
removesAnOrganizationWideAlertConfig(organizationId, alertConfigId, callback) | Removes An Organization Wide Alert Config | {base_path}/{version}/organizations/{pathv1}/alerts/profiles/{pathv2}?{query} | Yes |
updateAnOrganizationWideAlertConfig(organizationId, alertConfigId, body, callback) | Update An Organization Wide Alert Config | {base_path}/{version}/organizations/{pathv1}/alerts/profiles/{pathv2}?{query} | Yes |
listtheswitchportsinanorganizationbyswitch(organizationId, callback) | List the switchports in an organization by switch | {base_path}/{version}/organizations/{pathv1}/switch/ports/bySwitch?{query} | Yes |
listLayer3InterfacesForASwitch(serial, callback) | List Layer 3 Interfaces For A Switch | {base_path}/{version}/devices/{pathv1}/switch/routing/interfaces?{query} | Yes |
createALayer3InterfaceForASwitch(serial, body, callback) | Create A Layer 3 Interface For A Switch | {base_path}/{version}/devices/{pathv1}/switch/routing/interfaces?{query} | Yes |
returnALayer3InterfaceForASwitch(serial, interfaceId, callback) | Return A Layer 3 Interface For A Switch | {base_path}/{version}/devices/{pathv1}/switch/routing/interfaces/{pathv2}?{query} | Yes |
updateALayer3InterfaceForASwitch(serial, interfaceId, body, callback) | Update A Layer 3 Interface For A Switch | {base_path}/{version}/devices/{pathv1}/switch/routing/interfaces/{pathv2}?{query} | Yes |
deleteALayer3InterfaceFromTheSwitch(serial, interfaceId, callback) | Delete A Layer 3 Interface From The Switch | {base_path}/{version}/devices/{pathv1}/switch/routing/interfaces/{pathv2}?{query} | Yes |
listLayer3InterfacesForASwitchStack(networkId, switchStackId, callback) | List Layer 3 Interfaces For A Switch Stack | {base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/interfaces?{query} | Yes |
createALayer3InterfaceForASwitchStack(networkId, switchStackId, body, callback) | Create A Layer 3 Interface For A Switch Stack | {base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/interfaces?{query} | Yes |
returnALayer3InterfaceFromASwitchStack(networkId, switchStackId, interfaceId, callback) | Return A Layer 3 Interface From A Switch Stack | {base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/interfaces/{pathv3}?{query} | Yes |
updateALayer3InterfaceForASwitchStack(networkId, switchStackId, interfaceId, body, callback) | Update A Layer 3 Interface For A Switch Stack | {base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/interfaces/{pathv3}?{query} | Yes |
deleteALayer3InterfaceFromASwitchStack(networkId, switchStackId, interfaceId, callback) | Delete A Layer 3 Interface From A Switch Stack | {base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/interfaces/{pathv3}?{query} | Yes |
listMulticastRendezvousPoints(networkId, callback) | List Multicast Rendezvous Points | {base_path}/{version}/networks/{pathv1}/switch/routing/multicast/rendezvousPoints?{query} | Yes |
createAMulticastRendezvousPoint(networkId, body, callback) | Create A Multicast Rendezvous Point | {base_path}/{version}/networks/{pathv1}/switch/routing/multicast/rendezvousPoints?{query} | Yes |
returnAMulticastRendezvousPoint(networkId, rendezvousPointId, callback) | Return A Multicast Rendezvous Point | {base_path}/{version}/networks/{pathv1}/switch/routing/multicast/rendezvousPoints/{pathv2}?{query} | Yes |
deleteAMulticastRendezvousPoint(networkId, rendezvousPointId, callback) | Delete A Multicast Rendezvous Point | {base_path}/{version}/networks/{pathv1}/switch/routing/multicast/rendezvousPoints/{pathv2}?{query} | Yes |
updateAMulticastRendezvousPoint(networkId, rendezvousPointId, body, callback) | Update A Multicast Rendezvous Point | {base_path}/{version}/networks/{pathv1}/switch/routing/multicast/rendezvousPoints/{pathv2}?{query} | Yes |
returnMulticastSettingsForANetwork(networkId, callback) | Return Multicast Settings For A Network | {base_path}/{version}/networks/{pathv1}/switch/routing/multicast?{query} | Yes |
updateMulticastSettingsForANetwork(networkId, body, callback) | Update Multicast Settings For A Network | {base_path}/{version}/networks/{pathv1}/switch/routing/multicast?{query} | Yes |
returnLayer3OSPFRoutingConfiguration(networkId, callback) | Return Layer 3 OSPF Routing Configuration | {base_path}/{version}/networks/{pathv1}/switch/routing/ospf?{query} | Yes |
updateLayer3OSPFRoutingConfiguration(networkId, body, callback) | Update Layer 3 OSPF Routing Configuration | {base_path}/{version}/networks/{pathv1}/switch/routing/ospf?{query} | Yes |
returnTheSwitchAlternateManagementInterfaceForTheNetwork(networkId, callback) | Return The Switch Alternate Management Interface For The Network | {base_path}/{version}/networks/{pathv1}/switch/alternateManagementInterface?{query} | Yes |
updateTheSwitchAlternateManagementInterfaceForTheNetwork(networkId, body, callback) | Update The Switch Alternate Management Interface For The Network | {base_path}/{version}/networks/{pathv1}/switch/alternateManagementInterface?{query} | Yes |
returnAlternateManagementInterfaceAndDevicesWithIPAssigned(networkId, callback) | Return Alternate Management Interface And Devices With IP Assigned | {base_path}/{version}/networks/{pathv1}/wireless/alternateManagementInterface?{query} | Yes |
updateAlternateManagementInterfaceAndDeviceStaticIP(networkId, body, callback) | Update Alternate Management Interface And Device Static IP | {base_path}/{version}/networks/{pathv1}/wireless/alternateManagementInterface?{query} | Yes |
returnthenetworkSDHCPv4serversseenwithintheselectedtimeframeDefault1day(networkId, callback) | Return the network's DHCPv4 servers seen within the selected timeframe (default 1 day) | {base_path}/{version}/networks/{pathv1}/switch/dhcp/v4/servers/seen?{query} | Yes |
returnTheListOfServersTrustedByDynamicARPInspectionOnThisNetwork(networkId, callback) | Return The List Of Servers Trusted By Dynamic ARP Inspection On This Network | {base_path}/{version}/networks/{pathv1}/switch/dhcpServerPolicy/arpInspection/trustedServers?{query} | Yes |
addAServerToBeTrustedByDynamicARPInspectionOnThisNetwork(networkId, body, callback) | Add A Server To Be Trusted By Dynamic ARP Inspection On This Network | {base_path}/{version}/networks/{pathv1}/switch/dhcpServerPolicy/arpInspection/trustedServers?{query} | Yes |
updateAServerThatIsTrustedByDynamicARPInspectionOnThisNetwork(networkId, trustedServerId, body, callback) | Update A Server That Is Trusted By Dynamic ARP Inspection On This Network | {base_path}/{version}/networks/{pathv1}/switch/dhcpServerPolicy/arpInspection/trustedServers/{pathv2}?{query} | Yes |
removeAServerFromBeingTrustedByDynamicARPInspectionOnThisNetwork(networkId, trustedServerId, callback) | Remove A Server From Being Trusted By Dynamic ARP Inspection On This Network | {base_path}/{version}/networks/{pathv1}/switch/dhcpServerPolicy/arpInspection/trustedServers/{pathv2}?{query} | Yes |
returnthedevicesthathaveaDynamicARPInspectionwarningandtheirwarnings(networkId, callback) | Return the devices that have a Dynamic ARP Inspection warning and their warnings | {base_path}/{version}/networks/{pathv1}/switch/dhcpServerPolicy/arpInspection/warnings/byDevice?{query} | Yes |
listthepowerstatusinformationfordevicesinanorganization(organizationId, callback) | List the power status information for devices in an organization | {base_path}/{version}/organizations/{pathv1}/devices/powerModules/statuses/byDevice?{query} | Yes |
listthecurrentuplinkaddressesfordevicesinanorganization(organizationId, callback) | List the current uplink addresses for devices in an organization. | {base_path}/{version}/organizations/{pathv1}/devices/uplinks/addresses/byDevice?{query} | Yes |
cloneportLevelandsomeswitchLevelconfigurationsettingsfromasourceswitchtooneormoretargetswitches(organizationId, body, callback) | Clone port-level and some switch-level configuration settings from a source switch to one or more t | {base_path}/{version}/organizations/{pathv1}/switch/devices/clone?{query} | Yes |
returnASingleDeviceFromTheInventoryOfAnOrganization(organizationId, serial, callback) | Return A Single Device From The Inventory Of An Organization | {base_path}/{version}/organizations/{pathv1}/inventory/devices/{pathv2}?{query} | Yes |
returnTheBillingSettingsOfThisNetwork(networkId, callback) | Return The Billing Settings Of This Network | {base_path}/{version}/networks/{pathv1}/wireless/billing?{query} | Yes |
updateTheBillingSettings(networkId, body, callback) | Update The Billing Settings | {base_path}/{version}/networks/{pathv1}/wireless/billing?{query} | Yes |
listTheBonjourForwardingSettingAndRulesForTheSSID(networkId, number, callback) | List The Bonjour Forwarding Setting And Rules For The SSID | {base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/bonjourForwarding?{query} | Yes |
updateTheBonjourForwardingSettingAndRulesForTheSSID(networkId, number, body, callback) | Update The Bonjour Forwarding Setting And Rules For The SSID | {base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/bonjourForwarding?{query} | Yes |
listAllIdentityPSKsInAWirelessNetwork(networkId, number, callback) | List All Identity PS Ks In A Wireless Network | {base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/identityPsks?{query} | Yes |
createAnIdentityPSK(networkId, number, body, callback) | Create An Identity PSK | {base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/identityPsks?{query} | Yes |
returnAnIdentityPSK(networkId, number, identityPskId, callback) | Return An Identity PSK | {base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/identityPsks/{pathv3}?{query} | Yes |
updateAnIdentityPSK(networkId, number, identityPskId, body, callback) | Update An Identity PSK | {base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/identityPsks/{pathv3}?{query} | Yes |
deleteAnIdentityPSK(networkId, number, identityPskId, callback) | Delete An Identity PSK | {base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/identityPsks/{pathv3}?{query} | Yes |
listTheVPNSettingsForTheSSID(networkId, number, callback) | List The VPN Settings For The SSID | {base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/vpn?{query} | Yes |
updateTheVPNSettingsForTheSSID(networkId, number, body, callback) | Update The VPN Settings For The SSID | {base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/vpn?{query} | Yes |
returnAPchannelutilizationovertimeforadeviceornetworkclient(networkId, callback) | Return AP channel utilization over time for a device or network client | {base_path}/{version}/networks/{pathv1}/wireless/channelUtilizationHistory?{query} | Yes |
returnwirelessclientcountsovertimeforanetworkDeviceOrnetworkclient(networkId, callback) | Return wireless client counts over time for a network, device, or network client | {base_path}/{version}/networks/{pathv1}/wireless/clientCountHistory?{query} | Yes |
listthewirelessconnectivityeventsforaclientwithinanetworkinthetimespan(networkId, clientId, callback) | List the wireless connectivity events for a client within a network in the timespan. | {base_path}/{version}/networks/{pathv1}/wireless/clients/{pathv2}/connectivityEvents?{query} | Yes |
returnaveragewirelesslatencyovertimeforanetworkDeviceOrnetworkclient(networkId, callback) | Return average wireless latency over time for a network, device, or network client | {base_path}/{version}/networks/{pathv1}/wireless/latencyHistory?{query} | Yes |
returnPHYdataratesovertimeforanetworkDeviceOrnetworkclient(networkId, callback) | Return PHY data rates over time for a network, device, or network client | {base_path}/{version}/networks/{pathv1}/wireless/dataRateHistory?{query} | Yes |
listwirelessmeshstatusesforrepeaters(networkId, callback) | List wireless mesh statuses for repeaters | {base_path}/{version}/networks/{pathv1}/wireless/meshStatuses?{query} | Yes |
returnsignalqualitySNRRSSIOvertimeforadeviceornetworkclient(networkId, callback) | Return signal quality (SNR/RSSI) over time for a device or network client | {base_path}/{version}/networks/{pathv1}/wireless/signalQualityHistory?{query} | Yes |
getapplicationhealthbytime(networkId, applicationId, callback) | Get application health by time | {base_path}/{version}/networks/{pathv1}/insight/applications/{pathv2}/healthByTime?{query} | Yes |
listallInsighttrackedapplications(organizationId, callback) | List all Insight tracked applications | {base_path}/{version}/organizations/{pathv1}/insight/applications?{query} | Yes |
returnthelatestavailablereadingforeachmetricfromeachsensorSortedbysensorserial(organizationId, callback) | Return the latest available reading for each metric from each sensor, sorted by sensor serial | {base_path}/{version}/organizations/{pathv1}/sensor/readings/latest?{query} | Yes |
listTrustedAccessConfigs(networkId, callback) | List Trusted Access Configs | {base_path}/{version}/networks/{pathv1}/sm/trustedAccessConfigs?{query} | Yes |
listUserAccessDevicesAndItsTrustedAccessConnections(networkId, callback) | List User Access Devices And Its Trusted Access Connections | {base_path}/{version}/networks/{pathv1}/sm/userAccessDevices?{query} | Yes |
deleteAUserAccessDevice(networkId, userAccessDeviceId, callback) | Delete A User Access Device | {base_path}/{version}/networks/{pathv1}/sm/userAccessDevices/{pathv2}?{query} | Yes |
gettheorganizationSAPNScertificate(organizationId, callback) | Get the organization's APNS certificate | {base_path}/{version}/organizations/{pathv1}/sm/apnsCert?{query} | Yes |
listTheVPPAccountsInTheOrganization(organizationId, callback) | List The VPP Accounts In The Organization | {base_path}/{version}/organizations/{pathv1}/sm/vppAccounts?{query} | Yes |
getAHashContainingTheUnparsedTokenOfTheVPPAccountWithTheGivenID(organizationId, vppAccountId, callback) | Get A Hash Containing The Unparsed Token Of The VPP Account With The Given ID | {base_path}/{version}/organizations/{pathv1}/sm/vppAccounts/{pathv2}?{query} | Yes |
enqueueAJobToPingATargetHostFromTheDevice(serial, body, callback) | Enqueue A Job To Ping A Target Host From The Device | {base_path}/{version}/devices/{pathv1}/liveTools/ping?{query} | Yes |
returnAPingJob(serial, id, callback) | Return A Ping Job | {base_path}/{version}/devices/{pathv1}/liveTools/ping/{pathv2}?{query} | Yes |
enqueueAJobToCheckConnectivityStatusToTheDevice(serial, body, callback) | Enqueue A Job To Check Connectivity Status To The Device | {base_path}/{version}/devices/{pathv1}/liveTools/pingDevice?{query} | Yes |
returnAPingDeviceJob(serial, id, callback) | Return A Ping Device Job | {base_path}/{version}/devices/{pathv1}/liveTools/pingDevice/{pathv2}?{query} | Yes |
claimavMXintoanetwork(networkId, body, callback) | Claim a vMX into a network | {base_path}/{version}/networks/{pathv1}/devices/claim/vmx?{query} | Yes |
rollbackaFirmwareUpgradeForANetwork(networkId, body, callback) | Rollback a Firmware Upgrade For A Network | {base_path}/{version}/networks/{pathv1}/firmwareUpgrades/rollbacks?{query} | Yes |
getFirmwareUpgradeInformationForANetwork(networkId, callback) | Get Firmware Upgrade Information For A Network | {base_path}/{version}/networks/{pathv1}/firmwareUpgrades?{query} | Yes |
updateFirmwareUpgradeInformationForANetwork(networkId, body, callback) | Update Firmware Upgrade Information For A Network | {base_path}/{version}/networks/{pathv1}/firmwareUpgrades?{query} | Yes |
returnallglobalalertsonthisnetwork(networkId, callback) | Return all global alerts on this network | {base_path}/{version}/networks/{pathv1}/health/alerts?{query} | Yes |
authorizeAUserConfiguredWithMerakiAuthenticationForANetworkCurrentlySupports8021XSplashGuestAndClientVPNUsersAndCurrentlyOrganizationsHaveA50000UserCap(networkId, body, callback) | Authorize A User Configured With Meraki Authentication For A Network Currently Supports 802 1 X Spl | {base_path}/{version}/networks/{pathv1}/merakiAuthUsers?{query} | Yes |
deauthorizeAUser(networkId, merakiAuthUserId, callback) | Deauthorize A User | {base_path}/{version}/networks/{pathv1}/merakiAuthUsers/{pathv2}?{query} | Yes |
updateAUserConfiguredWithMerakiAuthenticationCurrently8021XRADIUSSplashGuestAndClientVPNUsersCanBeUpdated(networkId, merakiAuthUserId, body, callback) | Update A User Configured With Meraki Authentication Currently 802 1 X RADIUS Splash Guest And Clien | {base_path}/{version}/networks/{pathv1}/merakiAuthUsers/{pathv2}?{query} | Yes |
addAnMQTTBroker(networkId, body, callback) | Add An MQTT Broker | {base_path}/{version}/networks/{pathv1}/mqttBrokers?{query} | Yes |
listTheMQTTBrokersForThisNetwork(networkId, callback) | List The MQTT Brokers For This Network | {base_path}/{version}/networks/{pathv1}/mqttBrokers?{query} | Yes |
deleteAnMQTTBroker(networkId, mqttBrokerId, callback) | Delete An MQTT Broker | {base_path}/{version}/networks/{pathv1}/mqttBrokers/{pathv2}?{query} | Yes |
returnAnMQTTBroker(networkId, mqttBrokerId, callback) | Return An MQTT Broker | {base_path}/{version}/networks/{pathv1}/mqttBrokers/{pathv2}?{query} | Yes |
updateAnMQTTBroker(networkId, mqttBrokerId, body, callback) | Update An MQTT Broker | {base_path}/{version}/networks/{pathv1}/mqttBrokers/{pathv2}?{query} | Yes |
getpoliciesforallclientswithpolicies(networkId, callback) | Get policies for all clients with policies | {base_path}/{version}/networks/{pathv1}/policies/byClient?{query} | Yes |
listofdevicesandconnectionsamongthemwithinthenetwork(networkId, callback) | List of devices and connections among them within the network. | {base_path}/{version}/networks/{pathv1}/topology/linkLayer?{query} | Yes |
createAWebhookPayloadTemplateForANetwork(networkId, body, callback) | Create A Webhook Payload Template For A Network | {base_path}/{version}/networks/{pathv1}/webhooks/payloadTemplates?{query} | Yes |
listTheWebhookPayloadTemplatesForANetwork(networkId, callback) | List The Webhook Payload Templates For A Network | {base_path}/{version}/networks/{pathv1}/webhooks/payloadTemplates?{query} | Yes |
destroyAWebhookPayloadTemplateForANetwork(networkId, payloadTemplateId, callback) | Destroy A Webhook Payload Template For A Network | {base_path}/{version}/networks/{pathv1}/webhooks/payloadTemplates/{pathv2}?{query} | Yes |
getTheWebhookPayloadTemplateForANetwork(networkId, payloadTemplateId, callback) | Get The Webhook Payload Template For A Network | {base_path}/{version}/networks/{pathv1}/webhooks/payloadTemplates/{pathv2}?{query} | Yes |
updateAWebhookPayloadTemplateForANetwork(networkId, payloadTemplateId, body, callback) | Update A Webhook Payload Template For A Network | {base_path}/{version}/networks/{pathv1}/webhooks/payloadTemplates/{pathv2}?{query} | Yes |
returntheapplicationusagedataforclients(networkId, callback) | Return the application usage data for clients | {base_path}/{version}/networks/{pathv1}/clients/applicationUsage?{query} | Yes |
returnsatimeseriesoftotaltrafficconsumptionratesforallclientsonanetworkwithinagiventimespanInmegabitspersecond(networkId, callback) | Returns a timeseries of total traffic consumption rates for all clients on a network within a given | {base_path}/{version}/networks/{pathv1}/clients/bandwidthUsageHistory?{query} | Yes |
returndatausageInmegabitspersecondOvertimeforallclientsinthegivenorganizationwithinagiventimerange(organizationId, callback) | Return data usage (in megabits per second) over time for all clients in the given organization with | {base_path}/{version}/organizations/{pathv1}/clients/bandwidthUsageHistory?{query} | Yes |
returntheusagehistoriesforclients(networkId, callback) | Return the usage histories for clients | {base_path}/{version}/networks/{pathv1}/clients/usageHistories?{query} | Yes |
getthechannelutilizationovereachradioforallAPsinanetwork(networkId, callback) | Get the channel utilization over each radio for all APs in a network. | {base_path}/{version}/networks/{pathv1}/networkHealth/channelUtilization?{query} | Yes |
createsNewAdaptivePolicyACL(organizationId, body, callback) | Creates New Adaptive Policy ACL | {base_path}/{version}/organizations/{pathv1}/adaptivePolicy/acls?{query} | Yes |
listAdaptivePolicyACLsInAOrganization(organizationId, callback) | List Adaptive Policy AC Ls In A Organization | {base_path}/{version}/organizations/{pathv1}/adaptivePolicy/acls?{query} | Yes |
deletesTheSpecifiedAdaptivePolicyACL(organizationId, aclId, callback) | Deletes The Specified Adaptive Policy ACL | {base_path}/{version}/organizations/{pathv1}/adaptivePolicy/acls/{pathv2}?{query} | Yes |
returnsTheAdaptivePolicyACLInformation(organizationId, aclId, callback) | Returns The Adaptive Policy ACL Information | {base_path}/{version}/organizations/{pathv1}/adaptivePolicy/acls/{pathv2}?{query} | Yes |
updatesAnAdaptivePolicyACL(organizationId, aclId, body, callback) | Updates An Adaptive Policy ACL | {base_path}/{version}/organizations/{pathv1}/adaptivePolicy/acls/{pathv2}?{query} | Yes |
createsANewAdaptivePolicyGroup(organizationId, body, callback) | Creates A New Adaptive Policy Group | {base_path}/{version}/organizations/{pathv1}/adaptivePolicy/groups?{query} | Yes |
listAdaptivePolicyGroupsInAOrganization(organizationId, callback) | List Adaptive Policy Groups In A Organization | {base_path}/{version}/organizations/{pathv1}/adaptivePolicy/groups?{query} | Yes |
deletesTheSpecifiedAdaptivePolicyGroupAndAnyAssociatedPoliciesAndReferences(organizationId, id, callback) | Deletes The Specified Adaptive Policy Group And Any Associated Policies And References | {base_path}/{version}/organizations/{pathv1}/adaptivePolicy/groups/{pathv2}?{query} | Yes |
returnsAnAdaptivePolicyGroup(organizationId, id, callback) | Returns An Adaptive Policy Group | {base_path}/{version}/organizations/{pathv1}/adaptivePolicy/groups/{pathv2}?{query} | Yes |
updatesAnAdaptivePolicyGroup(organizationId, id, body, callback) | Updates An Adaptive Policy Group | {base_path}/{version}/organizations/{pathv1}/adaptivePolicy/groups/{pathv2}?{query} | Yes |
addAnAdaptivePolicy(organizationId, body, callback) | Add An Adaptive Policy | {base_path}/{version}/organizations/{pathv1}/adaptivePolicy/policies?{query} | Yes |
listAdaptivePoliciesInAnOrganization(organizationId, callback) | List Adaptive Policies In An Organization | {base_path}/{version}/organizations/{pathv1}/adaptivePolicy/policies?{query} | Yes |
deleteAnAdaptivePolicy(organizationId, id, callback) | Delete An Adaptive Policy | {base_path}/{version}/organizations/{pathv1}/adaptivePolicy/policies/{pathv2}?{query} | Yes |
returnAnAdaptivePolicy(organizationId, id, callback) | Return An Adaptive Policy | {base_path}/{version}/organizations/{pathv1}/adaptivePolicy/policies/{pathv2}?{query} | Yes |
updateAnAdaptivePolicy(organizationId, id, body, callback) | Update An Adaptive Policy | {base_path}/{version}/organizations/{pathv1}/adaptivePolicy/policies/{pathv2}?{query} | Yes |
returntheclientdetailsinanorganization(organizationId, callback) | Return the client details in an organization | {base_path}/{version}/organizations/{pathv1}/clients/search?{query} | Yes |
createANewConfigurationTemplate(organizationId, body, callback) | Create A New Configuration Template | {base_path}/{version}/organizations/{pathv1}/configTemplates?{query} | Yes |
returnASingleConfigurationTemplate(organizationId, configTemplateId, callback) | Return A Single Configuration Template | {base_path}/{version}/organizations/{pathv1}/configTemplates/{pathv2}?{query} | Yes |
updateAConfigurationTemplate(organizationId, configTemplateId, body, callback) | Update A Configuration Template | {base_path}/{version}/organizations/{pathv1}/configTemplates/{pathv2}?{query} | Yes |
createANewEarlyAccessFeatureOptInForAnOrganization(organizationId, body, callback) | Create A New Early Access Feature Opt In For An Organization | {base_path}/{version}/organizations/{pathv1}/earlyAccess/features/optIns?{query} | Yes |
listTheEarlyAccessFeatureOptInsForAnOrganization(organizationId, callback) | List The Early Access Feature Opt Ins For An Organization | {base_path}/{version}/organizations/{pathv1}/earlyAccess/features/optIns?{query} | Yes |
deleteAnEarlyAccessFeatureOptIn(organizationId, optInId, callback) | Delete An Early Access Feature Opt In | {base_path}/{version}/organizations/{pathv1}/earlyAccess/features/optIns/{pathv2}?{query} | Yes |
showAnEarlyAccessFeatureOptInForAnOrganization(organizationId, optInId, callback) | Show An Early Access Feature Opt In For An Organization | {base_path}/{version}/organizations/{pathv1}/earlyAccess/features/optIns/{pathv2}?{query} | Yes |
updateAnEarlyAccessFeatureOptInForAnOrganization(organizationId, optInId, body, callback) | Update An Early Access Feature Opt In For An Organization | {base_path}/{version}/organizations/{pathv1}/earlyAccess/features/optIns/{pathv2}?{query} | Yes |
listTheAvailableEarlyAccessFeaturesForOrganization(organizationId, callback) | List The Available Early Access Features For Organization | {base_path}/{version}/organizations/{pathv1}/earlyAccess/features?{query} | Yes |
claimAListOfDevicesLicensesAndOrOrdersIntoAnOrganizationInventory(organizationId, body, callback) | Claim A List Of Devices Licenses And Or Orders Into An Organization Inventory | {base_path}/{version}/organizations/{pathv1}/inventory/claim?{query} | Yes |
releaseAListOfClaimedDevicesFromAnOrganization(organizationId, body, callback) | Release A List Of Claimed Devices From An Organization | {base_path}/{version}/organizations/{pathv1}/inventory/release?{query} | Yes |
returnsTheLoginSecuritySettingsForAnOrganization(organizationId, callback) | Returns The Login Security Settings For An Organization | {base_path}/{version}/organizations/{pathv1}/loginSecurity?{query} | Yes |
updateTheLoginSecuritySettingsForAnOrganization(organizationId, body, callback) | Update The Login Security Settings For An Organization | {base_path}/{version}/organizations/{pathv1}/loginSecurity?{query} | Yes |
createASAMLIdPForYourOrganization(organizationId, body, callback) | Create A SAML Id P For Your Organization | {base_path}/{version}/organizations/{pathv1}/saml/idps?{query} | Yes |
listTheSAMLIdPsInYourOrganization(organizationId, callback) | List The SAML Id Ps In Your Organization | {base_path}/{version}/organizations/{pathv1}/saml/idps?{query} | Yes |
getASAMLIdPFromYourOrganization(organizationId, idpId, callback) | Get A SAML Id P From Your Organization | {base_path}/{version}/organizations/{pathv1}/saml/idps/{pathv2}?{query} | Yes |
removeASAMLIdPInYourOrganization(organizationId, idpId, callback) | Remove A SAML Id P In Your Organization | {base_path}/{version}/organizations/{pathv1}/saml/idps/{pathv2}?{query} | Yes |
updateASAMLIdPInYourOrganization(organizationId, idpId, body, callback) | Update A SAML Id P In Your Organization | {base_path}/{version}/organizations/{pathv1}/saml/idps/{pathv2}?{query} | Yes |
returnsTheSAMLSSOEnabledSettingsForAnOrganization(organizationId, callback) | Returns The SAML SSO Enabled Settings For An Organization | {base_path}/{version}/organizations/{pathv1}/saml?{query} | Yes |
updatesTheSAMLSSOEnabledSettingsForAnOrganization(organizationId, body, callback) | Updates The SAML SSO Enabled Settings For An Organization | {base_path}/{version}/organizations/{pathv1}/saml?{query} | Yes |
listtheavailabilityinformationfordevicesinanorganization(organizationId, callback) | List the availability information for devices in an organization | {base_path}/{version}/organizations/{pathv1}/devices/availabilities?{query} | Yes |
returnthetop10appliancessortedbyutilizationovergiventimerange(organizationId, callback) | Return the top 10 appliances sorted by utilization over given time range. | {base_path}/{version}/organizations/{pathv1}/summary/top/appliances/byUtilization?{query} | Yes |
returnmetricsfororganizationStop10clientsbydatausageInmbOvergiventimerange(organizationId, callback) | Return metrics for organization's top 10 clients by data usage (in mb) over given time range. | {base_path}/{version}/organizations/{pathv1}/summary/top/clients/byUsage?{query} | Yes |
returnmetricsfororganizationStop10devicessortedbydatausageovergiventimerange(organizationId, callback) | Return metrics for organization's top 10 devices sorted by data usage over given time range | {base_path}/{version}/organizations/{pathv1}/summary/top/devices/byUsage?{query} | Yes |
returnmetricsfororganizationStopclientsbydatausageInmbOvergiventimerangeGroupedbymanufacturer(organizationId, callback) | Return metrics for organization's top clients by data usage (in mb) over given time range, grouped | {base_path}/{version}/organizations/{pathv1}/summary/top/clients/manufacturers/byUsage?{query} | Yes |
returnmetricsfororganizationStop10devicemodelssortedbydatausageovergiventimerange(organizationId, callback) | Return metrics for organization's top 10 device models sorted by data usage over given time range | {base_path}/{version}/organizations/{pathv1}/summary/top/devices/models/byUsage?{query} | Yes |
returnmetricsfororganizationStop10ssidsbydatausageovergiventimerange(organizationId, callback) | Return metrics for organization's top 10 ssids by data usage over given time range | {base_path}/{version}/organizations/{pathv1}/summary/top/ssids/byUsage?{query} | Yes |
returnmetricsfororganizationStop10switchesbyenergyusageovergiventimerange(organizationId, callback) | Return metrics for organization's top 10 switches by energy usage over given time range | {base_path}/{version}/organizations/{pathv1}/summary/top/switches/byEnergyUsage?{query} | Yes |
returnalistofalerttypestobeusedwithmanagingwebhookalerts(organizationId, callback) | Return a list of alert types to be used with managing webhook alerts | {base_path}/{version}/organizations/{pathv1}/webhooks/alertTypes?{query} | Yes |
Authentication
This document will go through the steps for authenticating the Cisco Meraki adapter with the authentication methods we have worked with in the past. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication HERE.
Companies periodically change authentication methods to provide better security. As this happens this section should be updated and contributed/merge back into the adapter repository.
Static Token (APIKEY) Authentication
The Cisco Meraki adapter authenticates with a static token or api-key.
STEPS
- Ensure you have access to a Cisco Meraki server and that it is running
- Follow the steps in the README.md to import the adapter into IAP if you have not already done so
- Use the properties below for the
properties.authentication
field"authentication": { "auth_method": "static_token", "token": "$ENCd0bfd12e1273f41189835144cbd02517d08573dfa6d215cf09598a17ee4145950289e0e6630b609d77cb2ef7e8726c2697d230c8e7f6d295", "auth_field": "header.headers.X-Cisco-Meraki-API-Key", "auth_field_format": "{token}", "auth_logging": false }
you can leave all of the other properties in the authentication section, they will not be used when the auth_method is static_token.
- Restart the adapter. If your properties were set correctly, the adapter should go online.
Troubleshooting
- Make sure you copied over the correct username and password.
- Turn on debug level logs for the adapter in IAP Admin Essentials.
- Turn on auth_logging for the adapter in IAP Admin Essentials (adapter properties).
- Investigate the logs - in particular:
- The FULL REQUEST log to make sure the proper headers are being sent with the request.
- The FULL BODY log to make sure the payload is accurate.
- The CALL RETURN log to see what the other system is telling us.
- Credentials should be masked by the adapter so make sure you verify the username and password - including that there are erroneous spaces at the front or end.
- Remember when you are done to turn auth_logging off as you do not want to log credentials.
Additional Information
Enhancements
Adding a Second Instance of an Adapter
You can add a second instance of this adapter without adding new code on the file system. To do this go into the IAP Admin Essentials and add a new service config for this adapter. The two instances of the adapter should have unique ids. In addition, they should point to different instances (unique host and port) of the other system.
Adding Adapter Calls
There are multiple ways to add calls to an existing adapter.
The easiest way would be to use the Adapter Builder update process. This process takes in a Swagger or OpenAPI document, allows you to select the calls you want to add and then generates a zip file that can be used to update the adapter. Once you have the zip file simply put it in the adapter directory and execute npm run adapter:update
.
mv updatePackage.zip adapter-meraki
cd adapter-meraki
npm run adapter:update
If you do not have a Swagger or OpenAPI document, you can use a Postman Collection and convert that to an OpenAPI document using APIMatic and then follow the first process.
If you want to manually update the adapter that can also be done the key thing is to make sure you update all of the right files. Within the entities directory you will find 1 or more entities. You can create a new entity or add to an existing entity. Each entity has an action.json file, any new call will need to be put in the action.json file. It will also need to be added to the enum for the ph_request_type in the appropriate schema files. Once this configuration is complete you will need to add the call to the adapter.js file and, in order to make it available as a workflow task in IAP, it should also be added to the pronghorn.json file. You can optionally add it to the unit and integration test files. There is more information on how to work on each of these files in the Adapter Technical Resources on our Documentation Site.
Files to update
* entities/<entity>/action.json: add an action
* entities/<entity>/schema.json (or the schema defined on the action): add action to the enum for ph_request_type
* adapter.js: add the new method and make sure it calls the proper entity and action
* pronghorn.json: add the new method
* test/unit/adapterTestUnit.js (optional but best practice): add unit test(s) - function is there, any required parameters error when not passed in
* test/integration/adapterTestIntegration.js (optional but best practice): add integration test
Adding Adapter Properties
While changing adapter properties is done in the service instance configuration section of IAP, adding properties has to be done in the adapter. To add a property you should edit the propertiesSchema.json with the proper information for the property. In addition, you should modify the sampleProperties to have the new property in it.
Files to update
* propertiesSchema.json: add the new property and how it is defined
* sampleProperties: add the new property with a default value
* test/unit/adapterTestUnit.js (optional but best practice): add the property to the global properties
* test/integration/adapterTestIntegration.js (optional but best practice): add the property to the global properties
Changing Adapter Authentication
Often an adapter is built before knowing the authentication and authentication processes can also change over time. The adapter supports many different kinds of authentication but it does require configuration. Some forms of authentication can be defined entirely with the adapter properties but others require configuration.
Files to update
* entities/.system/action.json: change the getToken action as needed
* entities/.system/schemaTokenReq.json: add input parameters (external name is name in other system)
* entities/.system/schemaTokenResp.json: add response parameters (external name is name in other system)
* propertiesSchema.json: add any new property and how it is defined
* sampleProperties: add any new property with a default value
* test/unit/adapterTestUnit.js (optional but best practice): add the property to the global properties
* test/integration/adapterTestIntegration.js (optional but best practice): add the property to the global properties
Enhancing Adapter Integration Tests
The adapter integration tests are written to be able to test in either stub (standalone) mode or integrated to the other system. However, if integrating to the other system, you may need to provide better data than what the adapter provides by default as that data is likely to fail for create and update. To provide better data, edit the adapter integration test file. Make sure you do not remove the marker and keep custom code below the marker so you do not impact future migrations. Once the edits are complete, run the integration test as it instructs you to above. When you run integrated to the other system, you can also save mockdata for future use by changing the isSaveMockData flag to true.
Files to update
* test/integration/adapterTestIntegration.js: add better data for the create and update calls so that they will not fail.
As mentioned previously, for most of these changes as well as other possible changes, there is more information on how to work on an adapter in the Adapter Technical Resources on our Documentation Site.
Contributing
First off, thanks for taking the time to contribute!
The following is a set of rules for contributing.
Code of Conduct
This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to support@itential.com.
How to Contribute
Follow the contributing guide (here)[https://gitlab.com/itentialopensource/adapters/contributing-guide]
Helpful Links
Node Scripts
There are several node scripts that now accompany the adapter. These scripts are provided to make several activities easier. Many of these scripts can have issues with different versions of IAP as they have dependencies on IAP and Mongo. If you have issues with the scripts please report them to the Itential Adapter Team. Each of these scripts are described below.
Run | Description |
---|---|
npm run adapter:install | Provides an easier way to install the adapter. |
npm run adapter:checkMigrate | Checks whether your adapter can and should be migrated to the latest foundation. |
npm run adapter:findPath | Can be used to see if the adapter supports a particular API call. |
npm run adapter:migrate | Provides an easier way to update your adapter after you download the migration zip from Itential DevSite. |
npm run adapter:update | Provides an easier way to update your adapter after you download the update zip from Itential DevSite. |
npm run adapter:revert | Allows you to revert after a migration or update if it resulted in issues. |
npm run troubleshoot | Provides a way to troubleshoot the adapter - runs connectivity, healthcheck and basic get. |
npm run connectivity | Provides a connectivity check to the Servicenow system. |
npm run healthcheck | Checks whether the configured healthcheck call works to Servicenow. |
npm run basicget | Checks whether the basic get calls works to Servicenow. |
Troubleshoot
Run npm run troubleshoot
to start the interactive troubleshooting process. The command allows you to verify and update connection, authentication as well as healthcheck configuration. After that it will test these properties by sending HTTP request to the endpoint. If the tests pass, it will persist these changes into IAP.
You also have the option to run individual commands to perform specific test:
npm run healthcheck
will perform a healthcheck request of with current setting.npm run basicget
will perform some non-parameter GET request with current setting.npm run connectivity
will perform networking diagnostics of the adatper endpoint.
Connectivity Issues
- You can run the adapter troubleshooting script which will check connectivity, run the healthcheck and run basic get calls.
npm run troubleshoot
- Verify the adapter properties are set up correctly.
Go into the Itential Platform GUI and verify/update the properties
- Verify there is connectivity between the Itential Platform Server and Meraki Server.
ping the ip address of Meraki server
try telnet to the ip address port of Meraki
execute a curl command to the other system
- Verify the credentials provided for Meraki.
login to Meraki using the provided credentials
- Verify the API of the call utilized for Meraki Healthcheck.
Go into the Itential Platform GUI and verify/update the properties
Functional Issues
Adapter logs are located in /var/log/pronghorn
. In older releases of the Itential Platform, there is a pronghorn.log
file which contains logs for all of the Itential Platform. In newer versions, adapters can be configured to log into their own files.