txt: ## dist_github-khalidelboray-Zap.md
  ## Chunk 3 of 3
   - typically invoked via ZAP
  
  ## class Zap::Search
  
  class `Zap::Search` Methods
  
  ### method harByHeaderRegex
  
  ```
  method harByHeaderRegex(
      :$regex!,
      :$baseurl,
      :$start,
      :$count
  ) returns Mu
  
  ```
  
  Returns the HTTP messages, in HAR format, that match the given regular expression in the header(s) optionally filtered by URL and paginated with 'start' position and 'count' of messages.
  
  ### method harByRequestRegex
  
  ```
  method harByRequestRegex(
      :$regex!,
      :$baseurl,
      :$start,
      :$count
  ) returns Mu
  
  ```
  
  Returns the HTTP messages, in HAR format, that match the given regular expression in the request optionally filtered by URL and paginated with 'start' position and 'count' of messages.
  
  ### method harByResponseRegex
  
  ```
  method harByResponseRegex(
      :$regex!,
      :$baseurl,
      :$start,
      :$count
  ) returns Mu
  
  ```
  
  Returns the HTTP messages, in HAR format, that match the given regular expression in the response optionally filtered by URL and paginated with 'start' position and 'count' of messages.
  
  ### method harByUrlRegex
  
  ```
  method harByUrlRegex(
      :$regex!,
      :$baseurl,
      :$start,
      :$count
  ) returns Mu
  
  ```
  
  Returns the HTTP messages, in HAR format, that match the given regular expression in the URL optionally filtered by URL and paginated with 'start' position and 'count' of messages.
  
  ### method messagesByResponseRegex
  
  ```
  method messagesByResponseRegex(
      :$regex!,
      :$baseurl,
      :$start,
      :$count
  ) returns Mu
  
  ```
  
  Returns the HTTP messages that match the given regular expression in the response optionally filtered by URL and paginated with 'start' position and 'count' of messages.
  
  ### method messagesByUrlRegex
  
  ```
  method messagesByUrlRegex(
      :$regex!,
      :$baseurl,
      :$start,
      :$count
  ) returns Mu
  
  ```
  
  Returns the HTTP messages that match the given regular expression in the URL optionally filtered by URL and paginated with 'start' position and 'count' of messages.
  
  ### method urlsByHeaderRegex
  
  ```
  method urlsByHeaderRegex(
      :$regex!,
      :$baseurl,
      :$start,
      :$count
  ) returns Mu
  
  ```
  
  Returns the URLs of the HTTP messages that match the given regular expression in the header(s) optionally filtered by URL and paginated with 'start' position and 'count' of messages.
  
  ### method urlsByRequestRegex
  
  ```
  method urlsByRequestRegex(
      :$regex!,
      :$baseurl,
      :$start,
      :$count
  ) returns Mu
  
  ```
  
  Returns the URLs of the HTTP messages that match the given regular expression in the request optionally filtered by URL and paginated with 'start' position and 'count' of messages.
  
  ### method urlsByResponseRegex
  
  ```
  method urlsByResponseRegex(
      :$regex!,
      :$baseurl,
      :$start,
      :$count
  ) returns Mu
  
  ```
  
  Returns the URLs of the HTTP messages that match the given regular expression in the response optionally filtered by URL and paginated with 'start' position and 'count' of messages.
  
  ### method urlsByUrlRegex
  
  ```
  method urlsByUrlRegex(
      :$regex!,
      :$baseurl,
      :$start,
      :$count
  ) returns Mu
  
  ```
  
  Returns the URLs of the HTTP messages that match the given regular expression in the URL optionally filtered by URL and paginated with 'start' position and 'count' of messages.
  
  ## class Zap::Replacer
  
  class `Zap::Replacer` Methods
  
  ### method removeRule
  
  ```
  method removeRule(
      :$description!
  ) returns Mu
  
  ```
  
  Removes the rule with the given description
  
  ### method setEnabled
  
  ```
  method setEnabled(
      :$description!,
      :$bool!
  ) returns Mu
  
  ```
  
  Enables or disables the rule with the given description based on the bool parameter
  
  ## class Zap::Context
  
  class `Zap::Context` Methods
  
  ### method excludeAllContextTechnologies
  
  ```
  method excludeAllContextTechnologies(
      :$contextName!
  ) returns Mu
  
  ```
  
  Excludes all built in technologies from a context
  
  ### method excludeContextTechnologies
  
  ```
  method excludeContextTechnologies(
      :$contextName!,
      :$technologyNames!
  ) returns Mu
  
  ```
  
  Excludes technologies with the given names, separated by a comma, from a context
  
  ### method excludeFromContext
  
  ```
  method excludeFromContext(
      :$contextName!,
      :$regex!
  ) returns Mu
  
  ```
  
  Add exclude regex to context
  
  ### method exportContext
  
  ```
  method exportContext(
      :$contextName!,
      :$contextFile!
  ) returns Mu
  
  ```
  
  Exports the context with the given name to a file. If a relative file path is specified it will be resolved against the "contexts" directory in ZAP "home" dir.
  
  ### method importContext
  
  ```
  method importContext(
      :$contextFile!
  ) returns Mu
  
  ```
  
  Imports a context from a file. If a relative file path is specified it will be resolved against the "contexts" directory in ZAP "home" dir.
  
  ### method includeAllContextTechnologies
  
  ```
  method includeAllContextTechnologies(
      :$contextName!
  ) returns Mu
  
  ```
  
  Includes all built in technologies in to a context
  
  ### method includeContextTechnologies
  
  ```
  method includeContextTechnologies(
      :$contextName!,
      :$technologyNames!
  ) returns Mu
  
  ```
  
  Includes technologies with the given names, separated by a comma, to a context
  
  ### method includeInContext
  
  ```
  method includeInContext(
      :$contextName!,
      :$regex!
  ) returns Mu
  
  ```
  
  Add include regex to context
  
  ### method newContext
  
  ```
  method newContext(
      :$contextName!
  ) returns Mu
  
  ```
  
  Creates a new context with the given name in the current session
  
  ### method removeContext
  
  ```
  method removeContext(
      :$contextName!
  ) returns Mu
  
  ```
  
  Removes a context in the current session
  
  ### method setContextInScope
  
  ```
  method setContextInScope(
      :$contextName!,
      :$booleanInScope!
  ) returns Mu
  
  ```
  
  Sets a context to in scope (contexts are in scope by default)
  
  ### method setContextRegexs
  
  ```
  method setContextRegexs(
      :$contextName!,
      :$incRegexs!,
      :$excRegexs!
  ) returns Mu
  
  ```
  
  Set the regexs to include and exclude for a context, both supplied as JSON string arrays
  
  ### method excludeRegexs
  
  ```
  method excludeRegexs(
      :$contextName!
  ) returns Mu
  
  ```
  
  List excluded regexs for context
  
  ### method excludedTechnologyList
  
  ```
  method excludedTechnologyList(
      :$contextName!
  ) returns Mu
  
  ```
  
  Lists the names of all technologies excluded from a context
  
  ### method includeRegexs
  
  ```
  method includeRegexs(
      :$contextName!
  ) returns Mu
  
  ```
  
  List included regexs for context
  
  ### method includedTechnologyList
  
  ```
  method includedTechnologyList(
      :$contextName!
  ) returns Mu
  
  ```
  
  Lists the names of all technologies included in a context
  
  ### method technologyList
  
  ```
  method technologyList() returns Mu
  
  ```
  
  Lists the names of all built in technologies
  
  ### method urls
  
  ```
  method urls(
      :$contextName!
  ) returns Mu
  
  ```
  
  Lists the URLs accessed through/by ZAP, that belong to the context with the given name.
  
  ## class Zap::Autoupdate
  
  class `Zap::Autoupdate` Methods
  
  ### method downloadLatestRelease
  
  ```
  method downloadLatestRelease() returns Mu
  
  ```
  
  Downloads the latest release, if any
  
  ### method installAddon
  
  ```
  method installAddon(
      :$id!
  ) returns Mu
  
  ```
  
  Installs or updates the specified add-on, returning when complete (i.e. not asynchronously)
  
  ### method setOptionCheckAddonUpdates
  
  ```
  method setOptionCheckAddonUpdates(
      :$Boolean!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method setOptionCheckOnStart
  
  ```
  method setOptionCheckOnStart(
      :$Boolean!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method setOptionDownloadNewRelease
  
  ```
  method setOptionDownloadNewRelease(
      :$Boolean!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method setOptionInstallAddonUpdates
  
  ```
  method setOptionInstallAddonUpdates(
      :$Boolean!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method setOptionInstallScannerRules
  
  ```
  method setOptionInstallScannerRules(
      :$Boolean!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method setOptionReportAlphaAddons
  
  ```
  method setOptionReportAlphaAddons(
      :$Boolean!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method setOptionReportBetaAddons
  
  ```
  method setOptionReportBetaAddons(
      :$Boolean!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method setOptionReportReleaseAddons
  
  ```
  method setOptionReportReleaseAddons(
      :$Boolean!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method uninstallAddon
  
  ```
  method uninstallAddon(
      :$id!
  ) returns Mu
  
  ```
  
  Uninstalls the specified add-on
  
  ### method latestVersionNumber
  
  ```
  method latestVersionNumber() returns Mu
  
  ```
  
  Returns the latest version number
  
  ### method localAddons
  
  ```
  method localAddons() returns Mu
  
  ```
  
  Returns a list with all local add-ons, installed or not.
  
  ### method marketplaceAddons
  
  ```
  method marketplaceAddons() returns Mu
  
  ```
  
  Return a list of all of the add-ons on the ZAP Marketplace (this information is read once and then cached)
  
  ### method newAddons
  
  ```
  method newAddons() returns Mu
  
  ```
  
  Return a list of any add-ons that have been added to the Marketplace since the last check for updates
  
  ### method optionAddonDirectories
  
  ```
  method optionAddonDirectories() returns Mu
  
  ```
  
  No Doc
  
  ### method optionCheckAddonUpdates
  
  ```
  method optionCheckAddonUpdates() returns Mu
  
  ```
  
  No Doc
  
  ### method optionCheckOnStart
  
  ```
  method optionCheckOnStart() returns Mu
  
  ```
  
  No Doc
  
  ### method optionDayLastChecked
  
  ```
  method optionDayLastChecked() returns Mu
  
  ```
  
  No Doc
  
  ### method optionDayLastInstallWarned
  
  ```
  method optionDayLastInstallWarned() returns Mu
  
  ```
  
  No Doc
  
  ### method optionDayLastUpdateWarned
  
  ```
  method optionDayLastUpdateWarned() returns Mu
  
  ```
  
  No Doc
  
  ### method optionDownloadDirectory
  
  ```
  method optionDownloadDirectory() returns Mu
  
  ```
  
  No Doc
  
  ### method optionDownloadNewRelease
  
  ```
  method optionDownloadNewRelease() returns Mu
  
  ```
  
  No Doc
  
  ### method optionInstallAddonUpdates
  
  ```
  method optionInstallAddonUpdates() returns Mu
  
  ```
  
  No Doc
  
  ### method optionInstallScannerRules
  
  ```
  method optionInstallScannerRules() returns Mu
  
  ```
  
  No Doc
  
  ### method optionReportAlphaAddons
  
  ```
  method optionReportAlphaAddons() returns Mu
  
  ```
  
  No Doc
  
  ### method optionReportBetaAddons
  
  ```
  method optionReportBetaAddons() returns Mu
  
  ```
  
  No Doc
  
  ### method optionReportReleaseAddons
  
  ```
  method optionReportReleaseAddons() returns Mu
  
  ```
  
  No Doc
  
  ### method updatedAddons
  
  ```
  method updatedAddons() returns Mu
  
  ```
  
  Return a list of any add-ons that have been changed in the Marketplace since the last check for updates
  
  ## class Zap::Alert
  
  class `Zap::Alert` Methods
  
  ### method addAlert
  
  ```
  method addAlert(
      :$messageId!,
      :$name!,
      :$riskId!,
      :$confidenceId!,
      :$description!,
      :$param,
      :$attack,
      :$otherInfo,
      :$solution,
      :$references,
      :$evidence,
      :$cweId,
      :$wascId
  ) returns Mu
  
  ```
  
  Add an alert associated with the given message ID, with the provided details. (The ID of the created alert is returned.)
  
  ### method deleteAlert
  
  ```
  method deleteAlert(
      :$id!
  ) returns Mu
  
  ```
  
  Deletes the alert with the given ID.
  
  ### method deleteAllAlerts
  
  ```
  method deleteAllAlerts() returns Mu
  
  ```
  
  Deletes all alerts of the current session.
  
  ### method updateAlert
  
  ```
  method updateAlert(
      :$id!,
      :$name!,
      :$riskId!,
      :$confidenceId!,
      :$description!,
      :$param,
      :$attack,
      :$otherInfo,
      :$solution,
      :$references,
      :$evidence,
      :$cweId,
      :$wascId
  ) returns Mu
  
  ```
  
  Update the alert with the given ID, with the provided details.
  
  ### method alerts
  
  ```
  method alerts(
      :$baseurl,
      :$start,
      :$count,
      :$riskId
  ) returns Mu
  
  ```
  
  Gets the alerts raised by ZAP, optionally filtering by URL or riskId, and paginating with 'start' position and 'count' of alerts
  
  ### method alertsByRisk
  
  ```
  method alertsByRisk(
      :$url,
      :$recurse
  ) returns Mu
  
  ```
  
  Gets a summary of the alerts, optionally filtered by a 'url'. If 'recurse' is true then all alerts that apply to urls that start with the specified 'url' will be returned, otherwise only those on exactly the same 'url' (ignoring url parameters)
  
  ### method alertsSummary
  
  ```
  method alertsSummary(
      :$baseurl
  ) returns Mu
  
  ```
  
  Gets number of alerts grouped by each risk level, optionally filtering by URL
  
  ### method numberOfAlerts
  
  ```
  method numberOfAlerts(
      :$baseurl,
      :$riskId
  ) returns Mu
  
  ```
  
  Gets the number of alerts, optionally filtering by URL or riskId
  