ZAP API UI

Component: ajaxSpider

Views

allowedResources	Gets the allowed resources. The allowed resources are always fetched even if out of scope, allowing to include necessary resources (e.g. scripts) from 3rd-parties.
fullResults	Gets the full crawled content detected by the AJAX Spider. Returns a set of values based on 'inScope' URLs, 'outOfScope' URLs, and 'errors' encountered during the last/current run of the AJAX Spider.
numberOfResults	Gets the number of resources found.
optionBrowserId	Gets the configured browser to use for crawling.
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.
optionClickElemsOnce	Gets the value configured for the AJAX Spider to know if it should click on the elements only once.
optionEventWait	Gets the time to wait after an event (in milliseconds). For example: the wait delay after the cursor hovers over an element, in order for a menu to display, etc.
optionMaxCrawlDepth	Gets the configured value for the max crawl depth.
optionMaxCrawlStates	Gets the configured value for the maximum crawl states allowed.
optionMaxDuration	Gets the configured max duration of the crawl, the value is in minutes.
optionNumberOfBrowsers	Gets the configured number of browsers to be used.
optionRandomInputs	Gets if the AJAX Spider will use random values in form fields when crawling, if set to true.
optionReloadWait	Gets the configured time to wait after reloading the page, this value is in milliseconds.
results (start count )	Gets the current results of the crawler.
status	Gets the current status of the crawler. Actual values are Stopped and Running.

Actions

addAllowedResource (regex* enabled )	Adds an allowed resource.
removeAllowedResource (regex* )	Removes an allowed resource.
scan (url inScope contextName subtreeOnly )	Runs the AJAX Spider against a given target.
scanAsUser (contextName* userName* url subtreeOnly )	Runs the AJAX Spider from the perspective of a User of the web application.
setEnabledAllowedResource (regex* enabled* )	Sets whether or not an allowed resource is enabled.
setOptionBrowserId (String* )	Sets the configuration of the AJAX Spider to use one of the supported browsers.
setOptionClickDefaultElems (Boolean* )	Sets whether or not the the AJAX Spider will only click on the default HTML elements.
setOptionClickElemsOnce (Boolean* )	When enabled, the crawler attempts to interact with each element (e.g., by clicking) only once.
setOptionEventWait (Integer* )	Sets the time to wait after an event (in milliseconds). For example: the wait delay after the cursor hovers over an element, in order for a menu to display, etc.
setOptionMaxCrawlDepth (Integer* )	Sets the maximum depth that the crawler can reach.
setOptionMaxCrawlStates (Integer* )	Sets the maximum number of states that the crawler should crawl.
setOptionMaxDuration (Integer* )	The maximum time that the crawler is allowed to run.
setOptionNumberOfBrowsers (Integer* )	Sets the number of windows to be used by AJAX Spider.
setOptionRandomInputs (Boolean* )	When enabled, inserts random values into form fields.
setOptionReloadWait (Integer* )	Sets the time to wait after the page is loaded before interacting with it.
stop	Stops the AJAX Spider.