[−][src]Module zap_api::core
Functions
| access_url | Convenient and simple action to access a URL, optionally following redirections. Returns the request sent and response received and followed redirections, if any. Other actions are available which offer more control on what is sent, like, 'sendRequest' or 'sendHarRequest'. |
| add_proxy_chain_excluded_domain | Adds a domain to be excluded from the outgoing proxy, using the specified value. Optionally sets if the new entry is enabled (default, true) and whether or not the new value is specified as a regex (default, false). |
| alert | Gets the alert with the given ID, the corresponding HTTP message can be obtained with the 'messageId' field and 'message' API method Deprecated Use the API endpoint with the same name in the 'alert' component instead. |
| alerts | Gets the alerts raised by ZAP, optionally filtering by URL or riskId, and paginating with 'start' position and 'count' of alerts Deprecated Use the API endpoint with the same name in the 'alert' component instead. |
| alerts_summary | Gets number of alerts grouped by each risk level, optionally filtering by URL Deprecated Use the API endpoint with the same name in the 'alert' component instead. |
| child_nodes | Gets the child nodes underneath the specified URL in the Sites tree |
| clear_excluded_from_proxy | Clears the regexes of URLs excluded from the local proxies. |
| delete_alert | Deletes the alert with the given ID. Deprecated Use the API endpoint with the same name in the 'alert' component instead. |
| delete_all_alerts | Deletes all alerts of the current session. Deprecated Use the API endpoint with the same name in the 'alert' component instead. |
| delete_site_node | Deletes the site node found in the Sites Tree on the basis of the URL, HTTP method, and post data (if applicable and specified). |
| disable_all_proxy_chain_excluded_domains | Disables all domains excluded from the outgoing proxy. |
| disable_client_certificate | Disables the option for use of client certificates. |
| enable_all_proxy_chain_excluded_domains | Enables all domains excluded from the outgoing proxy. |
| enable_pkcs_12_client_certificate | Enables use of a PKCS12 client certificate for the certificate with the given file system path, password, and optional index. |
| exclude_from_proxy | Adds a regex of URLs that should be excluded from the local proxies. |
| excluded_from_proxy | Gets the regular expressions, applied to URLs, to exclude from the local proxies. |
| generate_root_ca | Generates a new Root CA certificate for the local proxies. |
| home_directory | |
| hosts | This file was automatically generated. Gets the name of the hosts accessed through/by ZAP |
| htmlreport | Generates a report in HTML format |
| jsonreport | Generates a report in JSON format |
| load_session | Loads the session with the given name. If a relative path is specified it will be resolved against the "session" directory in ZAP "home" dir. |
| mdreport | Generates a report in Markdown format |
| message | Gets the HTTP message with the given ID. Returns the ID, request/response headers and bodies, cookies, note, type, RTT, and timestamp. |
| message_har | Gets the message with the given ID in HAR format |
| messages | Gets the HTTP messages sent by ZAP, request and response, optionally filtered by URL and paginated with 'start' position and 'count' of messages |
| messages_by_id | Gets the HTTP messages with the given IDs. |
| messages_har | Gets the HTTP messages sent through/by ZAP, in HAR format, optionally filtered by URL and paginated with 'start' position and 'count' of messages |
| messages_har_by_id | Gets the HTTP messages with the given IDs, in HAR format. |
| mode | Gets the mode |
| modify_proxy_chain_excluded_domain | Modifies a domain excluded from the outgoing proxy. Allows to modify the value, if enabled or if a regex. The domain is selected with its index, which can be obtained with the view proxyChainExcludedDomains. |
| new_session | Creates a new session, optionally overwriting existing files. If a relative path is specified it will be resolved against the "session" directory in ZAP "home" dir. |
| number_of_alerts | Gets the number of alerts, optionally filtering by URL or riskId Deprecated Use the API endpoint with the same name in the 'alert' component instead. |
| number_of_messages | Gets the number of messages, optionally filtering by URL |
| option_alert_overrides_file_path | Gets the path to the file with alert overrides. |
| option_default_user_agent | Gets the user agent that ZAP should use when creating HTTP messages (for example, spider messages or CONNECT requests to outgoing proxy). |
| option_dns_ttl_successful_queries | Gets the TTL (in seconds) of successful DNS queries. |
| option_http_state | |
| option_http_state_enabled | |
| option_maximum_alert_instances | Gets the maximum number of alert instances to include in a report. |
| option_merge_related_alerts | Gets whether or not related alerts will be merged in any reports generated. |
| option_proxy_chain_name | |
| option_proxy_chain_password | |
| option_proxy_chain_port | |
| option_proxy_chain_prompt | |
| option_proxy_chain_realm | |
| option_proxy_chain_skip_name | Use view proxyChainExcludedDomains instead. Deprecated |
| option_proxy_chain_user_name | |
| option_proxy_excluded_domains | Use view proxyChainExcludedDomains instead. Deprecated |
| option_proxy_excluded_domains_enabled | Use view proxyChainExcludedDomains instead. Deprecated |
| option_single_cookie_request_header | |
| option_timeout_in_secs | Gets the connection time out, in seconds. |
| option_use_proxy_chain | |
| option_use_proxy_chain_auth | |
| proxy_chain_excluded_domains | Gets all the domains that are excluded from the outgoing proxy. For each domain the following are shown: the index, the value (domain), if enabled, and if specified as a regex. |
| proxy_pac | |
| remove_proxy_chain_excluded_domain | Removes a domain excluded from the outgoing proxy, with the given index. The index can be obtained with the view proxyChainExcludedDomains. |
| rootcert | Gets the Root CA certificate used by the local proxies. |
| run_garbage_collection | |
| save_session | Saves the session with the name supplied, optionally overwriting existing files. If a relative path is specified it will be resolved against the "session" directory in ZAP "home" dir. |
| send_har_request | Sends the first HAR request entry, optionally following redirections. Returns, in HAR format, the request sent and response received and followed redirections, if any. The Mode is enforced when sending the request (and following redirections), custom manual requests are not allowed in 'Safe' mode nor in 'Protected' mode if out of scope. |
| send_request | Sends the HTTP request, optionally following redirections. Returns the request sent and response received and followed redirections, if any. The Mode is enforced when sending the request (and following redirections), custom manual requests are not allowed in 'Safe' mode nor in 'Protected' mode if out of scope. |
| session_location | Gets the location of the current session file |
| set_home_directory | |
| set_mode | Sets the mode, which may be one of [safe, protect, standard, attack] |
| set_option_alert_overrides_file_path | Sets (or clears, if empty) the path to the file with alert overrides. |
| set_option_default_user_agent | Sets the user agent that ZAP should use when creating HTTP messages (for example, spider messages or CONNECT requests to outgoing proxy). |
| set_option_dns_ttl_successful_queries | Sets the TTL (in seconds) of successful DNS queries (applies after ZAP restart). |
| set_option_http_state_enabled | |
| set_option_maximum_alert_instances | Sets the maximum number of alert instances to include in a report. A value of zero is treated as unlimited. |
| set_option_merge_related_alerts | Sets whether or not related alerts will be merged in any reports generated. |
| set_option_proxy_chain_name | |
| set_option_proxy_chain_password | |
| set_option_proxy_chain_port | |
| set_option_proxy_chain_prompt | |
| set_option_proxy_chain_realm | |
| set_option_proxy_chain_skip_name | Use actions [add|modify|remove]ProxyChainExcludedDomain instead. Deprecated Option no longer in effective use. |
| set_option_proxy_chain_user_name | |
| set_option_single_cookie_request_header | |
| set_option_timeout_in_secs | Sets the connection time out, in seconds. |
| set_option_use_proxy_chain | Sets whether or not the outgoing proxy should be used. The address/hostname of the outgoing proxy must be set to enable this option. |
| set_option_use_proxy_chain_auth | |
| setproxy | |
| shutdown | Shuts down ZAP |
| sites | Gets the sites accessed through/by ZAP (scheme and domain) |
| snapshot_session | Snapshots the session, optionally with the given name, and overwriting existing files. If no name is specified the name of the current session with a timestamp appended is used. If a relative path is specified it will be resolved against the "session" directory in ZAP "home" dir. |
| urls | Gets the URLs accessed through/by ZAP, optionally filtering by (base) URL. |
| version | Gets ZAP version |
| xmlreport | Generates a report in XML format |
| zap_home_path | Gets the path to ZAP's home directory. |