Juniper Mist AI Sites Maps API

A Site Map is a visual representation of the layout and structure of a location, such as a building or campus.It includes accurate information about the placement, positions, heights, and orientations of Juniper Mist Access Points (APs) and other devices in the deployment.The floorplan is an essential component of location services as it enables the location engine to generate accurate location estimates for client devices, assets, and users at the site.

Documentation Provider Profile APIs.io OpenAPI GitHub

Juniper Mist AI Sites Maps 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 Maps. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 13 operations across 9 paths, and defines 55 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.

13 operations 9 paths 55 schemas 2 DELETE2 GET8 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

Contact

Thomas Munzer

License

MIT

Resource Areas

Authentication & Security 3

Juniper Mist AI Sites Maps 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 13

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

Sites Maps 13

A Site Map is a visual representation of the layout and structure of a location, such as a building or campus. It includes accurate information about the placement, positions, hei…

GET

/api/v1/sites/{site_id}/maps

listSiteMaps

listSiteMaps 3 params → 200400401403404429

POST

/api/v1/sites/{site_id}/maps

createSiteMap

createSiteMap 1 param body → 200400401403404429

POST

/api/v1/sites/{site_id}/maps/auto_geofences

startSiteMapsAutoGeofence

startSiteMapsAutoGeofence 1 param → 200400401403404429

POST

/api/v1/sites/{site_id}/maps/import

importSiteMaps

importSiteMaps 1 param body → 200400401403404429

DELETE

/api/v1/sites/{site_id}/maps/{map_id}

deleteSiteMap

deleteSiteMap 2 params → 200400401403404429

GET

/api/v1/sites/{site_id}/maps/{map_id}

getSiteMap

getSiteMap 2 params → 200400401403404429

PUT

/api/v1/sites/{site_id}/maps/{map_id}

updateSiteMap

updateSiteMap 2 params body → 200400401403404429

POST

/api/v1/sites/{site_id}/maps/{map_id}/auto_geofences

startSiteMapAutoGeofence

startSiteMapAutoGeofence 2 params → 200400401403404429

DELETE

/api/v1/sites/{site_id}/maps/{map_id}/image

deleteSiteMapImage

deleteSiteMapImage 2 params → 200400401403404429

POST

/api/v1/sites/{site_id}/maps/{map_id}/image

addSiteMapImage

addSiteMapImage 2 params body → 200400401403404429

POST

/api/v1/sites/{site_id}/maps/{map_id}/replace

replaceSiteMapImage

replaceSiteMapImage 2 params body → 200400401403404429

POST

/api/v1/sites/{site_id}/maps/{map_id}/set_map

bulkAssignSiteApsToMap

bulkAssignSiteApsToMap 2 params body → 200400401403404429

POST

/api/v1/sites/{site_id}/maps/{map_id}/wayfinding/import

importSiteWayfindings

importSiteWayfindings 2 params body → 200400401403404429

Schemas 55

The contract defines 55 schemas that model the data the API accepts and returns. The most detailed are map (31 properties), map_jibestream (9 properties), response_map_import_ap (7 properties), response_map_import (5 properties). Each schema is shown below with its type and property counts.

response_set_devices_map_moved

array

map_import_json

object

4 properties 1 required

map_site_import_file

object

4 properties

response_map_import_summary

object

3 properties 3 required

map_wall_path_nodes

array

map_geofence_vertices

array

List of vertices defining the geofence

map_geofences

array

List of geofences for the map

map_wall_path

object

JSON blob for wall definition (same format as wayfindingpath)

2 properties

map_sitesurvey_path_items

object

4 properties

latlng_br

object

When type=google, latitude / longitude of the bottom-right corner

2 properties

map_sitesurvey_path_items_nodes

array

map_site_replace_file_json

object

1 property

latlng_tl

object

When type=google, latitude / longitude of the top-left corner

2 properties

response_http401

object

1 property

map_import_json_vendor_name

string

enum: ekahau, ibwave

map_micello_vendor_name

string

The vendor ‘micello’. enum: micello

map_node_position

object

2 properties 2 required

response_map_import_ap_action

string

enum: assigned-named-placed, assigned-placed, ignored, named-placed, placed

map_jibestream_vendor_name

string

The vendor ‘jibestream’. enum: jibestream

map_wayfinding_micello

object

3 properties

map_geofence_vertice

object

2 properties

map_view

stringnull

if type==google. enum: hybrid, roadmap, satellite, terrain

created_time

number

When the object has been created, in epoch

mac_addresses_macs

array

map_wayfinding

object

Properties related to wayfinding

2 properties

image_import

object

2 properties 1 required

map_micello

object

4 properties 4 required

map_sitesurvey_path

array

Sitesurveypath

mac_addresses

object

1 property 1 required

maps

array

response_map_import

object

5 properties 4 required

map_wayfinding_path_nodes

array

response_map_import_ap

object

7 properties 5 required

response_http429

object

1 property

map_geofence

object

2 properties

map_node

object

Nodes on maps

3 properties 1 required

org_id

string

response_set_devices_map

object

2 properties

string

Unique ID of the object instance in the Mist Organization

response_set_devices_map_locked

array

map_type

string

enum: google, image

response_http403

object

1 property

wayfinding_import_json

map_jibestream

object

9 properties 9 required

response_map_import_floorplans

array

map_wayfinding_path

object

JSON blob for wayfinding (using Dijkstra’s algorithm)

2 properties

site_id

string

response_http404

object

1 property

response_map_import_aps

array

response_http400

object

1 property

map_site_replace_file

object

2 properties 1 required

response_map_import_floorplan

object

5 properties 4 required

map

object

Map

31 properties

modified_time

number

When the object has been modified for the last time, in epoch

map_site_replace_file_json_transform

object

If transform is provided, all the locations of the objects on the map (AP, Zone, Vbeacon, Beacon) will be transformed as well (relative to the new Map)

4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Juniper Mist AI publishes across the network.

Juniper Mist WebSocket Streaming API

AE Profile APIs.io

Juniper Mist Webhooks API

AE Profile APIs.io

Juniper Mist AI Admins API

AE Profile APIs.io

Juniper Mist AI Admins Login API

AE Profile APIs.io

Juniper Mist AI Admins Login - OAuth2 API

AE Profile APIs.io

Juniper Mist AI Admins Logout API

AE Profile APIs.io

Juniper Mist AI Admins Lookup API

AE Profile APIs.io

Juniper Mist AI Admins Recover Password API

AE Profile APIs.io

Juniper Mist AI Constants Definitions API

AE Profile APIs.io

Juniper Mist AI Constants Events API

AE Profile APIs.io

Juniper Mist AI Constants Models API

AE Profile APIs.io

Juniper Mist AI Installer API

AE Profile APIs.io

#Sites Maps

← Back to J APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Juniper Mist AI Sites Maps API

Metadata

Authentication & Security 3

Paths & Operations 13

Schemas 55

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Juniper Mist AI Sites Maps API

Metadata

Authentication & Security 3

Paths & Operations 13

Schemas 55

Specification

Source

More from Juniper Mist AI 12

API Details

Provider

Explore more