Scanner REST Reference

/scanner

Methods
GET

Gets the list of Scanners.

NOTE: This call will return all Scanners for an Administrator. For an Organization User, it will only return agent-capable Scanners associated with that User's Organization.

Fields Parameter
Expand

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

    ?fields=<field>,...

Allowed Fields (Admin User)

*id
**name
**description
**status
ip
port
useProxy
enabled
verifyHost
managePlugins
authType
cert
username
password
agentCapable
version
webVersion
admin
msp
numScans
numHosts
numSessions
numTCPSessions
loadAvg
uptime
pluginSet
loadedPluginSet
serverUUID
createdTime
modifiedTime
zones
nessusManagerOrgs

Allowed Fields (Org User)

*id
**name
**description
**status
agentCapable

Legend

* = always comes back

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

None

Example Response
Expand
{
	"type" : "regular",
	"response" : [
		{
			"id" : "12",
			"name" : "Scanner 1",
			"description" : "Copied from QA",
			"status" : "1"
		},
		{
			"id" : "14",
			"name" : "Scanner using Safe Scan Range",
			"description" : "",
			"status" : "16"
		},
		{
			"id" : "15",
			"name" : "mp zone 1 scanner",
			"description" : "Copied from QA",
			"status" : "1"
		},
		{
			"id" : "16",
			"name" : "NessusTest",
			"description" : "Copied From QA",
			"status" : "32"
		},
		{
			"id" : "17",
			"name" : "sc",
			"description" : "",
			"status" : "2"
		}
	],
	"error_code" : 0,
	"error_msg" : "",
	"warnings" : [],
	"timestamp" : 1426878501
}