> User Documentation Home

User Handbook
Tutorials
Resources

The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

ZAP Pipeline Plugin

View this plugin on the Plugins site

archiveZap: Create & Archive ZAP report

  • failAllAlerts
    • Type: int
  • failHighAlerts
    • Type: int
  • failMediumAlerts
    • Type: int
  • failLowAlerts
    • Type: int
  • falsePositivesFilePath
    • Type: String
  • keepAlive
    • Type: boolean

configurePassiveRules: Configures the list of passive rules to apply / avoid (https://www.zaproxy.org/docs/alerts/)

  • action
    • Type: String
  • ids
    • Type: Array / List of int

importZapScanPolicy: Import a ZAP scan policy from the specified path

  • policyPath
    • Type: String

importZapUrls: Load a list of URLs for ZAP to use from the specified path

  • path
    • Type: String

runZapAttack: Run ZAP attack by changing to attack mode and starting the attack

  • scanPolicyName
    • Type: String
  • userId
    • Type: int
  • contextId
    • Type: int
  • recurse
    • Type: boolean
  • inScopeOnly
    • Type: boolean
  • method
    • Type: String
  • postData
    • Type: String

runZapCrawler: Run ZAP crawler on a specified host

  • host
    • Type: String
  • maxChildren
    • Type: int
  • contextName
    • Type: String
  • contextId
    • Type: int
  • subtreeOnly
    • Type: boolean
  • recurse
    • Type: boolean
  • userId
    • Type: int

startZap: Start ZAP process

  • host
    • Type: String
  • port
    • Type: int
  • timeout
    • Type: int
  • zapHome
    • Type: String
  • allowedHosts
    • Type: Array / List of String
  • sessionPath
    • Type: String
  • externalZap
    • Type: boolean
  • rootCaFile
    • Type: String
  • additionalConfigurations
    • Type: Array / List of String

stopZap: Stop the ZAP instance.

    Was this page helpful?

    Please submit your feedback about this page through this quick form.

    Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

        


    See existing feedback here.