Package: meraki
Meraki Dashboard API Python LibraryThe Meraki Dashboard API Python library provides all current
Merakidashboard APIcalls to interface with the Cisco Meraki
cloud-managed platform. Meraki generates the library based on dashboard API's OpenAPI spec to keep it up to date with
the latest API releases, and provides the full source code for the library including the tools used to generate the
library, if you are participating in the Early Access program or would like to contribute to the development of the
library. Meraki welcomes constructive pull requests that maintain backwards compatibility with prior versions. The
library requires Python 3.8+, receives support from the community, and you can install it
viaPyPI:pip install --upgrade merakiIf you participate
inour Early Access programand would like to use early access features via the library,
you'llfind instructions in the generator readme.FeaturesWhile you can make direct HTTP requests to dashboard API in any programming language or REST API client, using a client
library can make it easier for you to focus on your specific use case, without the overhead of having to write functions
to handle the dashboard API calls. The Python library can also take care of error handling, logging, retries, and other
convenient processes and options for you automatically.Support for all API endpoints, as it uses theOpenAPI specificationto
generate source codeLog all API requests made to a local file as well as on-screen consoleAutomatic retries upon 429 rate limit errors, using
theRetry-Afterfieldwithin response headersGet all (or a specified number of) pages of data with built-in pagination controlTweak settings such as maximum retries, certificate path, suppress logging, and other optionsSimulate POST/PUT/DELETE calls to preview first, so that network configuration does not get changedSetupEnable API access in your Meraki dashboard organization and obtain an API
key (instructions)Keep your API key safe and secure, as it is similar to a password for your dashboard. If publishing your Python code
to a wider audience, please research secure handling of API keys.Install the latest version ofPython 3Usepip(or an alternative such aseasy_install) to install the library from the
PythonPackage Index:pip install merakiIf you have both Python3 and Python2 installed, you may need to usepip3(sopip3 install meraki) along
withpython3on your systemIfmerakiwas previously installed, you can upgrade to the latest non-beta release
withpip install --upgrade merakiThe library supports Meraki dashboard API v1. You can also specify the version of the library when installing withpip:See the fullrelease historyto pick the version you want, or
usepip install meraki==without including a version number to display the list of available versionsVersions begin with1(1.0.0bzfor beta)Specify the version you want with the install command; for example:pip install meraki==1.34.0You can also see the version currently installed withpip show merakiEnd-of-life v0 versions of the Python library begin with0(0.x.y) and are not supported nor
recommended.UsageExport your API key as
anenvironment variable, for example:exportMERAKI_DASHBOARD_API_KEY=YOUR_KEY_HEREAlternatively, define your API key as a variable in your source code; this method is not recommended due to its
inherent insecurity.Single line of code to import and use the library goes at the top of your script:importmerakiInstantiate the client (API consumer class), optionally specifying any of the parameters available to set:dashboard=meraki.DashboardAPI()Make dashboard API calls in your source code, using the formatclient.scope.operation, whereclientis the name
you defined in the previous step (dashboardabove),scopeis the corresponding scope that represents the first
tag from the OpenAPI spec, andoperationis the operation of the API endpoint. For example, to make a call to get
the list of organizations accessible by the API key defined in step 1, use this function call:my_orgs=dashboard.organizations.getOrganizations()ExamplesYou can find fully working example scripts in theexamplesfolder.ScriptPurposeorg_wide_clients.pyThat code collects the clients of all networks, in all orgs to which the key has access. No changes are made, since only GET endpoints are called, and the data is written to local CSV output files.AsyncIOasynciois a library to write concurrent code using theasync/awaitsyntax. Special thanks to Heimo
Stieg (@coreGreenberet) who has ported the API to asyncio.Installation on macOSIf you use a Mac, then you may need to takeadditional Python installation stepsthat aren't required on other platforms. This
isa limitation of macOS and not the library. This step is
not required on Windows.UsageThe usage is similiar to the sequential version above. However it has has some differences.Export your API key as
anenvironment variable, for example:exportMERAKI_DASHBOARD_API_KEY=YOUR_KEY_HEREAlternatively, define your API key as a variable in your source code; this method is not recommended due to its
inherent insecurity.Single line of code to import and use the library goes at the top of your script:importmeraki.aioInstantiate the client (API consumer class), optionally specifying any of the parameters available to set:asyncwithmeraki.aio.AsyncDashboardAPI()asaiomeraki:Theasync withstatement is important here to make sure, that the client sessions will be closed after using the
api.Make dashboard API calls in your source code, using the format awaitclient.section.operation, whereclientis
the name you defined in the previous step (aiomerakiabove),sectionis the corresponding group (or tag from
the OpenAPI spec) from theAPI docs, andoperationis the name (or
operation ID from OpenAPI) of the API endpoint. For example, to make a call to get the list of organizations
accessible by the API key defined in step 1, use this function call:my_orgs=awaitaiomeraki.organizations.getOrganizations()Run everything inside an event loop.importasyncioif__name__=="__main__":# replace my_async_entry_point with the name of your entry point methodasyncio.run(my_async_entry_point())ExamplesYou can find fully working example scripts in theexamplesfolder.ScriptPurposeaio_org_wide_clients.pyThat code is a asyncio port from org_wide_clients.py and collects the clients of allnetworks, in all orgs to which the key has access. No changes are made, since only GET endpoints are called, and thedata is written to local CSV output files.aio_ips2firewall.pyThat code will collect the source IP of security events and creates L7 firewall rules toblock them.usage: aio_ips2firewall.py [-h] -o ORGANIZATIONS [ORGANIZATIONS ...] [-f FILTER] [-s] [-d DAYS]Note for application developers and ecosystem partnersWe're so glad that you're leveraging our Python library. It's best practice to identify your application with every API
request that you make. You can easily do this automatically just by following the format defined
inconfig.pyand passing the session
kwarg:MERAKI_PYTHON_SDK_CALLERUnless you are an ecosystem partner, this identifier is optional.If you are an ecosystem partner and you have questions about this requirement, please reach out to your ecosystem
rep.If you have any questions about the formatting, please ask your question by opening an issue in this repo.