txt: ## dist_github-khalidelboray-Zap.md
  ## Chunk 2 of 3
  
  
  ```
  method setOptionPostForm(
      :$Boolean!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method setOptionProcessForm
  
  ```
  method setOptionProcessForm(
      :$Boolean!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method setOptionRequestWaitTime
  
  ```
  method setOptionRequestWaitTime(
      :$Integer!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method setOptionScopeString
  
  ```
  method setOptionScopeString(
      :$String!
  ) returns Mu
  
  ```
  
  Use actions [add|modify|remove]DomainAlwaysInScope instead.
  
  ### method setOptionSendRefererHeader
  
  ```
  method setOptionSendRefererHeader(
      :$Boolean!
  ) returns Mu
  
  ```
  
  Sets whether or not the 'Referer' header should be sent while spidering.
  
  ### method setOptionShowAdvancedDialog
  
  ```
  method setOptionShowAdvancedDialog(
      :$Boolean!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method setOptionSkipURLString
  
  ```
  method setOptionSkipURLString(
      :$String!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method setOptionThreadCount
  
  ```
  method setOptionThreadCount(
      :$Integer!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method setOptionUserAgent
  
  ```
  method setOptionUserAgent(
      :$String!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method stop
  
  ```
  method stop(
      :$scanId
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method stopAllScans
  
  ```
  method stopAllScans() returns Mu
  
  ```
  
  No Doc
  
  ## class Zap::Selenium
  
  class `Zap::Selenium` Methods
  
  ### method setOptionChromeDriverPath
  
  ```
  method setOptionChromeDriverPath(
      :$String!
  ) returns Mu
  
  ```
  
  Sets the current path to ChromeDriver
  
  ### method setOptionFirefoxBinaryPath
  
  ```
  method setOptionFirefoxBinaryPath(
      :$String!
  ) returns Mu
  
  ```
  
  Sets the current path to Firefox binary
  
  ### method setOptionFirefoxDriverPath
  
  ```
  method setOptionFirefoxDriverPath(
      :$String!
  ) returns Mu
  
  ```
  
  Sets the current path to Firefox driver (geckodriver)
  
  ### method setOptionIeDriverPath
  
  ```
  method setOptionIeDriverPath(
      :$String!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method setOptionPhantomJsBinaryPath
  
  ```
  method setOptionPhantomJsBinaryPath(
      :$String!
  ) returns Mu
  
  ```
  
  Sets the current path to PhantomJS binary
  
  ### method optionFirefoxDriverPath
  
  ```
  method optionFirefoxDriverPath() returns Mu
  
  ```
  
  Returns the current path to Firefox driver (geckodriver)
  
  ### method optionIeDriverPath
  
  ```
  method optionIeDriverPath() returns Mu
  
  ```
  
  No Doc
  
  ### method optionPhantomJsBinaryPath
  
  ```
  method optionPhantomJsBinaryPath() returns Mu
  
  ```
  
  Returns the current path to PhantomJS binary
  
  ## class Zap::Httpsessions
  
  class `Zap::Httpsessions` Methods
  
  ### method addDefaultSessionToken
  
  ```
  method addDefaultSessionToken(
      :$sessionToken!,
      :$tokenEnabled
  ) returns Mu
  
  ```
  
  Adds a default session token with the given name and enabled state.
  
  ### method addSessionToken
  
  ```
  method addSessionToken(
      :$site!,
      :$sessionToken!
  ) returns Mu
  
  ```
  
  Adds the session token to the given site.
  
  ### method createEmptySession
  
  ```
  method createEmptySession(
      :$site!,
      :$session
  ) returns Mu
  
  ```
  
  Creates an empty session for the given site. Optionally with the given name.
  
  ### method removeDefaultSessionToken
  
  ```
  method removeDefaultSessionToken(
      :$sessionToken!
  ) returns Mu
  
  ```
  
  Removes the default session token with the given name.
  
  ### method removeSession
  
  ```
  method removeSession(
      :$site!,
      :$session!
  ) returns Mu
  
  ```
  
  Removes the session from the given site.
  
  ### method removeSessionToken
  
  ```
  method removeSessionToken(
      :$site!,
      :$sessionToken!
  ) returns Mu
  
  ```
  
  Removes the session token from the given site.
  
  ### method renameSession
  
  ```
  method renameSession(
      :$site!,
      :$oldSessionName!,
      :$newSessionName!
  ) returns Mu
  
  ```
  
  Renames the session of the given site.
  
  ### method setActiveSession
  
  ```
  method setActiveSession(
      :$site!,
      :$session!
  ) returns Mu
  
  ```
  
  Sets the given session as active for the given site.
  
  ### method setDefaultSessionTokenEnabled
  
  ```
  method setDefaultSessionTokenEnabled(
      :$sessionToken!,
      :$tokenEnabled!
  ) returns Mu
  
  ```
  
  Sets whether or not the default session token with the given name is enabled.
  
  ### method setSessionTokenValue
  
  ```
  method setSessionTokenValue(
      :$site!,
      :$session!,
      :$sessionToken!,
      :$tokenValue!
  ) returns Mu
  
  ```
  
  Sets the value of the session token of the given session for the given site.
  
  ### method unsetActiveSession
  
  ```
  method unsetActiveSession(
      :$site!
  ) returns Mu
  
  ```
  
  Unsets the active session of the given site.
  
  ### method sessionTokens
  
  ```
  method sessionTokens(
      :$site!
  ) returns Mu
  
  ```
  
  Gets the names of the session tokens for the given site.
  
  ### method sessions
  
  ```
  method sessions(
      :$site!,
      :$session
  ) returns Mu
  
  ```
  
  Gets the sessions for the given site. Optionally returning just the session with the given name.
  
  ### method sites
  
  ```
  method sites() returns Mu
  
  ```
  
  Gets all of the sites that have sessions.
  
  ## class Zap::Localproxies
  
  class `Zap::Localproxies` Methods
  
  ### method removeAdditionalProxy
  
  ```
  method removeAdditionalProxy(
      :$address!,
      :$port!
  ) returns Mu
  
  ```
  
  Removes the additional proxy with the specified address and port.
  
  ## class Zap::Websocket
  
  class `Zap::Websocket` Methods
  
  ### method message
  
  ```
  method message(
      :$channelId!,
      :$messageId!
  ) returns Mu
  
  ```
  
  Returns full details of the message specified by the channelId and messageId
  
  ### method messages
  
  ```
  method messages(
      :$channelId,
      :$start,
      :$count,
      :$payloadPreviewLength
  ) returns Mu
  
  ```
  
  Returns a list of all of the messages that meet the given criteria (all optional), where channelId is a channel identifier, start is the offset to start returning messages from (starting from 0), count is the number of messages to return (default no limit) and payloadPreviewLength is the maximum number bytes to return for the payload contents
  
  ### method sendTextMessage
  
  ```
  method sendTextMessage(
      :$channelId!,
      :$outgoing!,
      :$message!
  ) returns Mu
  
  ```
  
  Sends the specified message on the channel specified by channelId, if outgoing is 'True' then the message will be sent to the server and if it is 'False' then it will be sent to the client
  
  ### method setBreakTextMessage
  
  ```
  method setBreakTextMessage(
      :$message!,
      :$outgoing!
  ) returns Mu
  
  ```
  
  Sets the text message for an intercepted websockets message
  
  ## class Zap::Authentication
  
  class `Zap::Authentication` Methods
  
  ### method setAuthenticationMethod
  
  ```
  method setAuthenticationMethod(
      :$contextId!,
      :$authMethodName!,
      :$authMethodConfigParams
  ) returns Mu
  
  ```
  
  Sets the authentication method for the context with the given ID.
  
  ### method setLoggedInIndicator
  
  ```
  method setLoggedInIndicator(
      :$contextId!,
      :$loggedInIndicatorRegex!
  ) returns Mu
  
  ```
  
  Sets the logged in indicator for the context with the given ID.
  
  ### method setLoggedOutIndicator
  
  ```
  method setLoggedOutIndicator(
      :$contextId!,
      :$loggedOutIndicatorRegex!
  ) returns Mu
  
  ```
  
  Sets the logged out indicator for the context with the given ID.
  
  ### method getLoggedInIndicator
  
  ```
  method getLoggedInIndicator(
      :$contextId!
  ) returns Mu
  
  ```
  
  Gets the logged in indicator for the context with the given ID.
  
  ### method getLoggedOutIndicator
  
  ```
  method getLoggedOutIndicator(
      :$contextId!
  ) returns Mu
  
  ```
  
  Gets the logged out indicator for the context with the given ID.
  
  ### method getSupportedAuthenticationMethods
  
  ```
  method getSupportedAuthenticationMethods() returns Mu
  
  ```
  
  Gets the name of the authentication methods.
  
  ## class Zap::Pscan
  
  class `Zap::Pscan` Methods
  
  ### method disableAllScanners
  
  ```
  method disableAllScanners() returns Mu
  
  ```
  
  Disables all passive scanners
  
  ### method disableAllTags
  
  ```
  method disableAllTags() returns Mu
  
  ```
  
  Disables all passive scan tags.
  
  ### method disableScanners
  
  ```
  method disableScanners(
      :$ids!
  ) returns Mu
  
  ```
  
  Disables all passive scanners with the given IDs (comma separated list of IDs)
  
  ### method enableAllScanners
  
  ```
  method enableAllScanners() returns Mu
  
  ```
  
  Enables all passive scanners
  
  ### method enableAllTags
  
  ```
  method enableAllTags() returns Mu
  
  ```
  
  Enables all passive scan tags.
  
  ### method enableScanners
  
  ```
  method enableScanners(
      :$ids!
  ) returns Mu
  
  ```
  
  Enables all passive scanners with the given IDs (comma separated list of IDs)
  
  ### method setEnabled
  
  ```
  method setEnabled(
      :$enabled!
  ) returns Mu
  
  ```
  
  Sets whether or not the passive scanning is enabled (Note: the enabled state is not persisted).
  
  ### method setMaxAlertsPerRule
  
  ```
  method setMaxAlertsPerRule(
      :$maxAlerts!
  ) returns Mu
  
  ```
  
  Sets the maximum number of alerts a passive scan rule should raise.
  
  ### method setScanOnlyInScope
  
  ```
  method setScanOnlyInScope(
      :$onlyInScope!
  ) returns Mu
  
  ```
  
  Sets whether or not the passive scan should be performed only on messages that are in scope.
  
  ### method setScannerAlertThreshold
  
  ```
  method setScannerAlertThreshold(
      :$id!,
      :$alertThreshold!
  ) returns Mu
  
  ```
  
  Sets the alert threshold of the passive scanner with the given ID, accepted values for alert threshold: OFF, DEFAULT, LOW, MEDIUM and HIGH
  
  ### method recordsToScan
  
  ```
  method recordsToScan() returns Mu
  
  ```
  
  The number of records the passive scanner still has to scan
  
  ### method scanOnlyInScope
  
  ```
  method scanOnlyInScope() returns Mu
  
  ```
  
  Tells whether or not the passive scan should be performed only on messages that are in scope.
  
  ### method scanners
  
  ```
  method scanners() returns Mu
  
  ```
  
  Lists all passive scanners with its ID, name, enabled state and alert threshold.
  
  ## class Zap::Sessionmanagement
  
  class `Zap::Sessionmanagement` Methods
  
  ### method getSupportedSessionManagementMethods
  
  ```
  method getSupportedSessionManagementMethods() returns Mu
  
  ```
  
  Gets the name of the session management methods.
  
  ### method setSessionManagementMethod
  
  ```
  method setSessionManagementMethod(
      :$contextId!,
      :$methodName!,
      :$methodConfigParams
  ) returns Mu
  
  ```
  
  Sets the session management method for the context with the given ID.
  
  ## class Zap::Script
  
  class `Zap::Script` Methods
  
  ### method globalVar
  
  ```
  method globalVar(
      :$varKey!
  ) returns Mu
  
  ```
  
  Gets the value of the global variable with the given key. Returns an API error (DOES\_NOT\_EXIST) if no value was previously set.
  
  ### method globalVars
  
  ```
  method globalVars() returns Mu
  
  ```
  
  Gets all the global variables (key/value pairs).
  
  ### method listEngines
  
  ```
  method listEngines() returns Mu
  
  ```
  
  Lists the script engines available
  
  ### method listScripts
  
  ```
  method listScripts() returns Mu
  
  ```
  
  Lists the scripts available, with its engine, name, description, type and error state.
  
  ### method listTypes
  
  ```
  method listTypes() returns Mu
  
  ```
  
  Lists the script types available.
  
  ### method scriptCustomVar
  
  ```
  method scriptCustomVar(
      :$scriptName!,
      :$varKey!
  ) returns Mu
  
  ```
  
  Gets the value (string representation) of a custom variable. Returns an API error (DOES\_NOT\_EXIST) if no script with the given name exists or if no value was previously set.
  
  ### method scriptCustomVars
  
  ```
  method scriptCustomVars(
      :$scriptName!
  ) returns Mu
  
  ```
  
  Gets all the custom variables (key/value pairs, the value is the string representation) of a script. Returns an API error (DOES\_NOT\_EXIST) if no script with the given name exists.
  
  ### method scriptVar
  
  ```
  method scriptVar(
      :$scriptName!,
      :$varKey!
  ) returns Mu
  
  ```
  
  Gets the value of the variable with the given key for the given script. Returns an API error (DOES\_NOT\_EXIST) if no script with the given name exists or if no value was previously set.
  
  ### method scriptVars
  
  ```
  method scriptVars(
      :$scriptName!
  ) returns Mu
  
  ```
  
  Gets all the variables (key/value pairs) of the given script. Returns an API error (DOES\_NOT\_EXIST) if no script with the given name exists.
  
  ### method clearGlobalCustomVar
  
  ```
  method clearGlobalCustomVar(
      :$varKey!
  ) returns Mu
  
  ```
  
  Clears a global custom variable.
  
  ### method clearGlobalVar
  
  ```
  method clearGlobalVar(
      :$varKey!
  ) returns Mu
  
  ```
  
  Clears the global variable with the given key.
  
  ### method clearGlobalVars
  
  ```
  method clearGlobalVars() returns Mu
  
  ```
  
  Clears the global variables.
  
  ### method clearScriptCustomVar
  
  ```
  method clearScriptCustomVar(
      :$scriptName!,
      :$varKey!
  ) returns Mu
  
  ```
  
  Clears a script custom variable.
  
  ### method clearScriptVar
  
  ```
  method clearScriptVar(
      :$scriptName!,
      :$varKey!
  ) returns Mu
  
  ```
  
  Clears the variable with the given key of the given script. Returns an API error (DOES\_NOT\_EXIST) if no script with the given name exists.
  
  ### method clearScriptVars
  
  ```
  method clearScriptVars(
      :$scriptName!
  ) returns Mu
  
  ```
  
  Clears the variables of the given script. Returns an API error (DOES\_NOT\_EXIST) if no script with the given name exists.
  
  ### method disable
  
  ```
  method disable(
      :$scriptName!
  ) returns Mu
  
  ```
  
  Disables the script with the given name
  
  ### method enable
  
  ```
  method enable(
      :$scriptName!
  ) returns Mu
  
  ```
  
  Enables the script with the given name
  
  ### method load
  
  ```
  method load(
      :$scriptName!,
      :$scriptType!,
      :$scriptEngine!,
      :$fileName!,
      :$scriptDescription,
      :$charset
  ) returns Mu
  
  ```
  
  Loads a script into ZAP from the given local file, with the given name, type and engine, optionally with a description, and a charset name to read the script (the charset name is required if the script is not in UTF-8, for example, in ISO-8859-1).
  
  ### method remove
  
  ```
  method remove(
      :$scriptName!
  ) returns Mu
  
  ```
  
  Removes the script with the given name
  
  ### method runStandAloneScript
  
  ```
  method runStandAloneScript(
      :$scriptName!
  ) returns Mu
  
  ```
  
  Runs the stand alone script with the given name
  
  ### method setGlobalVar
  
  ```
  method setGlobalVar(
      :$varKey!,
      :$varValue
  ) returns Mu
  
  ```
  
  Sets the value of the global variable with the given key.
  
  ### method setScriptVar
  
  ```
  method setScriptVar(
      :$scriptName!,
      :$varKey!,
      :$varValue
  ) returns Mu
  
  ```
  
  Sets the value of the variable with the given key of the given script. Returns an API error (DOES\_NOT\_EXIST) if no script with the given name exists.
  
  ## class Zap::Ajaxspider
  
  class `Zap::Ajaxspider` Methods
  
  ### method optionBrowserId
  
  ```
  method optionBrowserId() returns Mu
  
  ```
  
  No Doc
  
  ### method optionClickDefaultElems
  
  ```
  method optionClickDefaultElems() returns Mu
  
  ```
  
  No Doc
  
  ### method optionClickElemsOnce
  
  ```
  method optionClickElemsOnce() returns Mu
  
  ```
  
  No Doc
  
  ### method optionEventWait
  
  ```
  method optionEventWait() returns Mu
  
  ```
  
  No Doc
  
  ### method optionMaxCrawlDepth
  
  ```
  method optionMaxCrawlDepth() returns Mu
  
  ```
  
  No Doc
  
  ### method optionMaxCrawlStates
  
  ```
  method optionMaxCrawlStates() returns Mu
  
  ```
  
  No Doc
  
  ### method optionMaxDuration
  
  ```
  method optionMaxDuration() returns Mu
  
  ```
  
  No Doc
  
  ### method optionNumberOfBrowsers
  
  ```
  method optionNumberOfBrowsers() returns Mu
  
  ```
  
  No Doc
  
  ### method optionRandomInputs
  
  ```
  method optionRandomInputs() returns Mu
  
  ```
  
  No Doc
  
  ### method optionReloadWait
  
  ```
  method optionReloadWait() returns Mu
  
  ```
  
  No Doc
  
  ### method results
  
  ```
  method results(
      :$start,
      :$count
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method status
  
  ```
  method status() returns Mu
  
  ```
  
  No Doc
  
  ### method scan
  
  ```
  method scan(
      :$url,
      :$inScope,
      :$contextName,
      :$subtreeOnly
  ) returns Mu
  
  ```
  
  Runs the spider against the given URL and/or context, optionally, spidering everything in scope. The parameter 'contextName' can be used to constrain the scan to a Context, the option 'in scope' is ignored if a context was also specified. The parameter 'subtreeOnly' allows to restrict the spider under a site's subtree (using the specified 'url').
  
  ### method scanAsUser
  
  ```
  method scanAsUser(
      :$contextName!,
      :$userName!,
      :$url,
      :$subtreeOnly
  ) returns Mu
  
  ```
  
  Runs the spider from the perspective of a User, obtained using the given context name and user name. The parameter 'url' allows to specify the starting point for the spider, otherwise it's used an existing URL from the context (if any). The parameter 'subtreeOnly' allows to restrict the spider under a site's subtree (using the specified 'url').
  
  ### method setOptionBrowserId
  
  ```
  method setOptionBrowserId(
      :$String!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method setOptionClickDefaultElems
  
  ```
  method setOptionClickDefaultElems(
      :$Boolean!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method setOptionClickElemsOnce
  
  ```
  method setOptionClickElemsOnce(
      :$Boolean!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method setOptionEventWait
  
  ```
  method setOptionEventWait(
      :$Integer!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method setOptionMaxCrawlDepth
  
  ```
  method setOptionMaxCrawlDepth(
      :$Integer!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method setOptionMaxCrawlStates
  
  ```
  method setOptionMaxCrawlStates(
      :$Integer!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method setOptionMaxDuration
  
  ```
  method setOptionMaxDuration(
      :$Integer!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method setOptionNumberOfBrowsers
  
  ```
  method setOptionNumberOfBrowsers(
      :$Integer!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method setOptionRandomInputs
  
  ```
  method setOptionRandomInputs(
      :$Boolean!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method setOptionReloadWait
  
  ```
  method setOptionReloadWait(
      :$Integer!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method stop
  
  ```
  method stop() returns Mu
  
  ```
  
  No Doc
  
  ## class Zap::Core
  
  class `Zap::Core` Methods
  
  ### method alertsSummary
  
  ```
  method alertsSummary(
      :$baseurl
  ) returns Mu
  
  ```
  
  Gets number of alerts grouped by each risk level, optionally filtering by URL
  
  ### method childNodes
  
  ```
  method childNodes(
      :$url
  ) returns Mu
  
  ```
  
  Gets the child nodes underneath the specified URL in the Sites tree
  
  ### method excludedFromProxy
  
  ```
  method excludedFromProxy() returns Mu
  
  ```
  
  Gets the regular expressions, applied to URLs, to exclude from the local proxies.
  
  ### method homeDirectory
  
  ```
  method homeDirectory() returns Mu
  
  ```
  
  No Doc
  
  ### method hosts
  
  ```
  method hosts() returns Mu
  
  ```
  
  Gets the name of the hosts accessed through/by ZAP
  
  ### method message
  
  ```
  method message(
      :$id!
  ) returns Mu
  
  ```
  
  Gets the HTTP message with the given ID. Returns the ID, request/response headers and bodies, cookies, note, type, RTT, and timestamp.
  
  ### method messages
  
  ```
  method messages(
      :$baseurl,
      :$start,
      :$count
  ) returns Mu
  
  ```
  
  Gets the HTTP messages sent by ZAP, request and response, optionally filtered by URL and paginated with 'start' position and 'count' of messages
  
  ### method messagesById
  
  ```
  method messagesById(
      :$ids!
  ) returns Mu
  
  ```
  
  Gets the HTTP messages with the given IDs.
  
  ### method mode
  
  ```
  method mode() returns Mu
  
  ```
  
  Gets the mode
  
  ### method numberOfAlerts
  
  ```
  method numberOfAlerts(
      :$baseurl,
      :$riskId
  ) returns Mu
  
  ```
  
  Gets the number of alerts, optionally filtering by URL or riskId
  
  ### method numberOfMessages
  
  ```
  method numberOfMessages(
      :$baseurl
  ) returns Mu
  
  ```
  
  Gets the number of messages, optionally filtering by URL
  
  ### method optionAlertOverridesFilePath
  
  ```
  method optionAlertOverridesFilePath() returns Mu
  
  ```
  
  Gets the path to the file with alert overrides.
  
  ### method optionDefaultUserAgent
  
  ```
  method optionDefaultUserAgent() returns Mu
  
  ```
  
  Gets the user agent that ZAP should use when creating HTTP messages (for example, spider messages or CONNECT requests to outgoing proxy).
  
  ### method optionDnsTtlSuccessfulQueries
  
  ```
  method optionDnsTtlSuccessfulQueries() returns Mu
  
  ```
  
  Gets the TTL (in seconds) of successful DNS queries.
  
  ### method optionHttpState
  
  ```
  method optionHttpState() returns Mu
  
  ```
  
  No Doc
  
  ### method optionHttpStateEnabled
  
  ```
  method optionHttpStateEnabled() returns Mu
  
  ```
  
  No Doc
  
  ### method optionMaximumAlertInstances
  
  ```
  method optionMaximumAlertInstances() returns Mu
  
  ```
  
  Gets the maximum number of alert instances to include in a report.
  
  ### method optionMergeRelatedAlerts
  
  ```
  method optionMergeRelatedAlerts() returns Mu
  
  ```
  
  Gets whether or not related alerts will be merged in any reports generated.
  
  ### method optionProxyChainName
  
  ```
  method optionProxyChainName() returns Mu
  
  ```
  
  No Doc
  
  ### method optionProxyChainPassword
  
  ```
  method optionProxyChainPassword() returns Mu
  
  ```
  
  No Doc
  
  ### method optionProxyChainPort
  
  ```
  method optionProxyChainPort() returns Mu
  
  ```
  
  No Doc
  
  ### method optionProxyChainPrompt
  
  ```
  method optionProxyChainPrompt() returns Mu
  
  ```
  
  No Doc
  
  ### method optionProxyChainRealm
  
  ```
  method optionProxyChainRealm() returns Mu
  
  ```
  
  No Doc
  
  ### method optionProxyChainSkipName
  
  ```
  method optionProxyChainSkipName() returns Mu
  
  ```
  
  Use view proxyChainExcludedDomains instead.
  
  ### method optionProxyChainUserName
  
  ```
  method optionProxyChainUserName() returns Mu
  
  ```
  
  No Doc
  
  ### method optionProxyExcludedDomains
  
  ```
  method optionProxyExcludedDomains() returns Mu
  
  ```
  
  Use view proxyChainExcludedDomains instead.
  
  ### method optionProxyExcludedDomainsEnabled
  
  ```
  method optionProxyExcludedDomainsEnabled() returns Mu
  
  ```
  
  Use view proxyChainExcludedDomains instead.
  
  ### method optionSingleCookieRequestHeader
  
  ```
  method optionSingleCookieRequestHeader() returns Mu
  
  ```
  
  No Doc
  
  ### method optionTimeoutInSecs
  
  ```
  method optionTimeoutInSecs() returns Mu
  
  ```
  
  Gets the connection time out, in seconds.
  
  ### method optionUseProxyChain
  
  ```
  method optionUseProxyChain() returns Mu
  
  ```
  
  No Doc
  
  ### method optionUseProxyChainAuth
  
  ```
  method optionUseProxyChainAuth() returns Mu
  
  ```
  
  No Doc
  
  ### method proxyChainExcludedDomains
  
  ```
  method proxyChainExcludedDomains() returns Mu
  
  ```
  
  Gets all the domains that are excluded from the outgoing proxy. For each domain the following are shown: the index, the value (domain), if enabled, and if specified as a regex.
  
  ### method sessionLocation
  
  ```
  method sessionLocation() returns Mu
  
  ```
  
  Gets the location of the current session file
  
  ### method sites
  
  ```
  method sites() returns Mu
  
  ```
  
  Gets the sites accessed through/by ZAP (scheme and domain)
  
  ### method urls
  
  ```
  method urls(
      :$baseurl
  ) returns Mu
  
  ```
  
  Gets the URLs accessed through/by ZAP, optionally filtering by (base) URL.
  
  ### method version
  
  ```
  method version() returns Mu
  
  ```
  
  Gets ZAP version
  
  ### method zapHomePath
  
  ```
  method zapHomePath() returns Mu
  
  ```
  
  Gets the path to ZAP's home directory.
  
  ### method htmlreport
  
  ```
  method htmlreport() returns Mu
  
  ```
  
  Generates a report in HTML format
  
  ### method jsonreport
  
  ```
  method jsonreport() returns Mu
  
  ```
  
  Generates a report in JSON format
  
  ### method mdreport
  
  ```
  method mdreport() returns Mu
  
  ```
  
  Generates a report in Markdown format
  
  ### method messageHar
  
  ```
  method messageHar(
      :$id!
  ) returns Mu
  
  ```
  
  Gets the message with the given ID in HAR format
  
  ### method messagesHar
  
  ```
  method messagesHar(
      :$baseurl,
      :$start,
      :$count
  ) returns Mu
  
  ```
  
  Gets the HTTP messages sent through/by ZAP, in HAR format, optionally filtered by URL and paginated with 'start' position and 'count' of messages
  
  ### method messagesHarById
  
  ```
  method messagesHarById(
      :$ids!
  ) returns Mu
  
  ```
  
  Gets the HTTP messages with the given IDs, in HAR format.
  
  ### method proxypac
  
  ```
  method proxypac() returns Mu
  
  ```
  
  No Doc
  
  ### method rootcert
  
  ```
  method rootcert() returns Mu
  
  ```
  
  Gets the Root CA certificate used by the local proxies.
  
  ### method sendHarRequest
  
  ```
  method sendHarRequest(
      :$request!,
      :$followRedirects
  ) returns Mu
  
  ```
  
  Sends the first HAR request entry, optionally following redirections. Returns, in HAR format, the request sent and response received and followed redirections, if any. The Mode is enforced when sending the request (and following redirections), custom manual requests are not allowed in 'Safe' mode nor in 'Protected' mode if out of scope.
  
  ### method setproxy
  
  ```
  method setproxy(
      :$proxy!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method xmlreport
  
  ```
  method xmlreport() returns Mu
  
  ```
  
  Generates a report in XML format
  
  ### method accessUrl
  
  ```
  method accessUrl(
      :$url!,
      :$followRedirects
  ) returns Mu
  
  ```
  
  Convenient and simple action to access a URL, optionally following redirections. Returns the request sent and response received and followed redirections, if any. Other actions are available which offer more control on what is sent, like, 'sendRequest' or 'sendHarRequest'.
  
  ### method addProxyChainExcludedDomain
  
  ```
  method addProxyChainExcludedDomain(
      :$value!,
      :$isRegex,
      :$isEnabled
  ) returns Mu
  
  ```
  
  Adds a domain to be excluded from the outgoing proxy, using the specified value. Optionally sets if the new entry is enabled (default, true) and whether or not the new value is specified as a regex (default, false).
  
  ### method clearExcludedFromProxy
  
  ```
  method clearExcludedFromProxy() returns Mu
  
  ```
  
  Clears the regexes of URLs excluded from the local proxies.
  
  ### 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 deleteSiteNode
  
  ```
  method deleteSiteNode(
      :$url!,
      :$method,
      :$postData
  ) returns Mu
  
  ```
  
  Deletes the site node found in the Sites Tree on the basis of the URL, HTTP method, and post data (if applicable and specified).
  
  ### method disableAllProxyChainExcludedDomains
  
  ```
  method disableAllProxyChainExcludedDomains() returns Mu
  
  ```
  
  Disables all domains excluded from the outgoing proxy.
  
  ### method disableClientCertificate
  
  ```
  method disableClientCertificate() returns Mu
  
  ```
  
  Disables the option for use of client certificates.
  
  ### method enableAllProxyChainExcludedDomains
  
  ```
  method enableAllProxyChainExcludedDomains() returns Mu
  
  ```
  
  Enables all domains excluded from the outgoing proxy.
  
  ### method enablePKCS12ClientCertificate
  
  ```
  method enablePKCS12ClientCertificate(
      :$filePath!,
      :$password!,
      :$index
  ) returns Mu
  
  ```
  
  Enables use of a PKCS12 client certificate for the certificate with the given file system path, password, and optional index.
  
  ### method excludeFromProxy
  
  ```
  method excludeFromProxy(
      :$regex!
  ) returns Mu
  
  ```
  
  Adds a regex of URLs that should be excluded from the local proxies.
  
  ### method generateRootCA
  
  ```
  method generateRootCA() returns Mu
  
  ```
  
  Generates a new Root CA certificate for the local proxies.
  
  ### method loadSession
  
  ```
  method loadSession(
      :$name!
  ) returns Mu
  
  ```
  
  Loads the session with the given name. If a relative path is specified it will be resolved against the "session" directory in ZAP "home" dir.
  
  ### method modifyProxyChainExcludedDomain
  
  ```
  method modifyProxyChainExcludedDomain(
      :$idx!,
      :$value,
      :$isRegex,
      :$isEnabled
  ) returns Mu
  
  ```
  
  Modifies a domain excluded from the outgoing proxy. Allows to modify the value, if enabled or if a regex. The domain is selected with its index, which can be obtained with the view proxyChainExcludedDomains.
  
  ### method newSession
  
  ```
  method newSession(
      :$name,
      :$overwrite
  ) returns Mu
  
  ```
  
  Creates a new session, optionally overwriting existing files. If a relative path is specified it will be resolved against the "session" directory in ZAP "home" dir.
  
  ### method removeProxyChainExcludedDomain
  
  ```
  method removeProxyChainExcludedDomain(
      :$idx!
  ) returns Mu
  
  ```
  
  Removes a domain excluded from the outgoing proxy, with the given index. The index can be obtained with the view proxyChainExcludedDomains.
  
  ### method runGarbageCollection
  
  ```
  method runGarbageCollection() returns Mu
  
  ```
  
  No Doc
  
  ### method saveSession
  
  ```
  method saveSession(
      :$name!,
      :$overwrite
  ) returns Mu
  
  ```
  
  Saves the session.
  
  ### method sendRequest
  
  ```
  method sendRequest(
      :$request!,
      :$followRedirects
  ) returns Mu
  
  ```
  
  Sends the HTTP request, optionally following redirections. Returns the request sent and response received and followed redirections, if any. The Mode is enforced when sending the request (and following redirections), custom manual requests are not allowed in 'Safe' mode nor in 'Protected' mode if out of scope.
  
  ### method setHomeDirectory
  
  ```
  method setHomeDirectory(
      :$dir!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method setMode
  
  ```
  method setMode(
      :$mode!
  ) returns Mu
  
  ```
  
  Sets the mode, which may be one of [safe, protect, standard, attack]
  
  ### method setOptionAlertOverridesFilePath
  
  ```
  method setOptionAlertOverridesFilePath(
      :$filePath
  ) returns Mu
  
  ```
  
  Sets (or clears, if empty) the path to the file with alert overrides.
  
  ### method setOptionDefaultUserAgent
  
  ```
  method setOptionDefaultUserAgent(
      :$String!
  ) returns Mu
  
  ```
  
  Sets the user agent that ZAP should use when creating HTTP messages (for example, spider messages or CONNECT requests to outgoing proxy).
  
  ### method setOptionDnsTtlSuccessfulQueries
  
  ```
  method setOptionDnsTtlSuccessfulQueries(
      :$Integer!
  ) returns Mu
  
  ```
  
  Sets the TTL (in seconds) of successful DNS queries (applies after ZAP restart).
  
  ### method setOptionHttpStateEnabled
  
  ```
  method setOptionHttpStateEnabled(
      :$Boolean!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method setOptionMaximumAlertInstances
  
  ```
  method setOptionMaximumAlertInstances(
      :$numberOfInstances!
  ) returns Mu
  
  ```
  
  Sets the maximum number of alert instances to include in a report. A value of zero is treated as unlimited.
  
  ### method setOptionMergeRelatedAlerts
  
  ```
  method setOptionMergeRelatedAlerts(
      :$enabled!
  ) returns Mu
  
  ```
  
  Sets whether or not related alerts will be merged in any reports generated.
  
  ### method setOptionProxyChainName
  
  ```
  method setOptionProxyChainName(
      :$String!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method setOptionProxyChainPassword
  
  ```
  method setOptionProxyChainPassword(
      :$String!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method setOptionProxyChainPort
  
  ```
  method setOptionProxyChainPort(
      :$Integer!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method setOptionProxyChainPrompt
  
  ```
  method setOptionProxyChainPrompt(
      :$Boolean!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method setOptionProxyChainRealm
  
  ```
  method setOptionProxyChainRealm(
      :$String!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method setOptionProxyChainSkipName
  
  ```
  method setOptionProxyChainSkipName(
      :$String!
  ) returns Mu
  
  ```
  
  Use actions [add|modify|remove]ProxyChainExcludedDomain instead.
  
  ### method setOptionProxyChainUserName
  
  ```
  method setOptionProxyChainUserName(
      :$String!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method setOptionSingleCookieRequestHeader
  
  ```
  method setOptionSingleCookieRequestHeader(
      :$Boolean!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method setOptionTimeoutInSecs
  
  ```
  method setOptionTimeoutInSecs(
      :$Integer!
  ) returns Mu
  
  ```
  
  Sets the connection time out, in seconds.
  
  ### method setOptionUseProxyChain
  
  ```
  method setOptionUseProxyChain(
      :$Boolean!
  ) returns Mu
  
  ```
  
  Sets whether or not the outgoing proxy should be used. The address/hostname of the outgoing proxy must be set to enable this option.
  
  ### method setOptionUseProxyChainAuth
  
  ```
  method setOptionUseProxyChainAuth(
      :$Boolean!
  ) returns Mu
  
  ```
  
  No Doc
  
  ### method shutdown
  
  ```
  method shutdown() returns Mu
  
  ```
  
  Shuts down ZAP
  
  ### method snapshotSession
  
  ```
  method snapshotSession(
      :$name,
      :$overwrite
  ) returns Mu
  
  ```
  
  Snapshots the session, optionally with the given name, and overwriting existing files. If no name is specified the name of the current session with a timestamp appended is used. If a relative path is specified it will be resolved against the "session" directory in ZAP "home" dir.
  
  ## class Zap::Users
  
  class `Zap::Users` Methods
  
  ### method newUser
  
  ```
  method newUser(
      :$contextId!,
      :$name!
  ) returns Mu
  
  ```
  
  Creates a new user with the given name for the context with the given ID.
  
  ### method removeUser
  
  ```
  method removeUser(
      :$contextId!,
      :$userId!
  ) returns Mu
  
  ```
  
  Removes the user with the given ID that belongs to the context with the given ID.
  
  ### method setAuthenticationCredentials
  
  ```
  method setAuthenticationCredentials(
      :$contextId!,
      :$userId!,
      :$authCredentialsConfigParams
  ) returns Mu
  
  ```
  
  Sets the authentication credentials for the user with the given ID that belongs to the context with the given ID.
  
  ### method setUserEnabled
  
  ```
  method setUserEnabled(
      :$contextId!,
      :$userId!,
      :$enabled!
  ) returns Mu
  
  ```
  
  Sets whether or not the user, with the given ID that belongs to the context with the given ID, should be enabled.
  
  ### method setUserName
  
  ```
  method setUserName(
      :$contextId!,
      :$userId!,
      :$name!
  ) returns Mu
  
  ```
  
  Renames the user with the given ID that belongs to the context with the given ID.
  
  ### method getUserById
  
  ```
  method getUserById(
      :$contextId!,
      :$userId!
  ) returns Mu
  
  ```
  
  Gets the data of the user with the given ID that belongs to the context with the given ID.
  
  ### method usersList
  
  ```
  method usersList(
      :$contextId
  ) returns Mu
  
  ```
  
  Gets a list of users that belong to the context with the given ID, or all users if none provided.
  
  ## class Zap::Acsrf
  
  class `Zap::Acsrf` Methods
  
  ### method removeOptionToken
  
  ```
  method removeOptionToken(
      :$String!
  ) returns Mu
  
  ```
  
  Removes the anti-CSRF token with the given name
  
  ### method genForm
  
  ```
  method genForm(
      :$hrefId!
  ) returns Mu
  
  ```
  
  Generate a form for testing lack of anti-CSRF tokens