Group Zones Resource

Description

This resource is for manipulating the zones associated with a group.

GET /groups/:ID/zones

Get all zones associated with 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 you want to query.
q	No	Query Parameter	Filter results by zone name, description, or subnets.

GET Response Values

Each data element will be a zone resource object.

Example GET Request

 GET /groups/407/zones

Example GET Response

{
    "rows": 1,
    "data": [
        {
            "id": 3026,
            "name": "Overloaded Zone A",
            "description": null,
            "revisions_resource": "/zones/3026/revisions",
            "subnets_resource": "/zones/3026/subnets",
            "configurations_resource": "/zones/3026/configurations",
            "victims_resource": "/zones/3026/victims",
            "traffic_resource": "/zones/3026/traffic",
            "group_resource": "/groups/407",
            "group_name": "Electic bugaloo",
            "customer_resource": "/customers/407",
            "customer_name": "Electic bugaloo",
            "zone_resource": "/zones/3026",
            "toplists_resource": "/zones/3026/toplists",
            "toplists_all_resource": "/zones/3026/toplists/all",
            "topapps_resource": "/zones/3026/topapps",
            "topapps_all_resource": "/zones/3026/topapps/all",
            "topprotocols_resource": "/zones/3026/topprotocols",
            "topprotocols_all_resource": "/zones/3026/topprotocols/all",
            "topvlans_resource": "/zones/3026/topvlans",
            "topvlans_all_resource": "/zones/3026/topvlans/all",
            "topattackers_resource": "/zones/3026/topattackers",
            "topattackers_all_resource": "/zones/3026/topattackers/all",
            "log_resource": "/zones/3026/logs",
            "revision_current_resource": "/zones/3026/revisions/current",
            "zone_devices_resource": "/zones/3026/devices",
            "is_under_attack_resource": "/zones/3026/is_under_attack",
            "template_resource": "/zones/3026/template",
            "filter_list_requests_resource": "/zones/3026/filter_list_requests",
            "filter_list_resource": "/zones/3026/filter_list",
            "tcp_dumps_resource": "/zones/3026/tcp_dump"
        }
    ],
    "start": 0
} 

POST /groups/:ID/zones

Create a new zone for the given group.

POST Parameters

Name	Required	Type	Description	Default Value
:ID	Yes	URL Parameter	The unique numeric ID of the group you're creating a zone for.
name	Yes	JSON String	The name of the new zone
description	No	JSON String	A description of the new zone.

POST Response Values

The response will be the newly created zone resource object.

Example POST Request

POST /groups/407/zones
 
JSON Body:
{
    "data":{
        "name":"New Test Zone"
    }
}

Example POST Response

HTTP/1.1 201 Created
 
{
    "id": 3999,
    "name": "New Test Zone",
    "description": null,
    "revisions_resource": "/zones/3999/revisions",
    "subnets_resource": "/zones/3999/subnets",
    "configurations_resource": "/zones/3999/configurations",
    "victims_resource": "/zones/3999/victims",
    "traffic_resource": "/zones/3999/traffic",
    "group_resource": "/groups/407",
    "group_name": "Electic bugaloo",
    "customer_resource": "/customers/407",
    "customer_name": "Electic bugaloo",
    "zone_resource": "/zones/3999",
    "toplists_resource": "/zones/3999/toplists",
    "toplists_all_resource": "/zones/3999/toplists/all",
    "topapps_resource": "/zones/3999/topapps",
    "topapps_all_resource": "/zones/3999/topapps/all",
    "topprotocols_resource": "/zones/3999/topprotocols",
    "topprotocols_all_resource": "/zones/3999/topprotocols/all",
    "topvlans_resource": "/zones/3999/topvlans",
    "topvlans_all_resource": "/zones/3999/topvlans/all",
    "topattackers_resource": "/zones/3999/topattackers",
    "topattackers_all_resource": "/zones/3999/topattackers/all",
    "log_resource": "/zones/3999/logs",
    "revision_current_resource": "/zones/3999/revisions/current",
    "zone_devices_resource": "/zones/3999/devices",
    "is_under_attack_resource": "/zones/3999/is_under_attack",
    "template_resource": "/zones/3999/template",
    "filter_list_requests_resource": "/zones/3999/filter_list_requests",
    "filter_list_resource": "/zones/3999/filter_list",
    "tcp_dumps_resource": "/zones/3999/tcp_dump"
}

DELETE /groups/:ID/zones

Deletes **all **zones associated with this group. If you want to delete single zones, use the get query for the full list of zone resources, then delete the individual zone resources you wish to remove.

DELETE Parameters

Name	Required	Type	Description	Default Value
:ID	Yes	URL Parameter	The unique numeric ID of the group.

Example DELETE Request

 DELETE /groups/407/zones

Example DELETE Response

 HTTP/1.1 200 OK