OrgsMaps

importOrgMapToSite

POST
/api/v1/orgs/{org_id}/sites/{site_name}/maps/import

Import floorplan data into a site from a multipart upload. The upload includes an Ekahau or iBwave floorplan file, optional import options JSON, and optional AP name-mapping CSV; matching inventory can be assigned to the site and APs placed when names or MAC addresses match.

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

org_id*string
Formatuuid
site_name*string

Request Body

multipart/form-data

a JSON string, site id required, vendor option: ekahau, ibwave, etc., import_all_floorplans: optional, default: false, import_height: optional, default: true, import_orientation: optional, default: true "file": a binary file, option: .esx "csv": a csv file for ap name mapping, optional

Multipart payload for importing map files at site scope

auto_deviceprofile_assignment?boolean

Whether to auto assign device to deviceprofile by name

csv?string

Optional AP name-mapping CSV file

file?string

Ekahau or iBwave floorplan file to import

json?

Import options for the site map file

Response Body

curl -X POST "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/sites/string/maps/import"

{  "aps": [    {      "action": "assigned-placed",      "floorplan_id": "6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9",      "height": 3,      "mac": "5c5b35000001",      "map_id": "845a23bf-bed9-e43c-4c86-6fa474be7ae5",      "orientation": 45    }  ],  "floorplans": [    {      "action": "imported",      "id": "cbdb7f0b-3be0-4872-88f9-58790b509c23",      "map_id": "845a23bf-bed9-e43c-4c86-6fa474be7ae5",      "name": "map1"    }  ],  "site_id": "4ac1dcf4-9d8b-7211-65c4-057819f0862b",  "summary": {    "num_ap_assigned": 1,    "num_inv_assigned": 1,    "num_map_assigned": 1  }}