Package org.zaproxy.clientapi.gen

Class Pscan

java.lang.Object

org.zaproxy.clientapi.gen.deprecated.PscanDeprecated

org.zaproxy.clientapi.gen.Pscan

public class Pscan
extends PscanDeprecated

This file was automatically generated.

Constructor Summary

Constructors

Constructor	Description
Pscan(ClientApi api)

Method Summary

Modifier and Type	Method	Description
ApiResponse	clearQueue()	Clears the passive scan queue.
ApiResponse	currentRule()	Deprecated.
ApiResponse	currentTasks()	Shows information about the passive scan tasks currently being run (if any).
ApiResponse	disableAllScanners()	Disables all passive scan rules.
ApiResponse	disableAllTags()	Disables all passive scan tags.
ApiResponse	disableScanners(java.lang.String ids)	Disables passive scan rules.
ApiResponse	enableAllScanners()	Enables all passive scan rules.
ApiResponse	enableAllTags()	Enables all passive scan tags.
ApiResponse	enableScanners(java.lang.String ids)	Enables passive scan rules.
ApiResponse	maxAlertsPerRule()	Gets the maximum number of alerts a passive scan rule should raise.
ApiResponse	recordsToScan()	The number of records the passive scanner still has to scan.
ApiResponse	scanners()	Lists all passive scan rules with their ID, name, enabled state, and alert threshold.
ApiResponse	scanOnlyInScope()	Tells whether or not the passive scan should be performed only on messages that are in scope.
ApiResponse	setEnabled(java.lang.String enabled)	Sets whether or not the passive scanning is enabled (Note: the enabled state is not persisted).
ApiResponse	setMaxAlertsPerRule(java.lang.String maxalerts)	Sets the maximum number of alerts a passive scan rule can raise.
ApiResponse	setScannerAlertThreshold(java.lang.String id, java.lang.String alertthreshold)	Sets the alert threshold of a passive scan rule.
ApiResponse	setScanOnlyInScope(java.lang.String onlyinscope)	Sets whether or not the passive scan should be performed only on messages that are in scope.

Methods inherited from class org.zaproxy.clientapi.gen.deprecated.PscanDeprecated

disableAllScanners, disableScanners, enableAllScanners, enableScanners, setEnabled, setScannerAlertThreshold

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

scanOnlyInScope

public ApiResponse scanOnlyInScope()
                            throws ClientApiException

Tells whether or not the passive scan should be performed only on messages that are in scope.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

recordsToScan

public ApiResponse recordsToScan()
                          throws ClientApiException

The number of records the passive scanner still has to scan.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

scanners

public ApiResponse scanners()
                     throws ClientApiException

Lists all passive scan rules with their ID, name, enabled state, and alert threshold.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

currentRule

@Deprecated
public ApiResponse currentRule()
                        throws ClientApiException

Deprecated.

Shows information about the passive scan rule currently being run (if any).

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

currentTasks

public ApiResponse currentTasks()
                         throws ClientApiException

Shows information about the passive scan tasks currently being run (if any).

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

maxAlertsPerRule

public ApiResponse maxAlertsPerRule()
                             throws ClientApiException

Gets the maximum number of alerts a passive scan rule should raise.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

setEnabled

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

Sets whether or not the passive scanning is enabled (Note: the enabled state is not persisted).

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

setScanOnlyInScope

public ApiResponse setScanOnlyInScope(java.lang.String onlyinscope)
                               throws ClientApiException

Sets whether or not the passive scan should be performed only on messages that are in scope.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

enableAllScanners

public ApiResponse enableAllScanners()
                              throws ClientApiException

Enables all passive scan rules.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

disableAllScanners

public ApiResponse disableAllScanners()
                               throws ClientApiException

Disables all passive scan rules.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

enableScanners

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

Enables passive scan rules.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

disableScanners

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

Disables passive scan rules.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

setScannerAlertThreshold

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

Sets the alert threshold of a passive scan rule.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

setMaxAlertsPerRule

public ApiResponse setMaxAlertsPerRule(java.lang.String maxalerts)
                                throws ClientApiException

Sets the maximum number of alerts a passive scan rule can raise.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

disableAllTags

public ApiResponse disableAllTags()
                           throws ClientApiException

Disables all passive scan tags.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

enableAllTags

public ApiResponse enableAllTags()
                          throws ClientApiException

Enables all passive scan tags.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException

clearQueue

public ApiResponse clearQueue()
                       throws ClientApiException

Clears the passive scan queue.

This component is optional and therefore the API will only work if it is installed

Throws:

ClientApiException