PAGES

← OWASP ZAP

OWASP ZAP — API

ZAP APIv2.16.1 Read the vendor's spec ↗

  • 735 endpoints
  • 73 deprecated
  • 2 versions archived since Jul 20, 2026
  • Last checked Sep 14, 2026

The HTTP API for controlling and accessing ZAP.

Get started

first call 
$ curl "http://zap/JSON/ascan/view/status/" \
  -H "X-ZAP-API-Key: $API_KEY"

Set $API_KEY first, then paste.

Base URL
http://zap
1 more
  • http://127.0.0.1:8080 The URL of a Local Proxy of ZAP.
Authenticate
API key in the X-ZAP-API-Key header
1 other scheme
  • API key as the apikey query parameter
Shape

What it covers

37 more areas

Endpoints

735 of 735

Open an endpoint for a runnable command, its inputs and what it returns.

Core 97

  • GET /JSON/core/action/accessUrl/ Convenient and simple action to access a URL, optionally following redirections.

    Loading…

  • GET /JSON/core/action/addProxyChainExcludedDomain/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/action/clearExcludedFromProxy/ Clears the regexes of URLs excluded from the local proxies.

    Loading…

  • GET /JSON/core/action/createSbomZip/ Create a zip file of the ZAP core and add-on SBOMs

    Loading…

  • GET /JSON/core/action/deleteAlert/ Use the API endpoint with the same name in the 'alert' component instead. deprecated

    Loading…

  • GET /JSON/core/action/deleteAllAlerts/ Use the API endpoint with the same name in the 'alert' component instead. deprecated

    Loading…

  • GET /JSON/core/action/deleteSiteNode/ Deletes the site node found in the Sites Tree on the basis of the URL, HTTP method, and post data (if applicable and specified).

    Loading…

  • GET /JSON/core/action/disableAllProxyChainExcludedDomains/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/action/disableClientCertificate/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/action/enableAllProxyChainExcludedDomains/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/action/enablePKCS12ClientCertificate/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/action/excludeFromProxy/ Adds a regex of URLs that should be excluded from the local proxies.

    Loading…

  • GET /JSON/core/action/generateRootCA/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/action/loadSession/ Loads the session with the given name.

    Loading…

  • GET /JSON/core/action/modifyProxyChainExcludedDomain/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/action/newSession/ Creates a new session, optionally overwriting existing files.

    Loading…

  • GET /JSON/core/action/removeProxyChainExcludedDomain/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/action/runGarbageCollection/

    Loading…

  • GET /JSON/core/action/saveSession/ Saves the session.

    Loading…

  • GET /JSON/core/action/sendRequest/ Sends the HTTP request, optionally following redirections.

    Loading…

  • GET /JSON/core/action/setHomeDirectory/

    Loading…

  • GET /JSON/core/action/setLogLevel/ Sets the logging level for a given logger name.

    Loading…

  • GET /JSON/core/action/setMode/ Sets the mode, which may be one of [safe, protect, standard, attack]

    Loading…

  • GET /JSON/core/action/setOptionAlertOverridesFilePath/ Sets (or clears, if empty) the path to the file with alert overrides.

    Loading…

  • GET /JSON/core/action/setOptionDefaultUserAgent/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/action/setOptionDnsTtlSuccessfulQueries/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/action/setOptionHttpStateEnabled/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/action/setOptionMaximumAlertInstances/ Sets the maximum number of alert instances to include in a report.

    Loading…

  • GET /JSON/core/action/setOptionMergeRelatedAlerts/ Sets whether or not related alerts will be merged in any reports generated.

    Loading…

  • GET /JSON/core/action/setOptionProxyChainName/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/action/setOptionProxyChainPassword/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/action/setOptionProxyChainPort/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/action/setOptionProxyChainPrompt/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/action/setOptionProxyChainRealm/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/action/setOptionProxyChainSkipName/ Option no longer in effective use. deprecated

    Loading…

  • GET /JSON/core/action/setOptionProxyChainUserName/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/action/setOptionSingleCookieRequestHeader/ Option no longer in effective use. deprecated

    Loading…

  • GET /JSON/core/action/setOptionTimeoutInSecs/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/action/setOptionUseProxyChain/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/action/setOptionUseProxyChainAuth/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/action/setOptionUseSocksProxy/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/action/shutdown/ Shuts down ZAP

    Loading…

  • GET /JSON/core/action/snapshotSession/ Snapshots the session, optionally with the given name, and overwriting existing files.

    Loading…

  • GET /JSON/core/view/alert/ Use the API endpoint with the same name in the 'alert' component instead. deprecated

    Loading…

  • GET /JSON/core/view/alerts/ Use the API endpoint with the same name in the 'alert' component instead. deprecated

    Loading…

  • GET /JSON/core/view/alertsSummary/ Use the API endpoint with the same name in the 'alert' component instead. deprecated

    Loading…

  • GET /JSON/core/view/childNodes/ Gets the child nodes underneath the specified URL in the Sites tree

    Loading…

  • GET /JSON/core/view/excludedFromProxy/ Gets the regular expressions, applied to URLs, to exclude from the local proxies.

    Loading…

  • GET /JSON/core/view/getLogLevel/ The detailed logging config, optionally filtered based on a name (ex: starts with).

    Loading…

  • GET /JSON/core/view/homeDirectory/ deprecated

    Loading…

  • GET /JSON/core/view/hosts/ Gets the name of the hosts accessed through/by ZAP

    Loading…

  • GET /JSON/core/view/message/ Gets the HTTP message with the given ID.

    Loading…

  • GET /JSON/core/view/messages/ Gets the HTTP messages sent by ZAP, request and response, optionally filtered by URL and paginated with 'start' position and 'count' of messages

    Loading…

  • GET /JSON/core/view/messagesById/ Gets the HTTP messages with the given IDs.

    Loading…

  • GET /JSON/core/view/mode/ Gets the mode

    Loading…

  • GET /JSON/core/view/numberOfAlerts/ Use the API endpoint with the same name in the 'alert' component instead. deprecated

    Loading…

  • GET /JSON/core/view/numberOfMessages/ Gets the number of messages, optionally filtering by URL

    Loading…

  • GET /JSON/core/view/optionAlertOverridesFilePath/ Gets the path to the file with alert overrides.

    Loading…

  • GET /JSON/core/view/optionDefaultUserAgent/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/view/optionDnsTtlSuccessfulQueries/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/view/optionHttpState/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/view/optionHttpStateEnabled/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/view/optionMaximumAlertInstances/ Gets the maximum number of alert instances to include in a report.

    Loading…

  • GET /JSON/core/view/optionMergeRelatedAlerts/ Gets whether or not related alerts will be merged in any reports generated.

    Loading…

  • GET /JSON/core/view/optionProxyChainName/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/view/optionProxyChainPassword/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/view/optionProxyChainPort/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/view/optionProxyChainPrompt/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/view/optionProxyChainRealm/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/view/optionProxyChainSkipName/ Use view proxyChainExcludedDomains instead. deprecated

    Loading…

  • GET /JSON/core/view/optionProxyChainUserName/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/view/optionProxyExcludedDomains/ Use view proxyChainExcludedDomains instead. deprecated

    Loading…

  • GET /JSON/core/view/optionProxyExcludedDomainsEnabled/ Use view proxyChainExcludedDomains instead. deprecated

    Loading…

  • GET /JSON/core/view/optionSingleCookieRequestHeader/ Option no longer in effective use. deprecated

    Loading…

  • GET /JSON/core/view/optionTimeoutInSecs/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/view/optionUseProxyChain/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/view/optionUseProxyChainAuth/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/view/optionUseSocksProxy/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/view/proxyChainExcludedDomains/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/core/view/sessionLocation/ Gets the location of the current session file

    Loading…

  • GET /JSON/core/view/sites/ Gets the sites accessed through/by ZAP (scheme and domain)

    Loading…

  • GET /JSON/core/view/urls/ Gets the URLs accessed through/by ZAP, optionally filtering by (base) URL.

    Loading…

  • GET /JSON/core/view/version/ Gets ZAP version

    Loading…

  • GET /JSON/core/view/zapHomePath/ Gets the path to ZAP's home directory.

    Loading…

  • GET /OTHER/core/other/fileDownload/ Download a file from the transfer directory

    Loading…

  • GET /OTHER/core/other/fileUpload/ Upload a file to the transfer directory.

    Loading…

  • GET /OTHER/core/other/htmlreport/ Use the 'generate' API endpoint the 'reports' component instead. deprecated

    Loading…

  • GET /OTHER/core/other/jsonreport/ Use the 'generate' API endpoint the 'reports' component instead. deprecated

    Loading…

  • GET /OTHER/core/other/mdreport/ Use the 'generate' API endpoint the 'reports' component instead. deprecated

    Loading…

  • GET /OTHER/core/other/messageHar/ Use the API endpoints in the 'exim' add-on instead. deprecated

    Loading…

  • GET /OTHER/core/other/messagesHar/ Use the API endpoints in the 'exim' add-on instead. deprecated

    Loading…

  • GET /OTHER/core/other/messagesHarById/ Use the API endpoints in the 'exim' add-on instead. deprecated

    Loading…

  • GET /OTHER/core/other/proxy.pac/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /OTHER/core/other/rootcert/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /OTHER/core/other/sendHarRequest/ Use the API endpoints in the 'exim' add-on instead. deprecated

    Loading…

  • GET /OTHER/core/other/setproxy/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /OTHER/core/other/xmlreport/ Use the 'generate' API endpoint the 'reports' component instead. deprecated

    Loading…

Ascan 90

  • GET /JSON/ascan/action/addExcludedParam/ Adds a new parameter excluded from the scan, using the specified name.

    Loading…

  • GET /JSON/ascan/action/addScanPolicy/

    Loading…

  • GET /JSON/ascan/action/clearExcludedFromScan/ Clears the regexes of URLs excluded from the active scans.

    Loading…

  • GET /JSON/ascan/action/disableAllScanners/ Disables all scan rules of the scan policy with the given name, or the default if none given.

    Loading…

  • GET /JSON/ascan/action/disableScanners/ Disables the scan rules with the given IDs (comma separated list of IDs) of the scan policy with the given name, or the default if none given.

    Loading…

  • GET /JSON/ascan/action/enableAllScanners/ Enables all scan rules of the scan policy with the given name, or the default if none given.

    Loading…

  • GET /JSON/ascan/action/enableScanners/ Enables the scan rules with the given IDs (comma separated list of IDs) of the scan policy with the given name, or the default if none given.

    Loading…

  • GET /JSON/ascan/action/excludeFromScan/ Adds a regex of URLs that should be excluded from the active scans.

    Loading…

  • GET /JSON/ascan/action/importScanPolicy/ Imports a Scan Policy using the given file system path.

    Loading…

  • GET /JSON/ascan/action/modifyExcludedParam/ Modifies a parameter excluded from the scan.

    Loading…

  • GET /JSON/ascan/action/pause/

    Loading…

  • GET /JSON/ascan/action/pauseAllScans/

    Loading…

  • GET /JSON/ascan/action/removeAllScans/

    Loading…

  • GET /JSON/ascan/action/removeExcludedParam/ Removes a parameter excluded from the scan, with the given index.

    Loading…

  • GET /JSON/ascan/action/removeScan/

    Loading…

  • GET /JSON/ascan/action/removeScanPolicy/

    Loading…

  • GET /JSON/ascan/action/resume/

    Loading…

  • GET /JSON/ascan/action/resumeAllScans/

    Loading…

  • GET /JSON/ascan/action/scan/ Runs the active scanner against the given URL or Context.

    Loading…

  • GET /JSON/ascan/action/scanAsUser/ Active Scans from the perspective of a User, obtained using the given Context ID and User ID.

    Loading…

  • GET /JSON/ascan/action/setEnabledPolicies/

    Loading…

  • GET /JSON/ascan/action/setOptionAddQueryParam/ Sets whether or not the active scanner should add a query param to GET requests which do not have parameters to start with.

    Loading…

  • GET /JSON/ascan/action/setOptionAllowAttackOnStart/

    Loading…

  • GET /JSON/ascan/action/setOptionAttackPolicy/

    Loading…

  • GET /JSON/ascan/action/setOptionDefaultPolicy/

    Loading…

  • GET /JSON/ascan/action/setOptionDelayInMs/ This option has been superseded. deprecated

    Loading…

  • GET /JSON/ascan/action/setOptionEncodeCookieValues/ Sets whether or not the active scanner should encode cookie values.

    Loading…

  • GET /JSON/ascan/action/setOptionHandleAntiCSRFTokens/

    Loading…

  • GET /JSON/ascan/action/setOptionHostPerScan/

    Loading…

  • GET /JSON/ascan/action/setOptionInjectPluginIdInHeader/ Sets whether or not the active scanner should inject the HTTP request header X-ZAP-Scan-ID, with the ID of the scan rule that's sending the requests.

    Loading…

  • GET /JSON/ascan/action/setOptionMaxAlertsPerRule/ Sets the maximum number of alerts that a rule can raise before being skipped.

    Loading…

  • GET /JSON/ascan/action/setOptionMaxChartTimeInMins/

    Loading…

  • GET /JSON/ascan/action/setOptionMaxResultsToList/

    Loading…

  • GET /JSON/ascan/action/setOptionMaxRuleDurationInMins/

    Loading…

  • GET /JSON/ascan/action/setOptionMaxScanDurationInMins/

    Loading…

  • GET /JSON/ascan/action/setOptionMaxScansInUI/

    Loading…

  • GET /JSON/ascan/action/setOptionPromptInAttackMode/

    Loading…

  • GET /JSON/ascan/action/setOptionPromptToClearFinishedScans/

    Loading…

  • GET /JSON/ascan/action/setOptionRescanInAttackMode/

    Loading…

  • GET /JSON/ascan/action/setOptionScanHeadersAllRequests/ Sets whether or not the HTTP Headers of all requests should be scanned.

    Loading…

  • GET /JSON/ascan/action/setOptionScanNullJsonValues/ Sets whether or not the active scanner should scan null JSON values.

    Loading…

  • GET /JSON/ascan/action/setOptionShowAdvancedDialog/

    Loading…

  • GET /JSON/ascan/action/setOptionTargetParamsEnabledRPC/

    Loading…

  • GET /JSON/ascan/action/setOptionTargetParamsInjectable/

    Loading…

  • GET /JSON/ascan/action/setOptionThreadPerHost/

    Loading…

  • GET /JSON/ascan/action/setPolicyAlertThreshold/

    Loading…

  • GET /JSON/ascan/action/setPolicyAttackStrength/

    Loading…

  • GET /JSON/ascan/action/setScannerAlertThreshold/

    Loading…

  • GET /JSON/ascan/action/setScannerAttackStrength/

    Loading…

  • GET /JSON/ascan/action/skipScanner/ Skips the scan rule using the given IDs of the scan and the scan rule.

    Loading…

  • GET /JSON/ascan/action/stop/

    Loading…

  • GET /JSON/ascan/action/stopAllScans/

    Loading…

  • GET /JSON/ascan/action/updateScanPolicy/

    Loading…

  • GET /JSON/ascan/view/alertsIds/ Gets the IDs of the alerts raised during the scan with the given ID.

    Loading…

  • GET /JSON/ascan/view/attackModeQueue/

    Loading…

  • GET /JSON/ascan/view/excludedFromScan/ Gets the regexes of URLs excluded from the active scans.

    Loading…

  • GET /JSON/ascan/view/excludedParamTypes/ Gets all the types of excluded parameters.

    Loading…

  • GET /JSON/ascan/view/excludedParams/ Gets all the parameters that are excluded.

    Loading…

  • GET /JSON/ascan/view/messagesIds/ Gets the IDs of the messages sent during the scan with the given ID.

    Loading…

  • GET /JSON/ascan/view/optionAddQueryParam/ Tells whether or not the active scanner should add a query parameter to GET request that don't have parameters to start with.

    Loading…

  • GET /JSON/ascan/view/optionAllowAttackOnStart/

    Loading…

  • GET /JSON/ascan/view/optionAttackPolicy/

    Loading…

  • GET /JSON/ascan/view/optionDefaultPolicy/

    Loading…

  • GET /JSON/ascan/view/optionDelayInMs/ This option has been superseded. deprecated

    Loading…

  • GET /JSON/ascan/view/optionEncodeCookieValues/ Tells whether or not the active scanner should encode cookie values.

    Loading…

  • GET /JSON/ascan/view/optionExcludedParamList/ Use view excludedParams instead. deprecated

    Loading…

  • GET /JSON/ascan/view/optionHandleAntiCSRFTokens/

    Loading…

  • GET /JSON/ascan/view/optionHostPerScan/

    Loading…

  • GET /JSON/ascan/view/optionInjectPluginIdInHeader/ Tells whether or not the active scanner should inject the HTTP request header X-ZAP-Scan-ID, with the ID of the scan rule that's sending the requests.

    Loading…

  • GET /JSON/ascan/view/optionMaxAlertsPerRule/ Gets the maximum number of alerts that a rule can raise before being skipped.

    Loading…

  • GET /JSON/ascan/view/optionMaxChartTimeInMins/

    Loading…

  • GET /JSON/ascan/view/optionMaxResultsToList/

    Loading…

  • GET /JSON/ascan/view/optionMaxRuleDurationInMins/

    Loading…

  • GET /JSON/ascan/view/optionMaxScanDurationInMins/

    Loading…

  • GET /JSON/ascan/view/optionMaxScansInUI/

    Loading…

  • GET /JSON/ascan/view/optionPromptInAttackMode/

    Loading…

  • GET /JSON/ascan/view/optionPromptToClearFinishedScans/

    Loading…

  • GET /JSON/ascan/view/optionRescanInAttackMode/

    Loading…

  • GET /JSON/ascan/view/optionScanHeadersAllRequests/ Tells whether or not the HTTP Headers of all requests should be scanned.

    Loading…

  • GET /JSON/ascan/view/optionScanNullJsonValues/ Tells whether or not the active scanner should scan null JSON values.

    Loading…

  • GET /JSON/ascan/view/optionShowAdvancedDialog/

    Loading…

  • GET /JSON/ascan/view/optionTargetParamsEnabledRPC/

    Loading…

  • GET /JSON/ascan/view/optionTargetParamsInjectable/

    Loading…

  • GET /JSON/ascan/view/optionThreadPerHost/

    Loading…

  • GET /JSON/ascan/view/policies/

    Loading…

  • GET /JSON/ascan/view/scanPolicyNames/

    Loading…

  • GET /JSON/ascan/view/scanProgress/

    Loading…

  • GET /JSON/ascan/view/scanners/ Gets the scan rules, optionally, of the given scan policy or scanner policy/category ID.

    Loading…

  • GET /JSON/ascan/view/scans/

    Loading…

  • GET /JSON/ascan/view/status/

    Loading…

Spider 71

  • GET /JSON/spider/action/addDomainAlwaysInScope/ Adds a new domain that's always in scope, using the specified value.

    Loading…

  • GET /JSON/spider/action/clearExcludedFromScan/ Clears the regexes of URLs excluded from the spider scans.

    Loading…

  • GET /JSON/spider/action/disableAllDomainsAlwaysInScope/ Disables all domains that are always in scope.

    Loading…

  • GET /JSON/spider/action/enableAllDomainsAlwaysInScope/ Enables all domains that are always in scope.

    Loading…

  • GET /JSON/spider/action/excludeFromScan/ Adds a regex of URLs that should be excluded from the spider scans.

    Loading…

  • GET /JSON/spider/action/modifyDomainAlwaysInScope/ Modifies a domain that's always in scope.

    Loading…

  • GET /JSON/spider/action/pause/

    Loading…

  • GET /JSON/spider/action/pauseAllScans/

    Loading…

  • GET /JSON/spider/action/removeAllScans/

    Loading…

  • GET /JSON/spider/action/removeDomainAlwaysInScope/ Removes a domain that's always in scope, with the given index.

    Loading…

  • GET /JSON/spider/action/removeScan/

    Loading…

  • GET /JSON/spider/action/resume/

    Loading…

  • GET /JSON/spider/action/resumeAllScans/

    Loading…

  • GET /JSON/spider/action/scan/ Runs the spider against the given URL (or context).

    Loading…

  • GET /JSON/spider/action/scanAsUser/ Runs the spider from the perspective of a User, obtained using the given Context ID and User ID.

    Loading…

  • GET /JSON/spider/action/setOptionAcceptCookies/ Sets whether or not a spider process should accept cookies while spidering.

    Loading…

  • GET /JSON/spider/action/setOptionHandleODataParametersVisited/

    Loading…

  • GET /JSON/spider/action/setOptionHandleParameters/

    Loading…

  • GET /JSON/spider/action/setOptionLogoutAvoidance/ Sets whether or not the Spider should attempt to avoid logout related paths/functionality.

    Loading…

  • GET /JSON/spider/action/setOptionMaxChildren/ Sets the maximum number of child nodes (per node) that can be crawled, 0 means no limit.

    Loading…

  • GET /JSON/spider/action/setOptionMaxDepth/ Sets the maximum depth the spider can crawl, 0 for unlimited depth.

    Loading…

  • GET /JSON/spider/action/setOptionMaxDuration/

    Loading…

  • GET /JSON/spider/action/setOptionMaxParseSizeBytes/ Sets the maximum size, in bytes, that a response might have to be parsed.

    Loading…

  • GET /JSON/spider/action/setOptionMaxScansInUI/

    Loading…

  • GET /JSON/spider/action/setOptionParseComments/

    Loading…

  • GET /JSON/spider/action/setOptionParseDsStore/

    Loading…

  • GET /JSON/spider/action/setOptionParseGit/

    Loading…

  • GET /JSON/spider/action/setOptionParseRobotsTxt/

    Loading…

  • GET /JSON/spider/action/setOptionParseSVNEntries/

    Loading…

  • GET /JSON/spider/action/setOptionParseSitemapXml/

    Loading…

  • GET /JSON/spider/action/setOptionPostForm/

    Loading…

  • GET /JSON/spider/action/setOptionProcessForm/

    Loading…

  • GET /JSON/spider/action/setOptionSendRefererHeader/ Sets whether or not the 'Referer' header should be sent while spidering.

    Loading…

  • GET /JSON/spider/action/setOptionShowAdvancedDialog/

    Loading…

  • GET /JSON/spider/action/setOptionSkipURLString/

    Loading…

  • GET /JSON/spider/action/setOptionThreadCount/

    Loading…

  • GET /JSON/spider/action/setOptionUserAgent/

    Loading…

  • GET /JSON/spider/action/stop/

    Loading…

  • GET /JSON/spider/action/stopAllScans/

    Loading…

  • GET /JSON/spider/view/addedNodes/ Returns a list of the names of the nodes added to the Sites tree by the specified scan.

    Loading…

  • GET /JSON/spider/view/allUrls/ Returns a list of unique URLs from the history table based on HTTP messages added by the Spider.

    Loading…

  • GET /JSON/spider/view/domainsAlwaysInScope/ Gets all the domains that are always in scope.

    Loading…

  • GET /JSON/spider/view/excludedFromScan/ Gets the regexes of URLs excluded from the spider scans.

    Loading…

  • GET /JSON/spider/view/fullResults/

    Loading…

  • GET /JSON/spider/view/optionAcceptCookies/ Gets whether or not a spider process should accept cookies while spidering.

    Loading…

  • GET /JSON/spider/view/optionDomainsAlwaysInScope/ Use view domainsAlwaysInScope instead. deprecated

    Loading…

  • GET /JSON/spider/view/optionDomainsAlwaysInScopeEnabled/ Use view domainsAlwaysInScope instead. deprecated

    Loading…

  • GET /JSON/spider/view/optionHandleODataParametersVisited/

    Loading…

  • GET /JSON/spider/view/optionHandleParameters/

    Loading…

  • GET /JSON/spider/view/optionLogoutAvoidance/ Gets whether or not the spider should attempt to avoid logout related paths/functionality.

    Loading…

  • GET /JSON/spider/view/optionMaxChildren/ Gets the maximum number of child nodes (per node) that can be crawled, 0 means no limit.

    Loading…

  • GET /JSON/spider/view/optionMaxDepth/ Gets the maximum depth the spider can crawl, 0 if unlimited.

    Loading…

  • GET /JSON/spider/view/optionMaxDuration/

    Loading…

  • GET /JSON/spider/view/optionMaxParseSizeBytes/ Gets the maximum size, in bytes, that a response might have to be parsed, or 0 for unlimited.

    Loading…

  • GET /JSON/spider/view/optionMaxScansInUI/

    Loading…

  • GET /JSON/spider/view/optionParseComments/

    Loading…

  • GET /JSON/spider/view/optionParseDsStore/

    Loading…

  • GET /JSON/spider/view/optionParseGit/

    Loading…

  • GET /JSON/spider/view/optionParseRobotsTxt/

    Loading…

  • GET /JSON/spider/view/optionParseSVNEntries/

    Loading…

  • GET /JSON/spider/view/optionParseSitemapXml/

    Loading…

  • GET /JSON/spider/view/optionPostForm/

    Loading…

  • GET /JSON/spider/view/optionProcessForm/

    Loading…

  • GET /JSON/spider/view/optionSendRefererHeader/ Gets whether or not the 'Referer' header should be sent while spidering.

    Loading…

  • GET /JSON/spider/view/optionShowAdvancedDialog/

    Loading…

  • GET /JSON/spider/view/optionSkipURLString/

    Loading…

  • GET /JSON/spider/view/optionThreadCount/

    Loading…

  • GET /JSON/spider/view/optionUserAgent/

    Loading…

  • GET /JSON/spider/view/results/

    Loading…

  • GET /JSON/spider/view/scans/

    Loading…

  • GET /JSON/spider/view/status/

    Loading…

Network 48

  • GET /JSON/network/action/addAlias/ Adds an alias for the local servers/proxies.

    Loading…

  • GET /JSON/network/action/addHttpProxyExclusion/ Adds a host to be excluded from the HTTP proxy.

    Loading…

  • GET /JSON/network/action/addLocalServer/ Adds a local server/proxy.

    Loading…

  • GET /JSON/network/action/addPassThrough/ Adds an authority to pass-through the local proxies.

    Loading…

  • GET /JSON/network/action/addPkcs12ClientCertificate/ Adds a client certificate contained in a PKCS#12 file, the certificate is automatically set as active and used.

    Loading…

  • GET /JSON/network/action/addRateLimitRule/ Adds a rate limit rule

    Loading…

  • GET /JSON/network/action/generateRootCaCert/ Generates a new Root CA certificate, used to issue server certificates.

    Loading…

  • GET /JSON/network/action/importRootCaCert/ Imports a Root CA certificate to be used to issue server certificates.

    Loading…

  • GET /JSON/network/action/removeAlias/ Removes an alias.

    Loading…

  • GET /JSON/network/action/removeHttpProxyExclusion/ Removes an HTTP proxy exclusion.

    Loading…

  • GET /JSON/network/action/removeLocalServer/ Removes a local server/proxy.

    Loading…

  • GET /JSON/network/action/removePassThrough/ Removes a pass-through.

    Loading…

  • GET /JSON/network/action/removeRateLimitRule/ Remove a rate limit rule

    Loading…

  • GET /JSON/network/action/setAliasEnabled/ Sets whether or not an alias is enabled.

    Loading…

  • GET /JSON/network/action/setConnectionTimeout/ Sets the timeout, for reads and connects.

    Loading…

  • GET /JSON/network/action/setDefaultUserAgent/ Sets the default user-agent.

    Loading…

  • GET /JSON/network/action/setDnsTtlSuccessfulQueries/ Sets the TTL of successful DNS queries.

    Loading…

  • GET /JSON/network/action/setHttpProxy/ Sets the HTTP proxy configuration.

    Loading…

  • GET /JSON/network/action/setHttpProxyAuthEnabled/ Sets whether or not the HTTP proxy authentication is enabled.

    Loading…

  • GET /JSON/network/action/setHttpProxyEnabled/ Sets whether or not the HTTP proxy is enabled.

    Loading…

  • GET /JSON/network/action/setHttpProxyExclusionEnabled/ Sets whether or not an HTTP proxy exclusion is enabled.

    Loading…

  • GET /JSON/network/action/setPassThroughEnabled/ Sets whether or not a pass-through is enabled.

    Loading…

  • GET /JSON/network/action/setRateLimitRuleEnabled/ Set enabled state for a rate limit rule.

    Loading…

  • GET /JSON/network/action/setRootCaCertValidity/ Sets the Root CA certificate validity.

    Loading…

  • GET /JSON/network/action/setServerCertValidity/ Sets the server certificate validity.

    Loading…

  • GET /JSON/network/action/setSocksProxy/ Sets the SOCKS proxy configuration.

    Loading…

  • GET /JSON/network/action/setSocksProxyEnabled/ Sets whether or not the SOCKS proxy is enabled.

    Loading…

  • GET /JSON/network/action/setUseClientCertificate/ Sets whether or not to use the active client certificate.

    Loading…

  • GET /JSON/network/action/setUseGlobalHttpState/ Sets whether or not to use the global HTTP state.

    Loading…

  • GET /JSON/network/view/getAliases/ Gets the aliases used to identify the local servers/proxies.

    Loading…

  • GET /JSON/network/view/getConnectionTimeout/ Gets the connection timeout, in seconds.

    Loading…

  • GET /JSON/network/view/getDefaultUserAgent/ Gets the default user-agent.

    Loading…

  • GET /JSON/network/view/getDnsTtlSuccessfulQueries/ Gets the TTL (in seconds) of successful DNS queries.

    Loading…

  • GET /JSON/network/view/getHttpProxy/ Gets the HTTP proxy.

    Loading…

  • GET /JSON/network/view/getHttpProxyExclusions/ Gets the HTTP proxy exclusions.

    Loading…

  • GET /JSON/network/view/getLocalServers/ Gets the local servers/proxies.

    Loading…

  • GET /JSON/network/view/getPassThroughs/ Gets the authorities that will pass-through the local proxies.

    Loading…

  • GET /JSON/network/view/getRateLimitRules/ List of rate limit rules.

    Loading…

  • GET /JSON/network/view/getRootCaCertValidity/ Gets the Root CA certificate validity, in days.

    Loading…

  • GET /JSON/network/view/getServerCertValidity/ Gets the server certificate validity, in days.

    Loading…

  • GET /JSON/network/view/getSocksProxy/ Gets the SOCKS proxy.

    Loading…

  • GET /JSON/network/view/isHttpProxyAuthEnabled/ Tells whether or not the HTTP proxy authentication is enabled.

    Loading…

  • GET /JSON/network/view/isHttpProxyEnabled/ Tells whether or not the HTTP proxy is enabled.

    Loading…

  • GET /JSON/network/view/isSocksProxyEnabled/ Tells whether or not the SOCKS proxy is enabled.

    Loading…

  • GET /JSON/network/view/isUseGlobalHttpState/ Tells whether or not to use global HTTP state.

    Loading…

  • GET /OTHER/network/other/proxy.pac/ Provides a PAC file, proxying through the main proxy.

    Loading…

  • GET /OTHER/network/other/rootCaCert/ Gets the Root CA certificate used to issue server certificates.

    Loading…

  • GET /OTHER/network/other/setProxy/ Sets the HTTP proxy configuration.

    Loading…

Ajaxspider 41

  • GET /JSON/ajaxSpider/action/addAllowedResource/ Adds an allowed resource.

    Loading…

  • GET /JSON/ajaxSpider/action/addExcludedElement/ Adds an excluded element to a context.

    Loading…

  • GET /JSON/ajaxSpider/action/modifyExcludedElement/ Modifies an excluded element of a context.

    Loading…

  • GET /JSON/ajaxSpider/action/removeAllowedResource/ Removes an allowed resource.

    Loading…

  • GET /JSON/ajaxSpider/action/removeExcludedElement/ Removes an excluded element from a context.

    Loading…

  • GET /JSON/ajaxSpider/action/scan/ Runs the AJAX Spider against a given target.

    Loading…

  • GET /JSON/ajaxSpider/action/scanAsUser/ Runs the AJAX Spider from the perspective of a User of the web application.

    Loading…

  • GET /JSON/ajaxSpider/action/setEnabledAllowedResource/ Sets whether or not an allowed resource is enabled.

    Loading…

  • GET /JSON/ajaxSpider/action/setOptionBrowserId/ Sets the configuration of the AJAX Spider to use one of the supported browsers.

    Loading…

  • GET /JSON/ajaxSpider/action/setOptionClickDefaultElems/ Sets whether or not the AJAX Spider will only click on the default HTML elements.

    Loading…

  • GET /JSON/ajaxSpider/action/setOptionClickElemsOnce/ When enabled, the crawler attempts to interact with each element (e.g., by clicking) only once.

    Loading…

  • GET /JSON/ajaxSpider/action/setOptionEnableExtensions/

    Loading…

  • GET /JSON/ajaxSpider/action/setOptionEventWait/ Sets the time to wait after an event (in milliseconds).

    Loading…

  • GET /JSON/ajaxSpider/action/setOptionLogoutAvoidance/ Sets whether or not the AJAX Spider should avoid clicking logout elements.

    Loading…

  • GET /JSON/ajaxSpider/action/setOptionMaxCrawlDepth/ Sets the maximum depth that the crawler can reach.

    Loading…

  • GET /JSON/ajaxSpider/action/setOptionMaxCrawlStates/ Sets the maximum number of states that the crawler should crawl.

    Loading…

  • GET /JSON/ajaxSpider/action/setOptionMaxDuration/ The maximum time that the crawler is allowed to run.

    Loading…

  • GET /JSON/ajaxSpider/action/setOptionNumberOfBrowsers/ Sets the number of windows to be used by AJAX Spider.

    Loading…

  • GET /JSON/ajaxSpider/action/setOptionRandomInputs/ When enabled, inserts random values into form fields.

    Loading…

  • GET /JSON/ajaxSpider/action/setOptionReloadWait/ Sets the time to wait after the page is loaded before interacting with it.

    Loading…

  • GET /JSON/ajaxSpider/action/setOptionScopeCheck/ Sets the scope check.

    Loading…

  • GET /JSON/ajaxSpider/action/stop/ Stops the AJAX Spider.

    Loading…

  • GET /JSON/ajaxSpider/view/allowedResources/ Gets the allowed resources.

    Loading…

  • GET /JSON/ajaxSpider/view/excludedElements/ Gets the excluded elements.

    Loading…

  • GET /JSON/ajaxSpider/view/fullResults/ Gets the full crawled content detected by the AJAX Spider.

    Loading…

  • GET /JSON/ajaxSpider/view/numberOfResults/ Gets the number of resources found.

    Loading…

  • GET /JSON/ajaxSpider/view/optionBrowserId/ Gets the configured browser to use for crawling.

    Loading…

  • GET /JSON/ajaxSpider/view/optionClickDefaultElems/ Gets the configured value for 'Click Default Elements Only', HTML elements such as 'a', 'button', 'input', all associated with some action or links on the page.

    Loading…

  • GET /JSON/ajaxSpider/view/optionClickElemsOnce/ Gets the value configured for the AJAX Spider to know if it should click on the elements only once.

    Loading…

  • GET /JSON/ajaxSpider/view/optionEnableExtensions/

    Loading…

  • GET /JSON/ajaxSpider/view/optionEventWait/ Gets the time to wait after an event (in milliseconds).

    Loading…

  • GET /JSON/ajaxSpider/view/optionLogoutAvoidance/ Gets the value of the Logout Avoidance option.

    Loading…

  • GET /JSON/ajaxSpider/view/optionMaxCrawlDepth/ Gets the configured value for the max crawl depth.

    Loading…

  • GET /JSON/ajaxSpider/view/optionMaxCrawlStates/ Gets the configured value for the maximum crawl states allowed.

    Loading…

  • GET /JSON/ajaxSpider/view/optionMaxDuration/ Gets the configured max duration of the crawl, the value is in minutes.

    Loading…

  • GET /JSON/ajaxSpider/view/optionNumberOfBrowsers/ Gets the configured number of browsers to be used.

    Loading…

  • GET /JSON/ajaxSpider/view/optionRandomInputs/ Gets if the AJAX Spider will use random values in form fields when crawling, if set to true.

    Loading…

  • GET /JSON/ajaxSpider/view/optionReloadWait/ Gets the configured time to wait after reloading the page, this value is in milliseconds.

    Loading…

  • GET /JSON/ajaxSpider/view/optionScopeCheck/ Gets the configured scope check.

    Loading…

  • GET /JSON/ajaxSpider/view/results/ Gets the current results of the crawler.

    Loading…

  • GET /JSON/ajaxSpider/view/status/ Gets the current status of the crawler.

    Loading…

Hud 37

  • GET /JSON/hud/action/log/ Used by the HUD to log messages from the browser

    Loading…

  • GET /JSON/hud/action/recordRequest/ Used by the HUD to cache a request the user wants to send in the browser

    Loading…

  • GET /JSON/hud/action/resetTutorialTasks/ Reset the tutorial tasks so that they must be completed again

    Loading…

  • GET /JSON/hud/action/setOptionBaseDirectory/ Set the base directory from which the HUD files are loaded

    Loading…

  • GET /JSON/hud/action/setOptionDevelopmentMode/ Sets the boolean option 'Development mode'

    Loading…

  • GET /JSON/hud/action/setOptionEnableOnDomainMsgs/

    Loading…

  • GET /JSON/hud/action/setOptionEnabledForDaemon/

    Loading…

  • GET /JSON/hud/action/setOptionEnabledForDesktop/

    Loading…

  • GET /JSON/hud/action/setOptionInScopeOnly/ Sets the boolean option 'In scope only'

    Loading…

  • GET /JSON/hud/action/setOptionRemoveCSP/ Sets the boolean option 'Remove CSP'

    Loading…

  • GET /JSON/hud/action/setOptionShowWelcomeScreen/

    Loading…

  • GET /JSON/hud/action/setOptionSkipTutorialTasks/

    Loading…

  • GET /JSON/hud/action/setOptionTutorialTaskDone/

    Loading…

  • GET /JSON/hud/action/setOptionTutorialTestMode/

    Loading…

  • GET /JSON/hud/action/setUiOption/ Sets a UI option with the given key and value.

    Loading…

  • GET /JSON/hud/view/getUiOption/ Gets a UI option set using setUiOption.

    Loading…

  • GET /JSON/hud/view/heartbeat/ Used by service workers to keep alive

    Loading…

  • GET /JSON/hud/view/hudAlertData/ Returns the alert summary needed by the HUD for the specified URL

    Loading…

  • GET /JSON/hud/view/optionAllowUnsafeEval/ Returns true if the 'Allow unsafe-eval' option is set

    Loading…

  • GET /JSON/hud/view/optionBaseDirectory/ Returns the base directory from which the HUD files are loaded

    Loading…

  • GET /JSON/hud/view/optionDevelopmentMode/ Returns true if the 'Development mode' option is set

    Loading…

  • GET /JSON/hud/view/optionEnableOnDomainMsgs/

    Loading…

  • GET /JSON/hud/view/optionEnableTelemetry/

    Loading…

  • GET /JSON/hud/view/optionEnabledForDaemon/

    Loading…

  • GET /JSON/hud/view/optionEnabledForDesktop/

    Loading…

  • GET /JSON/hud/view/optionInScopeOnly/ Returns true if the 'In scope only' option is set

    Loading…

  • GET /JSON/hud/view/optionRemoveCSP/ Returns true if the 'Remove CSP' option is set

    Loading…

  • GET /JSON/hud/view/optionShowWelcomeScreen/

    Loading…

  • GET /JSON/hud/view/optionSkipTutorialTasks/

    Loading…

  • GET /JSON/hud/view/optionTutorialHost/

    Loading…

  • GET /JSON/hud/view/optionTutorialPort/

    Loading…

  • GET /JSON/hud/view/optionTutorialTasksDone/

    Loading…

  • GET /JSON/hud/view/optionTutorialTestMode/

    Loading…

  • GET /JSON/hud/view/optionTutorialUpdates/

    Loading…

  • GET /JSON/hud/view/tutorialUpdates/

    Loading…

  • GET /JSON/hud/view/upgradedDomains/

    Loading…

  • GET /OTHER/hud/other/changesInHtml/ Returns the changelog in HTML format

    Loading…

Autoupdate 32

  • GET /JSON/autoupdate/action/downloadLatestRelease/ Downloads the latest release, if any

    Loading…

  • GET /JSON/autoupdate/action/installAddon/ Installs or updates the specified add-on, returning when complete (i.e. not asynchronously)

    Loading…

  • GET /JSON/autoupdate/action/installLocalAddon/

    Loading…

  • GET /JSON/autoupdate/action/setOptionCheckAddonUpdates/

    Loading…

  • GET /JSON/autoupdate/action/setOptionCheckOnStart/

    Loading…

  • GET /JSON/autoupdate/action/setOptionDownloadNewRelease/

    Loading…

  • GET /JSON/autoupdate/action/setOptionInstallAddonUpdates/

    Loading…

  • GET /JSON/autoupdate/action/setOptionInstallScannerRules/

    Loading…

  • GET /JSON/autoupdate/action/setOptionReportAlphaAddons/

    Loading…

  • GET /JSON/autoupdate/action/setOptionReportBetaAddons/

    Loading…

  • GET /JSON/autoupdate/action/setOptionReportReleaseAddons/

    Loading…

  • GET /JSON/autoupdate/action/uninstallAddon/ Uninstalls the specified add-on

    Loading…

  • GET /JSON/autoupdate/view/installedAddons/ Return a list of all of the installed add-ons

    Loading…

  • GET /JSON/autoupdate/view/isLatestVersion/ Returns 'true' if ZAP is on the latest version

    Loading…

  • GET /JSON/autoupdate/view/latestVersionNumber/ Returns the latest version number

    Loading…

  • GET /JSON/autoupdate/view/localAddons/ Returns a list with all local add-ons, installed or not.

    Loading…

  • GET /JSON/autoupdate/view/marketplaceAddons/ Return a list of all of the add-ons on the ZAP Marketplace (this information is read once and then cached)

    Loading…

  • GET /JSON/autoupdate/view/newAddons/ Return a list of any add-ons that have been added to the Marketplace since the last check for updates

    Loading…

  • GET /JSON/autoupdate/view/optionAddonDirectories/

    Loading…

  • GET /JSON/autoupdate/view/optionCheckAddonUpdates/

    Loading…

  • GET /JSON/autoupdate/view/optionCheckOnStart/

    Loading…

  • GET /JSON/autoupdate/view/optionDayLastChecked/

    Loading…

  • GET /JSON/autoupdate/view/optionDayLastInstallWarned/

    Loading…

  • GET /JSON/autoupdate/view/optionDayLastUpdateWarned/

    Loading…

  • GET /JSON/autoupdate/view/optionDownloadDirectory/

    Loading…

  • GET /JSON/autoupdate/view/optionDownloadNewRelease/

    Loading…

  • GET /JSON/autoupdate/view/optionInstallAddonUpdates/

    Loading…

  • GET /JSON/autoupdate/view/optionInstallScannerRules/

    Loading…

  • GET /JSON/autoupdate/view/optionReportAlphaAddons/

    Loading…

  • GET /JSON/autoupdate/view/optionReportBetaAddons/

    Loading…

  • GET /JSON/autoupdate/view/optionReportReleaseAddons/

    Loading…

  • GET /JSON/autoupdate/view/updatedAddons/ Return a list of any add-ons that have been changed in the Marketplace since the last check for updates

    Loading…

Script 24

  • GET /JSON/script/action/clearGlobalCustomVar/ Clears a global custom variable.

    Loading…

  • GET /JSON/script/action/clearGlobalVar/ Clears the global variable with the given key.

    Loading…

  • GET /JSON/script/action/clearGlobalVars/ Clears the global variables.

    Loading…

  • GET /JSON/script/action/clearScriptCustomVar/ Clears a script custom variable.

    Loading…

  • GET /JSON/script/action/clearScriptVar/ Clears the variable with the given key of the given script.

    Loading…

  • GET /JSON/script/action/clearScriptVars/ Clears the variables of the given script.

    Loading…

  • GET /JSON/script/action/disable/ Disables the script with the given name

    Loading…

  • GET /JSON/script/action/enable/ Enables the script with the given name

    Loading…

  • GET /JSON/script/action/load/ 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 scrip

    Loading…

  • GET /JSON/script/action/remove/ Removes the script with the given name

    Loading…

  • GET /JSON/script/action/runStandAloneScript/ Runs the stand alone script with the given name

    Loading…

  • GET /JSON/script/action/setGlobalVar/ Sets the value of the global variable with the given key.

    Loading…

  • GET /JSON/script/action/setScriptVar/ Sets the value of the variable with the given key of the given script.

    Loading…

  • GET /JSON/script/view/globalCustomVar/ Gets the value (string representation) of a global custom variable.

    Loading…

  • GET /JSON/script/view/globalCustomVars/ Gets all the global custom variables (key/value pairs, the value is the string representation).

    Loading…

  • GET /JSON/script/view/globalVar/ Gets the value of the global variable with the given key.

    Loading…

  • GET /JSON/script/view/globalVars/ Gets all the global variables (key/value pairs).

    Loading…

  • GET /JSON/script/view/listEngines/ Lists the script engines available

    Loading…

  • GET /JSON/script/view/listScripts/ Lists the scripts available, with its engine, name, description, type and error state.

    Loading…

  • GET /JSON/script/view/listTypes/ Lists the script types available.

    Loading…

  • GET /JSON/script/view/scriptCustomVar/ Gets the value (string representation) of a custom variable.

    Loading…

  • GET /JSON/script/view/scriptCustomVars/ Gets all the custom variables (key/value pairs, the value is the string representation) of a script.

    Loading…

  • GET /JSON/script/view/scriptVar/ Gets the value of the variable with the given key for the given script.

    Loading…

  • GET /JSON/script/view/scriptVars/ Gets all the variables (key/value pairs) of the given script.

    Loading…

Selenium 22

  • GET /JSON/selenium/action/addBrowserArgument/ Adds a browser argument.

    Loading…

  • GET /JSON/selenium/action/launchBrowser/ Launches a browser proxying through ZAP, for manual usage.

    Loading…

  • GET /JSON/selenium/action/removeBrowserArgument/ Removes a browser argument.

    Loading…

  • GET /JSON/selenium/action/setBrowserArgumentEnabled/ Sets whether or not a browser argument is enabled.

    Loading…

  • GET /JSON/selenium/action/setOptionChromeBinaryPath/ Sets the current path to Chrome binary

    Loading…

  • GET /JSON/selenium/action/setOptionChromeDriverPath/ Sets the current path to ChromeDriver

    Loading…

  • GET /JSON/selenium/action/setOptionFirefoxBinaryPath/ Sets the current path to Firefox binary

    Loading…

  • GET /JSON/selenium/action/setOptionFirefoxDefaultProfile/

    Loading…

  • GET /JSON/selenium/action/setOptionFirefoxDriverPath/ Sets the current path to Firefox driver (geckodriver)

    Loading…

  • GET /JSON/selenium/action/setOptionIeDriverPath/ Option no longer in effective use. deprecated

    Loading…

  • GET /JSON/selenium/action/setOptionLastDirectory/

    Loading…

  • GET /JSON/selenium/action/setOptionPhantomJsBinaryPath/ Option no longer in effective use. deprecated

    Loading…

  • GET /JSON/selenium/view/getBrowserArguments/ Gets the browser arguments.

    Loading…

  • GET /JSON/selenium/view/optionBrowserExtensions/

    Loading…

  • GET /JSON/selenium/view/optionChromeBinaryPath/ Returns the current path to Chrome binary

    Loading…

  • GET /JSON/selenium/view/optionChromeDriverPath/ Returns the current path to ChromeDriver

    Loading…

  • GET /JSON/selenium/view/optionFirefoxBinaryPath/ Returns the current path to Firefox binary

    Loading…

  • GET /JSON/selenium/view/optionFirefoxDefaultProfile/

    Loading…

  • GET /JSON/selenium/view/optionFirefoxDriverPath/ Returns the current path to Firefox driver (geckodriver)

    Loading…

  • GET /JSON/selenium/view/optionIeDriverPath/ Option no longer in effective use. deprecated

    Loading…

  • GET /JSON/selenium/view/optionLastDirectory/

    Loading…

  • GET /JSON/selenium/view/optionPhantomJsBinaryPath/ Option no longer in effective use. deprecated

    Loading…

Context 21

  • GET /JSON/context/action/excludeAllContextTechnologies/ Excludes all built in technologies from a context

    Loading…

  • GET /JSON/context/action/excludeContextTechnologies/ Excludes technologies with the given names, separated by a comma, from a context

    Loading…

  • GET /JSON/context/action/excludeFromContext/ Add exclude regex to context

    Loading…

  • GET /JSON/context/action/exportContext/ Exports the context with the given name to a file.

    Loading…

  • GET /JSON/context/action/importContext/ Imports a context from a file.

    Loading…

  • GET /JSON/context/action/includeAllContextTechnologies/ Includes all built in technologies in to a context

    Loading…

  • GET /JSON/context/action/includeContextTechnologies/ Includes technologies with the given names, separated by a comma, to a context

    Loading…

  • GET /JSON/context/action/includeInContext/ Add include regex to context

    Loading…

  • GET /JSON/context/action/newContext/ Creates a new context with the given name in the current session

    Loading…

  • GET /JSON/context/action/removeContext/ Removes a context in the current session

    Loading…

  • GET /JSON/context/action/setContextCheckingStrategy/ Set the checking strategy for a context - this defines how ZAP checks that a request is authenticated

    Loading…

  • GET /JSON/context/action/setContextInScope/ Sets a context to in scope (contexts are in scope by default)

    Loading…

  • GET /JSON/context/action/setContextRegexs/ Set the regexs to include and exclude for a context, both supplied as JSON string arrays

    Loading…

  • GET /JSON/context/view/context/ List the information about the named context

    Loading…

  • GET /JSON/context/view/contextList/ List context names of current session

    Loading…

  • GET /JSON/context/view/excludeRegexs/ List excluded regexs for context

    Loading…

  • GET /JSON/context/view/excludedTechnologyList/ Lists the names of all technologies excluded from a context

    Loading…

  • GET /JSON/context/view/includeRegexs/ List included regexs for context

    Loading…

  • GET /JSON/context/view/includedTechnologyList/ Lists the names of all technologies included in a context

    Loading…

  • GET /JSON/context/view/technologyList/ Lists the names of all built in technologies

    Loading…

  • GET /JSON/context/view/urls/ Lists the URLs accessed through/by ZAP, that belong to the context with the given name.

    Loading…

Graphql 20

  • GET /JSON/graphql/action/importFile/ Imports a GraphQL Schema from a File.

    Loading…

  • GET /JSON/graphql/action/importUrl/ Imports a GraphQL Schema from a URL.

    Loading…

  • GET /JSON/graphql/action/setOptionArgsType/ Sets how arguments are specified.

    Loading…

  • GET /JSON/graphql/action/setOptionLenientMaxQueryDepthEnabled/ Sets whether or not Maximum Query Depth is enforced leniently.

    Loading…

  • GET /JSON/graphql/action/setOptionMaxAdditionalQueryDepth/ Sets the maximum additional query generation depth (used if enforced leniently).

    Loading…

  • GET /JSON/graphql/action/setOptionMaxArgsDepth/ Sets the maximum arguments generation depth.

    Loading…

  • GET /JSON/graphql/action/setOptionMaxQueryDepth/ Sets the maximum query generation depth.

    Loading…

  • GET /JSON/graphql/action/setOptionOptionalArgsEnabled/ Sets whether or not Optional Arguments should be specified.

    Loading…

  • GET /JSON/graphql/action/setOptionQueryGenEnabled/ Sets whether the query generator is enabled.

    Loading…

  • GET /JSON/graphql/action/setOptionQuerySplitType/ Sets the level for which a single query is generated.

    Loading…

  • GET /JSON/graphql/action/setOptionRequestMethod/ Sets the request method.

    Loading…

  • GET /JSON/graphql/view/optionArgsType/ Returns how arguments are currently specified.

    Loading…

  • GET /JSON/graphql/view/optionLenientMaxQueryDepthEnabled/ Returns whether or not lenient maximum query generation depth is enabled.

    Loading…

  • GET /JSON/graphql/view/optionMaxAdditionalQueryDepth/ Returns the current maximum additional query generation depth.

    Loading…

  • GET /JSON/graphql/view/optionMaxArgsDepth/ Returns the current maximum arguments generation depth.

    Loading…

  • GET /JSON/graphql/view/optionMaxQueryDepth/ Returns the current maximum query generation depth.

    Loading…

  • GET /JSON/graphql/view/optionOptionalArgsEnabled/ Returns whether or not optional arguments are currently specified.

    Loading…

  • GET /JSON/graphql/view/optionQueryGenEnabled/ Returns whether the query generator is enabled.

    Loading…

  • GET /JSON/graphql/view/optionQuerySplitType/ Returns the current level for which a single query is generated.

    Loading…

  • GET /JSON/graphql/view/optionRequestMethod/ Returns the current request method.

    Loading…

Pscan 17

  • GET /JSON/pscan/action/clearQueue/ Clears the passive scan queue.

    Loading…

  • GET /JSON/pscan/action/disableAllScanners/ Disables all passive scan rules.

    Loading…

  • GET /JSON/pscan/action/disableAllTags/ Disables all passive scan tags.

    Loading…

  • GET /JSON/pscan/action/disableScanners/ Disables passive scan rules.

    Loading…

  • GET /JSON/pscan/action/enableAllScanners/ Enables all passive scan rules.

    Loading…

  • GET /JSON/pscan/action/enableAllTags/ Enables all passive scan tags.

    Loading…

  • GET /JSON/pscan/action/enableScanners/ Enables passive scan rules.

    Loading…

  • GET /JSON/pscan/action/setEnabled/ Sets whether or not the passive scanning is enabled (Note: the enabled state is not persisted).

    Loading…

  • GET /JSON/pscan/action/setMaxAlertsPerRule/ Sets the maximum number of alerts a passive scan rule can raise.

    Loading…

  • GET /JSON/pscan/action/setScanOnlyInScope/ Sets whether or not the passive scan should be performed only on messages that are in scope.

    Loading…

  • GET /JSON/pscan/action/setScannerAlertThreshold/ Sets the alert threshold of a passive scan rule.

    Loading…

  • GET /JSON/pscan/view/currentRule/ Use the currentTasks view instead. deprecated

    Loading…

  • GET /JSON/pscan/view/currentTasks/ Shows information about the passive scan tasks currently being run (if any).

    Loading…

  • GET /JSON/pscan/view/maxAlertsPerRule/ Gets the maximum number of alerts a passive scan rule should raise.

    Loading…

  • GET /JSON/pscan/view/recordsToScan/ The number of records the passive scanner still has to scan.

    Loading…

  • GET /JSON/pscan/view/scanOnlyInScope/ Tells whether or not the passive scan should be performed only on messages that are in scope.

    Loading…

  • GET /JSON/pscan/view/scanners/ Lists all passive scan rules with their ID, name, enabled state, and alert threshold.

    Loading…

Httpsessions 16

  • GET /JSON/httpSessions/action/addDefaultSessionToken/ Adds a default session token with the given name and enabled state.

    Loading…

  • GET /JSON/httpSessions/action/addSessionToken/ Adds the session token to the given site.

    Loading…

  • GET /JSON/httpSessions/action/createEmptySession/ Creates an empty session for the given site.

    Loading…

  • GET /JSON/httpSessions/action/removeDefaultSessionToken/ Removes the default session token with the given name.

    Loading…

  • GET /JSON/httpSessions/action/removeSession/ Removes the session from the given site.

    Loading…

  • GET /JSON/httpSessions/action/removeSessionToken/ Removes the session token from the given site.

    Loading…

  • GET /JSON/httpSessions/action/renameSession/ Renames the session of the given site.

    Loading…

  • GET /JSON/httpSessions/action/setActiveSession/ Sets the given session as active for the given site.

    Loading…

  • GET /JSON/httpSessions/action/setDefaultSessionTokenEnabled/ Sets whether or not the default session token with the given name is enabled.

    Loading…

  • GET /JSON/httpSessions/action/setSessionTokenValue/ Sets the value of the session token of the given session for the given site.

    Loading…

  • GET /JSON/httpSessions/action/unsetActiveSession/ Unsets the active session of the given site.

    Loading…

  • GET /JSON/httpSessions/view/activeSession/ Gets the name of the active session for the given site.

    Loading…

  • GET /JSON/httpSessions/view/defaultSessionTokens/ Gets the default session tokens.

    Loading…

  • GET /JSON/httpSessions/view/sessionTokens/ Gets the names of the session tokens for the given site.

    Loading…

  • GET /JSON/httpSessions/view/sessions/ Gets the sessions for the given site.

    Loading…

  • GET /JSON/httpSessions/view/sites/ Gets all of the sites that have sessions.

    Loading…

Users 15

  • GET /JSON/users/action/authenticateAsUser/ Tries to authenticate as the identified user, returning the authentication request and whether it appears to have succeeded.

    Loading…

  • GET /JSON/users/action/newUser/ Creates a new user with the given name for the context with the given ID.

    Loading…

  • GET /JSON/users/action/pollAsUser/ Tries to poll as the identified user, returning the authentication request and whether it appears to have succeeded.

    Loading…

  • GET /JSON/users/action/removeUser/ Removes the user with the given ID that belongs to the context with the given ID.

    Loading…

  • GET /JSON/users/action/setAuthenticationCredentials/ Sets the authentication credentials for the user with the given ID that belongs to the context with the given ID.

    Loading…

  • GET /JSON/users/action/setAuthenticationState/ Sets fields in the authentication state for the user identified by the Context and User Ids.

    Loading…

  • GET /JSON/users/action/setCookie/ Sets the specified cookie for the user identified by the Context and User Ids.

    Loading…

  • GET /JSON/users/action/setUserEnabled/ Sets whether or not the user, with the given ID that belongs to the context with the given ID, should be enabled.

    Loading…

  • GET /JSON/users/action/setUserName/ Renames the user with the given ID that belongs to the context with the given ID.

    Loading…

  • GET /JSON/users/view/getAuthenticationCredentials/ Gets the authentication credentials of the user with given ID that belongs to the context with the given ID.

    Loading…

  • GET /JSON/users/view/getAuthenticationCredentialsConfigParams/ Gets the configuration parameters for the credentials of the context with the given ID.

    Loading…

  • GET /JSON/users/view/getAuthenticationSession/ Gets the authentication session information for the user identified by the Context and User Ids, e.g. cookies and realm credentials.

    Loading…

  • GET /JSON/users/view/getAuthenticationState/ Gets the authentication state information for the user identified by the Context and User Ids.

    Loading…

  • GET /JSON/users/view/getUserById/ Gets the data of the user with the given ID that belongs to the context with the given ID.

    Loading…

  • GET /JSON/users/view/usersList/ Gets a list of users that belong to the context with the given ID, or all users if none provided.

    Loading…

Alert 13

  • GET /JSON/alert/action/addAlert/ Add an alert associated with the given message ID, with the provided details.

    Loading…

  • GET /JSON/alert/action/deleteAlert/ Deletes the alert with the given ID.

    Loading…

  • GET /JSON/alert/action/deleteAlerts/ Deletes all the alerts optionally filtered by URL which fall within the Context with the provided name, risk, or base URL.

    Loading…

  • GET /JSON/alert/action/deleteAllAlerts/ Deletes all alerts of the current session.

    Loading…

  • GET /JSON/alert/action/updateAlert/ Update the alert with the given ID, with the provided details.

    Loading…

  • GET /JSON/alert/action/updateAlertsConfidence/ Update the confidence of the alerts.

    Loading…

  • GET /JSON/alert/action/updateAlertsRisk/ Update the risk of the alerts.

    Loading…

  • GET /JSON/alert/view/alert/ Gets the alert with the given ID, the corresponding HTTP message can be obtained with the 'messageId' field and 'message' API method

    Loading…

  • GET /JSON/alert/view/alertCountsByRisk/ Gets a count of the alerts, optionally filtered as per alertsPerRisk

    Loading…

  • GET /JSON/alert/view/alerts/ Gets the alerts raised by ZAP, optionally filtering by URL or riskId, and paginating with 'start' position and 'count' of alerts

    Loading…

  • GET /JSON/alert/view/alertsByRisk/ Gets a summary of the alerts, optionally filtered by a 'url'.

    Loading…

  • GET /JSON/alert/view/alertsSummary/ Gets number of alerts grouped by each risk level, optionally filtering by URL

    Loading…

  • GET /JSON/alert/view/numberOfAlerts/ Gets the number of alerts, optionally filtering by URL or riskId

    Loading…

Stats 13

  • GET /JSON/stats/action/clearStats/ Clears all of the statistics

    Loading…

  • GET /JSON/stats/action/setOptionInMemoryEnabled/ Sets whether in memory statistics are enabled

    Loading…

  • GET /JSON/stats/action/setOptionStatsdHost/ Sets the Statsd service hostname, supply an empty string to stop using a Statsd service

    Loading…

  • GET /JSON/stats/action/setOptionStatsdPort/ Sets the Statsd service port

    Loading…

  • GET /JSON/stats/action/setOptionStatsdPrefix/ Sets the prefix to be applied to all stats sent to the configured Statsd service

    Loading…

  • GET /JSON/stats/view/allSitesStats/ Gets all of the site based statistics, optionally filtered by a key prefix

    Loading…

  • GET /JSON/stats/view/optionInMemoryEnabled/ Returns 'true' if in memory statistics are enabled, otherwise returns 'false'

    Loading…

  • GET /JSON/stats/view/optionStatsdEnabled/ Returns 'true' if a Statsd server has been correctly configured, otherwise returns 'false'

    Loading…

  • GET /JSON/stats/view/optionStatsdHost/ Gets the Statsd service hostname

    Loading…

  • GET /JSON/stats/view/optionStatsdPort/ Gets the Statsd service port

    Loading…

  • GET /JSON/stats/view/optionStatsdPrefix/ Gets the prefix to be applied to all stats sent to the configured Statsd service

    Loading…

  • GET /JSON/stats/view/siteStats/ Gets all of the global statistics, optionally filtered by a key prefix

    Loading…

  • GET /JSON/stats/view/stats/ Statistics

    Loading…

Alertfilter 12

  • GET /JSON/alertFilter/action/addAlertFilter/ Adds a new alert filter for the context with the given ID.

    Loading…

  • GET /JSON/alertFilter/action/addGlobalAlertFilter/ Adds a new global alert filter.

    Loading…

  • GET /JSON/alertFilter/action/applyAll/ Applies all currently enabled Global and Context alert filters.

    Loading…

  • GET /JSON/alertFilter/action/applyContext/ Applies all currently enabled Context alert filters.

    Loading…

  • GET /JSON/alertFilter/action/applyGlobal/ Applies all currently enabled Global alert filters.

    Loading…

  • GET /JSON/alertFilter/action/removeAlertFilter/ Removes an alert filter from the context with the given ID.

    Loading…

  • GET /JSON/alertFilter/action/removeGlobalAlertFilter/ Removes a global alert filter.

    Loading…

  • GET /JSON/alertFilter/action/testAll/ Tests all currently enabled Global and Context alert filters.

    Loading…

  • GET /JSON/alertFilter/action/testContext/ Tests all currently enabled Context alert filters.

    Loading…

  • GET /JSON/alertFilter/action/testGlobal/ Tests all currently enabled Global alert filters.

    Loading…

  • GET /JSON/alertFilter/view/alertFilterList/ Lists the alert filters of the context with the given ID.

    Loading…

  • GET /JSON/alertFilter/view/globalAlertFilterList/ Lists the global alert filters.

    Loading…

Break 11

  • GET /JSON/break/action/addHttpBreakpoint/ Adds a custom HTTP breakpoint.

    Loading…

  • GET /JSON/break/action/break/ Controls the global break functionality.

    Loading…

  • GET /JSON/break/action/continue/ Submits the currently intercepted message and unsets the global request/response breakpoints

    Loading…

  • GET /JSON/break/action/drop/ Drops the currently intercepted message

    Loading…

  • GET /JSON/break/action/removeHttpBreakpoint/ Removes the specified breakpoint

    Loading…

  • GET /JSON/break/action/setHttpMessage/ Overwrites the currently intercepted message with the data provided

    Loading…

  • GET /JSON/break/action/step/ Submits the currently intercepted message, the next request or response will automatically be intercepted

    Loading…

  • GET /JSON/break/view/httpMessage/ Returns the HTTP message currently intercepted (if any)

    Loading…

  • GET /JSON/break/view/isBreakAll/ Returns True if ZAP will break on both requests and responses

    Loading…

  • GET /JSON/break/view/isBreakRequest/ Returns True if ZAP will break on requests

    Loading…

  • GET /JSON/break/view/isBreakResponse/ Returns True if ZAP will break on responses

    Loading…

Oast 11

  • GET /JSON/oast/action/setActiveScanService/ Sets the service used with the active scanner.

    Loading…

  • GET /JSON/oast/action/setBoastOptions/ Sets the BOAST options.

    Loading…

  • GET /JSON/oast/action/setCallbackOptions/ Sets the Callback options.

    Loading…

  • GET /JSON/oast/action/setDaysToKeepRecords/ Sets the number of days the OAST records will be kept for.

    Loading…

  • GET /JSON/oast/action/setInteractshOptions/ Sets the Interactsh options.

    Loading…

  • GET /JSON/oast/view/getActiveScanService/ Gets the service used with the active scanner, if any.

    Loading…

  • GET /JSON/oast/view/getBoastOptions/ Gets the BOAST options.

    Loading…

  • GET /JSON/oast/view/getCallbackOptions/ Gets the Callback options.

    Loading…

  • GET /JSON/oast/view/getDaysToKeepRecords/ Gets the number of days the OAST records will be kept for.

    Loading…

  • GET /JSON/oast/view/getInteractshOptions/ Gets the Interactsh options.

    Loading…

  • GET /JSON/oast/view/getServices/ Gets all of the services.

    Loading…

Exim 9

  • GET /JSON/exim/action/exportSitesTree/ Exports the Sites Tree in the Sites Tree YAML format.

    Loading…

  • GET /JSON/exim/action/importHar/ Imports a HAR file.

    Loading…

  • GET /JSON/exim/action/importModsec2Logs/ Imports ModSecurity2 logs from the file with the given file system path.

    Loading…

  • GET /JSON/exim/action/importUrls/ Imports URLs (one per line) from the file with the given file system path.

    Loading…

  • GET /JSON/exim/action/importZapLogs/ Imports previously exported ZAP messages from the file with the given file system path.

    Loading…

  • GET /JSON/exim/action/pruneSitesTree/ Prunes the Sites Tree based on a file in the Sites Tree YAML format.

    Loading…

  • GET /OTHER/exim/other/exportHar/ Gets the HTTP messages sent through/by ZAP, in HAR format, optionally filtered by URL and paginated with 'start' position and 'count' of messages

    Loading…

  • GET /OTHER/exim/other/exportHarById/ Gets the HTTP messages with the given IDs, in HAR format.

    Loading…

  • GET /OTHER/exim/other/sendHarRequest/ Sends the first HAR request entry, optionally following redirections.

    Loading…

Authentication 8

  • GET /JSON/authentication/action/setAuthenticationMethod/ Sets the authentication method for the context with the given ID.

    Loading…

  • GET /JSON/authentication/action/setLoggedInIndicator/ Sets the logged in indicator for the context with the given ID.

    Loading…

  • GET /JSON/authentication/action/setLoggedOutIndicator/ Sets the logged out indicator for the context with the given ID.

    Loading…

  • GET /JSON/authentication/view/getAuthenticationMethod/ Gets the name of the authentication method for the context with the given ID.

    Loading…

  • GET /JSON/authentication/view/getAuthenticationMethodConfigParams/ Gets the configuration parameters for the authentication method with the given name.

    Loading…

  • GET /JSON/authentication/view/getLoggedInIndicator/ Gets the logged in indicator for the context with the given ID.

    Loading…

  • GET /JSON/authentication/view/getLoggedOutIndicator/ Gets the logged out indicator for the context with the given ID.

    Loading…

  • GET /JSON/authentication/view/getSupportedAuthenticationMethods/ Gets the name of the authentication methods.

    Loading…

Custompayloads 8

  • GET /JSON/custompayloads/action/addCustomPayload/ Adds a new payload.

    Loading…

  • GET /JSON/custompayloads/action/disableCustomPayload/ Disables a given payload.

    Loading…

  • GET /JSON/custompayloads/action/disableCustomPayloads/ Disables payloads for a given category.

    Loading…

  • GET /JSON/custompayloads/action/enableCustomPayload/ Enables a given payload.

    Loading…

  • GET /JSON/custompayloads/action/enableCustomPayloads/ Enables payloads for a given category.

    Loading…

  • GET /JSON/custompayloads/action/removeCustomPayload/ Removes a payload.

    Loading…

  • GET /JSON/custompayloads/view/customPayloads/ Lists all the payloads currently loaded (category, payload, enabled state).

    Loading…

  • GET /JSON/custompayloads/view/customPayloadsCategories/ Lists all available categories.

    Loading…

Pnh 8

  • GET /JSON/pnh/action/monitor/

    Loading…

  • GET /JSON/pnh/action/oracle/

    Loading…

  • GET /JSON/pnh/action/startMonitoring/

    Loading…

  • GET /JSON/pnh/action/stopMonitoring/

    Loading…

  • GET /OTHER/pnh/other/fx_pnh.xpi/

    Loading…

  • GET /OTHER/pnh/other/manifest/

    Loading…

  • GET /OTHER/pnh/other/pnh/

    Loading…

  • GET /OTHER/pnh/other/service/

    Loading…

Acsrf 6

  • GET /JSON/acsrf/action/addOptionToken/ Adds an anti-CSRF token with the given name, enabled by default

    Loading…

  • GET /JSON/acsrf/action/removeOptionToken/ Removes the anti-CSRF token with the given name

    Loading…

  • GET /JSON/acsrf/action/setOptionPartialMatchingEnabled/ Define if ZAP should detect CSRF tokens by searching for partial matches.

    Loading…

  • GET /JSON/acsrf/view/optionPartialMatchingEnabled/ Define if ZAP should detect CSRF tokens by searching for partial matches

    Loading…

  • GET /JSON/acsrf/view/optionTokensNames/ Lists the names of all anti-CSRF tokens

    Loading…

  • GET /OTHER/acsrf/other/genForm/ Generate a form for testing lack of anti-CSRF tokens - typically invoked via ZAP

    Loading…

Websocket 6

  • GET /JSON/websocket/action/sendTextMessage/ 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

    Loading…

  • GET /JSON/websocket/action/setBreakTextMessage/ Sets the text message for an intercepted websockets message

    Loading…

  • GET /JSON/websocket/view/breakTextMessage/ Returns a text representation of an intercepted websockets message

    Loading…

  • GET /JSON/websocket/view/channels/ Returns all of the registered web socket channels

    Loading…

  • GET /JSON/websocket/view/message/ Returns full details of the message specified by the channelId and messageId

    Loading…

  • GET /JSON/websocket/view/messages/ 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), coun

    Loading…

Client 5

  • GET /JSON/client/action/exportClientMap/ Exports the Client Map to a file.

    Loading…

  • GET /JSON/client/action/reportEvent/

    Loading…

  • GET /JSON/client/action/reportObject/

    Loading…

  • GET /JSON/client/action/reportZestScript/

    Loading…

  • GET /JSON/client/action/reportZestStatement/

    Loading…

Ruleconfig 5

  • GET /JSON/ruleConfig/action/resetAllRuleConfigValues/ Reset all of the rule configurations

    Loading…

  • GET /JSON/ruleConfig/action/resetRuleConfigValue/ Reset the specified rule configuration, which must already exist

    Loading…

  • GET /JSON/ruleConfig/action/setRuleConfigValue/ Set the specified rule configuration, which must already exist

    Loading…

  • GET /JSON/ruleConfig/view/allRuleConfigs/ Show all of the rule configurations

    Loading…

  • GET /JSON/ruleConfig/view/ruleConfigValue/ Show the specified rule configuration

    Loading…

Accesscontrol 4

  • GET /JSON/accessControl/action/scan/ Starts an Access Control scan with the given context ID and user ID.

    Loading…

  • GET /JSON/accessControl/action/writeHTMLreport/ Generates an Access Control report for the given context ID and saves it based on the provided filename (path).

    Loading…

  • GET /JSON/accessControl/view/getScanProgress/ Gets the Access Control scan progress (percentage integer) for the given context ID.

    Loading…

  • GET /JSON/accessControl/view/getScanStatus/ Gets the Access Control scan status (description string) for the given context ID.

    Loading…

Forceduser 4

  • GET /JSON/forcedUser/action/setForcedUser/ Sets the user (ID) that should be used in 'forced user' mode for the given context (ID)

    Loading…

  • GET /JSON/forcedUser/action/setForcedUserModeEnabled/ Sets if 'forced user' mode should be enabled or not

    Loading…

  • GET /JSON/forcedUser/view/getForcedUser/ Gets the user (ID) set as 'forced user' for the given context (ID)

    Loading…

  • GET /JSON/forcedUser/view/isForcedUserModeEnabled/ Returns 'true' if 'forced user' mode is enabled, 'false' otherwise

    Loading…

Replacer 4

  • GET /JSON/replacer/action/addRule/ Adds a replacer rule.

    Loading…

  • GET /JSON/replacer/action/removeRule/ Removes the rule with the given description

    Loading…

  • GET /JSON/replacer/action/setEnabled/ Enables or disables the rule with the given description based on the bool parameter

    Loading…

  • GET /JSON/replacer/view/rules/ Returns full details of all of the rules

    Loading…

Sessionmanagement 4

  • GET /JSON/sessionManagement/action/setSessionManagementMethod/ Sets the session management method for the context with the given ID.

    Loading…

  • GET /JSON/sessionManagement/view/getSessionManagementMethod/ Gets the name of the session management method for the context with the given ID.

    Loading…

  • GET /JSON/sessionManagement/view/getSessionManagementMethodConfigParams/ Gets the configuration parameters for the session management method with the given name.

    Loading…

  • GET /JSON/sessionManagement/view/getSupportedSessionManagementMethods/ Gets the name of the session management methods.

    Loading…

Automation 3

  • GET /JSON/automation/action/endDelayJob/

    Loading…

  • GET /JSON/automation/action/runPlan/

    Loading…

  • GET /JSON/automation/view/planProgress/

    Loading…

Clientspider 3

  • GET /JSON/clientSpider/action/scan/ Starts a client spider scan.

    Loading…

  • GET /JSON/clientSpider/action/stop/ Stops a client spider scan.

    Loading…

  • GET /JSON/clientSpider/view/status/ Gets the status of a client spider scan.

    Loading…

Localproxies 3

  • GET /JSON/localProxies/action/addAdditionalProxy/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/localProxies/action/removeAdditionalProxy/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

  • GET /JSON/localProxies/view/additionalProxies/ Use the API endpoints in the 'network' component instead. deprecated

    Loading…

Reports 3

  • GET /JSON/reports/action/generate/ Generate a report with the supplied parameters.

    Loading…

  • GET /JSON/reports/view/templateDetails/ View details of the specified template.

    Loading…

  • GET /JSON/reports/view/templates/ View available templates.

    Loading…

Revisit 3

  • GET /JSON/revisit/action/revisitSiteOff/

    Loading…

  • GET /JSON/revisit/action/revisitSiteOn/

    Loading…

  • GET /JSON/revisit/view/revisitList/

    Loading…

Wappalyzer 3

  • GET /JSON/wappalyzer/view/listAll/ Lists all sites and their associated applications (technologies).

    Loading…

  • GET /JSON/wappalyzer/view/listSite/ Lists all the applications (technologies) associated with a specific site.

    Loading…

  • GET /JSON/wappalyzer/view/listSites/ Lists all the sites recognized by the Technology Detection add-on.

    Loading…

Authorization 2

  • GET /JSON/authorization/action/setBasicAuthorizationDetectionMethod/ Sets the authorization detection method for a context as one that identifies un-authorized messages based on: the message's status code or a regex pattern in the response's header or body.

    Loading…

  • GET /JSON/authorization/view/getAuthorizationDetectionMethod/ Obtains all the configuration of the authorization detection method that is currently set for a context.

    Loading…

Keyboard 2

  • GET /OTHER/keyboard/other/cheatsheetActionOrder/ Lists the keyboard shortcuts sorted by action, optionally, showing actions without shortcut set.

    Loading…

  • GET /OTHER/keyboard/other/cheatsheetKeyOrder/ Lists the keyboard shortcuts sorted by keyboard shortcut, optionally, showing actions without shortcut set.

    Loading…

Openapi 2

  • GET /JSON/openapi/action/importFile/ Imports an OpenAPI definition from a local file.

    Loading…

  • GET /JSON/openapi/action/importUrl/ Imports an OpenAPI definition from a URL.

    Loading…

Postman 2

  • GET /JSON/postman/action/importFile/

    Loading…

  • GET /JSON/postman/action/importUrl/

    Loading…

Reveal 2

  • GET /JSON/reveal/action/setReveal/ Sets if shows hidden fields and enables disabled fields

    Loading…

  • GET /JSON/reveal/view/reveal/ Tells if shows hidden fields and enables disabled fields

    Loading…

Soap 2

  • GET /JSON/soap/action/importFile/ Import a WSDL definition from local file.

    Loading…

  • GET /JSON/soap/action/importUrl/ Import a WSDL definition from a URL.

    Loading…

Dev 1

  • GET /OTHER/dev/other/openapi/ Provides the OpenAPI definition of the ZAP API, in YAML format.

    Loading…

Paramdigger 1

  • GET /JSON/paramDigger/action/helloWorld/

    Loading…

Params 1

  • GET /JSON/params/view/params/ Shows the parameters for the specified site, or for all sites if the site is not specified

    Loading…

Quickstartlaunch 1

  • GET /OTHER/quickstartlaunch/other/startPage/

    Loading…

Retest 1

  • GET /JSON/retest/action/retest/

    Loading…

Change log

    • ⚠GET /JSON/ascan/action/setOptionDelayInMs/
    • ⚠GET /JSON/ascan/view/optionDelayInMs/
    • ⚠GET /JSON/ascan/view/optionExcludedParamList/
    • ⚠GET /JSON/core/action/addProxyChainExcludedDomain/
    • ⚠GET /JSON/core/action/deleteAlert/
    • ⚠GET /JSON/core/action/deleteAllAlerts/
    • ⚠GET /JSON/core/action/disableAllProxyChainExcludedDomains/
    • ⚠GET /JSON/core/action/disableClientCertificate/
    • ⚠GET /JSON/core/action/enableAllProxyChainExcludedDomains/
    • ⚠GET /JSON/core/action/enablePKCS12ClientCertificate/
    • ⚠GET /JSON/core/action/generateRootCA/
    • ⚠GET /JSON/core/action/modifyProxyChainExcludedDomain/
    • ⚠GET /JSON/core/action/removeProxyChainExcludedDomain/
    • ⚠GET /JSON/core/action/setOptionDefaultUserAgent/
    • ⚠GET /JSON/core/action/setOptionDnsTtlSuccessfulQueries/
    • ⚠GET /JSON/core/action/setOptionHttpStateEnabled/
    • ⚠GET /JSON/core/action/setOptionProxyChainName/
    • ⚠GET /JSON/core/action/setOptionProxyChainPassword/
    • ⚠GET /JSON/core/action/setOptionProxyChainPort/
    • ⚠GET /JSON/core/action/setOptionProxyChainPrompt/
    • ⚠GET /JSON/core/action/setOptionProxyChainRealm/
    • ⚠GET /JSON/core/action/setOptionProxyChainSkipName/
    • ⚠GET /JSON/core/action/setOptionProxyChainUserName/
    • ⚠GET /JSON/core/action/setOptionSingleCookieRequestHeader/
    • ⚠GET /JSON/core/action/setOptionTimeoutInSecs/
    • ⚠GET /JSON/core/action/setOptionUseProxyChain/
    • ⚠GET /JSON/core/action/setOptionUseProxyChainAuth/
    • ⚠GET /JSON/core/action/setOptionUseSocksProxy/
    • ⚠GET /JSON/core/view/alert/
    • ⚠GET /JSON/core/view/alerts/
    • ⚠GET /JSON/core/view/alertsSummary/
    • ⚠GET /JSON/core/view/homeDirectory/
    • ⚠GET /JSON/core/view/numberOfAlerts/
    • ⚠GET /JSON/core/view/optionDefaultUserAgent/
    • ⚠GET /JSON/core/view/optionDnsTtlSuccessfulQueries/
    • ⚠GET /JSON/core/view/optionHttpState/
    • ⚠GET /JSON/core/view/optionHttpStateEnabled/
    • ⚠GET /JSON/core/view/optionProxyChainName/
    • ⚠GET /JSON/core/view/optionProxyChainPassword/
    • ⚠GET /JSON/core/view/optionProxyChainPort/
    • ⚠GET /JSON/core/view/optionProxyChainPrompt/
    • ⚠GET /JSON/core/view/optionProxyChainRealm/
    • ⚠GET /JSON/core/view/optionProxyChainSkipName/
    • ⚠GET /JSON/core/view/optionProxyChainUserName/
    • ⚠GET /JSON/core/view/optionProxyExcludedDomains/
    • ⚠GET /JSON/core/view/optionProxyExcludedDomainsEnabled/
    • ⚠GET /JSON/core/view/optionSingleCookieRequestHeader/
    • ⚠GET /JSON/core/view/optionTimeoutInSecs/
    • ⚠GET /JSON/core/view/optionUseProxyChain/
    • ⚠GET /JSON/core/view/optionUseProxyChainAuth/
    • ⚠GET /JSON/core/view/optionUseSocksProxy/
    • ⚠GET /JSON/core/view/proxyChainExcludedDomains/
    • ⚠GET /JSON/localProxies/action/addAdditionalProxy/
    • ⚠GET /JSON/localProxies/action/removeAdditionalProxy/
    • ⚠GET /JSON/localProxies/view/additionalProxies/
    • ⚠GET /JSON/pscan/view/currentRule/
    • ⚠GET /JSON/selenium/action/setOptionIeDriverPath/
    • ⚠GET /JSON/selenium/action/setOptionPhantomJsBinaryPath/
    • ⚠GET /JSON/selenium/view/optionIeDriverPath/
    • ⚠GET /JSON/selenium/view/optionPhantomJsBinaryPath/
    • ⚠GET /JSON/spider/view/optionDomainsAlwaysInScope/
    • ⚠GET /JSON/spider/view/optionDomainsAlwaysInScopeEnabled/
    • ⚠GET /OTHER/core/other/htmlreport/
    • ⚠GET /OTHER/core/other/jsonreport/
    • ⚠GET /OTHER/core/other/mdreport/
    • ⚠GET /OTHER/core/other/messageHar/
    • ⚠GET /OTHER/core/other/messagesHar/
    • ⚠GET /OTHER/core/other/messagesHarById/
    • ⚠GET /OTHER/core/other/proxy.pac/
    • ⚠GET /OTHER/core/other/rootcert/
    • ⚠GET /OTHER/core/other/sendHarRequest/
    • ⚠GET /OTHER/core/other/setproxy/
    • ⚠GET /OTHER/core/other/xmlreport/
compare.md

    Free the public facts, no sign-in Any paid plan all other sections Researcher & Business pricing history and category rank

    my-toolchain — 0 tools

      Betas, release candidates and previews. Turn it off to see final releases only. It also applies to changes you ask for over MCP when you're signed in.
      browse all tools → score card for your toolchain →
      cyber-toolchain / feedback

      Send us feedback