org.zaproxy.clientapi.gen

Class Pscan

java.lang.Object

org.zaproxy.clientapi.gen.Pscan

public class Pscan
extends java.lang.Object

This file was automatically generated.

Constructor Summary

Constructors

Constructor and Description
Pscan(ClientApi api)

Method Summary

Modifier and Type	Method and Description
ApiResponse	disableAllScanners(java.lang.String apikey) Disables all passive scanners
ApiResponse	disableScanners(java.lang.String apikey, java.lang.String ids) Disables all passive scanners with the given IDs (comma separated list of IDs)
ApiResponse	enableAllScanners(java.lang.String apikey) Enables all passive scanners
ApiResponse	enableScanners(java.lang.String apikey, java.lang.String ids) Enables all passive scanners with the given IDs (comma separated list of IDs)
ApiResponse	recordsToScan() The number of records the passive scanner still has to scan
ApiResponse	scanners() Lists all passive scanners with its ID, name, enabled state and alert threshold.
ApiResponse	setEnabled(java.lang.String apikey, java.lang.String enabled) Sets whether or not the passive scanning is enabled
ApiResponse	setScannerAlertThreshold(java.lang.String apikey, java.lang.String id, java.lang.String alertthreshold) Sets the alert threshold of the passive scanner with the given ID, accepted values for alert threshold: OFF, DEFAULT, LOW, MEDIUM and HIGH

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Pscan

public Pscan(ClientApi api)

Method Detail

recordsToScan

public ApiResponse recordsToScan()
                          throws ClientApiException

The number of records the passive scanner still has to scan

Throws:

ClientApiException

scanners

public ApiResponse scanners()
                     throws ClientApiException

Lists all passive scanners with its ID, name, enabled state and alert threshold.

Throws:

ClientApiException

setEnabled

public ApiResponse setEnabled(java.lang.String apikey,
                              java.lang.String enabled)
                       throws ClientApiException

Sets whether or not the passive scanning is enabled

Throws:

ClientApiException

enableAllScanners

public ApiResponse enableAllScanners(java.lang.String apikey)
                              throws ClientApiException

Enables all passive scanners

Throws:

ClientApiException

disableAllScanners

public ApiResponse disableAllScanners(java.lang.String apikey)
                               throws ClientApiException

Disables all passive scanners

Throws:

ClientApiException

enableScanners

public ApiResponse enableScanners(java.lang.String apikey,
                                  java.lang.String ids)
                           throws ClientApiException

Enables all passive scanners with the given IDs (comma separated list of IDs)

Throws:

ClientApiException

disableScanners

public ApiResponse disableScanners(java.lang.String apikey,
                                   java.lang.String ids)
                            throws ClientApiException

Disables all passive scanners with the given IDs (comma separated list of IDs)

Throws:

ClientApiException

setScannerAlertThreshold

public ApiResponse setScannerAlertThreshold(java.lang.String apikey,
                                            java.lang.String id,
                                            java.lang.String alertthreshold)
                                     throws ClientApiException

Sets the alert threshold of the passive scanner with the given ID, accepted values for alert threshold: OFF, DEFAULT, LOW, MEDIUM and HIGH

Throws:

ClientApiException