Mist APIs
The 100% API architecture of Juniper Mist backs every visible feature in the Juniper Mist portal. Anything that you can do in the portal, you can automate at scale by using the API. Representational State Transfer (REST) is a stateless client/server architecture with a uniform interface. Since machines have no use for a user interface, APIs allow for a defined and faster way for machines to communicate with each other. APIs also enable you and other users to create your own way of interacting with systems and applications. You can even create custom features.
The Juniper Mist API is available to any customer with a Juniper Mist account.
Juniper Mist API Architecture
Juniper Mist uses REST APIs, which use HTTP methods (GET, POST, PUT, and DELETE) to transfer data in JavaScript Object Notation (JSON) format. Depending on the use case, it is also possible to use Webhooks (HTTP POST messages sent by Mist) or the Websockets to get real time information.
RESTful API Requests
Using RESTful APIs follows a similar practice to the CRUD (CREATE, READ, UPDATE, DELETE) methodology used in development. These are the four basic actions or functions used when working with data.
| CRUD | HTTP/REST |
|---|---|
| Create | POST |
| Read | GET |
| Update | PUT |
| Delete | DELETE |
The REST APIs can be used to perform the same action as the Mist Dashboard (the Mist Dashboard is using the same Public APIs) to provision, deploy, configure and monitor the network infrastructure.
Webhooks
Webhooks are HTTP POST message sent by the Mist Cloud based on different type of event. This can be used to receive real-time notification as events happen across your Juniper Mist organization or within a particular Juniper Mist organization or site.
Websockets
The WebSocket protocol is a bidirectional communication session between a client and a server. This can be used to stream data from the Mist Cloud to your server, like during when peroforming "Streaming PCAPs" or to populate custom dashboard with the live status of Juniper Mist access points (APs) and real-time location data of Bluetooth Low Energy (BLE) assets.