Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Juniper Mist AI Sites vBeacons API

A vBeacon is a virtual beacon that is created and configured on a floorplan and are configured with a name and messageIt is a Mist patented technology that provides proximity-related notifications to users on a mobile app using the Mist SDK.vBeacons allow users to receive notifications when their device is within the proximity of the beacon, based on the power transmitted. When a user goes near the location of a vbeacon, a notification is sent to the application with the configured message.

Juniper Mist AI Sites vBeacons API is one of 211 APIs that Juniper Mist AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Sites vBeacons. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 13 schemas. It is described by OpenAPI 3.1.0, at version 2604.1.1.

Requests are made against 12 base URLs: https://api.mist.com, https://api.gc1.mist.com, https://api.ac2.mist.com, https://api.gc2.mist.com, https://api.gc4.mist.com, https://api.eu.mist.com, https://api.gc3.mist.com, https://api.ac6.mist.com, https://api.gc6.mist.com, https://api.ac5.mist.com, https://api.gc5.mist.com, https://api.gc7.mist.com.

5 operations 2 paths 13 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2604.1.1
Base URL
https://api.mist.com/api/v1
Authentication
API Key, HTTP Basic, API Key
License
Resource Areas
1

Authentication & Security 3

Juniper Mist AI Sites vBeacons API declares 3 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiToken). It accepts HTTP basic authentication (basicAuth). An API key is passed in the header as X-CSRFToken (csrfToken). By default, every request must be authenticated.

  • apiToken — Like many other API providers, it’s also possible to generate API Tokens to be used (in HTTP Header) for authentication. An API token ties to a Admin with equa…
  • basicAuth — While our current UI uses Session / Cookie-based authentication, it’s also possible to do Basic Auth.
  • csrfToken — This protects the website against [Cross Site Request Forgery](https://en.wikipedia.org/wiki/Cross-siterequestforgery), all the POST / PUT / DELETE APIs needs…

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Sites vBeacons 5

A vBeacon is a virtual beacon that is created and configured on a floorplan and are configured with a name and message It is a Mist patented technology that provides proximity-rel…

GET
/api/v1/sites/{site_id}/vbeacons
listSiteVBeacons
listSiteVBeacons 3 params → 200400401403404429
POST
/api/v1/sites/{site_id}/vbeacons
createSiteVBeacon
createSiteVBeacon 1 param body → 200400401403404429
DELETE
/api/v1/sites/{site_id}/vbeacons/{vbeacon_id}
deleteSiteVBeacon
deleteSiteVBeacon 2 params → 200400401403404429
GET
/api/v1/sites/{site_id}/vbeacons/{vbeacon_id}
getSiteVBeacon
getSiteVBeacon 2 params → 200400401403404429
PUT
/api/v1/sites/{site_id}/vbeacons/{vbeacon_id}
updateSiteVBeacon
updateSiteVBeacon 2 params body → 200400401403404429

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are vbeacon (18 properties), response_http400 (1 property), response_http401 (1 property), response_http404 (1 property). Each schema is shown below with its type and property counts.

id
string
Unique ID of the object instance in the Mist Organization
response_http403
object
1 property
vbeacon
object
vBeacon
18 properties
site_id
string
response_http404
object
1 property
modified_time
number
When the object has been modified for the last time, in epoch
response_http400
object
1 property
response_http429
object
1 property
ble_config_power_mode
string
enum: custom, default
vbeacons
array
response_http401
object
1 property
org_id
string
created_time
number
When the object has been created, in epoch

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mist-ai-sites-vbeacons-api-openapi.yml Raw ↑

Other APIs Juniper Mist AI publishes across the network.

Juniper Mist WebSocket Streaming API
Juniper Mist Webhooks API
Juniper Mist AI Admins API
Juniper Mist AI Admins Login API
Juniper Mist AI Admins Login - OAuth2 API
Juniper Mist AI Admins Logout API
Juniper Mist AI Admins Lookup API
Juniper Mist AI Admins Recover Password API
Juniper Mist AI Constants Definitions API
Juniper Mist AI Constants Events API
Juniper Mist AI Constants Models API
Juniper Mist AI Installer API