SitesMaps

bulkAssignSiteApsToMap

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

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

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 containing one or more MAC addresses

macs*array<string>

List of MAC addresses included in the request

Items1 <= items

Response Body

curl -X POST "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/maps/000000ab-00ab-00ab-00ab-0000000000ab/set_map" \  -H "Content-Type: application/json" \  -d '{    "macs": [      "5c5b35000001",      "5c5b35584a6f"    ]  }'
{  "locked": [    "5c5b35584a6f"  ],  "moved": [    "5c5b35000001"  ]}