SitesMapsAuto-Zone
getSiteMapAutoZoneStatus
This API provides the current status of the auto zones service for a given map
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
map_id*string
Format
uuidsite_id*string
Format
uuidResponse Body
curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/maps/000000ab-00ab-00ab-00ab-0000000000ab/auto_zones"{ "status": "awaiting_review", "zones": [ { "name": "zone1", "vertices": [ { "x": 0, "y": 0 }, { "x": 0, "y": 10 }, { "x": 10, "y": 10 }, { "x": 10, "y": 0 } ] }, { "name": "zone2", "vertices": [ { "x": 0, "y": 0 }, { "x": 0, "y": 20 }, { "x": 20, "y": 20 }, { "x": 20, "y": 0 } ] } ]}deleteSiteApAutoplacement DELETE
This API is called to force stop auto placement for a given map
startSiteMapAutoZone POST
This API starts the auto zones service for a specified map. This map must have an image to parse for the auto zones service. Repeated POST requests to this endpoint while the auto zones service is processing the map will be rejected.