Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
SitesMaps

listSiteMaps

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

Get List of Site Maps

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

Query Parameters

mapstack_id?string

Filter maps by mapstack UUID; returns only maps belonging to that mapstack

Formatuuid
limit?integer

Maximum number of results to return per page

Range0 <= value
Default100
page?integer

Select the page number to return when using page-based pagination; starts at 1

Range1 <= value
Default1

Response Body

curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/maps"
[  {    "created_time": 0,    "flags": {},    "height": 0,    "height_m": 0,    "id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",    "latlng_br": {      "lat": "string",      "lng": "string"    },    "latlng_tl": {      "lat": "string",      "lng": "string"    },    "locked": true,    "mapstack_floor": 1,    "mapstack_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",    "modified_time": 0,    "name": "string",    "occupancy_limit": 0,    "org_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",    "orientation": 0,    "origin_x": 0,    "origin_y": 0,    "ppm": 0,    "site_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",    "sitesurvey_path": [      {        "coordinate": "string",        "id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",        "name": "string",        "nodes": [          {            "edges": {              "N2": "string"            },            "name": "string",            "position": {              "x": 0,              "y": 0            }          }        ]      }    ],    "thumbnail_url": "string",    "type": "image",    "url": "string",    "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,        "map_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1"      },      "snap_to_path": true    },    "wayfinding_path": {      "coordinate": "string",      "nodes": [        {          "edges": {            "N2": "string"          },          "name": "string",          "position": {            "x": 0,            "y": 0          }        }      ]    },    "width": 0,    "width_m": 0  }]

bulkAssignSiteApsToMap POST

This API can be used to assign a list of AP Macs associated with site_id to the specified map_id. Note that map_id must be associated with corresponding site_id. This API obeys the following rules 1. if AP is unassigned to any Map, it gets associated with map_id 2. Any moved APs are returned in the response 3. If the AP is considered a locked AP, no action will be taken

createSiteMap POST

Create Site Map