[−][src]Module zap_api::spider
Functions
| add_domain_always_in_scope | Adds 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). |
| added_nodes | Returns a list of the names of the nodes added to the Sites tree by the specified scan. |
| all_urls | Returns a list of unique URLs from the history table based on HTTP messages added by the Spider. |
| clear_excluded_from_scan | Clears the regexes of URLs excluded from the spider scans. |
| disable_all_domains_always_in_scope | Disables all domains that are always in scope. |
| domains_always_in_scope | Gets 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. |
| enable_all_domains_always_in_scope | Enables all domains that are always in scope. |
| exclude_from_scan | Adds a regex of URLs that should be excluded from the spider scans. |
| excluded_from_scan | Gets the regexes of URLs excluded from the spider scans. |
| full_results | |
| modify_domain_always_in_scope | Modifies 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. |
| option_accept_cookies | Gets whether or not a spider process should accept cookies while spidering. |
| option_domains_always_in_scope | Use view domainsAlwaysInScope instead. Deprecated |
| option_domains_always_in_scope_enabled | Use view domainsAlwaysInScope instead. Deprecated |
| option_handle_o_data_parameters_visited | |
| option_handle_parameters | |
| option_max_children | Gets the maximum number of child nodes (per node) that can be crawled, 0 means no limit. |
| option_max_depth | Gets the maximum depth the spider can crawl, 0 if unlimited. |
| option_max_duration | |
| option_max_parse_size_bytes | Gets the maximum size, in bytes, that a response might have to be parsed. |
| option_max_scans_in_ui | |
| option_parse_comments | |
| option_parse_git | |
| option_parse_robots_txt | |
| option_parse_sitemap_xml | |
| option_parse_svn_entries | |
| option_post_form | |
| option_process_form | |
| option_request_wait_time | |
| option_scope | |
| option_scope_text | |
| option_send_referer_header | Gets whether or not the 'Referer' header should be sent while spidering. |
| option_show_advanced_dialog | |
| option_skip_url_string | |
| option_thread_count | |
| option_user_agent | |
| pause | |
| pause_all_scans | |
| remove_all_scans | |
| remove_domain_always_in_scope | Removes a domain that's always in scope, with the given index. The index can be obtained with the view domainsAlwaysInScope. |
| remove_scan | |
| results | |
| resume | |
| resume_all_scans | |
| scan | Runs 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'). |
| scan_as_user | Runs the spider from the perspective of a User, obtained using the given Context ID and User ID. See 'scan' action for more details. |
| scans | |
| set_option_accept_cookies | Sets whether or not a spider process should accept cookies while spidering. |
| set_option_handle_o_data_parameters_visited | |
| set_option_handle_parameters | |
| set_option_max_children | Sets the maximum number of child nodes (per node) that can be crawled, 0 means no limit. |
| set_option_max_depth | Sets the maximum depth the spider can crawl, 0 for unlimited depth. |
| set_option_max_duration | |
| set_option_max_parse_size_bytes | Sets the maximum size, in bytes, that a response might have to be parsed. This allows the spider to skip big responses/files. |
| set_option_max_scans_in_ui | |
| set_option_parse_comments | |
| set_option_parse_git | |
| set_option_parse_robots_txt | |
| set_option_parse_sitemap_xml | |
| set_option_parse_svn_entries | |
| set_option_post_form | |
| set_option_process_form | |
| set_option_request_wait_time | |
| set_option_scope_string | Use actions [add|modify|remove]DomainAlwaysInScope instead. Deprecated Option no longer in effective use. |
| set_option_send_referer_header | Sets whether or not the 'Referer' header should be sent while spidering. |
| set_option_show_advanced_dialog | |
| set_option_skip_url_string | |
| set_option_thread_count | |
| set_option_user_agent | |
| status | This file was automatically generated. |
| stop | |
| stop_all_scans |