OverviewThe Meraki Dashboard API is an interface for software to interact directly with the Meraki cloud platform and Meraki managed devices. The API contains a set of tools known as endpoints for building software and applications that communicate with the Meraki Dashboard for use cases such as provisioning, bulk configuration changes, monitoring, and role-based access controls. The Dashboard API is a modern, RESTful API using HTTPS requests to a URL and JSON as a human-readable format.
![]() ![]()
What is API Documentation? API documentation is a technical content deliverable, containing instructions about how to effectively use and integrate with an API. It’s a concise reference manual containing all the information required to work with the API, with details about the functions, classes, return types, arguments and more, supported by tutorials and examples. API Documentation has traditionally been done using regular content creation and maintenance tools and text editors.
![]()
The Dashboard API is an open-ended tool can be used for many purposes, and here are some examples of how it is used today by Meraki customers:. Add new organizations, admins, networks, devices, VLANs, SSIDs.
Provision thousands of new sites in minutes with an automation script. Automatically onboard and off-board new employees' teleworker device. Build your own dashboard for store managers, field techs, or unique use cases. API RequestsEvery request must specify an API key via a request header.
Further, the API key must be specified in the URL. The API will return 404 (rather than a 403) in response to a request with a missing or incorrect API key in order to prevent leaking the existence of resources to unauthorized users.X-Cisco-Meraki-API-Key: The API version must be specified in the URL:an API version is released, we will make only backwards-compatible changes to it. Backwards-compatible changes include:. Adding new API resources.Adding new optional request parameters to existing API methods.Adding new properties to existing API responses.Changing the order of properties in existing API responsesIdentifiers in the API are opaque strings. A, for example, might be the string “126043”, whereas an might contain characters, such as “4S1234567”.
Client applications must not try to parse them as numbers.
![]() Comments are closed.
|
AuthorWrite something about yourself. No need to be fancy, just an overview. Archives
January 2023
Categories |