Groups Resource

Description

This resource is for listing accessible groups or creating new ones.

GET /groups

Get a list of groups, optionally filtered by query parameter. This is a paged query.

GET Parameters

Name	Required	Type	Description	Default Value
q	No	Query Parameter	Filter the returned results by group name, description, zone name, zone's description or subnets.

GET Response Values

Each data element will be a full group resource object.

Example GET Request

 GET /groups?q=documentation

Example GET Response

 {
    "rows": 1,
    "data": [
        {
            "name": "Test Group",
            "description": "Nick's group for documentation",
            "mode": "NONE",
            "customer_resource": "/customers/279",
            "zones_resource": "/groups/279/zones",
            "reports_resource": "/groups/279/report_statuses",
            "scheduled_reports_resource": "/groups/279/scheduled_reports",
            "customer_configurations_resource": "/groups/279/configurations",
            "customer_devices_resource": "/groups/279/mapped_devices",
            "customer_traffic_resource": "/groups/279/traffic",
            "customer_logs_resource": "/groups/279/logs",
            "group_resource": "/groups/279",
            "group_configurations_resource": "/groups/279/configurations",
            "group_traffic_resource": "/groups/279/traffic",
            "group_logs_resource": "/groups/279/logs",
            "members_resource": "/groups/279/members",
            "roles_resource": "/groups/279/roles",
            "users_resource": "/groups/279/users",
            "templates_resource": "/groups/279/templates",
            "subnets_resource": "/groups/279/subnets",
            "mapped_devices_resource": "/groups/279/mapped_devices",
            "pre_mapped_devices_resource": "/groups/279/pre_mapped_devices",
            "sub_groups_resource": "/groups/279/groups",
            "parent_resource": "/groups/0"
        }
    ],
    "start": 0
}

POST /groups

Create a new group.

POST Parameters

Name	Required	Type	Description	Default Value
group_id	No	JSON Number	This will be the parent group for the new group. If omitted, this will try to create the group as a child of the Default Group.	0
name	Yes	JSON String	The name for the new group.
description	No	JSON String	A description for the new group.

POST Response Values

The response will include the new full group resource object.

Example POST Request

POST /groups
 
JSON Body:
{
    "group_id": 407,
    "data": {
        "name": "New group.",
        "description": "Created for API documentation."
    }
}

Example POST Response

HTTP/1.1 201 Created
 
{
    "name": "New group.",
    "description": "Created for API documentation.",
    "mode": "NONE",
    "customer_resource": "/customers/715",
    "zones_resource": "/groups/715/zones",
    "reports_resource": "/groups/715/report_statuses",
    "scheduled_reports_resource": "/groups/715/scheduled_reports",
    "customer_configurations_resource": "/groups/715/configurations",
    "customer_devices_resource": "/groups/715/mapped_devices",
    "customer_traffic_resource": "/groups/715/traffic",
    "customer_logs_resource": "/groups/715/logs",
    "group_resource": "/groups/715",
    "group_configurations_resource": "/groups/715/configurations",
    "group_traffic_resource": "/groups/715/traffic",
    "group_logs_resource": "/groups/715/logs",
    "members_resource": "/groups/715/members",
    "roles_resource": "/groups/715/roles",
    "users_resource": "/groups/715/users",
    "templates_resource": "/groups/715/templates",
    "subnets_resource": "/groups/715/subnets",
    "mapped_devices_resource": "/groups/715/mapped_devices",
    "pre_mapped_devices_resource": "/groups/715/pre_mapped_devices",
    "sub_groups_resource": "/groups/715/groups",
    "parent_resource": "/groups/407"
}