You are here: Scan > Scan by ID

/scan/{id}

Methods

GET

Gets the Scan associated with {id}.

Note: Although a Scan's Schedule 'dependentID' is stored as the schedule ID of the object a scan is dependent upon in the database, it is sent from and returned to the user as the ID of the actual scan object.

Fields Parameter

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

?fields=<field>,...

Allowed Fields

*id

**name

**description

**status

ipList

type

policy

plugin

repository

zone

dhcpTracking

classifyMitigatedAge

emailOnLaunch

emailOnFinish

timeoutAction

scanningVirtualHosts

rolloverType

createdTime

modifiedTime

ownerGroup

creator

owner

reports

assets

credentials

numDependents

schedule

policy

policyPrefs

maxScanTime

Legend

* = always comes back

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

Request Parameters

None

Expand Parameters

credentials

Example Response

{

"type" : "regular",

"response" : {

"id" : "4",

"name" : "POSTtest",

"description" : "This is a test for POST",

"ipList" : "",

"type" : "policy",

"dhcpTracking" : "false",

"classifyMitigatedAge" : "0",

"emailOnLaunch" : "false",

"emailOnFinish" : "false",

"timeoutAction" : "import",

"scanningVirtualHosts" : "false",

"rolloverType" : "template",

"status" : "0",

"createdTime" : "1406815242",

"modifiedTime" : "1406815242",

"reports" : [],

"assets" : [],

"numDependents" : "0",

"schedule" : {

"id" : "17",

"dependentID" : "14",

"objectType" : "scan",

"type" : "dependent",

"start" : "",

"repeatRule" : "",

"nextRun" : 0,

"dependent" : {

"id" : "14",

"name" : "Daily IP Scan",

"description" : "",

"status" : "1024"

}

},

"policy" : {

"id" : "1000002",

"name" : "POST TEST",

"description" : "Test of post for use with scan post test"

},

"policyPrefs" : [],

"repository" : {

"id" : "2",

"name" : "test",

"description" : "test"

},

"ownerGroup" : {

"id" : "0",

"name" : "Full Access",

"description" : "Full Access group"

},

"creator" : {

"id" : "1",

"username" : "head3",

"firstname" : "",

"lastname" : ""

},

"owner" : {

"id" : "1",

"username" : "head3",

"firstname" : "",

"lastname" : ""

}

},

"error_code" : 0,

"error_msg" : "",

"warnings" : [],

"timestamp" : 1406828664

}

Copyright © 2016. Tenable Network Security, Inc. All rights reserved. Tenable Network Security and Nessus are registered trademarks of Tenable Network Security, Inc. SecurityCenter Continuous View, Passive Vulnerability Scanner, and Log Correlation Engine are trademarks of Tenable Network Security, Inc. All other products or services are trademarks of their respective owners.