Skip to main content

Python library for scraping your meraki dashboard of the data necessary to automate functions not available in the public API.

Project description

meraki_dashboard (module for easier access to hidden apis such as delete umbrella)

This module is specifically for gathering relevant data from the meraki dashboard UI that is necessary for automating configurations that are not available via the public Meraki API. There is a lot more data necessary for some of these calls, the simplest I have used this module for is removing an umbrella integration on an SSID which only requires a couple parameters to execute, example here

Quick Start

  1. Install via preferred method
  2. Import into your script import meraki_dashboard
  3. Create and instance of the MerakiDashboardAPI() class dashboard = meraki_dashboard.MerakiDashboardAPI(username=xxxx,password=xxxx)
  4. Get your dashboard data via one of the 2 available methods dashboard.get_org_data() or dashboard.get_orgs_data()
  5. Parse the data received dashboard.parse_values()
  6. Gather the locale or node_group or organization you need for your calls e.g. `[local for locale in dashboard.locales if locale.name in ['networkname1','networkname2']]
  7. Start making API calls.
  8. Watch your token expiration, this is not automatic yet, but a call to dashboard.refresh_token(shard_id) will refresh the values you need for subsequent calls
  9. If you want to store your dashboard data for importing later, make a call to dashboard.use_sqlite(db_filename) and next time you instantiate your object, you can call use.sqlite(db_filename) before get_orgs_data() and it will import all of the previous data, you will still need to perform a meraki_login() to get the necessary dash_auth cookie for authentication to shard(s) and refresh_token() to get the relevant token(s) for your shard(s)

Note: I recommend using the dashboard.session object for calls as it will maintain the session_id cookie and dash_auth cookie as needed for you. It is up to you to ensure you pass in the shard specific headers for your calls.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

meraki_dashboard-0.1.1.tar.gz (9.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

meraki_dashboard-0.1.1-py3-none-any.whl (14.1 kB view details)

Uploaded Python 3

File details

Details for the file meraki_dashboard-0.1.1.tar.gz.

File metadata

  • Download URL: meraki_dashboard-0.1.1.tar.gz
  • Upload date:
  • Size: 9.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.2

File hashes

Hashes for meraki_dashboard-0.1.1.tar.gz
Algorithm Hash digest
SHA256 e3bc8ceaca296b0769c79aa3c0254d06e22d72dc1b2037645d187f7393ce7682
MD5 4b89b3764d3011ccaa95fc738c4bc2af
BLAKE2b-256 2efab9e1317b333c56833644cb68aa31d8de938ffd22e3d0be1c589c4c7bacc1

See more details on using hashes here.

File details

Details for the file meraki_dashboard-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for meraki_dashboard-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fa763a7e2ec174c5313c931892507cb0837e3b3d49329471ec19b1ea3c1bce04
MD5 e6d970b3fde1f01aeb7552e0eb7a0be0
BLAKE2b-256 65f0e7f9de11d42dd94566b7395278f67762b1aa9dfb7af4142342e64bb98017

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page