Group Groups Resource

Description

This resource lists or creates children groups for a given group.

GET /groups/:ID/groups

List the children groups of the given group. This is a paged query.

GET Parameters

Name	Required	Type	Description	Default Value
:ID	Yes	URL Parameter	The numeric ID of the group whose children groups you are querying.
q	No	Query Parameter	Filter responses based on child group names or descriptions.

GET Response Values

Every returned element will be a group resource object.

Example GET Request

 GET /groups/407/groups

Example GET Response

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

POST /groups/:ID/groups

Create a child group under the given group.

POST Parameters

Name	Required	Type	Description	Default Value
:ID	Yes	URL Parameter	The numeric ID of the group under which you are creating a child.
name	Yes	JSON String	The name of the new group to be created.
description	No	JSON String	The description for the new group.

POST Response Values

The response will be the new group resource object for the created group.

Example POST Request

POST /groups/407/groups
 
JSON Body:
{
    "data":{
        "name":"Second new group.",
        "description": "Also for API documentation."
    }
}

Example POST Response

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