Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
SitesMaps

updateSiteMap

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

Update Site Map

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

site_id*string
Formatuuid
map_id*string
Formatuuid

Request Body

application/json

Request Body

Map or floorplan metadata for a site or organization

geofences?array<>

Location boundary definitions configured on this map

height?integer

When type==image, height of the map image in pixels

height_m?number

Physical height of the map in meters

Formatdouble
latlng_br?

When type==google, bottom-right map bounds coordinate

latlng_tl?

When type==google, top-left map bounds coordinate

locked?boolean

Whether this map is considered locked down

Defaultfalse
mapstack_floor?integer

Optional floor number within the map stack

Range0 <= value
mapstack_id?string

Map stack containing this map

Formatuuid
name?string

The name of the map

occupancy_limit?integer

Maximum occupancy configured for this map

orientation?integer

Map orientation in degrees; 0 means up is north, 90 means up is west

Range0 <= value <= 359
Default0
origin_x?integer

User-annotated X origin, pixels

origin_y?integer

User-annotated Y origin, pixels

ppm?number

When type==image, pixels per meter for the map image

sitesurvey_path?array<>

Site survey path geometry for this map

Items0 <= items
type?map_type

Map type, such as image or google

Default"image"

Value in

  • "google"
  • "image"
view?|

If type==google, map tile view to display. enum: hybrid, roadmap, satellite, terrain.

Value in

  • "hybrid"
  • "roadmap"
  • "satellite"
  • "terrain"
wall_path?

Wall path geometry for this map

wayfinding?

Navigation pathfinding settings for this map

wayfinding_path?

Wayfinding path geometry for this map

width?integer

When type==image, width of the map image in pixels

width_m?number

Physical width of the map in meters

Formatdouble

Response Body

curl -X PUT "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/maps/000000ab-00ab-00ab-00ab-0000000000ab" \  -H "Content-Type: application/json" \  -d '{    "height": 0,    "height_m": 0,    "latlng_br": {      "lat": "string",      "lng": "string"    },    "latlng_tl": {      "lat": "string",      "lng": "string"    },    "locked": true,    "name": "string",    "occupancy_limit": 0,    "orientation": 0,    "origin_x": 0,    "origin_y": 0,    "ppm": 0,    "sitesurvey_path": [      {        "coordinate": "string",        "name": "string",        "nodes": [          {            "edges": {              "N2": "string"            },            "name": "string",            "position": {              "x": 0,              "y": 0            }          }        ]      }    ],    "type": "image",    "view": "roadmap",    "wall_path": {      "coordinate": "string",      "nodes": [        {          "edges": {            "N2": "string"          },          "name": "string",          "position": {            "x": 0,            "y": 0          }        }      ]    },    "wayfinding": {      "micello": {        "account_key": "string",        "default_level_id": 0      },      "snap_to_path": true    },    "wayfinding_path": {      "coordinate": "string",      "nodes": [        {          "edges": {            "N2": "string"          },          "name": "string",          "position": {            "x": 0,            "y": 0          }        }      ]    },    "width": 0,    "width_m": 0  }'
{  "created_time": 0.1,  "flags": {    "assetHoldTime": 5,    "storeTime": 10  },  "for_site": true,  "geofences": [    {      "name": "example",      "vertices": [        {          "X": 700,          "Y": 100        }      ]    }  ],  "height": 1500,  "height_m": 0.1,  "id": "53f10664-3ce8-4c27-b382-0ef66432349f",  "latlng_br": {    "lat": "string",    "lng": "string"  },  "latlng_tl": {    "lat": "string",    "lng": "string"  },  "locked": false,  "mapstack_floor": 1,  "mapstack_id": "6a2856e5-9974-4b44-b75f-f41547024f71",  "modified_time": 0.1,  "name": "Mist Office",  "occupancy_limit": 0,  "org_id": "a97c1b22-a4e9-411e-9bfd-d8695a0f9e61",  "orientation": 30,  "origin_x": 35,  "origin_y": 60,  "ppm": 40.94,  "site_id": "441a1214-6928-442a-8e92-e1d34b8ec6a6",  "sitesurvey_path": [],  "thumbnail_url": "https://url/to/image.png",  "type": "image",  "url": "https://url/to/image.png",  "view": "hybrid",  "wall_path": {    "coordinate": "actual",    "nodes": []  },  "wayfinding": {    "micello": {      "account_key": "adasdf",      "default_level_id": 5,      "map_id": "c660f81dd250c"    },    "snap_to_path": true  },  "wayfinding_path": {    "coordinate": "actual",    "nodes": []  },  "width": 1250,  "width_m": 0.1}

deleteSiteMap DELETE

Delete Site Map

importSiteMaps POST

Import data from files is a multipart POST which has an file, an optional json, and an optional csv, to create floorplan, assign matching inventory to specific site, place ap if name or mac matches. # Note This endpoint (at the site level), the AP must be already assigned to the site to be placed on the floorplan. If you want to place APs from the Org inventory, it is required to use the endpoint at the Org level [importOrgMaps](/api/mist/orgs/orgs-maps/importOrgMaps) # CSV File Format ```csv Vendor AP name,Mist AP Mac US Office AP-2,5c:5b:35:00:00:02 US Office AP-3,5c5b35000002 ```