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 Details

  • Method Details

    • 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(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(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(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(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(String id, 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(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