Zones Resource

Description

This resource lists the zones that you have permission to access and lets you create new ones.

GET /zones

Lists all zones you have permission to access. This is a paged query.

GET Parameters

Name	Required	Type	Description	Default Value
ip	No	Query Parameter	Filter by the zone's subnet IPs
vlan	No	Query Parameter	Filter by zone VLAN. Not a currently supported configuration option.
name	No	Query Parameter	Filter by the display name of the zone.
q	No	Query Parameter	Generic query to filter by subnet name, description, subnet IPs, or VLAN .
include_prefix	No	Query Parameter	If included and set to true, the list of prefixes used for each Zone's routes will be included in the result. Supported in rWeb 9.1+.

GET Response Values

Each element in the data array will be a full zone resource object.

Example GET Request

 GET /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": "Electric 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 /zones

Create a new zone.

POST Parameters

Name	Required	Type	Description	Default Value
group_id	Depends, see description	Query Parameter	The numeric ID of the group the new zone should be created in. Can be omitted if using "group_resource" instead, but at least one of these two values must be used.
group_resource	Depends, see description	JSON String	The group resource of the group the new zone should be created in. Can be omitted if using "group_id" instead, but at least one of these two values must be used.
name	Yes	JSON String	The display name of the new zone.
description	No	JSON String	A description for the new zone.

POST Response Values

Returns the newly created zone resource object.

Example POST Request

POST /zones

JSON Body:
{
    "data": {
        "group_resource": "/groups/407",
        "name": "New API Group"
    }
}

Example POST Response

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