Skip to main content

Meraki Dashboard API wrapper.

Project description

Meraki API is a wrapper around requests library to interact with the Meraki Dashboard API. It simplifies interacting with the API by keeping track of the users token, handling query and body parameters, and has the ability to execute the request lazily.

First, we can bootstrap the module by indicating our API Key.

>>> import MerakiAPI
>>> KEY = <Your user Meraki API KEY>
>>> meraki = MerakiAPI(KEY)

After this we don’t have to worry again about it. To get the a list of all the organizations we would call the organizations().index() function.

>>> response = meraki.organizations().index()

This will return a requests response object. If we want to get the json data from the response, we just call .json() over it.

>>> json = response.json()

If we want to set up the request to call it in the future we can use the lazy function before calling on index.

>>> lazy_request = meraki.organizations().lazy().index()

This will return a LazyRequests object that holds the request action until we need to run it. It is also useful to check the URL that was created, without actually generating a request to the API.

>>> lazy_request.get_url()
"https://dashboard.meraki.com/api/v0/organizations"

When we feel like it we can use the call function inside out LazyRequests object to send the request to the Server. This will also return a requests response object.

>>> lazy_request.call()

All the endpoints specified as of July 1 2017 are defined. You can see the official documentation at:

https://dashboard.meraki.com/api_docs

copyright:
  1. 2017 by Guzmán Monné.

license:

MIT, see LICENSE for more details.

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_api-1.1.3.tar.gz (13.4 kB view details)

Uploaded Source

Built Distribution

meraki_api-1.1.3-py3-none-any.whl (21.1 kB view details)

Uploaded Python 3

File details

Details for the file meraki_api-1.1.3.tar.gz.

File metadata

  • Download URL: meraki_api-1.1.3.tar.gz
  • Upload date:
  • Size: 13.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for meraki_api-1.1.3.tar.gz
Algorithm Hash digest
SHA256 1ae186b4a0ab6ccc8b70117ec891e082bbeecdf8871563905b746187bcf15914
MD5 f333eb1dfbc9107e5b2a0e28ce6332d6
BLAKE2b-256 809799745d62205790162d55c97fafd2fcd2791805b63030eebe7f52e139ffc1

See more details on using hashes here.

File details

Details for the file meraki_api-1.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for meraki_api-1.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 11f9dffc4a3af4bbc0b1badf06c2de1e48d4820bf6f914cc317fcacff6a18657
MD5 cb8a6e324a8fe6d7a7fbe6c9af844480
BLAKE2b-256 5a0652d507cba2dda57ae503b9ec3de20299c1790e96b56ca3c638d2a83bd6e4

See more details on using hashes here.

Supported by

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