SitesZones

createSiteZone

POST
/api/v1/sites/{site_id}/zones

Create Site Zone

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

Request Body

application/json

Request Body

Zone defined on a site map

name?string

Display name of the zone

vertices?array<>

Polygon vertices that define the zone boundary

Response Body

curl -X POST "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/zones" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "vertices": [      {        "x": 0,        "y": 0      }    ]  }'
{  "created_time": 0,  "id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",  "map_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",  "modified_time": 0,  "name": "string",  "org_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",  "site_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",  "vertices": [    {      "x": 0,      "y": 0    }  ]}