- Deployment Considerations
- Generate an API key
- Add API credentials
- Final steps
- Legacy Meraki Integrations
Deployment Considerations
Auvik has recently changed its Meraki integration. Historically, API requests were sourced from Auvik’s cloud IP addresses. This allowed customers to add the Meraki integration at a MSP level, and map to child sites with ease. Customers that deployed in this manner have been grandfathered in, but may have performance issues related to Meraki’s rate limiting. Essentially, the administrator could create an integration at a high level and map networks to child sites. This functionality is changing.
API integrations will now be sourced from the Auvik Collector. This will allow customers to specifically allow an IP address to make API requests in the Meraki Dashboard. If a customer deletes or modifies their integration it will default to the collector integration. This will allow customers to restrict API queries to an IP address they control. It will also improve the performance of the Meraki integration due to rate limiting.
Any changes to a grandfathered Meraki Integration (deletion or modification) will be irreversible.
Legacy Auvik Cloud Meraki Integration | Net New Integration | |
Global Level | Sites will be grandfathered in and can leave as is and functionality will continue to work with Meraki’s current rate limits. Admins that delete the integration at a global level will need to use a shared collector at the global level (or deploy a new one), and will need to re-map their networks to individual sites. |
Admins will need to deploy a collector at the top global level and will need to re-map their networks to individual sites. |
Individual Site | Sites will be grandfathered in and can leave as is and functionality will continue to work with Meraki’s current rate limits. | Admins will select a collector and create the integration from there. |
How to generate an API key
To connect to your cloud controller, you need to generate an API key. The user for whom the API key is being generated must have access to all organizations that are to be managed from your MSP dashboard.
If you have enabled Login IP ranges in your cloud controller web portal, add the public IP address that the selected collector will use to source its API requests.
- Log into the Meraki cloud controller web portal
-
If your Meraki dashboard is used for multiple organizations, selection the organization you want to see the dashboard for
- If your Meraki dashboard supports only one organization, skip to step 3.
- From the side navigation, hover over Organization
- Click Settings
-
Confirm that Enable access to the Cisco Meraki Dashboard API is checked
- If not, check it to enable API access
- Click Save
-
From the side navigation, click the next organization and repeat steps 3 and 4.
- If your Meraki dashboard supports only one organization, skip to step 7
- Repeat step 5 for all organizations where API access is to be enabled
- Click my profile
- Scroll down to API access
- Click Generate API key
- Copy the API key
- Click Save
How to add API credentials
-
If you’ve added the controller from your MSP dashboard, there’s one final configuration step: mapping your clients to the appropriate network.
-
If you’ve added the controller from your client dashboard, there’s one final configuration
- Click Discovery in the side navigation bar
- Click the Manage Credentials tab
- Click the API Credentials tab.
- Hover over the Add API Credentials button
- Choose Meraki
- In Auvik, fill in the following detail:
- Credential name
- API key (copied from the cloud controller web portal)
- Auvik Collector
- If no collector is available and you wish to map networks at this level you will need to deploy a shared collector.
-
Click Test Connection to confirm your settings are accurate
- This will only appear after filling in the other fields
- Click Save.
Legacy Meraki Integrations
Meraki’s rate limit of 100 calls/sec/IP is now strictly enforced. Auvik’s centralized (cloud) API polling model often exceeds this limit. By moving API traffic to be sourced from on-site collectors, the load is distributed, allowing customers to stay within Meraki’s thresholds and maintain uninterrupted monitoring.
How to Update Your Integration
- Go to Discovery > Manage Credentials.
- Click Edit next to your Meraki credential.
- Select the appropriate Auvik collector from the dropdown.
- Click Test Connection.
- If successful, click Save.
Customers with large Meraki Integrations that are mapped at the global or a multi-site level will likely need to do the following:
-
Deploy a Collector at a Higher Level
For customers who have set up Meraki integrations at a global or multi-site level, we recommend selecting (or deploying) a shared collector at that level. -
Reconfigure Integrations at Each Site
Alternatively, you can remove your current Meraki integrations and reconfigure them at the site level—assigning each to its respective collector.
Customers that wish to not add a collector at a multi-site level can add the Meraki integration at each site and map accordingly.