Comment on page
Zones
The
/zones endpoint provide access to discover, create and manage zones available. For more information on the role that zones play, see:Attribute | Type | Description |
id | string | Unique ID the represents the zone. |
name | string | Human readable name. |
description | string | Long form description of the zone. |
tags | string | Tags that provide context for the zone use. E.g. org, buidling, level. |
settings | object | JSON object containing configuration linked to this zone. |
triggers | array | List of trigger ID's to be applied to all systems that associate with this zone. |
created_at | integer | Timestamp of creation. |
get
https://example.com
/api/control/zones
Search
Queries default to searching for any of the entered terms (words). A small query language provides the ability to structure complex queries.
Operator | Action | |
+ | Matches both terms. | |
` | ` | Matches either terms. |
- | Negates a single token. | |
" | Wraps tokens to form a phrase. | |
( and ) | Provide precedence. | |
~N | Specifies edit distance (fuzziness) after a word. | |
~N | Specifies slop amount (deviation) after a phrase. | |
post
https://example.com
/api/control/zones
Create
get
https://example.com
/api/control/zones/{id}
Retrieve
put
https://example.com
/api/control/zones/{id}
Update
delete
https://example.com
/api/control/zones/{id}
Delete
Last modified 3yr ago