/scan
Methods
Gets the list of Scans.
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
Request Parameters
None
Expand Parameters
credentials
Filter Parameters
usable - The response will be an object containing an array of usable Scans. By default, both usable and manageable objects are returned.
manageable - The response will be an object containing all manageable Scans.. By default, both usable and manageable objects are returned.
Example Response
Adds a Scan, depending on access and permissions.
NOTE #1: A Blackout Window must not be in effect
NOTE #2: Setting schedule type to "template" means that the scan will not run on a schedule.
NOTE #3: If the field schedule frequency is "dependent", the field type cannot be "template"
NOTE #4: 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.
Request Parameters
Example Response
/scan/{id}
/scan/{uuid}
Methods
Gets the Scan associated with {id} or {uuid}.
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
Request Parameters
None
Expand Parameters
credentials
Example Response
Edits the Scan associated with {id} or {uuid}, changing only the passed in fields.
NOTE: A Scan's 'type' parameter cannot be changed.
Request Parameters
(All fields are optional)
See /scan::POST for parameters.
Example Response
See /scan/{id}::GETDeletes the Scan associated with {id} or {uuid}, depending on access and permissions.
Request Parameters
None
Example Response
/scan/{id}/copy
/scan/{uuid}/copy
Methods
Copies the Scan associated with {id} or {uuid}, depending on access and permissions.
Request Parameters
Example Response
/scan/{id}/launch
/scan/{uuid}/launch
Methods
Launches the Scan associated with {id} or {uuid}.
Request Parameters
NOTE: "diagnosticTarget" and "diagnosticPassword" are both optional, but must be provided together if present.