ZAP API — core
ZAP API — core. 97 operations. Lead operation: core. Self-contained Naftiko capability covering one Owasp Zap business surface.
What You Can Do
MCP Tools
convenient-and-simple-action-access
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, '
use-api-endpoints-network-component
Use the API endpoints in the 'network' component instead.
clears-regexes-urls-excluded-local
Clears the regexes of URLs excluded from the local proxies.
create-zip-file-zap-core
Create a zip file of the ZAP core and add-on SBOMs
use-api-endpoint-same-name
Use the API endpoint with the same name in the 'alert' component instead.
use-api-endpoint-same-name-2
Use the API endpoint with the same name in the 'alert' component instead.
deletes-site-node-found-sites
Deletes the site node found in the Sites Tree on the basis of the URL, HTTP method, and post data (if applicable and specified).
use-api-endpoints-network-component-2
Use the API endpoints in the 'network' component instead.
use-api-endpoints-network-component-3
Use the API endpoints in the 'network' component instead.
use-api-endpoints-network-component-4
Use the API endpoints in the 'network' component instead.
use-api-endpoints-network-component-5
Use the API endpoints in the 'network' component instead.
adds-regex-urls-that-should
Adds a regex of URLs that should be excluded from the local proxies.
use-api-endpoints-network-component-6
Use the API endpoints in the 'network' component instead.
loads-session-given-name-if
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.
use-api-endpoints-network-component-7
Use the API endpoints in the 'network' component instead.
creates-new-session-optionally-overwriting
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.
use-api-endpoints-network-component-8
Use the API endpoints in the 'network' component instead.
coreactionrungarbagecollection
coreactionrungarbagecollection
saves-session
Saves the session.
sends-http-request-optionally-following
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
coreactionsethomedirectory
coreactionsethomedirectory
sets-logging-level-given-logger
Sets the logging level for a given logger name.
sets-mode-which-may-be
Sets the mode, which may be one of [safe, protect, standard, attack]
sets-clears-if-empty-path
Sets (or clears, if empty) the path to the file with alert overrides.
use-api-endpoints-network-component-9
Use the API endpoints in the 'network' component instead.
use-api-endpoints-network-component-10
Use the API endpoints in the 'network' component instead.
use-api-endpoints-network-component-11
Use the API endpoints in the 'network' component instead.
sets-maximum-number-alert-instances
Sets the maximum number of alert instances to include in a report. A value of zero is treated as unlimited.
sets-whether-not-related-alerts
Sets whether or not related alerts will be merged in any reports generated.
use-api-endpoints-network-component-12
Use the API endpoints in the 'network' component instead.
use-api-endpoints-network-component-13
Use the API endpoints in the 'network' component instead.
use-api-endpoints-network-component-14
Use the API endpoints in the 'network' component instead.
use-api-endpoints-network-component-15
Use the API endpoints in the 'network' component instead.
use-api-endpoints-network-component-16
Use the API endpoints in the 'network' component instead.
option-no-longer-effective-use
Option no longer in effective use.
use-api-endpoints-network-component-17
Use the API endpoints in the 'network' component instead.
option-no-longer-effective-use-2
Option no longer in effective use.
use-api-endpoints-network-component-18
Use the API endpoints in the 'network' component instead.
use-api-endpoints-network-component-19
Use the API endpoints in the 'network' component instead.
use-api-endpoints-network-component-20
Use the API endpoints in the 'network' component instead.
use-api-endpoints-network-component-21
Use the API endpoints in the 'network' component instead.
shuts-down-zap
Shuts down ZAP
snapshots-session-optionally-given-name
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 th
use-api-endpoint-same-name-3
Use the API endpoint with the same name in the 'alert' component instead.
use-api-endpoint-same-name-4
Use the API endpoint with the same name in the 'alert' component instead.
use-api-endpoint-same-name-5
Use the API endpoint with the same name in the 'alert' component instead.
gets-child-nodes-underneath-specified
Gets the child nodes underneath the specified URL in the Sites tree
gets-regular-expressions-applied-urls
Gets the regular expressions, applied to URLs, to exclude from the local proxies.
detailed-logging-config-optionally-filtered
The detailed logging config, optionally filtered based on a name (ex: starts with).
coreviewhomedirectory
coreviewhomedirectory
gets-name-hosts-accessed-through
Gets the name of the hosts accessed through/by ZAP
gets-http-message-given-id
Gets the HTTP message with the given ID. Returns the ID, request/response headers and bodies, cookies, note, type, RTT, and timestamp.
gets-http-messages-sent-zap
Gets the HTTP messages sent by ZAP, request and response, optionally filtered by URL and paginated with 'start' position and 'count' of messages
gets-http-messages-given-ids
Gets the HTTP messages with the given IDs.
gets-mode
Gets the mode
use-api-endpoint-same-name-6
Use the API endpoint with the same name in the 'alert' component instead.
gets-number-messages-optionally-filtering
Gets the number of messages, optionally filtering by URL
gets-path-file-alert-overrides
Gets the path to the file with alert overrides.
use-api-endpoints-network-component-22
Use the API endpoints in the 'network' component instead.
use-api-endpoints-network-component-23
Use the API endpoints in the 'network' component instead.
use-api-endpoints-network-component-24
Use the API endpoints in the 'network' component instead.
use-api-endpoints-network-component-25
Use the API endpoints in the 'network' component instead.
gets-maximum-number-alert-instances
Gets the maximum number of alert instances to include in a report.
gets-whether-not-related-alerts
Gets whether or not related alerts will be merged in any reports generated.
use-api-endpoints-network-component-26
Use the API endpoints in the 'network' component instead.
use-api-endpoints-network-component-27
Use the API endpoints in the 'network' component instead.
use-api-endpoints-network-component-28
Use the API endpoints in the 'network' component instead.
use-api-endpoints-network-component-29
Use the API endpoints in the 'network' component instead.
use-api-endpoints-network-component-30
Use the API endpoints in the 'network' component instead.
use-view-proxychainexcludeddomains-instead
Use view proxyChainExcludedDomains instead.
use-api-endpoints-network-component-31
Use the API endpoints in the 'network' component instead.
use-view-proxychainexcludeddomains-instead-2
Use view proxyChainExcludedDomains instead.
use-view-proxychainexcludeddomains-instead-3
Use view proxyChainExcludedDomains instead.
option-no-longer-effective-use-3
Option no longer in effective use.
use-api-endpoints-network-component-32
Use the API endpoints in the 'network' component instead.
use-api-endpoints-network-component-33
Use the API endpoints in the 'network' component instead.
use-api-endpoints-network-component-34
Use the API endpoints in the 'network' component instead.
use-api-endpoints-network-component-35
Use the API endpoints in the 'network' component instead.
use-api-endpoints-network-component-36
Use the API endpoints in the 'network' component instead.
gets-location-current-session-file
Gets the location of the current session file
gets-sites-accessed-through-zap
Gets the sites accessed through/by ZAP (scheme and domain)
gets-urls-accessed-through-zap
Gets the URLs accessed through/by ZAP, optionally filtering by (base) URL.
gets-zap-version
Gets ZAP version
gets-path-zap-s-home-directory
Gets the path to ZAP's home directory.
download-file-transfer-directory
Download a file from the transfer directory
upload-file-transfer-directory-only
Upload a file to the transfer directory. Only POST requests accepted with encodings of "multipart/form-data" or "application/x-www-form-urlencoded".
use-generate-api-endpoint-reports
Use the 'generate' API endpoint the 'reports' component instead.
use-generate-api-endpoint-reports-2
Use the 'generate' API endpoint the 'reports' component instead.
use-generate-api-endpoint-reports-3
Use the 'generate' API endpoint the 'reports' component instead.
use-api-endpoints-exim-add
Use the API endpoints in the 'exim' add-on instead.
use-api-endpoints-exim-add-2
Use the API endpoints in the 'exim' add-on instead.
use-api-endpoints-exim-add-3
Use the API endpoints in the 'exim' add-on instead.
use-api-endpoints-network-component-37
Use the API endpoints in the 'network' component instead.
use-api-endpoints-network-component-38
Use the API endpoints in the 'network' component instead.
use-api-endpoints-exim-add-4
Use the API endpoints in the 'exim' add-on instead.
use-api-endpoints-network-component-39
Use the API endpoints in the 'network' component instead.
use-generate-api-endpoint-reports-4
Use the 'generate' API endpoint the 'reports' component instead.