Scan Zone REST Reference

/zone

Methods
GET

Gets the list of Zones

Fields Parameter
Expand

The fields parameter should be specified along the query string, and it takes the syntax

    ?fields=<field>,...

Allowed Fields

*id
**name
**description
**ipList
**createdTime
**modifiedTime
**organizations
**activeScanners
**totalScanners
**scanners

Legend

* = always comes back

** = comes back if fields list not specified on GET all
Request Parameters

None

Example Response
Expand
{
	"type" : "regular",
	"response" : [
		{
			"id" : "5",
			"name" : "Test Zone #1",
			"description" : "",
			"ipList" : "192.168.0.0\/24",
			"createdTime" : "1426871916",
			"modifiedTime" : "1426881426",
			"scanners" : [
				{
					"id" : "2",
					"name" : "Nessus 192.168.1.145:1234",
					"description" : "",
					"status" : "4"
				}
			],
			"organizations" : [
				{
					"id" : "38",
					"name" : "Test Org",
					"description" : ""
				}
			],
			"activeScanners" : 0,
			"totalScanners" : 1
		},
		{
			"id" : "6",
			"name" : "Test Zone #2",
			"description" : "",
			"ipList" : "192.168.0.0\/24",
			"createdTime" : "1426871931",
			"modifiedTime" : "1426871931",
			"scanners" : [],
			"organizations" : [],
			"activeScanners" : 0,
			"totalScanners" : 0
		}
	],
	"error_code" : 0,
	"error_msg" : "",
	"warnings" : [],
	"timestamp" : 1426882493
}