Overview
Demos and Resources
Contact
Search…
What is Engine?
Key Concepts
Security
Deployment
System Architecture
Single Sign-On
Integrations
Supported Integrations
Directory Services
IoT
Location Services
Administration
Backoffice
Developer Guide
Development Environment
Building Drivers
User Interfaces
API
Authentication
Control
Systems
Modules
Dependencies
Zones
Websocket
Support
Service Desk
Powered By
GitBook
Zones
The
/zones
endpoint provide access to discover, create and manage zones available. For more information on the role that zones play, see:
Zones
Model
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.
Discovery
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.
​
Management
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
Previous
Dependencies
Next
Websocket
Last modified
2yr ago
Copy link
Contents
Model
Discovery
get
Search
Management
post
Create
get
Retrieve
put
Update
delete
Delete