Skip to main content

IoT API

📄️Create Organization Groups

Create one or more groups in the organization hierarchy. Send one group, or an array of up to 1000 groups. <br/> A `parent` can be an existing group or a group listed earlier in the same request, so several levels can be created in one request: list each parent before its children. An empty, `null` or omitted `parent` creates the group directly under the top-level group. <br/> Group names are unique in a tenant. The hierarchy can be at most five levels deep, counting the top-level group. <br/> The request is all or nothing: if any group is rejected (for example a name that is already used, a parent that does not exist or is listed after its child, or a group that would be too deep), the request returns HTTP 400 and no group is created. <br/> For customers using the IoT Standalone Portal, refer to IoT Standalone Public API Authentication page.

📄️Get Organization Hierarchy

Retrieve the organization hierarchy as one list: the top-level group (named after the tenant), its groups and subgroups, and the sites in each group, as shown on the Sites page of the Device Security GUI. <br/> Each node has its `name`, its `type` (`root`, `group` or `site`), the name of its `parent` group, and its `path` (the names from the top-level group down to the node). For a site, `name` is the site's `external_id`, the value shown as 'Name' in the GUI. <br/> Nodes are listed depth first, and the groups and sites under each parent are sorted by name. Sites that are not in any group are listed under the top-level group, and groups without sites are included. Only the groups and sites your account can access are returned; the top-level group is always returned. <br/> Use `group` to get one group and everything beneath it, and `type` to keep one kind of node. An unknown query parameter returns HTTP 400. <br/> For customers using the IoT Standalone Portal, refer to IoT Standalone Public API Authentication page.

📄️Rename or Move an Organization Group

Rename one group, move it under another group, or both. The group keeps its subgroups and sites, and a move takes them along. <br/> Groups are identified by name, so renaming a group changes the name that scripts and integrations must use for it. <br/> The top-level group cannot be renamed or moved. A move that would place a group under itself or one of its subgroups, or make the hierarchy deeper than five levels (counting the top-level group), returns HTTP 400. If another request moves a group at the same time and the two moves conflict, the request returns HTTP 400 without making a change; retry it. <br/> For customers using the IoT Standalone Portal, refer to IoT Standalone Public API Authentication page.