{ "opencollection": "1.0.0", "info": { "name": "Mist Admins Sites Maps API", "version": "2604.1.1" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Sites Maps", "type": "folder" }, "items": [ { "info": { "name": "listSiteMaps", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/maps", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" } ] }, "docs": "Get List of Site Maps" }, { "info": { "name": "createSiteMap", "type": "http" }, "http": { "method": "POST", "url": "https://api.mist.com/api/v1/sites/:site_id/maps", "params": [ { "name": "site_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Site Map" }, { "info": { "name": "startSiteMapsAutoGeofence", "type": "http" }, "http": { "method": "POST", "url": "https://api.mist.com/api/v1/sites/:site_id/maps/auto_geofences", "params": [ { "name": "site_id", "value": "", "type": "path" } ] }, "docs": "The auto geofence service is a map parsing service that uses map image data to identify the exterior of buildings in the map image also known as \"geofences\". This API processes all maps for a given SiteId. The maps must have an image to parse for the auto geofence service. Repeated POST requests to this endpoint while the auto geofence service is processing the map will be rejected." }, { "info": { "name": "importSiteMaps", "type": "http" }, "http": { "method": "POST", "url": "https://api.mist.com/api/v1/sites/:site_id/maps/import", "params": [ { "name": "site_id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [] } }, "docs": "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.\n\n# Note\nThis 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](#operation/importOrgMaps)\n\n# CSV File Format\n```csv\nVendor AP name" }, { "info": { "name": "getSiteMap", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/maps/:map_id", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "map_id", "value": "", "type": "path" } ] }, "docs": "Get Site Map Details" }, { "info": { "name": "updateSiteMap", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mist.com/api/v1/sites/:site_id/maps/:map_id", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "map_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Site Map" }, { "info": { "name": "deleteSiteMap", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mist.com/api/v1/sites/:site_id/maps/:map_id", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "map_id", "value": "", "type": "path" } ] }, "docs": "Delete Site Map" }, { "info": { "name": "startSiteMapAutoGeofence", "type": "http" }, "http": { "method": "POST", "url": "https://api.mist.com/api/v1/sites/:site_id/maps/:map_id/auto_geofences", "params": [ { "name": "map_id", "value": "", "type": "path" }, { "name": "site_id", "value": "", "type": "path" } ] }, "docs": "The auto geofence service is a map parsing service that uses map image data to identify the exterior of buildings in the map image also known as \"geofences\". This API processes a single given MapId. This map must have an image to parse for the auto geofence service. Repeated POST requests to this endpoint while the auto geofence service is processing the map will be rejected." }, { "info": { "name": "addSiteMapImage", "type": "http" }, "http": { "method": "POST", "url": "https://api.mist.com/api/v1/sites/:site_id/maps/:map_id/image", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "map_id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [] } }, "docs": "Add image map is a multipart POST which has an file (Image) and an optional json parameter" }, { "info": { "name": "deleteSiteMapImage", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mist.com/api/v1/sites/:site_id/maps/:map_id/image", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "map_id", "value": "", "type": "path" } ] }, "docs": "Delete Site Map Image" }, { "info": { "name": "replaceSiteMapImage", "type": "http" }, "http": { "method": "POST", "url": "https://api.mist.com/api/v1/sites/:site_id/maps/:map_id/replace", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "map_id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [] } }, "docs": "Replace Map Image\n\n\nThis works like an PUT where the image will be replaced. 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)" }, { "info": { "name": "bulkAssignSiteApsToMap", "type": "http" }, "http": { "method": "POST", "url": "https://api.mist.com/api/v1/sites/:site_id/maps/:map_id/set_map", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "map_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 \n1. if AP is unassigned to any Map, it gets associated with map_id \n2. Any moved APs are returned in the response \n3. If the AP is considered a locked AP, no action will be taken" }, { "info": { "name": "importSiteWayfindings", "type": "http" }, "http": { "method": "POST", "url": "https://api.mist.com/api/v1/sites/:site_id/maps/:map_id/wayfinding/import", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "map_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This imports the vendor map meta data into the Map JSON. This is required by the SDK and App in order to access/render the vendor Map properly." } ] } ], "bundled": true }