{"id":21395966,"url":"https://github.com/khalidelboray/zap-api-raku","last_synced_at":"2026-04-01T22:04:07.079Z","repository":{"id":115625858,"uuid":"264284252","full_name":"khalidelboray/zap-api-raku","owner":"khalidelboray","description":"A Raku module for the OWASP ZAP API.","archived":false,"fork":false,"pushed_at":"2020-06-27T19:45:36.000Z","size":106,"stargazers_count":7,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-03-28T00:38:13.239Z","etag":null,"topics":["owasp","raku","raku-module","security","web-security","zaproxy"],"latest_commit_sha":null,"homepage":"https://khalidelboray.github.io/zap-api-raku/","language":"Raku","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"artistic-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/khalidelboray.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-05-15T19:46:30.000Z","updated_at":"2024-02-08T19:49:54.000Z","dependencies_parsed_at":null,"dependency_job_id":"e7e43bac-6a2e-48f4-9ca7-417bc5715900","html_url":"https://github.com/khalidelboray/zap-api-raku","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/khalidelboray/zap-api-raku","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khalidelboray%2Fzap-api-raku","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khalidelboray%2Fzap-api-raku/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khalidelboray%2Fzap-api-raku/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khalidelboray%2Fzap-api-raku/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/khalidelboray","download_url":"https://codeload.github.com/khalidelboray/zap-api-raku/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khalidelboray%2Fzap-api-raku/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31292631,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-01T21:15:39.731Z","status":"ssl_error","status_checked_at":"2026-04-01T21:15:34.046Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["owasp","raku","raku-module","security","web-security","zaproxy"],"created_at":"2024-11-22T14:24:14.054Z","updated_at":"2026-04-01T22:04:07.046Z","avatar_url":"https://github.com/khalidelboray.png","language":"Raku","funding_links":[],"categories":[],"sub_categories":[],"readme":"[OWASP ZAP API](https://www.zaproxy.org/docs/api/) Raku module\n==============================================================\n\nSYNOPSIS\n========\n\n## `Zap`\n\n```perl6\nuse lib 'lib';\nuse Zap;\n# Config Zap Client\nZapConfig(:apikey\u003capikey12345\u003e,:port\u003c8081\u003e,:addr\u003c127.0.0.1\u003e);\n# send a url to the spider\nmy $scanId = Zap::Spider.scan(:url\u003chttps://perl.org\u003e);\n# get the spider status\nmy $status = Zap::Spider.status(:$scanId);\n# wait for the spider to finish then get the result\n$*OUT = $*OUT.open(:!buffer);\nwhile Zap::Spider.status(:$scanId) \u003c 100 {\n    print \"Spider progress {Zap::Spider.status(:$scanId)}  \\r\";\n}\n$*OUT = $*OUT.open(:buffer);\nput \"URL : $_\" for Zap::Spider.results(:$scanId);\nmy @scans = Zap::Spider.scans; # this needs some work\nput \"ID , Progress , State\";\nfor @scans -\u003e %scan {\n    put %scan\u003cid progress state\u003e.fmt(\"%s\",', ')\n}\n\n```\nInstallation\n============\n\n`zef install Zap`\n\nTODO\n====\n\n* Make the code and API Response more easy to handle\n* Write a Script to provide a CLI `raku-zap` maybe ?\n* Write an Interface for the zap CLI \n* Automate Spider and Scanners \n* Since we are using Cro::HTTP::Client , we can handel the other response formats with `body-parsers` (a `Cro::HTTP::BodyParser` class)\n\n\nBad Generated Docs (needs more work)\n================== \n\nclass Zap::Ruleconfig\n---------------------\n\nclass `Zap::Ruleconfig` Methods\n\n### method resetAllRuleConfigValues\n\n```perl6\nmethod resetAllRuleConfigValues() returns Mu\n```\n\nReset all of the rule configurations\n\n### method resetRuleConfigValue\n\n```perl6\nmethod resetRuleConfigValue(\n    :$key!\n) returns Mu\n```\n\nReset the specified rule configuration, which must already exist\n\n### method setRuleConfigValue\n\n```perl6\nmethod setRuleConfigValue(\n    :$key!,\n    :$value\n) returns Mu\n```\n\nSet the specified rule configuration, which must already exist\n\nclass Zap::Break\n----------------\n\nclass `Zap::Break` Methods\n\n### method isBreakRequest\n\n```perl6\nmethod isBreakRequest() returns Mu\n```\n\nReturns True if ZAP will break on requests\n\n### method isBreakResponse\n\n```perl6\nmethod isBreakResponse() returns Mu\n```\n\nReturns True if ZAP will break on responses\n\n### method waitForHttpBreak\n\n```perl6\nmethod waitForHttpBreak(\n    :$poll,\n    :$keepalive\n) returns Mu\n```\n\nWaits until an HTTP breakpoint has been hit, at which point it returns the message. Poll is the number of milliseconds ZAP will pause between checking for breakpoints being hit (default 500). If keepalive is zero or less then the response will be returned as a Server Sent Event, otherwise it is used as the frequency in seconds at which 'keepalive' events should be returned and the response is sent as a standard response.\n\n### method addHttpBreakpoint\n\n```perl6\nmethod addHttpBreakpoint(\n    :$string!,\n    :$location!,\n    :$match!,\n    :$inverse!,\n    :$ignorecase!\n) returns Mu\n```\n\nAdds a custom HTTP breakpoint. The string is the string to match. Location may be one of: url, request_header, request_body, response_header or response_body. Match may be: contains or regex. Inverse (match) may be true or false. Lastly, ignorecase (when matching the string) may be true or false.\n\n### method break\n\n```perl6\nmethod break(\n    :$type!,\n    :$state!,\n    :$scope\n) returns Mu\n```\n\nControls the global break functionality. The type may be one of: http-all, http-request or http-response. The state may be true (for turning break on for the specified type) or false (for turning break off). Scope is not currently used.\n\n### method continue\n\n```perl6\nmethod continue() returns Mu\n```\n\nSubmits the currently intercepted message and unsets the global request/response breakpoints\n\n### method drop\n\n```perl6\nmethod drop() returns Mu\n```\n\nDrops the currently intercepted message\n\n### method removeHttpBreakpoint\n\n```perl6\nmethod removeHttpBreakpoint(\n    :$string!,\n    :$location!,\n    :$match!,\n    :$inverse!,\n    :$ignorecase!\n) returns Mu\n```\n\nRemoves the specified breakpoint\n\n### method setHttpMessage\n\n```perl6\nmethod setHttpMessage(\n    :$httpHeader!,\n    :$httpBody\n) returns Mu\n```\n\nOverwrites the currently intercepted message with the data provided\n\n### method step\n\n```perl6\nmethod step() returns Mu\n```\n\nSubmits the currently intercepted message, the next request or response will automatically be intercepted\n\nclass Zap::Hud\n--------------\n\nclass `Zap::Hud` Methods\n\n### method hudAlertData\n\n```perl6\nmethod hudAlertData(\n    :$url!\n) returns Mu\n```\n\nReturns the alert summary needed by the HUD for the specified URL\n\n### method optionAllowUnsafeEval\n\n```perl6\nmethod optionAllowUnsafeEval() returns Mu\n```\n\nReturns true if the 'Allow unsafe-eval' option is set\n\n### method optionBaseDirectory\n\n```perl6\nmethod optionBaseDirectory() returns Mu\n```\n\nReturns the base directory from which the HUD files are loaded\n\n### method optionDevelopmentMode\n\n```perl6\nmethod optionDevelopmentMode() returns Mu\n```\n\nReturns true if the 'Development mode' option is set\n\n### method optionEnableOnDomainMsgs\n\n```perl6\nmethod optionEnableOnDomainMsgs() returns Mu\n```\n\nNo Doc\n\n### method optionEnabledForDaemon\n\n```perl6\nmethod optionEnabledForDaemon() returns Mu\n```\n\nNo Doc\n\n### method optionEnabledForDesktop\n\n```perl6\nmethod optionEnabledForDesktop() returns Mu\n```\n\nNo Doc\n\n### method optionInScopeOnly\n\n```perl6\nmethod optionInScopeOnly() returns Mu\n```\n\nReturns true if the 'In scope only' option is set\n\n### method optionRemoveCSP\n\n```perl6\nmethod optionRemoveCSP() returns Mu\n```\n\nReturns true if the 'Remove CSP' option is set\n\n### method optionShowWelcomeScreen\n\n```perl6\nmethod optionShowWelcomeScreen() returns Mu\n```\n\nNo Doc\n\n### method optionSkipTutorialTasks\n\n```perl6\nmethod optionSkipTutorialTasks() returns Mu\n```\n\nNo Doc\n\n### method optionTutorialHost\n\n```perl6\nmethod optionTutorialHost() returns Mu\n```\n\nNo Doc\n\n### method optionTutorialPort\n\n```perl6\nmethod optionTutorialPort() returns Mu\n```\n\nNo Doc\n\n### method optionTutorialTasksDone\n\n```perl6\nmethod optionTutorialTasksDone() returns Mu\n```\n\nNo Doc\n\n### method optionTutorialTestMode\n\n```perl6\nmethod optionTutorialTestMode() returns Mu\n```\n\nNo Doc\n\n### method optionTutorialUpdates\n\n```perl6\nmethod optionTutorialUpdates() returns Mu\n```\n\nNo Doc\n\n### method tutorialUpdates\n\n```perl6\nmethod tutorialUpdates() returns Mu\n```\n\nNo Doc\n\n### method upgradedDomains\n\n```perl6\nmethod upgradedDomains() returns Mu\n```\n\nNo Doc\n\n### method changesInHtml\n\n```perl6\nmethod changesInHtml() returns Mu\n```\n\nReturns the changelog in HTML format\n\n### method log\n\n```perl6\nmethod log(\n    :$record!\n) returns Mu\n```\n\nUsed by the HUD to log messages from the browser\n\n### method recordRequest\n\n```perl6\nmethod recordRequest(\n    :$header!,\n    :$body!\n) returns Mu\n```\n\nUsed by the HUD to cache a request the user wants to send in the browser\n\n### method resetTutorialTasks\n\n```perl6\nmethod resetTutorialTasks() returns Mu\n```\n\nReset the tutorial tasks so that they must be completed again\n\n### method setOptionBaseDirectory\n\n```perl6\nmethod setOptionBaseDirectory(\n    :$String!\n) returns Mu\n```\n\nSet the base directory from which the HUD files are loaded\n\n### method setOptionDevelopmentMode\n\n```perl6\nmethod setOptionDevelopmentMode(\n    :$Boolean!\n) returns Mu\n```\n\nSets the boolean option 'Development mode'\n\n### method setOptionEnableOnDomainMsgs\n\n```perl6\nmethod setOptionEnableOnDomainMsgs(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionEnabledForDaemon\n\n```perl6\nmethod setOptionEnabledForDaemon(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionEnabledForDesktop\n\n```perl6\nmethod setOptionEnabledForDesktop(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionInScopeOnly\n\n```perl6\nmethod setOptionInScopeOnly(\n    :$Boolean!\n) returns Mu\n```\n\nSets the boolean option 'In scope only'\n\n### method setOptionRemoveCSP\n\n```perl6\nmethod setOptionRemoveCSP(\n    :$Boolean!\n) returns Mu\n```\n\nSets the boolean option 'Remove CSP'\n\n### method setOptionShowWelcomeScreen\n\n```perl6\nmethod setOptionShowWelcomeScreen(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionSkipTutorialTasks\n\n```perl6\nmethod setOptionSkipTutorialTasks(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionTutorialTaskDone\n\n```perl6\nmethod setOptionTutorialTaskDone(\n    :$String!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionTutorialTestMode\n\n```perl6\nmethod setOptionTutorialTestMode(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setUiOption\n\n```perl6\nmethod setUiOption(\n    :$key!,\n    :$value\n) returns Mu\n```\n\nSets a UI option with the given key and value. The key must be 50 or fewer alphanumeric characters\n\nclass Zap::Forceduser\n---------------------\n\nclass `Zap::Forceduser` Methods\n\n### method setForcedUser\n\n```perl6\nmethod setForcedUser(\n    :$contextId!,\n    :$userId!\n) returns Mu\n```\n\nSets the user (ID) that should be used in 'forced user' mode for the given context (ID)\n\n### method setForcedUserModeEnabled\n\n```perl6\nmethod setForcedUserModeEnabled(\n    :$boolean!\n) returns Mu\n```\n\nSets if 'forced user' mode should be enabled or not\n\nclass Zap::Stats\n----------------\n\nclass `Zap::Stats` Methods\n\n### method clearStats\n\n```perl6\nmethod clearStats(\n    :$keyPrefix\n) returns Mu\n```\n\nClears all of the statistics\n\n### method setOptionInMemoryEnabled\n\n```perl6\nmethod setOptionInMemoryEnabled(\n    :$Boolean!\n) returns Mu\n```\n\nSets whether in memory statistics are enabled\n\n### method setOptionStatsdHost\n\n```perl6\nmethod setOptionStatsdHost(\n    :$String!\n) returns Mu\n```\n\nSets the Statsd service hostname, supply an empty string to stop using a Statsd service\n\n### method setOptionStatsdPort\n\n```perl6\nmethod setOptionStatsdPort(\n    :$Integer!\n) returns Mu\n```\n\nSets the Statsd service port\n\n### method setOptionStatsdPrefix\n\n```perl6\nmethod setOptionStatsdPrefix(\n    :$String!\n) returns Mu\n```\n\nSets the prefix to be applied to all stats sent to the configured Statsd service\n\n### method optionStatsdEnabled\n\n```perl6\nmethod optionStatsdEnabled() returns Mu\n```\n\nReturns 'true' if a Statsd server has been correctly configured, otherwise returns 'false'\n\n### method optionStatsdHost\n\n```perl6\nmethod optionStatsdHost() returns Mu\n```\n\nGets the Statsd service hostname\n\n### method optionStatsdPort\n\n```perl6\nmethod optionStatsdPort() returns Mu\n```\n\nGets the Statsd service port\n\n### method optionStatsdPrefix\n\n```perl6\nmethod optionStatsdPrefix() returns Mu\n```\n\nGets the prefix to be applied to all stats sent to the configured Statsd service\n\n### method siteStats\n\n```perl6\nmethod siteStats(\n    :$site!,\n    :$keyPrefix\n) returns Mu\n```\n\nGets all of the global statistics, optionally filtered by a key prefix\n\n### method stats\n\n```perl6\nmethod stats(\n    :$keyPrefix\n) returns Mu\n```\n\nStatistics\n\nclass Zap::Alertfilter\n----------------------\n\nclass `Zap::Alertfilter` Methods\n\n### method addAlertFilter\n\n```perl6\nmethod addAlertFilter(\n    :$contextId!,\n    :$ruleId!,\n    :$newLevel!,\n    :$url,\n    :$urlIsRegex,\n    :$parameter,\n    :$enabled,\n    :$parameterIsRegex,\n    :$attack,\n    :$attackIsRegex,\n    :$evidence,\n    :$evidenceIsRegex\n) returns Mu\n```\n\nAdds a new alert filter for the context with the given ID.\n\n### method addGlobalAlertFilter\n\n```perl6\nmethod addGlobalAlertFilter(\n    :$ruleId!,\n    :$newLevel!,\n    :$url,\n    :$urlIsRegex,\n    :$parameter,\n    :$enabled,\n    :$parameterIsRegex,\n    :$attack,\n    :$attackIsRegex,\n    :$evidence,\n    :$evidenceIsRegex\n) returns Mu\n```\n\nAdds a new global alert filter.\n\n### method removeAlertFilter\n\n```perl6\nmethod removeAlertFilter(\n    :$contextId!,\n    :$ruleId!,\n    :$newLevel!,\n    :$url,\n    :$urlIsRegex,\n    :$parameter,\n    :$enabled,\n    :$parameterIsRegex,\n    :$attack,\n    :$attackIsRegex,\n    :$evidence,\n    :$evidenceIsRegex\n) returns Mu\n```\n\nRemoves an alert filter from the context with the given ID.\n\n### method removeGlobalAlertFilter\n\n```perl6\nmethod removeGlobalAlertFilter(\n    :$ruleId!,\n    :$newLevel!,\n    :$url,\n    :$urlIsRegex,\n    :$parameter,\n    :$enabled,\n    :$parameterIsRegex,\n    :$attack,\n    :$attackIsRegex,\n    :$evidence,\n    :$evidenceIsRegex\n) returns Mu\n```\n\nRemoves a global alert filter.\n\nclass Zap::Ascan\n----------------\n\nclass `Zap::Ascan` Methods\n\n### method addExcludedParam\n\n```perl6\nmethod addExcludedParam(\n    :$name!,\n    :$type,\n    :$url\n) returns Mu\n```\n\nAdds a new parameter excluded from the scan, using the specified name. Optionally sets if the new entry applies to a specific URL (default, all URLs) and sets the ID of the type of the parameter (default, ID of any type). The type IDs can be obtained with the view excludedParamTypes.\n\n### method addScanPolicy\n\n```perl6\nmethod addScanPolicy(\n    :$scanPolicyName!,\n    :$alertThreshold,\n    :$attackStrength\n) returns Mu\n```\n\nNo Doc\n\n### method clearExcludedFromScan\n\n```perl6\nmethod clearExcludedFromScan() returns Mu\n```\n\nClears the regexes of URLs excluded from the active scans.\n\n### method disableAllScanners\n\n```perl6\nmethod disableAllScanners(\n    :$scanPolicyName\n) returns Mu\n```\n\nDisables all scanners of the scan policy with the given name, or the default if none given.\n\n### method disableScanners\n\n```perl6\nmethod disableScanners(\n    :$ids!,\n    :$scanPolicyName\n) returns Mu\n```\n\nDisables the scanners with the given IDs (comma separated list of IDs) of the scan policy with the given name, or the default if none given.\n\n### method enableAllScanners\n\n```perl6\nmethod enableAllScanners(\n    :$scanPolicyName\n) returns Mu\n```\n\nEnables all scanners of the scan policy with the given name, or the default if none given.\n\n### method enableScanners\n\n```perl6\nmethod enableScanners(\n    :$ids!,\n    :$scanPolicyName\n) returns Mu\n```\n\nEnables the scanners with the given IDs (comma separated list of IDs) of the scan policy with the given name, or the default if none given.\n\n### method excludeFromScan\n\n```perl6\nmethod excludeFromScan(\n    :$regex!\n) returns Mu\n```\n\nAdds a regex of URLs that should be excluded from the active scans.\n\n### method importScanPolicy\n\n```perl6\nmethod importScanPolicy(\n    :$path!\n) returns Mu\n```\n\nImports a Scan Policy using the given file system path.\n\n### method modifyExcludedParam\n\n```perl6\nmethod modifyExcludedParam(\n    :$idx!,\n    :$name,\n    :$type,\n    :$url\n) returns Mu\n```\n\nModifies a parameter excluded from the scan. Allows to modify the name, the URL and the type of parameter. The parameter is selected with its index, which can be obtained with the view excludedParams.\n\n### method pause\n\n```perl6\nmethod pause(\n    :$scanId!\n) returns Mu\n```\n\nNo Doc\n\n### method pauseAllScans\n\n```perl6\nmethod pauseAllScans() returns Mu\n```\n\nNo Doc\n\n### method removeAllScans\n\n```perl6\nmethod removeAllScans() returns Mu\n```\n\nNo Doc\n\n### method removeExcludedParam\n\n```perl6\nmethod removeExcludedParam(\n    :$idx!\n) returns Mu\n```\n\nRemoves a parameter excluded from the scan, with the given index. The index can be obtained with the view excludedParams.\n\n### method removeScan\n\n```perl6\nmethod removeScan(\n    :$scanId!\n) returns Mu\n```\n\nNo Doc\n\n### method removeScanPolicy\n\n```perl6\nmethod removeScanPolicy(\n    :$scanPolicyName!\n) returns Mu\n```\n\nNo Doc\n\n### method resume\n\n```perl6\nmethod resume(\n    :$scanId!\n) returns Mu\n```\n\nNo Doc\n\n### method resumeAllScans\n\n```perl6\nmethod resumeAllScans() returns Mu\n```\n\nNo Doc\n\n### method scan\n\n```perl6\nmethod scan(\n    :$url,\n    :$recurse,\n    :$inScopeOnly,\n    :$scanPolicyName,\n    :$method,\n    :$postData,\n    :$contextId\n) returns Mu\n```\n\nRuns the active scanner against the given URL and/or Context. Optionally, the 'recurse' parameter can be used to scan URLs under the given URL, the parameter 'inScopeOnly' can be used to constrain the scan to URLs that are in scope (ignored if a Context is specified), the parameter 'scanPolicyName' allows to specify the scan policy (if none is given it uses the default scan policy), the parameters 'method' and 'postData' allow to select a given request in conjunction with the given URL.\n\n### method scanAsUser\n\n```perl6\nmethod scanAsUser(\n    :$url,\n    :$contextId,\n    :$userId,\n    :$recurse,\n    :$scanPolicyName,\n    :$method,\n    :$postData\n) returns Mu\n```\n\nActive Scans from the perspective of a User, obtained using the given Context ID and User ID. See 'scan' action for more details.\n\n### method setEnabledPolicies\n\n```perl6\nmethod setEnabledPolicies(\n    :$ids!,\n    :$scanPolicyName\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionAddQueryParam\n\n```perl6\nmethod setOptionAddQueryParam(\n    :$Boolean!\n) returns Mu\n```\n\nSets whether or not the active scanner should add a query param to GET requests which do not have parameters to start with.\n\n### method setOptionAllowAttackOnStart\n\n```perl6\nmethod setOptionAllowAttackOnStart(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionAttackPolicy\n\n```perl6\nmethod setOptionAttackPolicy(\n    :$String!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionDefaultPolicy\n\n```perl6\nmethod setOptionDefaultPolicy(\n    :$String!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionDelayInMs\n\n```perl6\nmethod setOptionDelayInMs(\n    :$Integer!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionHandleAntiCSRFTokens\n\n```perl6\nmethod setOptionHandleAntiCSRFTokens(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionHostPerScan\n\n```perl6\nmethod setOptionHostPerScan(\n    :$Integer!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionInjectPluginIdInHeader\n\n```perl6\nmethod setOptionInjectPluginIdInHeader(\n    :$Boolean!\n) returns Mu\n```\n\nSets whether or not the active scanner should inject the HTTP request header X-ZAP-Scan-ID, with the ID of the scanner that's sending the requests.\n\n### method setOptionMaxChartTimeInMins\n\n```perl6\nmethod setOptionMaxChartTimeInMins(\n    :$Integer!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionMaxResultsToList\n\n```perl6\nmethod setOptionMaxResultsToList(\n    :$Integer!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionMaxRuleDurationInMins\n\n```perl6\nmethod setOptionMaxRuleDurationInMins(\n    :$Integer!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionMaxScanDurationInMins\n\n```perl6\nmethod setOptionMaxScanDurationInMins(\n    :$Integer!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionMaxScansInUI\n\n```perl6\nmethod setOptionMaxScansInUI(\n    :$Integer!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionPromptInAttackMode\n\n```perl6\nmethod setOptionPromptInAttackMode(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionPromptToClearFinishedScans\n\n```perl6\nmethod setOptionPromptToClearFinishedScans(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionRescanInAttackMode\n\n```perl6\nmethod setOptionRescanInAttackMode(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionScanHeadersAllRequests\n\n```perl6\nmethod setOptionScanHeadersAllRequests(\n    :$Boolean!\n) returns Mu\n```\n\nSets whether or not the HTTP Headers of all requests should be scanned. Not just requests that send parameters, through the query or request body.\n\n### method setOptionShowAdvancedDialog\n\n```perl6\nmethod setOptionShowAdvancedDialog(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionTargetParamsEnabledRPC\n\n```perl6\nmethod setOptionTargetParamsEnabledRPC(\n    :$Integer!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionTargetParamsInjectable\n\n```perl6\nmethod setOptionTargetParamsInjectable(\n    :$Integer!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionThreadPerHost\n\n```perl6\nmethod setOptionThreadPerHost(\n    :$Integer!\n) returns Mu\n```\n\nNo Doc\n\n### method setPolicyAlertThreshold\n\n```perl6\nmethod setPolicyAlertThreshold(\n    :$id!,\n    :$alertThreshold!,\n    :$scanPolicyName\n) returns Mu\n```\n\nNo Doc\n\n### method setPolicyAttackStrength\n\n```perl6\nmethod setPolicyAttackStrength(\n    :$id!,\n    :$attackStrength!,\n    :$scanPolicyName\n) returns Mu\n```\n\nNo Doc\n\n### method setScannerAlertThreshold\n\n```perl6\nmethod setScannerAlertThreshold(\n    :$id!,\n    :$alertThreshold!,\n    :$scanPolicyName\n) returns Mu\n```\n\nNo Doc\n\n### method setScannerAttackStrength\n\n```perl6\nmethod setScannerAttackStrength(\n    :$id!,\n    :$attackStrength!,\n    :$scanPolicyName\n) returns Mu\n```\n\nNo Doc\n\n### method skipScanner\n\n```perl6\nmethod skipScanner(\n    :$scanId!,\n    :$scannerId!\n) returns Mu\n```\n\nSkips the scanner using the given IDs of the scan and the scanner.\n\n### method stop\n\n```perl6\nmethod stop(\n    :$scanId!\n) returns Mu\n```\n\nNo Doc\n\n### method stopAllScans\n\n```perl6\nmethod stopAllScans() returns Mu\n```\n\nNo Doc\n\n### method updateScanPolicy\n\n```perl6\nmethod updateScanPolicy(\n    :$scanPolicyName!,\n    :$alertThreshold,\n    :$attackStrength\n) returns Mu\n```\n\nNo Doc\n\n### method excludedFromScan\n\n```perl6\nmethod excludedFromScan() returns Mu\n```\n\nGets the regexes of URLs excluded from the active scans.\n\n### method excludedParamTypes\n\n```perl6\nmethod excludedParamTypes() returns Mu\n```\n\nGets all the types of excluded parameters. For each type the following are shown: the ID and the name.\n\n### method excludedParams\n\n```perl6\nmethod excludedParams() returns Mu\n```\n\nGets all the parameters that are excluded. For each parameter the following are shown: the name, the URL, and the parameter type.\n\n### method messagesIds\n\n```perl6\nmethod messagesIds(\n    :$scanId!\n) returns Mu\n```\n\nGets the IDs of the messages sent during the scan with the given ID. A message can be obtained with 'message' core view.\n\n### method optionAddQueryParam\n\n```perl6\nmethod optionAddQueryParam() returns Mu\n```\n\nTells whether or not the active scanner should add a query parameter to GET request that don't have parameters to start with.\n\n### method optionAllowAttackOnStart\n\n```perl6\nmethod optionAllowAttackOnStart() returns Mu\n```\n\nNo Doc\n\n### method optionAttackPolicy\n\n```perl6\nmethod optionAttackPolicy() returns Mu\n```\n\nNo Doc\n\n### method optionDefaultPolicy\n\n```perl6\nmethod optionDefaultPolicy() returns Mu\n```\n\nNo Doc\n\n### method optionDelayInMs\n\n```perl6\nmethod optionDelayInMs() returns Mu\n```\n\nNo Doc\n\n### method optionExcludedParamList\n\n```perl6\nmethod optionExcludedParamList() returns Mu\n```\n\nUse view excludedParams instead.\n\n### method optionHandleAntiCSRFTokens\n\n```perl6\nmethod optionHandleAntiCSRFTokens() returns Mu\n```\n\nNo Doc\n\n### method optionHostPerScan\n\n```perl6\nmethod optionHostPerScan() returns Mu\n```\n\nNo Doc\n\n### method optionInjectPluginIdInHeader\n\n```perl6\nmethod optionInjectPluginIdInHeader() returns Mu\n```\n\nTells whether or not the active scanner should inject the HTTP request header X-ZAP-Scan-ID, with the ID of the scanner that's sending the requests.\n\n### method optionMaxChartTimeInMins\n\n```perl6\nmethod optionMaxChartTimeInMins() returns Mu\n```\n\nNo Doc\n\n### method optionMaxResultsToList\n\n```perl6\nmethod optionMaxResultsToList() returns Mu\n```\n\nNo Doc\n\n### method optionMaxRuleDurationInMins\n\n```perl6\nmethod optionMaxRuleDurationInMins() returns Mu\n```\n\nNo Doc\n\n### method optionMaxScanDurationInMins\n\n```perl6\nmethod optionMaxScanDurationInMins() returns Mu\n```\n\nNo Doc\n\n### method optionMaxScansInUI\n\n```perl6\nmethod optionMaxScansInUI() returns Mu\n```\n\nNo Doc\n\n### method optionPromptInAttackMode\n\n```perl6\nmethod optionPromptInAttackMode() returns Mu\n```\n\nNo Doc\n\n### method optionPromptToClearFinishedScans\n\n```perl6\nmethod optionPromptToClearFinishedScans() returns Mu\n```\n\nNo Doc\n\n### method optionRescanInAttackMode\n\n```perl6\nmethod optionRescanInAttackMode() returns Mu\n```\n\nNo Doc\n\n### method optionScanHeadersAllRequests\n\n```perl6\nmethod optionScanHeadersAllRequests() returns Mu\n```\n\nTells whether or not the HTTP Headers of all requests should be scanned. Not just requests that send parameters, through the query or request body.\n\n### method optionShowAdvancedDialog\n\n```perl6\nmethod optionShowAdvancedDialog() returns Mu\n```\n\nNo Doc\n\n### method optionTargetParamsEnabledRPC\n\n```perl6\nmethod optionTargetParamsEnabledRPC() returns Mu\n```\n\nNo Doc\n\n### method optionTargetParamsInjectable\n\n```perl6\nmethod optionTargetParamsInjectable() returns Mu\n```\n\nNo Doc\n\n### method optionThreadPerHost\n\n```perl6\nmethod optionThreadPerHost() returns Mu\n```\n\nNo Doc\n\n### method policies\n\n```perl6\nmethod policies(\n    :$scanPolicyName,\n    :$policyId\n) returns Mu\n```\n\nNo Doc\n\n### method scanPolicyNames\n\n```perl6\nmethod scanPolicyNames() returns Mu\n```\n\nNo Doc\n\n### method scanProgress\n\n```perl6\nmethod scanProgress(\n    :$scanId\n) returns Mu\n```\n\nNo Doc\n\n### method scanners\n\n```perl6\nmethod scanners(\n    :$scanPolicyName,\n    :$policyId\n) returns Mu\n```\n\nGets the scanners, optionally, of the given scan policy and/or scanner policy/category ID.\n\n### method scans\n\n```perl6\nmethod scans() returns Mu\n```\n\nNo Doc\n\n### method status\n\n```perl6\nmethod status(\n    :$scanId\n) returns Mu\n```\n\nNo Doc\n\nclass Zap::Spider\n-----------------\n\nclass `Zap::Spider` Methods\n\n### method domainsAlwaysInScope\n\n```perl6\nmethod domainsAlwaysInScope() returns Mu\n```\n\nGets all the domains that are always in scope. For each domain the following are shown: the index, the value (domain), if enabled, and if specified as a regex.\n\n### method excludedFromScan\n\n```perl6\nmethod excludedFromScan() returns Mu\n```\n\nGets the regexes of URLs excluded from the spider scans.\n\n### method fullResults\n\n```perl6\nmethod fullResults(\n    :$scanId!\n) returns Mu\n```\n\nNo Doc\n\n### method optionAcceptCookies\n\n```perl6\nmethod optionAcceptCookies() returns Mu\n```\n\nGets whether or not a spider process should accept cookies while spidering.\n\n### method optionDomainsAlwaysInScope\n\n```perl6\nmethod optionDomainsAlwaysInScope() returns Mu\n```\n\nUse view domainsAlwaysInScope instead.\n\n### method optionDomainsAlwaysInScopeEnabled\n\n```perl6\nmethod optionDomainsAlwaysInScopeEnabled() returns Mu\n```\n\nUse view domainsAlwaysInScope instead.\n\n### method optionHandleODataParametersVisited\n\n```perl6\nmethod optionHandleODataParametersVisited() returns Mu\n```\n\nNo Doc\n\n### method optionHandleParameters\n\n```perl6\nmethod optionHandleParameters() returns Mu\n```\n\nNo Doc\n\n### method optionMaxChildren\n\n```perl6\nmethod optionMaxChildren() returns Mu\n```\n\nGets the maximum number of child nodes (per node) that can be crawled, 0 means no limit.\n\n### method optionMaxDepth\n\n```perl6\nmethod optionMaxDepth() returns Mu\n```\n\nGets the maximum depth the spider can crawl, 0 if unlimited.\n\n### method optionMaxDuration\n\n```perl6\nmethod optionMaxDuration() returns Mu\n```\n\nNo Doc\n\n### method optionMaxParseSizeBytes\n\n```perl6\nmethod optionMaxParseSizeBytes() returns Mu\n```\n\nGets the maximum size, in bytes, that a response might have to be parsed.\n\n### method optionMaxScansInUI\n\n```perl6\nmethod optionMaxScansInUI() returns Mu\n```\n\nNo Doc\n\n### method optionParseComments\n\n```perl6\nmethod optionParseComments() returns Mu\n```\n\nNo Doc\n\n### method optionParseGit\n\n```perl6\nmethod optionParseGit() returns Mu\n```\n\nNo Doc\n\n### method optionParseRobotsTxt\n\n```perl6\nmethod optionParseRobotsTxt() returns Mu\n```\n\nNo Doc\n\n### method optionParseSVNEntries\n\n```perl6\nmethod optionParseSVNEntries() returns Mu\n```\n\nNo Doc\n\n### method optionParseSitemapXml\n\n```perl6\nmethod optionParseSitemapXml() returns Mu\n```\n\nNo Doc\n\n### method optionPostForm\n\n```perl6\nmethod optionPostForm() returns Mu\n```\n\nNo Doc\n\n### method optionProcessForm\n\n```perl6\nmethod optionProcessForm() returns Mu\n```\n\nNo Doc\n\n### method optionRequestWaitTime\n\n```perl6\nmethod optionRequestWaitTime() returns Mu\n```\n\nNo Doc\n\n### method optionScope\n\n```perl6\nmethod optionScope() returns Mu\n```\n\nNo Doc\n\n### method optionScopeText\n\n```perl6\nmethod optionScopeText() returns Mu\n```\n\nNo Doc\n\n### method optionSendRefererHeader\n\n```perl6\nmethod optionSendRefererHeader() returns Mu\n```\n\nGets whether or not the 'Referer' header should be sent while spidering.\n\n### method optionShowAdvancedDialog\n\n```perl6\nmethod optionShowAdvancedDialog() returns Mu\n```\n\nNo Doc\n\n### method optionSkipURLString\n\n```perl6\nmethod optionSkipURLString() returns Mu\n```\n\nNo Doc\n\n### method optionThreadCount\n\n```perl6\nmethod optionThreadCount() returns Mu\n```\n\nNo Doc\n\n### method optionUserAgent\n\n```perl6\nmethod optionUserAgent() returns Mu\n```\n\nNo Doc\n\n### method results\n\n```perl6\nmethod results(\n    :$scanId\n) returns Mu\n```\n\nNo Doc\n\n### method scans\n\n```perl6\nmethod scans() returns Mu\n```\n\nNo Doc\n\n### method status\n\n```perl6\nmethod status(\n    :$scanId\n) returns Mu\n```\n\nNo Doc\n\n### method addDomainAlwaysInScope\n\n```perl6\nmethod addDomainAlwaysInScope(\n    :$value!,\n    :$isRegex,\n    :$isEnabled\n) returns Mu\n```\n\nAdds a new domain that's always in scope, 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).\n\n### method clearExcludedFromScan\n\n```perl6\nmethod clearExcludedFromScan() returns Mu\n```\n\nClears the regexes of URLs excluded from the spider scans.\n\n### method disableAllDomainsAlwaysInScope\n\n```perl6\nmethod disableAllDomainsAlwaysInScope() returns Mu\n```\n\nDisables all domains that are always in scope.\n\n### method enableAllDomainsAlwaysInScope\n\n```perl6\nmethod enableAllDomainsAlwaysInScope() returns Mu\n```\n\nEnables all domains that are always in scope.\n\n### method excludeFromScan\n\n```perl6\nmethod excludeFromScan(\n    :$regex!\n) returns Mu\n```\n\nAdds a regex of URLs that should be excluded from the spider scans.\n\n### method modifyDomainAlwaysInScope\n\n```perl6\nmethod modifyDomainAlwaysInScope(\n    :$idx!,\n    :$value,\n    :$isRegex,\n    :$isEnabled\n) returns Mu\n```\n\nModifies a domain that's always in scope. 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 domainsAlwaysInScope.\n\n### method pause\n\n```perl6\nmethod pause(\n    :$scanId!\n) returns Mu\n```\n\nNo Doc\n\n### method pauseAllScans\n\n```perl6\nmethod pauseAllScans() returns Mu\n```\n\nNo Doc\n\n### method removeAllScans\n\n```perl6\nmethod removeAllScans() returns Mu\n```\n\nNo Doc\n\n### method removeDomainAlwaysInScope\n\n```perl6\nmethod removeDomainAlwaysInScope(\n    :$idx!\n) returns Mu\n```\n\nRemoves a domain that's always in scope, with the given index. The index can be obtained with the view domainsAlwaysInScope.\n\n### method removeScan\n\n```perl6\nmethod removeScan(\n    :$scanId!\n) returns Mu\n```\n\nNo Doc\n\n### method resume\n\n```perl6\nmethod resume(\n    :$scanId!\n) returns Mu\n```\n\nNo Doc\n\n### method resumeAllScans\n\n```perl6\nmethod resumeAllScans() returns Mu\n```\n\nNo Doc\n\n### method scan\n\n```perl6\nmethod scan(\n    :$url,\n    :$maxChildren,\n    :$recurse,\n    :$contextName,\n    :$subtreeOnly\n) returns Mu\n```\n\nRuns the spider against the given URL (or context). Optionally, the 'maxChildren' parameter can be set to limit the number of children scanned, the 'recurse' parameter can be used to prevent the spider from seeding recursively, the parameter 'contextName' can be used to constrain the scan to a Context and the parameter 'subtreeOnly' allows to restrict the spider under a site's subtree (using the specified 'url').\n\n### method scanAsUser\n\n```perl6\nmethod scanAsUser(\n    :$contextId!,\n    :$userId!,\n    :$url,\n    :$maxChildren,\n    :$recurse,\n    :$subtreeOnly\n) returns Mu\n```\n\nRuns the spider from the perspective of a User, obtained using the given Context ID and User ID. See 'scan' action for more details.\n\n### method setOptionAcceptCookies\n\n```perl6\nmethod setOptionAcceptCookies(\n    :$Boolean!\n) returns Mu\n```\n\nSets whether or not a spider process should accept cookies while spidering.\n\n### method setOptionHandleODataParametersVisited\n\n```perl6\nmethod setOptionHandleODataParametersVisited(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionHandleParameters\n\n```perl6\nmethod setOptionHandleParameters(\n    :$String!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionMaxChildren\n\n```perl6\nmethod setOptionMaxChildren(\n    :$Integer!\n) returns Mu\n```\n\nSets the maximum number of child nodes (per node) that can be crawled, 0 means no limit.\n\n### method setOptionMaxDepth\n\n```perl6\nmethod setOptionMaxDepth(\n    :$Integer!\n) returns Mu\n```\n\nSets the maximum depth the spider can crawl, 0 for unlimited depth.\n\n### method setOptionMaxDuration\n\n```perl6\nmethod setOptionMaxDuration(\n    :$Integer!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionMaxParseSizeBytes\n\n```perl6\nmethod setOptionMaxParseSizeBytes(\n    :$Integer!\n) returns Mu\n```\n\nSets the maximum size, in bytes, that a response might have to be parsed. This allows the spider to skip big responses/files.\n\n### method setOptionMaxScansInUI\n\n```perl6\nmethod setOptionMaxScansInUI(\n    :$Integer!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionParseComments\n\n```perl6\nmethod setOptionParseComments(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionParseGit\n\n```perl6\nmethod setOptionParseGit(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionParseRobotsTxt\n\n```perl6\nmethod setOptionParseRobotsTxt(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionParseSVNEntries\n\n```perl6\nmethod setOptionParseSVNEntries(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionParseSitemapXml\n\n```perl6\nmethod setOptionParseSitemapXml(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionPostForm\n\n```perl6\nmethod setOptionPostForm(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionProcessForm\n\n```perl6\nmethod setOptionProcessForm(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionRequestWaitTime\n\n```perl6\nmethod setOptionRequestWaitTime(\n    :$Integer!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionScopeString\n\n```perl6\nmethod setOptionScopeString(\n    :$String!\n) returns Mu\n```\n\nUse actions [add|modify|remove]DomainAlwaysInScope instead.\n\n### method setOptionSendRefererHeader\n\n```perl6\nmethod setOptionSendRefererHeader(\n    :$Boolean!\n) returns Mu\n```\n\nSets whether or not the 'Referer' header should be sent while spidering.\n\n### method setOptionShowAdvancedDialog\n\n```perl6\nmethod setOptionShowAdvancedDialog(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionSkipURLString\n\n```perl6\nmethod setOptionSkipURLString(\n    :$String!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionThreadCount\n\n```perl6\nmethod setOptionThreadCount(\n    :$Integer!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionUserAgent\n\n```perl6\nmethod setOptionUserAgent(\n    :$String!\n) returns Mu\n```\n\nNo Doc\n\n### method stop\n\n```perl6\nmethod stop(\n    :$scanId\n) returns Mu\n```\n\nNo Doc\n\n### method stopAllScans\n\n```perl6\nmethod stopAllScans() returns Mu\n```\n\nNo Doc\n\nclass Zap::Selenium\n-------------------\n\nclass `Zap::Selenium` Methods\n\n### method setOptionChromeDriverPath\n\n```perl6\nmethod setOptionChromeDriverPath(\n    :$String!\n) returns Mu\n```\n\nSets the current path to ChromeDriver\n\n### method setOptionFirefoxBinaryPath\n\n```perl6\nmethod setOptionFirefoxBinaryPath(\n    :$String!\n) returns Mu\n```\n\nSets the current path to Firefox binary\n\n### method setOptionFirefoxDriverPath\n\n```perl6\nmethod setOptionFirefoxDriverPath(\n    :$String!\n) returns Mu\n```\n\nSets the current path to Firefox driver (geckodriver)\n\n### method setOptionIeDriverPath\n\n```perl6\nmethod setOptionIeDriverPath(\n    :$String!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionPhantomJsBinaryPath\n\n```perl6\nmethod setOptionPhantomJsBinaryPath(\n    :$String!\n) returns Mu\n```\n\nSets the current path to PhantomJS binary\n\n### method optionFirefoxDriverPath\n\n```perl6\nmethod optionFirefoxDriverPath() returns Mu\n```\n\nReturns the current path to Firefox driver (geckodriver)\n\n### method optionIeDriverPath\n\n```perl6\nmethod optionIeDriverPath() returns Mu\n```\n\nNo Doc\n\n### method optionPhantomJsBinaryPath\n\n```perl6\nmethod optionPhantomJsBinaryPath() returns Mu\n```\n\nReturns the current path to PhantomJS binary\n\nclass Zap::Httpsessions\n-----------------------\n\nclass `Zap::Httpsessions` Methods\n\n### method addDefaultSessionToken\n\n```perl6\nmethod addDefaultSessionToken(\n    :$sessionToken!,\n    :$tokenEnabled\n) returns Mu\n```\n\nAdds a default session token with the given name and enabled state.\n\n### method addSessionToken\n\n```perl6\nmethod addSessionToken(\n    :$site!,\n    :$sessionToken!\n) returns Mu\n```\n\nAdds the session token to the given site.\n\n### method createEmptySession\n\n```perl6\nmethod createEmptySession(\n    :$site!,\n    :$session\n) returns Mu\n```\n\nCreates an empty session for the given site. Optionally with the given name.\n\n### method removeDefaultSessionToken\n\n```perl6\nmethod removeDefaultSessionToken(\n    :$sessionToken!\n) returns Mu\n```\n\nRemoves the default session token with the given name.\n\n### method removeSession\n\n```perl6\nmethod removeSession(\n    :$site!,\n    :$session!\n) returns Mu\n```\n\nRemoves the session from the given site.\n\n### method removeSessionToken\n\n```perl6\nmethod removeSessionToken(\n    :$site!,\n    :$sessionToken!\n) returns Mu\n```\n\nRemoves the session token from the given site.\n\n### method renameSession\n\n```perl6\nmethod renameSession(\n    :$site!,\n    :$oldSessionName!,\n    :$newSessionName!\n) returns Mu\n```\n\nRenames the session of the given site.\n\n### method setActiveSession\n\n```perl6\nmethod setActiveSession(\n    :$site!,\n    :$session!\n) returns Mu\n```\n\nSets the given session as active for the given site.\n\n### method setDefaultSessionTokenEnabled\n\n```perl6\nmethod setDefaultSessionTokenEnabled(\n    :$sessionToken!,\n    :$tokenEnabled!\n) returns Mu\n```\n\nSets whether or not the default session token with the given name is enabled.\n\n### method setSessionTokenValue\n\n```perl6\nmethod setSessionTokenValue(\n    :$site!,\n    :$session!,\n    :$sessionToken!,\n    :$tokenValue!\n) returns Mu\n```\n\nSets the value of the session token of the given session for the given site.\n\n### method unsetActiveSession\n\n```perl6\nmethod unsetActiveSession(\n    :$site!\n) returns Mu\n```\n\nUnsets the active session of the given site.\n\n### method sessionTokens\n\n```perl6\nmethod sessionTokens(\n    :$site!\n) returns Mu\n```\n\nGets the names of the session tokens for the given site.\n\n### method sessions\n\n```perl6\nmethod sessions(\n    :$site!,\n    :$session\n) returns Mu\n```\n\nGets the sessions for the given site. Optionally returning just the session with the given name.\n\n### method sites\n\n```perl6\nmethod sites() returns Mu\n```\n\nGets all of the sites that have sessions.\n\nclass Zap::Localproxies\n-----------------------\n\nclass `Zap::Localproxies` Methods\n\n### method removeAdditionalProxy\n\n```perl6\nmethod removeAdditionalProxy(\n    :$address!,\n    :$port!\n) returns Mu\n```\n\nRemoves the additional proxy with the specified address and port.\n\nclass Zap::Websocket\n--------------------\n\nclass `Zap::Websocket` Methods\n\n### method message\n\n```perl6\nmethod message(\n    :$channelId!,\n    :$messageId!\n) returns Mu\n```\n\nReturns full details of the message specified by the channelId and messageId\n\n### method messages\n\n```perl6\nmethod messages(\n    :$channelId,\n    :$start,\n    :$count,\n    :$payloadPreviewLength\n) returns Mu\n```\n\nReturns 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\n\n### method sendTextMessage\n\n```perl6\nmethod sendTextMessage(\n    :$channelId!,\n    :$outgoing!,\n    :$message!\n) returns Mu\n```\n\nSends 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\n\n### method setBreakTextMessage\n\n```perl6\nmethod setBreakTextMessage(\n    :$message!,\n    :$outgoing!\n) returns Mu\n```\n\nSets the text message for an intercepted websockets message\n\nclass Zap::Authentication\n-------------------------\n\nclass `Zap::Authentication` Methods\n\n### method setAuthenticationMethod\n\n```perl6\nmethod setAuthenticationMethod(\n    :$contextId!,\n    :$authMethodName!,\n    :$authMethodConfigParams\n) returns Mu\n```\n\nSets the authentication method for the context with the given ID.\n\n### method setLoggedInIndicator\n\n```perl6\nmethod setLoggedInIndicator(\n    :$contextId!,\n    :$loggedInIndicatorRegex!\n) returns Mu\n```\n\nSets the logged in indicator for the context with the given ID.\n\n### method setLoggedOutIndicator\n\n```perl6\nmethod setLoggedOutIndicator(\n    :$contextId!,\n    :$loggedOutIndicatorRegex!\n) returns Mu\n```\n\nSets the logged out indicator for the context with the given ID.\n\n### method getLoggedInIndicator\n\n```perl6\nmethod getLoggedInIndicator(\n    :$contextId!\n) returns Mu\n```\n\nGets the logged in indicator for the context with the given ID.\n\n### method getLoggedOutIndicator\n\n```perl6\nmethod getLoggedOutIndicator(\n    :$contextId!\n) returns Mu\n```\n\nGets the logged out indicator for the context with the given ID.\n\n### method getSupportedAuthenticationMethods\n\n```perl6\nmethod getSupportedAuthenticationMethods() returns Mu\n```\n\nGets the name of the authentication methods.\n\nclass Zap::Pscan\n----------------\n\nclass `Zap::Pscan` Methods\n\n### method disableAllScanners\n\n```perl6\nmethod disableAllScanners() returns Mu\n```\n\nDisables all passive scanners\n\n### method disableAllTags\n\n```perl6\nmethod disableAllTags() returns Mu\n```\n\nDisables all passive scan tags.\n\n### method disableScanners\n\n```perl6\nmethod disableScanners(\n    :$ids!\n) returns Mu\n```\n\nDisables all passive scanners with the given IDs (comma separated list of IDs)\n\n### method enableAllScanners\n\n```perl6\nmethod enableAllScanners() returns Mu\n```\n\nEnables all passive scanners\n\n### method enableAllTags\n\n```perl6\nmethod enableAllTags() returns Mu\n```\n\nEnables all passive scan tags.\n\n### method enableScanners\n\n```perl6\nmethod enableScanners(\n    :$ids!\n) returns Mu\n```\n\nEnables all passive scanners with the given IDs (comma separated list of IDs)\n\n### method setEnabled\n\n```perl6\nmethod setEnabled(\n    :$enabled!\n) returns Mu\n```\n\nSets whether or not the passive scanning is enabled (Note: the enabled state is not persisted).\n\n### method setMaxAlertsPerRule\n\n```perl6\nmethod setMaxAlertsPerRule(\n    :$maxAlerts!\n) returns Mu\n```\n\nSets the maximum number of alerts a passive scan rule should raise.\n\n### method setScanOnlyInScope\n\n```perl6\nmethod setScanOnlyInScope(\n    :$onlyInScope!\n) returns Mu\n```\n\nSets whether or not the passive scan should be performed only on messages that are in scope.\n\n### method setScannerAlertThreshold\n\n```perl6\nmethod setScannerAlertThreshold(\n    :$id!,\n    :$alertThreshold!\n) returns Mu\n```\n\nSets the alert threshold of the passive scanner with the given ID, accepted values for alert threshold: OFF, DEFAULT, LOW, MEDIUM and HIGH\n\n### method recordsToScan\n\n```perl6\nmethod recordsToScan() returns Mu\n```\n\nThe number of records the passive scanner still has to scan\n\n### method scanOnlyInScope\n\n```perl6\nmethod scanOnlyInScope() returns Mu\n```\n\nTells whether or not the passive scan should be performed only on messages that are in scope.\n\n### method scanners\n\n```perl6\nmethod scanners() returns Mu\n```\n\nLists all passive scanners with its ID, name, enabled state and alert threshold.\n\nclass Zap::Sessionmanagement\n----------------------------\n\nclass `Zap::Sessionmanagement` Methods\n\n### method getSupportedSessionManagementMethods\n\n```perl6\nmethod getSupportedSessionManagementMethods() returns Mu\n```\n\nGets the name of the session management methods.\n\n### method setSessionManagementMethod\n\n```perl6\nmethod setSessionManagementMethod(\n    :$contextId!,\n    :$methodName!,\n    :$methodConfigParams\n) returns Mu\n```\n\nSets the session management method for the context with the given ID.\n\nclass Zap::Script\n-----------------\n\nclass `Zap::Script` Methods\n\n### method globalVar\n\n```perl6\nmethod globalVar(\n    :$varKey!\n) returns Mu\n```\n\nGets the value of the global variable with the given key. Returns an API error (DOES_NOT_EXIST) if no value was previously set.\n\n### method globalVars\n\n```perl6\nmethod globalVars() returns Mu\n```\n\nGets all the global variables (key/value pairs).\n\n### method listEngines\n\n```perl6\nmethod listEngines() returns Mu\n```\n\nLists the script engines available\n\n### method listScripts\n\n```perl6\nmethod listScripts() returns Mu\n```\n\nLists the scripts available, with its engine, name, description, type and error state.\n\n### method listTypes\n\n```perl6\nmethod listTypes() returns Mu\n```\n\nLists the script types available.\n\n### method scriptCustomVar\n\n```perl6\nmethod scriptCustomVar(\n    :$scriptName!,\n    :$varKey!\n) returns Mu\n```\n\nGets 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.\n\n### method scriptCustomVars\n\n```perl6\nmethod scriptCustomVars(\n    :$scriptName!\n) returns Mu\n```\n\nGets 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.\n\n### method scriptVar\n\n```perl6\nmethod scriptVar(\n    :$scriptName!,\n    :$varKey!\n) returns Mu\n```\n\nGets 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.\n\n### method scriptVars\n\n```perl6\nmethod scriptVars(\n    :$scriptName!\n) returns Mu\n```\n\nGets 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.\n\n### method clearGlobalCustomVar\n\n```perl6\nmethod clearGlobalCustomVar(\n    :$varKey!\n) returns Mu\n```\n\nClears a global custom variable.\n\n### method clearGlobalVar\n\n```perl6\nmethod clearGlobalVar(\n    :$varKey!\n) returns Mu\n```\n\nClears the global variable with the given key.\n\n### method clearGlobalVars\n\n```perl6\nmethod clearGlobalVars() returns Mu\n```\n\nClears the global variables.\n\n### method clearScriptCustomVar\n\n```perl6\nmethod clearScriptCustomVar(\n    :$scriptName!,\n    :$varKey!\n) returns Mu\n```\n\nClears a script custom variable.\n\n### method clearScriptVar\n\n```perl6\nmethod clearScriptVar(\n    :$scriptName!,\n    :$varKey!\n) returns Mu\n```\n\nClears 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.\n\n### method clearScriptVars\n\n```perl6\nmethod clearScriptVars(\n    :$scriptName!\n) returns Mu\n```\n\nClears the variables of the given script. Returns an API error (DOES_NOT_EXIST) if no script with the given name exists.\n\n### method disable\n\n```perl6\nmethod disable(\n    :$scriptName!\n) returns Mu\n```\n\nDisables the script with the given name\n\n### method enable\n\n```perl6\nmethod enable(\n    :$scriptName!\n) returns Mu\n```\n\nEnables the script with the given name\n\n### method load\n\n```perl6\nmethod load(\n    :$scriptName!,\n    :$scriptType!,\n    :$scriptEngine!,\n    :$fileName!,\n    :$scriptDescription,\n    :$charset\n) returns Mu\n```\n\nLoads 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).\n\n### method remove\n\n```perl6\nmethod remove(\n    :$scriptName!\n) returns Mu\n```\n\nRemoves the script with the given name\n\n### method runStandAloneScript\n\n```perl6\nmethod runStandAloneScript(\n    :$scriptName!\n) returns Mu\n```\n\nRuns the stand alone script with the given name\n\n### method setGlobalVar\n\n```perl6\nmethod setGlobalVar(\n    :$varKey!,\n    :$varValue\n) returns Mu\n```\n\nSets the value of the global variable with the given key.\n\n### method setScriptVar\n\n```perl6\nmethod setScriptVar(\n    :$scriptName!,\n    :$varKey!,\n    :$varValue\n) returns Mu\n```\n\nSets 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.\n\nclass Zap::Ajaxspider\n---------------------\n\nclass `Zap::Ajaxspider` Methods\n\n### method optionBrowserId\n\n```perl6\nmethod optionBrowserId() returns Mu\n```\n\nNo Doc\n\n### method optionClickDefaultElems\n\n```perl6\nmethod optionClickDefaultElems() returns Mu\n```\n\nNo Doc\n\n### method optionClickElemsOnce\n\n```perl6\nmethod optionClickElemsOnce() returns Mu\n```\n\nNo Doc\n\n### method optionEventWait\n\n```perl6\nmethod optionEventWait() returns Mu\n```\n\nNo Doc\n\n### method optionMaxCrawlDepth\n\n```perl6\nmethod optionMaxCrawlDepth() returns Mu\n```\n\nNo Doc\n\n### method optionMaxCrawlStates\n\n```perl6\nmethod optionMaxCrawlStates() returns Mu\n```\n\nNo Doc\n\n### method optionMaxDuration\n\n```perl6\nmethod optionMaxDuration() returns Mu\n```\n\nNo Doc\n\n### method optionNumberOfBrowsers\n\n```perl6\nmethod optionNumberOfBrowsers() returns Mu\n```\n\nNo Doc\n\n### method optionRandomInputs\n\n```perl6\nmethod optionRandomInputs() returns Mu\n```\n\nNo Doc\n\n### method optionReloadWait\n\n```perl6\nmethod optionReloadWait() returns Mu\n```\n\nNo Doc\n\n### method results\n\n```perl6\nmethod results(\n    :$start,\n    :$count\n) returns Mu\n```\n\nNo Doc\n\n### method status\n\n```perl6\nmethod status() returns Mu\n```\n\nNo Doc\n\n### method scan\n\n```perl6\nmethod scan(\n    :$url,\n    :$inScope,\n    :$contextName,\n    :$subtreeOnly\n) returns Mu\n```\n\nRuns 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').\n\n### method scanAsUser\n\n```perl6\nmethod scanAsUser(\n    :$contextName!,\n    :$userName!,\n    :$url,\n    :$subtreeOnly\n) returns Mu\n```\n\nRuns 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').\n\n### method setOptionBrowserId\n\n```perl6\nmethod setOptionBrowserId(\n    :$String!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionClickDefaultElems\n\n```perl6\nmethod setOptionClickDefaultElems(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionClickElemsOnce\n\n```perl6\nmethod setOptionClickElemsOnce(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionEventWait\n\n```perl6\nmethod setOptionEventWait(\n    :$Integer!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionMaxCrawlDepth\n\n```perl6\nmethod setOptionMaxCrawlDepth(\n    :$Integer!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionMaxCrawlStates\n\n```perl6\nmethod setOptionMaxCrawlStates(\n    :$Integer!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionMaxDuration\n\n```perl6\nmethod setOptionMaxDuration(\n    :$Integer!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionNumberOfBrowsers\n\n```perl6\nmethod setOptionNumberOfBrowsers(\n    :$Integer!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionRandomInputs\n\n```perl6\nmethod setOptionRandomInputs(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionReloadWait\n\n```perl6\nmethod setOptionReloadWait(\n    :$Integer!\n) returns Mu\n```\n\nNo Doc\n\n### method stop\n\n```perl6\nmethod stop() returns Mu\n```\n\nNo Doc\n\nclass Zap::Core\n---------------\n\nclass `Zap::Core` Methods\n\n### method alertsSummary\n\n```perl6\nmethod alertsSummary(\n    :$baseurl\n) returns Mu\n```\n\nGets number of alerts grouped by each risk level, optionally filtering by URL\n\n### method childNodes\n\n```perl6\nmethod childNodes(\n    :$url\n) returns Mu\n```\n\nGets the child nodes underneath the specified URL in the Sites tree\n\n### method excludedFromProxy\n\n```perl6\nmethod excludedFromProxy() returns Mu\n```\n\nGets the regular expressions, applied to URLs, to exclude from the local proxies.\n\n### method homeDirectory\n\n```perl6\nmethod homeDirectory() returns Mu\n```\n\nNo Doc\n\n### method hosts\n\n```perl6\nmethod hosts() returns Mu\n```\n\nGets the name of the hosts accessed through/by ZAP\n\n### method message\n\n```perl6\nmethod message(\n    :$id!\n) returns Mu\n```\n\nGets the HTTP message with the given ID. Returns the ID, request/response headers and bodies, cookies, note, type, RTT, and timestamp.\n\n### method messages\n\n```perl6\nmethod messages(\n    :$baseurl,\n    :$start,\n    :$count\n) returns Mu\n```\n\nGets the HTTP messages sent by ZAP, request and response, optionally filtered by URL and paginated with 'start' position and 'count' of messages\n\n### method messagesById\n\n```perl6\nmethod messagesById(\n    :$ids!\n) returns Mu\n```\n\nGets the HTTP messages with the given IDs.\n\n### method mode\n\n```perl6\nmethod mode() returns Mu\n```\n\nGets the mode\n\n### method numberOfAlerts\n\n```perl6\nmethod numberOfAlerts(\n    :$baseurl,\n    :$riskId\n) returns Mu\n```\n\nGets the number of alerts, optionally filtering by URL or riskId\n\n### method numberOfMessages\n\n```perl6\nmethod numberOfMessages(\n    :$baseurl\n) returns Mu\n```\n\nGets the number of messages, optionally filtering by URL\n\n### method optionAlertOverridesFilePath\n\n```perl6\nmethod optionAlertOverridesFilePath() returns Mu\n```\n\nGets the path to the file with alert overrides.\n\n### method optionDefaultUserAgent\n\n```perl6\nmethod optionDefaultUserAgent() returns Mu\n```\n\nGets the user agent that ZAP should use when creating HTTP messages (for example, spider messages or CONNECT requests to outgoing proxy).\n\n### method optionDnsTtlSuccessfulQueries\n\n```perl6\nmethod optionDnsTtlSuccessfulQueries() returns Mu\n```\n\nGets the TTL (in seconds) of successful DNS queries.\n\n### method optionHttpState\n\n```perl6\nmethod optionHttpState() returns Mu\n```\n\nNo Doc\n\n### method optionHttpStateEnabled\n\n```perl6\nmethod optionHttpStateEnabled() returns Mu\n```\n\nNo Doc\n\n### method optionMaximumAlertInstances\n\n```perl6\nmethod optionMaximumAlertInstances() returns Mu\n```\n\nGets the maximum number of alert instances to include in a report.\n\n### method optionMergeRelatedAlerts\n\n```perl6\nmethod optionMergeRelatedAlerts() returns Mu\n```\n\nGets whether or not related alerts will be merged in any reports generated.\n\n### method optionProxyChainName\n\n```perl6\nmethod optionProxyChainName() returns Mu\n```\n\nNo Doc\n\n### method optionProxyChainPassword\n\n```perl6\nmethod optionProxyChainPassword() returns Mu\n```\n\nNo Doc\n\n### method optionProxyChainPort\n\n```perl6\nmethod optionProxyChainPort() returns Mu\n```\n\nNo Doc\n\n### method optionProxyChainPrompt\n\n```perl6\nmethod optionProxyChainPrompt() returns Mu\n```\n\nNo Doc\n\n### method optionProxyChainRealm\n\n```perl6\nmethod optionProxyChainRealm() returns Mu\n```\n\nNo Doc\n\n### method optionProxyChainSkipName\n\n```perl6\nmethod optionProxyChainSkipName() returns Mu\n```\n\nUse view proxyChainExcludedDomains instead.\n\n### method optionProxyChainUserName\n\n```perl6\nmethod optionProxyChainUserName() returns Mu\n```\n\nNo Doc\n\n### method optionProxyExcludedDomains\n\n```perl6\nmethod optionProxyExcludedDomains() returns Mu\n```\n\nUse view proxyChainExcludedDomains instead.\n\n### method optionProxyExcludedDomainsEnabled\n\n```perl6\nmethod optionProxyExcludedDomainsEnabled() returns Mu\n```\n\nUse view proxyChainExcludedDomains instead.\n\n### method optionSingleCookieRequestHeader\n\n```perl6\nmethod optionSingleCookieRequestHeader() returns Mu\n```\n\nNo Doc\n\n### method optionTimeoutInSecs\n\n```perl6\nmethod optionTimeoutInSecs() returns Mu\n```\n\nGets the connection time out, in seconds.\n\n### method optionUseProxyChain\n\n```perl6\nmethod optionUseProxyChain() returns Mu\n```\n\nNo Doc\n\n### method optionUseProxyChainAuth\n\n```perl6\nmethod optionUseProxyChainAuth() returns Mu\n```\n\nNo Doc\n\n### method proxyChainExcludedDomains\n\n```perl6\nmethod proxyChainExcludedDomains() returns Mu\n```\n\nGets 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.\n\n### method sessionLocation\n\n```perl6\nmethod sessionLocation() returns Mu\n```\n\nGets the location of the current session file\n\n### method sites\n\n```perl6\nmethod sites() returns Mu\n```\n\nGets the sites accessed through/by ZAP (scheme and domain)\n\n### method urls\n\n```perl6\nmethod urls(\n    :$baseurl\n) returns Mu\n```\n\nGets the URLs accessed through/by ZAP, optionally filtering by (base) URL.\n\n### method version\n\n```perl6\nmethod version() returns Mu\n```\n\nGets ZAP version\n\n### method zapHomePath\n\n```perl6\nmethod zapHomePath() returns Mu\n```\n\nGets the path to ZAP's home directory.\n\n### method htmlreport\n\n```perl6\nmethod htmlreport() returns Mu\n```\n\nGenerates a report in HTML format\n\n### method jsonreport\n\n```perl6\nmethod jsonreport() returns Mu\n```\n\nGenerates a report in JSON format\n\n### method mdreport\n\n```perl6\nmethod mdreport() returns Mu\n```\n\nGenerates a report in Markdown format\n\n### method messageHar\n\n```perl6\nmethod messageHar(\n    :$id!\n) returns Mu\n```\n\nGets the message with the given ID in HAR format\n\n### method messagesHar\n\n```perl6\nmethod messagesHar(\n    :$baseurl,\n    :$start,\n    :$count\n) returns Mu\n```\n\nGets the HTTP messages sent through/by ZAP, in HAR format, optionally filtered by URL and paginated with 'start' position and 'count' of messages\n\n### method messagesHarById\n\n```perl6\nmethod messagesHarById(\n    :$ids!\n) returns Mu\n```\n\nGets the HTTP messages with the given IDs, in HAR format.\n\n### method proxypac\n\n```perl6\nmethod proxypac() returns Mu\n```\n\nNo Doc\n\n### method rootcert\n\n```perl6\nmethod rootcert() returns Mu\n```\n\nGets the Root CA certificate used by the local proxies.\n\n### method sendHarRequest\n\n```perl6\nmethod sendHarRequest(\n    :$request!,\n    :$followRedirects\n) returns Mu\n```\n\nSends 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.\n\n### method setproxy\n\n```perl6\nmethod setproxy(\n    :$proxy!\n) returns Mu\n```\n\nNo Doc\n\n### method xmlreport\n\n```perl6\nmethod xmlreport() returns Mu\n```\n\nGenerates a report in XML format\n\n### method accessUrl\n\n```perl6\nmethod accessUrl(\n    :$url!,\n    :$followRedirects\n) returns Mu\n```\n\nConvenient 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'.\n\n### method addProxyChainExcludedDomain\n\n```perl6\nmethod addProxyChainExcludedDomain(\n    :$value!,\n    :$isRegex,\n    :$isEnabled\n) returns Mu\n```\n\nAdds 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).\n\n### method clearExcludedFromProxy\n\n```perl6\nmethod clearExcludedFromProxy() returns Mu\n```\n\nClears the regexes of URLs excluded from the local proxies.\n\n### method deleteAlert\n\n```perl6\nmethod deleteAlert(\n    :$id!\n) returns Mu\n```\n\nDeletes the alert with the given ID.\n\n### method deleteAllAlerts\n\n```perl6\nmethod deleteAllAlerts() returns Mu\n```\n\nDeletes all alerts of the current session.\n\n### method deleteSiteNode\n\n```perl6\nmethod deleteSiteNode(\n    :$url!,\n    :$method,\n    :$postData\n) returns Mu\n```\n\nDeletes the site node found in the Sites Tree on the basis of the URL, HTTP method, and post data (if applicable and specified).\n\n### method disableAllProxyChainExcludedDomains\n\n```perl6\nmethod disableAllProxyChainExcludedDomains() returns Mu\n```\n\nDisables all domains excluded from the outgoing proxy.\n\n### method disableClientCertificate\n\n```perl6\nmethod disableClientCertificate() returns Mu\n```\n\nDisables the option for use of client certificates.\n\n### method enableAllProxyChainExcludedDomains\n\n```perl6\nmethod enableAllProxyChainExcludedDomains() returns Mu\n```\n\nEnables all domains excluded from the outgoing proxy.\n\n### method enablePKCS12ClientCertificate\n\n```perl6\nmethod enablePKCS12ClientCertificate(\n    :$filePath!,\n    :$password!,\n    :$index\n) returns Mu\n```\n\nEnables use of a PKCS12 client certificate for the certificate with the given file system path, password, and optional index.\n\n### method excludeFromProxy\n\n```perl6\nmethod excludeFromProxy(\n    :$regex!\n) returns Mu\n```\n\nAdds a regex of URLs that should be excluded from the local proxies.\n\n### method generateRootCA\n\n```perl6\nmethod generateRootCA() returns Mu\n```\n\nGenerates a new Root CA certificate for the local proxies.\n\n### method loadSession\n\n```perl6\nmethod loadSession(\n    :$name!\n) returns Mu\n```\n\nLoads the session with the given name. If a relative path is specified it will be resolved against the \"session\" directory in ZAP \"home\" dir.\n\n### method modifyProxyChainExcludedDomain\n\n```perl6\nmethod modifyProxyChainExcludedDomain(\n    :$idx!,\n    :$value,\n    :$isRegex,\n    :$isEnabled\n) returns Mu\n```\n\nModifies 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.\n\n### method newSession\n\n```perl6\nmethod newSession(\n    :$name,\n    :$overwrite\n) returns Mu\n```\n\nCreates 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.\n\n### method removeProxyChainExcludedDomain\n\n```perl6\nmethod removeProxyChainExcludedDomain(\n    :$idx!\n) returns Mu\n```\n\nRemoves a domain excluded from the outgoing proxy, with the given index. The index can be obtained with the view proxyChainExcludedDomains.\n\n### method runGarbageCollection\n\n```perl6\nmethod runGarbageCollection() returns Mu\n```\n\nNo Doc\n\n### method saveSession\n\n```perl6\nmethod saveSession(\n    :$name!,\n    :$overwrite\n) returns Mu\n```\n\nSaves the session.\n\n### method sendRequest\n\n```perl6\nmethod sendRequest(\n    :$request!,\n    :$followRedirects\n) returns Mu\n```\n\nSends 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.\n\n### method setHomeDirectory\n\n```perl6\nmethod setHomeDirectory(\n    :$dir!\n) returns Mu\n```\n\nNo Doc\n\n### method setMode\n\n```perl6\nmethod setMode(\n    :$mode!\n) returns Mu\n```\n\nSets the mode, which may be one of [safe, protect, standard, attack]\n\n### method setOptionAlertOverridesFilePath\n\n```perl6\nmethod setOptionAlertOverridesFilePath(\n    :$filePath\n) returns Mu\n```\n\nSets (or clears, if empty) the path to the file with alert overrides.\n\n### method setOptionDefaultUserAgent\n\n```perl6\nmethod setOptionDefaultUserAgent(\n    :$String!\n) returns Mu\n```\n\nSets the user agent that ZAP should use when creating HTTP messages (for example, spider messages or CONNECT requests to outgoing proxy).\n\n### method setOptionDnsTtlSuccessfulQueries\n\n```perl6\nmethod setOptionDnsTtlSuccessfulQueries(\n    :$Integer!\n) returns Mu\n```\n\nSets the TTL (in seconds) of successful DNS queries (applies after ZAP restart).\n\n### method setOptionHttpStateEnabled\n\n```perl6\nmethod setOptionHttpStateEnabled(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionMaximumAlertInstances\n\n```perl6\nmethod setOptionMaximumAlertInstances(\n    :$numberOfInstances!\n) returns Mu\n```\n\nSets the maximum number of alert instances to include in a report. A value of zero is treated as unlimited.\n\n### method setOptionMergeRelatedAlerts\n\n```perl6\nmethod setOptionMergeRelatedAlerts(\n    :$enabled!\n) returns Mu\n```\n\nSets whether or not related alerts will be merged in any reports generated.\n\n### method setOptionProxyChainName\n\n```perl6\nmethod setOptionProxyChainName(\n    :$String!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionProxyChainPassword\n\n```perl6\nmethod setOptionProxyChainPassword(\n    :$String!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionProxyChainPort\n\n```perl6\nmethod setOptionProxyChainPort(\n    :$Integer!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionProxyChainPrompt\n\n```perl6\nmethod setOptionProxyChainPrompt(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionProxyChainRealm\n\n```perl6\nmethod setOptionProxyChainRealm(\n    :$String!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionProxyChainSkipName\n\n```perl6\nmethod setOptionProxyChainSkipName(\n    :$String!\n) returns Mu\n```\n\nUse actions [add|modify|remove]ProxyChainExcludedDomain instead.\n\n### method setOptionProxyChainUserName\n\n```perl6\nmethod setOptionProxyChainUserName(\n    :$String!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionSingleCookieRequestHeader\n\n```perl6\nmethod setOptionSingleCookieRequestHeader(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionTimeoutInSecs\n\n```perl6\nmethod setOptionTimeoutInSecs(\n    :$Integer!\n) returns Mu\n```\n\nSets the connection time out, in seconds.\n\n### method setOptionUseProxyChain\n\n```perl6\nmethod setOptionUseProxyChain(\n    :$Boolean!\n) returns Mu\n```\n\nSets whether or not the outgoing proxy should be used. The address/hostname of the outgoing proxy must be set to enable this option.\n\n### method setOptionUseProxyChainAuth\n\n```perl6\nmethod setOptionUseProxyChainAuth(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method shutdown\n\n```perl6\nmethod shutdown() returns Mu\n```\n\nShuts down ZAP\n\n### method snapshotSession\n\n```perl6\nmethod snapshotSession(\n    :$name,\n    :$overwrite\n) returns Mu\n```\n\nSnapshots 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.\n\nclass Zap::Users\n----------------\n\nclass `Zap::Users` Methods\n\n### method newUser\n\n```perl6\nmethod newUser(\n    :$contextId!,\n    :$name!\n) returns Mu\n```\n\nCreates a new user with the given name for the context with the given ID.\n\n### method removeUser\n\n```perl6\nmethod removeUser(\n    :$contextId!,\n    :$userId!\n) returns Mu\n```\n\nRemoves the user with the given ID that belongs to the context with the given ID.\n\n### method setAuthenticationCredentials\n\n```perl6\nmethod setAuthenticationCredentials(\n    :$contextId!,\n    :$userId!,\n    :$authCredentialsConfigParams\n) returns Mu\n```\n\nSets the authentication credentials for the user with the given ID that belongs to the context with the given ID.\n\n### method setUserEnabled\n\n```perl6\nmethod setUserEnabled(\n    :$contextId!,\n    :$userId!,\n    :$enabled!\n) returns Mu\n```\n\nSets whether or not the user, with the given ID that belongs to the context with the given ID, should be enabled.\n\n### method setUserName\n\n```perl6\nmethod setUserName(\n    :$contextId!,\n    :$userId!,\n    :$name!\n) returns Mu\n```\n\nRenames the user with the given ID that belongs to the context with the given ID.\n\n### method getUserById\n\n```perl6\nmethod getUserById(\n    :$contextId!,\n    :$userId!\n) returns Mu\n```\n\nGets the data of the user with the given ID that belongs to the context with the given ID.\n\n### method usersList\n\n```perl6\nmethod usersList(\n    :$contextId\n) returns Mu\n```\n\nGets a list of users that belong to the context with the given ID, or all users if none provided.\n\nclass Zap::Acsrf\n----------------\n\nclass `Zap::Acsrf` Methods\n\n### method removeOptionToken\n\n```perl6\nmethod removeOptionToken(\n    :$String!\n) returns Mu\n```\n\nRemoves the anti-CSRF token with the given name\n\n### method genForm\n\n```perl6\nmethod genForm(\n    :$hrefId!\n) returns Mu\n```\n\nGenerate a form for testing lack of anti-CSRF tokens - typically invoked via ZAP\n\nclass Zap::Search\n-----------------\n\nclass `Zap::Search` Methods\n\n### method harByHeaderRegex\n\n```perl6\nmethod harByHeaderRegex(\n    :$regex!,\n    :$baseurl,\n    :$start,\n    :$count\n) returns Mu\n```\n\nReturns 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.\n\n### method harByRequestRegex\n\n```perl6\nmethod harByRequestRegex(\n    :$regex!,\n    :$baseurl,\n    :$start,\n    :$count\n) returns Mu\n```\n\nReturns 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.\n\n### method harByResponseRegex\n\n```perl6\nmethod harByResponseRegex(\n    :$regex!,\n    :$baseurl,\n    :$start,\n    :$count\n) returns Mu\n```\n\nReturns 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.\n\n### method harByUrlRegex\n\n```perl6\nmethod harByUrlRegex(\n    :$regex!,\n    :$baseurl,\n    :$start,\n    :$count\n) returns Mu\n```\n\nReturns 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.\n\n### method messagesByResponseRegex\n\n```perl6\nmethod messagesByResponseRegex(\n    :$regex!,\n    :$baseurl,\n    :$start,\n    :$count\n) returns Mu\n```\n\nReturns 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.\n\n### method messagesByUrlRegex\n\n```perl6\nmethod messagesByUrlRegex(\n    :$regex!,\n    :$baseurl,\n    :$start,\n    :$count\n) returns Mu\n```\n\nReturns 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.\n\n### method urlsByHeaderRegex\n\n```perl6\nmethod urlsByHeaderRegex(\n    :$regex!,\n    :$baseurl,\n    :$start,\n    :$count\n) returns Mu\n```\n\nReturns 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.\n\n### method urlsByRequestRegex\n\n```perl6\nmethod urlsByRequestRegex(\n    :$regex!,\n    :$baseurl,\n    :$start,\n    :$count\n) returns Mu\n```\n\nReturns 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.\n\n### method urlsByResponseRegex\n\n```perl6\nmethod urlsByResponseRegex(\n    :$regex!,\n    :$baseurl,\n    :$start,\n    :$count\n) returns Mu\n```\n\nReturns 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.\n\n### method urlsByUrlRegex\n\n```perl6\nmethod urlsByUrlRegex(\n    :$regex!,\n    :$baseurl,\n    :$start,\n    :$count\n) returns Mu\n```\n\nReturns 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.\n\nclass Zap::Replacer\n-------------------\n\nclass `Zap::Replacer` Methods\n\n### method removeRule\n\n```perl6\nmethod removeRule(\n    :$description!\n) returns Mu\n```\n\nRemoves the rule with the given description\n\n### method setEnabled\n\n```perl6\nmethod setEnabled(\n    :$description!,\n    :$bool!\n) returns Mu\n```\n\nEnables or disables the rule with the given description based on the bool parameter\n\nclass Zap::Context\n------------------\n\nclass `Zap::Context` Methods\n\n### method excludeAllContextTechnologies\n\n```perl6\nmethod excludeAllContextTechnologies(\n    :$contextName!\n) returns Mu\n```\n\nExcludes all built in technologies from a context\n\n### method excludeContextTechnologies\n\n```perl6\nmethod excludeContextTechnologies(\n    :$contextName!,\n    :$technologyNames!\n) returns Mu\n```\n\nExcludes technologies with the given names, separated by a comma, from a context\n\n### method excludeFromContext\n\n```perl6\nmethod excludeFromContext(\n    :$contextName!,\n    :$regex!\n) returns Mu\n```\n\nAdd exclude regex to context\n\n### method exportContext\n\n```perl6\nmethod exportContext(\n    :$contextName!,\n    :$contextFile!\n) returns Mu\n```\n\nExports 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.\n\n### method importContext\n\n```perl6\nmethod importContext(\n    :$contextFile!\n) returns Mu\n```\n\nImports a context from a file. If a relative file path is specified it will be resolved against the \"contexts\" directory in ZAP \"home\" dir.\n\n### method includeAllContextTechnologies\n\n```perl6\nmethod includeAllContextTechnologies(\n    :$contextName!\n) returns Mu\n```\n\nIncludes all built in technologies in to a context\n\n### method includeContextTechnologies\n\n```perl6\nmethod includeContextTechnologies(\n    :$contextName!,\n    :$technologyNames!\n) returns Mu\n```\n\nIncludes technologies with the given names, separated by a comma, to a context\n\n### method includeInContext\n\n```perl6\nmethod includeInContext(\n    :$contextName!,\n    :$regex!\n) returns Mu\n```\n\nAdd include regex to context\n\n### method newContext\n\n```perl6\nmethod newContext(\n    :$contextName!\n) returns Mu\n```\n\nCreates a new context with the given name in the current session\n\n### method removeContext\n\n```perl6\nmethod removeContext(\n    :$contextName!\n) returns Mu\n```\n\nRemoves a context in the current session\n\n### method setContextInScope\n\n```perl6\nmethod setContextInScope(\n    :$contextName!,\n    :$booleanInScope!\n) returns Mu\n```\n\nSets a context to in scope (contexts are in scope by default)\n\n### method setContextRegexs\n\n```perl6\nmethod setContextRegexs(\n    :$contextName!,\n    :$incRegexs!,\n    :$excRegexs!\n) returns Mu\n```\n\nSet the regexs to include and exclude for a context, both supplied as JSON string arrays\n\n### method excludeRegexs\n\n```perl6\nmethod excludeRegexs(\n    :$contextName!\n) returns Mu\n```\n\nList excluded regexs for context\n\n### method excludedTechnologyList\n\n```perl6\nmethod excludedTechnologyList(\n    :$contextName!\n) returns Mu\n```\n\nLists the names of all technologies excluded from a context\n\n### method includeRegexs\n\n```perl6\nmethod includeRegexs(\n    :$contextName!\n) returns Mu\n```\n\nList included regexs for context\n\n### method includedTechnologyList\n\n```perl6\nmethod includedTechnologyList(\n    :$contextName!\n) returns Mu\n```\n\nLists the names of all technologies included in a context\n\n### method technologyList\n\n```perl6\nmethod technologyList() returns Mu\n```\n\nLists the names of all built in technologies\n\n### method urls\n\n```perl6\nmethod urls(\n    :$contextName!\n) returns Mu\n```\n\nLists the URLs accessed through/by ZAP, that belong to the context with the given name.\n\nclass Zap::Autoupdate\n---------------------\n\nclass `Zap::Autoupdate` Methods\n\n### method downloadLatestRelease\n\n```perl6\nmethod downloadLatestRelease() returns Mu\n```\n\nDownloads the latest release, if any\n\n### method installAddon\n\n```perl6\nmethod installAddon(\n    :$id!\n) returns Mu\n```\n\nInstalls or updates the specified add-on, returning when complete (i.e. not asynchronously)\n\n### method setOptionCheckAddonUpdates\n\n```perl6\nmethod setOptionCheckAddonUpdates(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionCheckOnStart\n\n```perl6\nmethod setOptionCheckOnStart(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionDownloadNewRelease\n\n```perl6\nmethod setOptionDownloadNewRelease(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionInstallAddonUpdates\n\n```perl6\nmethod setOptionInstallAddonUpdates(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionInstallScannerRules\n\n```perl6\nmethod setOptionInstallScannerRules(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionReportAlphaAddons\n\n```perl6\nmethod setOptionReportAlphaAddons(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionReportBetaAddons\n\n```perl6\nmethod setOptionReportBetaAddons(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method setOptionReportReleaseAddons\n\n```perl6\nmethod setOptionReportReleaseAddons(\n    :$Boolean!\n) returns Mu\n```\n\nNo Doc\n\n### method uninstallAddon\n\n```perl6\nmethod uninstallAddon(\n    :$id!\n) returns Mu\n```\n\nUninstalls the specified add-on\n\n### method latestVersionNumber\n\n```perl6\nmethod latestVersionNumber() returns Mu\n```\n\nReturns the latest version number\n\n### method localAddons\n\n```perl6\nmethod localAddons() returns Mu\n```\n\nReturns a list with all local add-ons, installed or not.\n\n### method marketplaceAddons\n\n```perl6\nmethod marketplaceAddons() returns Mu\n```\n\nReturn a list of all of the add-ons on the ZAP Marketplace (this information is read once and then cached)\n\n### method newAddons\n\n```perl6\nmethod newAddons() returns Mu\n```\n\nReturn a list of any add-ons that have been added to the Marketplace since the last check for updates\n\n### method optionAddonDirectories\n\n```perl6\nmethod optionAddonDirectories() returns Mu\n```\n\nNo Doc\n\n### method optionCheckAddonUpdates\n\n```perl6\nmethod optionCheckAddonUpdates() returns Mu\n```\n\nNo Doc\n\n### method optionCheckOnStart\n\n```perl6\nmethod optionCheckOnStart() returns Mu\n```\n\nNo Doc\n\n### method optionDayLastChecked\n\n```perl6\nmethod optionDayLastChecked() returns Mu\n```\n\nNo Doc\n\n### method optionDayLastInstallWarned\n\n```perl6\nmethod optionDayLastInstallWarned() returns Mu\n```\n\nNo Doc\n\n### method optionDayLastUpdateWarned\n\n```perl6\nmethod optionDayLastUpdateWarned() returns Mu\n```\n\nNo Doc\n\n### method optionDownloadDirectory\n\n```perl6\nmethod optionDownloadDirectory() returns Mu\n```\n\nNo Doc\n\n### method optionDownloadNewRelease\n\n```perl6\nmethod optionDownloadNewRelease() returns Mu\n```\n\nNo Doc\n\n### method optionInstallAddonUpdates\n\n```perl6\nmethod optionInstallAddonUpdates() returns Mu\n```\n\nNo Doc\n\n### method optionInstallScannerRules\n\n```perl6\nmethod optionInstallScannerRules() returns Mu\n```\n\nNo Doc\n\n### method optionReportAlphaAddons\n\n```perl6\nmethod optionReportAlphaAddons() returns Mu\n```\n\nNo Doc\n\n### method optionReportBetaAddons\n\n```perl6\nmethod optionReportBetaAddons() returns Mu\n```\n\nNo Doc\n\n### method optionReportReleaseAddons\n\n```perl6\nmethod optionReportReleaseAddons() returns Mu\n```\n\nNo Doc\n\n### method updatedAddons\n\n```perl6\nmethod updatedAddons() returns Mu\n```\n\nReturn a list of any add-ons that have been changed in the Marketplace since the last check for updates\n\nclass Zap::Alert\n----------------\n\nclass `Zap::Alert` Methods\n\n### method addAlert\n\n```perl6\nmethod addAlert(\n    :$messageId!,\n    :$name!,\n    :$riskId!,\n    :$confidenceId!,\n    :$description!,\n    :$param,\n    :$attack,\n    :$otherInfo,\n    :$solution,\n    :$references,\n    :$evidence,\n    :$cweId,\n    :$wascId\n) returns Mu\n```\n\nAdd an alert associated with the given message ID, with the provided details. (The ID of the created alert is returned.)\n\n### method deleteAlert\n\n```perl6\nmethod deleteAlert(\n    :$id!\n) returns Mu\n```\n\nDeletes the alert with the given ID.\n\n### method deleteAllAlerts\n\n```perl6\nmethod deleteAllAlerts() returns Mu\n```\n\nDeletes all alerts of the current session.\n\n### method updateAlert\n\n```perl6\nmethod updateAlert(\n    :$id!,\n    :$name!,\n    :$riskId!,\n    :$confidenceId!,\n    :$description!,\n    :$param,\n    :$attack,\n    :$otherInfo,\n    :$solution,\n    :$references,\n    :$evidence,\n    :$cweId,\n    :$wascId\n) returns Mu\n```\n\nUpdate the alert with the given ID, with the provided details.\n\n### method alerts\n\n```perl6\nmethod alerts(\n    :$baseurl,\n    :$start,\n    :$count,\n    :$riskId\n) returns Mu\n```\n\nGets the alerts raised by ZAP, optionally filtering by URL or riskId, and paginating with 'start' position and 'count' of alerts\n\n### method alertsByRisk\n\n```perl6\nmethod alertsByRisk(\n    :$url,\n    :$recurse\n) returns Mu\n```\n\nGets 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)\n\n### method alertsSummary\n\n```perl6\nmethod alertsSummary(\n    :$baseurl\n) returns Mu\n```\n\nGets number of alerts grouped by each risk level, optionally filtering by URL\n\n### method numberOfAlerts\n\n```perl6\nmethod numberOfAlerts(\n    :$baseurl,\n    :$riskId\n) returns Mu\n```\n\nGets the number of alerts, optionally filtering by URL or riskId\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkhalidelboray%2Fzap-api-raku","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkhalidelboray%2Fzap-api-raku","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkhalidelboray%2Fzap-api-raku/lists"}