|
1 |
| -# Meraki Dashboard API |
| 1 | +# Meraki Dashboard APIs |
2 | 2 |
|
3 |
| -A RESTful API to programmatically manage and monitor Meraki networks at scale. |
| 3 | +The Meraki Dashboard API (referred to as Meraki API) is a RESTful API interface that allows you to programmatically manage and monitor Meraki networks at scale. |
4 | 4 |
|
5 | 5 | <img src="../images/cloud-code.png" width="200px">
|
6 | 6 |
|
7 |
| -## What can you do with it? |
8 | 7 |
|
9 |
| -- Add new organizations, admins, networks, devices, VLANs, and more |
10 |
| -- Configure thousands of networks in minutes |
11 |
| -- On-board and off-board new employees’ teleworker setup automatically |
12 |
| -- Build your own dashboard for store managers, field techs, or unique use cases |
13 |
| - |
14 |
| -Checkout out the [Explore](https://developer.cisco.com/meraki/explore/) section for open source projects, or browse the [Marketplace](https://apps.meraki.io/) for partner solutions. |
15 |
| - |
16 |
| -## What's New in v1 |
17 |
| - |
18 |
| -The Dashboard API has evolved significantly, providing hundreds of operations to manage your Meraki networks! |
19 |
| - |
20 |
| -We want to do so much more. But in order for us to include many of these new features or improvements, we need to break a few things. |
| 8 | +Meraki APIs provide a range of operations to |
21 | 9 |
|
22 |
| -The focus of this **major** version is on **Simplicity** and **Scale**, by providing an enjoyable developer experience. |
| 10 | +- Add new organizations, administrators, networks, devices, VLANs, and more |
| 11 | +- Configure thousands of networks in minutes |
| 12 | +- On-board and Off-board new employees’ teleworker setup automatically, and |
| 13 | +- Build custom dashboards for store managers, field technicians, or other unique use cases. |
23 | 14 |
|
24 |
| -The API documentation, Postman collection, and Python library will remain synced and up-to-date with improved navigation and features. |
25 | 15 |
|
26 |
| -In addition, several improvements and new operations have been included with this major release. |
| 16 | +Checkout out the [Explore](https://developer.cisco.com/meraki/explore/) section for open source projects, or browse the [Marketplace](https://apps.meraki.io/) for partner solutions. |
27 | 17 |
|
| 18 | +## Resources |
28 | 19 |
|
29 |
| -### API Documentation |
| 20 | +A resource is an entity or component within the Meraki ecosystem. Resources represent the various elements of a network. Here are some examples of Meraki resources: |
30 | 21 |
|
31 |
| -The API operation documentation and complimenting Postman Collection have a new folder structure for navigating the API. |
| 22 | +- **Organizations**: A collection of networks, representing the top-level structure in the Meraki hierarchy. |
| 23 | +- **Networks**: Specific networks within an organization, which contain devices and configurations. |
| 24 | +- **Devices**: Individual hardware units such as routers, switches, or access points within a network. |
| 25 | +- **VLANs**: Virtual local area networks configured within a network for segmenting traffic. |
| 26 | +- **SSIDs**: Wireless network identifiers that can be configured and managed. |
32 | 27 |
|
| 28 | +Each resource is typically represented by a unique URL. You can use APIs to configure or retrieve information about these resources. |
33 | 29 |
|
| 30 | +## Services |
34 | 31 |
|
35 |
| -#### Categories |
| 32 | +A service is a functionality or a set of API operations that interact with the resources of a Meraki product. (These operations are specific actions performed on a resource, such as GET, POST, PUT, or DELETE.) Services perform specific actions on resources such as: |
36 | 33 |
|
37 |
| -The services are grouped into categories, providing a collection of operations that behave in a similar way. |
| 34 | +- CONFIGURE service: Manage cloud configurations. |
| 35 | +- MONITOR service: Return status and history information. |
| 36 | +- LIVE TOOL service: Directly interact with devices. |
38 | 37 |
|
39 |
| -**CONFIGURE** operations are for managing cloud configurations |
| 38 | +## Meraki Products |
40 | 39 |
|
41 |
| -**MONITOR** operations will return status and history information |
| 40 | +A Meraki product refers to the hardware and software solutions offered by Cisco Meraki that are used to build and manage network infrastructure. These products include wireless access points, switches, or security appliances. |
42 | 41 |
|
43 |
| -**LIVE TOOL** operations will directly interact with the device |
| 42 | +## Resource URLs |
44 | 43 |
|
45 |
| -### Resource Path changes |
| 44 | +The resource URL or path contains the name of the Meraki product to reduce ambiguity when working with similar yet unique functionality. |
46 | 45 |
|
47 |
| -The operation URL paths will always contain the Meraki product if required, reducing ambiguity when working with resources that have similar yet unique functionality. |
| 46 | +The format of the path is 'product/service'. |
48 | 47 |
|
49 |
| -> **Examples of a product and service** |
| 48 | +> **Examples of a Path:** |
50 | 49 | >
|
51 | 50 | > `/appliance/ports`
|
52 | 51 | >
|
53 | 52 | > `/switch/ports`
|
54 | 53 |
|
55 |
| -### Base URI |
56 |
| - |
57 |
| -In most parts of the world, every API request will begin with the following **base URI**: |
58 |
| - |
59 |
| -> `https://api.meraki.com/api/v1` |
60 |
| -
|
61 |
| -For organizations hosted in different country dashboards, please refer to their [respective base URI](https://developer.cisco.com/meraki/api-v1/getting-started/#base-uri) |
| 54 | +## Base URI |
62 | 55 |
|
63 |
| -### See all the changes |
| 56 | +A base URI is the root address or endpoint that serves as the starting point for accessing the API's resources. The base URI includes the protocol, domain, and base path. All API requests append specific resource paths to this base URI. |
64 | 57 |
|
65 |
| -Visit the [Changelog](https://developer.cisco.com/meraki/whats-new/) for all the details. |
| 58 | +For most regions, the base URI for API requests is `https://api.meraki.com/api/v1`. |
66 | 59 |
|
67 |
| -### SDKs |
| 60 | +Different countries may have different base URIs, see the [respective base URI section](https://developer.cisco.com/meraki/api-v1/getting-started/#base-uri). |
68 | 61 |
|
69 |
| -Going forward, the custom Meraki [Python library](pythonLibrary.md) will be the recommended SDK for simplified API scripting. The previously auto-generated Python, Node.js, and Ruby SDKs for **v0** will remain in the Meraki GitHub but will no longer be maintained. |
70 | 62 |
|
71 |
| -#### Python |
| 63 | +## Reference to Open Source Projects and Solutions |
72 | 64 |
|
73 |
| -The Meraki [Python Library](pythonLibrary.md) has been updated to take advantage of all the new API enhancements plus many custom features to help both beginners and experienced programmers. |
| 65 | +Visit the [Explore](https://developer.cisco.com/meraki/explore/) section for open-source projects, or browse the [Marketplace](https://apps.meraki.io/) for partner solutions. |
0 commit comments