ZAP API UI

Component: clientSpider

Allows to manage the Client Spider.

Views

optionActionWaitTimeInSecsGets the action wait time option.
optionBrowserIdGets the browser ID option.
optionInitialLoadTimeInSecsGets the initial page load time option.
optionLogoutAvoidanceGets whether or not the spider avoids clicking logout elements.
optionMaxChildrenGets the maximum children option.
optionMaxDepthGets the maximum crawl depth option.
optionMaxDurationGets the maximum duration option.
optionMaxScansInUiGets the maximum scans in the UI option.
optionPageLoadTimeInSecsGets the page load time option.
optionScopeCheckGets the scope check option.
optionShutdownTimeInSecsGets the shutdown time option.
optionThreadCountGets the number of browser windows to open option.
status (scanId* ) Gets the status of a client spider scan.

Actions

scan (browser url contextName userName subtreeOnly maxCrawlDepth pageLoadTime actionWaitTime numberOfBrowsers scopeCheck logoutAvoidance ) Starts a client spider scan.
setOptionActionWaitTimeInSecs (Integer* ) Sets the action wait time option.
setOptionBrowserId (String* ) Sets the browser ID option.
setOptionInitialLoadTimeInSecs (Integer* ) Sets the initial page load time option.
setOptionLogoutAvoidance (Boolean* ) Sets whether or not the spider should avoid clicking logout elements.
setOptionMaxChildren (Integer* ) Sets the maximum children option.
setOptionMaxDepth (Integer* ) Sets the maximum crawl depth option.
setOptionMaxDuration (Integer* ) Sets the maximum duration option.
setOptionMaxScansInUi (Integer* ) Sets the maximum scans in the UI option.
setOptionPageLoadTimeInSecs (Integer* ) Sets the page load time option.
setOptionScopeCheck (String* ) Sets the scope check option.
setOptionShutdownTimeInSecs (Integer* ) Sets the shutdown time option.
setOptionThreadCount (Integer* ) Sets the number of browser windows to open option.
stop (scanId* ) Stops a client spider scan.