What You Can Do
MCP Tools
accesscontrolactionscan
Starts an Access Control scan with the given context ID and user ID. (Optional parameters: user ID for Unauthenticated user, boolean identifying whether or not Alerts are raised, and the Risk level for the Alerts.) [This assumes the Access
accesscontrolactionwritehtmlreport
Generates an Access Control report for the given context ID and saves it based on the provided filename (path).
accesscontrolviewgetscanprogress
Gets the Access Control scan progress (percentage integer) for the given context ID.
accesscontrolviewgetscanstatus
Gets the Access Control scan status (description string) for the given context ID.
acsrfactionaddoptiontoken
Adds an anti-CSRF token with the given name, enabled by default
acsrfactionremoveoptiontoken
Removes the anti-CSRF token with the given name
acsrfactionsetoptionpartialmatchingenabled
Define if ZAP should detect CSRF tokens by searching for partial matches.
acsrfothergenform
Generate a form for testing lack of anti-CSRF tokens - typically invoked via ZAP
acsrfviewoptionpartialmatchingenabled
Define if ZAP should detect CSRF tokens by searching for partial matches
acsrfviewoptiontokensnames
Lists the names of all anti-CSRF tokens
ajaxspideractionaddallowedresource
Adds an allowed resource.
ajaxspideractionaddexcludedelement
Adds an excluded element to a context.
ajaxspideractionmodifyexcludedelement
Modifies an excluded element of a context.
ajaxspideractionremoveallowedresource
Removes an allowed resource.
ajaxspideractionremoveexcludedelement
Removes an excluded element from a context.
ajaxspideractionscan
Runs the AJAX Spider against a given target.
ajaxspideractionscanasuser
Runs the AJAX Spider from the perspective of a User of the web application.
ajaxspideractionsetenabledallowedresource
Sets whether or not an allowed resource is enabled.
ajaxspideractionsetoptionbrowserid
Sets the configuration of the AJAX Spider to use one of the supported browsers.
ajaxspideractionsetoptionclickdefaultelems
Sets whether or not the AJAX Spider will only click on the default HTML elements.
ajaxspideractionsetoptionclickelemsonce
When enabled, the crawler attempts to interact with each element (e.g., by clicking) only once.
ajaxspideractionsetoptionenableextensions
GET /JSON/ajaxSpider/action/setOptionEnableExtensions/
ajaxspideractionsetoptioneventwait
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.
ajaxspideractionsetoptionlogoutavoidance
Sets whether or not the AJAX Spider should avoid clicking logout elements.
ajaxspideractionsetoptionmaxcrawldepth
Sets the maximum depth that the crawler can reach.
ajaxspideractionsetoptionmaxcrawlstates
Sets the maximum number of states that the crawler should crawl.
ajaxspideractionsetoptionmaxduration
The maximum time that the crawler is allowed to run.
ajaxspideractionsetoptionnumberofbrowsers
Sets the number of windows to be used by AJAX Spider.
ajaxspideractionsetoptionrandominputs
When enabled, inserts random values into form fields.
ajaxspideractionsetoptionreloadwait
Sets the time to wait after the page is loaded before interacting with it.
ajaxspideractionsetoptionscopecheck
Sets the scope check.
ajaxspideractionstop
Stops the AJAX Spider.
ajaxspiderviewallowedresources
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.
ajaxspiderviewexcludedelements
Gets the excluded elements. The excluded elements are not clicked during crawling, for example, to prevent logging out.
ajaxspiderviewfullresults
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.
ajaxspiderviewnumberofresults
Gets the number of resources found.
ajaxspiderviewoptionbrowserid
Gets the configured browser to use for crawling.
ajaxspiderviewoptionclickdefaultelems
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.
ajaxspiderviewoptionclickelemsonce
Gets the value configured for the AJAX Spider to know if it should click on the elements only once.
ajaxspiderviewoptionenableextensions
GET /JSON/ajaxSpider/view/optionEnableExtensions/
ajaxspiderviewoptioneventwait
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.
ajaxspiderviewoptionlogoutavoidance
Gets the value of the Logout Avoidance option.
ajaxspiderviewoptionmaxcrawldepth
Gets the configured value for the max crawl depth.
ajaxspiderviewoptionmaxcrawlstates
Gets the configured value for the maximum crawl states allowed.
ajaxspiderviewoptionmaxduration
Gets the configured max duration of the crawl, the value is in minutes.
ajaxspiderviewoptionnumberofbrowsers
Gets the configured number of browsers to be used.
ajaxspiderviewoptionrandominputs
Gets if the AJAX Spider will use random values in form fields when crawling, if set to true.
ajaxspiderviewoptionreloadwait
Gets the configured time to wait after reloading the page, this value is in milliseconds.
ajaxspiderviewoptionscopecheck
Gets the configured scope check.
ajaxspiderviewresults
Gets the current results of the crawler.
ajaxspiderviewstatus
Gets the current status of the crawler. Actual values are Stopped and Running.
alertactionaddalert
Add an alert associated with the given message ID, with the provided details. (The ID of the created alert is returned.)
alertactiondeletealert
Deletes the alert with the given ID.
alertactiondeletealerts
Deletes all the alerts optionally filtered by URL which fall within the Context with the provided name, risk, or base URL.
alertactiondeleteallalerts
Deletes all alerts of the current session.
alertactionupdatealert
Update the alert with the given ID, with the provided details.
alertactionupdatealertsconfidence
Update the confidence of the alerts.
alertactionupdatealertsrisk
Update the risk of the alerts.
alertviewalert
Gets the alert with the given ID, the corresponding HTTP message can be obtained with the 'messageId' field and 'message' API method
alertviewalertcountsbyrisk
Gets a count of the alerts, optionally filtered as per alertsPerRisk