Version 2.1.1792967583 · latest Download OpenAPI Markdown

Site groups

Groups for organizing sites; names are unique within a tenant and a group that still contains sites cannot be deleted.

site-groupsSitesAuthentication: User (some parameters admin only)5 endpoints

List site groups

GET/api/v2/site-groups

Authentication: User (some parameters admin only)

Field	Type	Required	Description
page	integer	—	Page number, starting from 1 Default `1`
page_size	integer	—	Items per page Default `20`
sort	string	—	Sort fields, comma-separated; prefix `-` for descending, e.g. `-created_at,id`
tenant_id	integer	—	Admin only: filter by tenant. Ignored for tenant credentials, which only see their own tenant's data
ids	string	—	Only list these IDs: comma-separated positive integers, at most 200 after deduplication (same as the page_size limit; more returns 400); an empty value is the same as omitting it. Combined with other filters as an intersection; IDs you cannot see are silently left out. Pagination is unchanged: set page_size to at least the number of IDs to get them in one page

POST/api/v2/site-groups

Authentication: User (some parameters admin only)

Field	Type	Required	Description
tenant_id	integer	—	Owning tenant when an admin creates on behalf of a tenant (required); ignored for tenant callers, whose own account is always the owner.

Field	Type	Required	Description
des	string	—	Description
name	string	Required	Name

GET/api/v2/site-groups/{id}

Authentication: User (some parameters admin only)

PUT/api/v2/site-groups/{id}

Authentication: User (some parameters admin only)

Field	Type	Required	Description
des	string	—	Description
name	string	Required	Name

DELETE/api/v2/site-groups/{id}

Authentication: User (some parameters admin only)

Field	Type	Required	Description
created_at	string	—	Created at read-only
des	string	—	Description
id	integer	—	Record ID read-only
name	string	—	Name
tenant_id	integer	—	Owner tenant (user) ID read-only
updated_at	string	—	Updated at read-only