ZAP API UI

Component: pscan

Allows to access and configure core passive scanning capabilities.

Views

currentRuleDeprecated API Endpoint. Its use is discouraged, it will be removed in a future version.
Use the currentTasks view instead.
Shows information about the passive scan rule currently being run (if any).
currentTasksShows information about the passive scan tasks currently being run (if any).
maxAlertsPerRuleGets the maximum number of alerts a passive scan rule should raise.
recordsToScanThe number of records the passive scanner still has to scan.
scanOnlyInScopeTells whether or not the passive scan should be performed only on messages that are in scope.
scannersLists all passive scan rules with their ID, name, enabled state, and alert threshold.

Actions

clearQueueClears the passive scan queue.
disableAllScannersDisables all passive scan rules.
disableAllTagsDisables all passive scan tags.
disableScanners (ids* ) Disables passive scan rules.
enableAllScannersEnables all passive scan rules.
enableAllTagsEnables all passive scan tags.
enableScanners (ids* ) Enables passive scan rules.
setEnabled (enabled* ) Sets whether or not the passive scanning is enabled (Note: the enabled state is not persisted).
setMaxAlertsPerRule (maxAlerts* ) Sets the maximum number of alerts a passive scan rule can raise.
setScanOnlyInScope (onlyInScope* ) Sets whether or not the passive scan should be performed only on messages that are in scope.
setScannerAlertThreshold (id* alertThreshold* ) Sets the alert threshold of a passive scan rule.