ZAP API — ascan
ZAP API — ascan. 90 operations. Lead operation: ascan. Self-contained Naftiko capability covering one Owasp Zap business surface.
What You Can Do
MCP Tools
adds-new-parameter-excluded-scan
Adds a new parameter excluded from the scan, using the specified name. Optionally sets if the new entry applies to a specific URL (default, all URLs) and sets the ID of the type of the parameter (default, ID of any type). The type IDs can b
ascanactionaddscanpolicy
ascanactionaddscanpolicy
clears-regexes-urls-excluded-active
Clears the regexes of URLs excluded from the active scans.
disables-all-scan-rules-scan
Disables all scan rules of the scan policy with the given name, or the default if none given.
disables-scan-rules-given-ids
Disables the scan rules with the given IDs (comma separated list of IDs) of the scan policy with the given name, or the default if none given.
enables-all-scan-rules-scan
Enables all scan rules of the scan policy with the given name, or the default if none given.
enables-scan-rules-given-ids
Enables the scan rules with the given IDs (comma separated list of IDs) of the scan policy with the given name, or the default if none given.
adds-regex-urls-that-should
Adds a regex of URLs that should be excluded from the active scans.
imports-scan-policy-using-given
Imports a Scan Policy using the given file system path.
modifies-parameter-excluded-scan-allows
Modifies a parameter excluded from the scan. Allows to modify the name, the URL and the type of parameter. The parameter is selected with its index, which can be obtained with the view excludedParams.
ascanactionpause
ascanactionpause
ascanactionpauseallscans
ascanactionpauseallscans
ascanactionremoveallscans
ascanactionremoveallscans
removes-parameter-excluded-scan-given
Removes a parameter excluded from the scan, with the given index. The index can be obtained with the view excludedParams.
ascanactionremovescan
ascanactionremovescan
ascanactionremovescanpolicy
ascanactionremovescanpolicy
ascanactionresume
ascanactionresume
ascanactionresumeallscans
ascanactionresumeallscans
runs-active-scanner-against-given
Runs the active scanner against the given URL or Context. Optionally, the 'recurse' parameter can be used to scan URLs under the given URL, the parameter 'inScopeOnly' can be used to constrain the scan to URLs that are in scope (ignored if
active-scans-perspective-user-obtained
Active Scans from the perspective of a User, obtained using the given Context ID and User ID. See 'scan' action for more details.
ascanactionsetenabledpolicies
ascanactionsetenabledpolicies
sets-whether-not-active-scanner
Sets whether or not the active scanner should add a query param to GET requests which do not have parameters to start with.
ascanactionsetoptionallowattackonstart
ascanactionsetoptionallowattackonstart
ascanactionsetoptionattackpolicy
ascanactionsetoptionattackpolicy
ascanactionsetoptiondefaultpolicy
ascanactionsetoptiondefaultpolicy
this-option-has-been-superseded
This option has been superseded. Use the API rate limit endpoints in the 'network' component instead.
sets-whether-not-active-scanner-2
Sets whether or not the active scanner should encode cookie values.
ascanactionsetoptionhandleanticsrftokens
ascanactionsetoptionhandleanticsrftokens
ascanactionsetoptionhostperscan
ascanactionsetoptionhostperscan
sets-whether-not-active-scanner-3
Sets whether or not the active scanner should inject the HTTP request header X-ZAP-Scan-ID, with the ID of the scan rule that's sending the requests.
sets-maximum-number-alerts-that
Sets the maximum number of alerts that a rule can raise before being skipped.
ascanactionsetoptionmaxcharttimeinmins
ascanactionsetoptionmaxcharttimeinmins
ascanactionsetoptionmaxresultstolist
ascanactionsetoptionmaxresultstolist
ascanactionsetoptionmaxruledurationinmins
ascanactionsetoptionmaxruledurationinmins
ascanactionsetoptionmaxscandurationinmins
ascanactionsetoptionmaxscandurationinmins
ascanactionsetoptionmaxscansinui
ascanactionsetoptionmaxscansinui
ascanactionsetoptionpromptinattackmode
ascanactionsetoptionpromptinattackmode
ascanactionsetoptionprompttoclearfinishedscans
ascanactionsetoptionprompttoclearfinishedscans
ascanactionsetoptionrescaninattackmode
ascanactionsetoptionrescaninattackmode
sets-whether-not-http-headers
Sets whether or not the HTTP Headers of all requests should be scanned. Not just requests that send parameters, through the query or request body.
sets-whether-not-active-scanner-4
Sets whether or not the active scanner should scan null JSON values.
ascanactionsetoptionshowadvanceddialog
ascanactionsetoptionshowadvanceddialog
ascanactionsetoptiontargetparamsenabledrpc
ascanactionsetoptiontargetparamsenabledrpc
ascanactionsetoptiontargetparamsinjectable
ascanactionsetoptiontargetparamsinjectable
ascanactionsetoptionthreadperhost
ascanactionsetoptionthreadperhost
ascanactionsetpolicyalertthreshold
ascanactionsetpolicyalertthreshold
ascanactionsetpolicyattackstrength
ascanactionsetpolicyattackstrength
ascanactionsetscanneralertthreshold
ascanactionsetscanneralertthreshold
ascanactionsetscannerattackstrength
ascanactionsetscannerattackstrength
skips-scan-rule-using-given
Skips the scan rule using the given IDs of the scan and the scan rule.
ascanactionstop
ascanactionstop
ascanactionstopallscans
ascanactionstopallscans
ascanactionupdatescanpolicy
ascanactionupdatescanpolicy
gets-ids-alerts-raised-during
Gets the IDs of the alerts raised during the scan with the given ID. An alert can be obtained with 'alert' core view.
ascanviewattackmodequeue
ascanviewattackmodequeue
gets-regexes-urls-excluded-active
Gets the regexes of URLs excluded from the active scans.
gets-all-types-excluded-parameters
Gets all the types of excluded parameters. For each type the following are shown: the ID and the name.
gets-all-parameters-that-are
Gets all the parameters that are excluded. For each parameter the following are shown: the name, the URL, and the parameter type.
gets-ids-messages-sent-during
Gets the IDs of the messages sent during the scan with the given ID. A message can be obtained with 'message' core view.
tells-whether-not-active-scanner
Tells whether or not the active scanner should add a query parameter to GET request that don't have parameters to start with.
ascanviewoptionallowattackonstart
ascanviewoptionallowattackonstart
ascanviewoptionattackpolicy
ascanviewoptionattackpolicy
ascanviewoptiondefaultpolicy
ascanviewoptiondefaultpolicy
this-option-has-been-superseded-2
This option has been superseded. Use the API rate limit endpoints in the 'network' component instead.
tells-whether-not-active-scanner-2
Tells whether or not the active scanner should encode cookie values.
use-view-excludedparams-instead
Use view excludedParams instead.
ascanviewoptionhandleanticsrftokens
ascanviewoptionhandleanticsrftokens
ascanviewoptionhostperscan
ascanviewoptionhostperscan
tells-whether-not-active-scanner-3
Tells whether or not the active scanner should inject the HTTP request header X-ZAP-Scan-ID, with the ID of the scan rule that's sending the requests.
gets-maximum-number-alerts-that
Gets the maximum number of alerts that a rule can raise before being skipped.
ascanviewoptionmaxcharttimeinmins
ascanviewoptionmaxcharttimeinmins
ascanviewoptionmaxresultstolist
ascanviewoptionmaxresultstolist
ascanviewoptionmaxruledurationinmins
ascanviewoptionmaxruledurationinmins
ascanviewoptionmaxscandurationinmins
ascanviewoptionmaxscandurationinmins
ascanviewoptionmaxscansinui
ascanviewoptionmaxscansinui
ascanviewoptionpromptinattackmode
ascanviewoptionpromptinattackmode
ascanviewoptionprompttoclearfinishedscans
ascanviewoptionprompttoclearfinishedscans
ascanviewoptionrescaninattackmode
ascanviewoptionrescaninattackmode
tells-whether-not-http-headers
Tells whether or not the HTTP Headers of all requests should be scanned. Not just requests that send parameters, through the query or request body.
tells-whether-not-active-scanner-4
Tells whether or not the active scanner should scan null JSON values.
ascanviewoptionshowadvanceddialog
ascanviewoptionshowadvanceddialog
ascanviewoptiontargetparamsenabledrpc
ascanviewoptiontargetparamsenabledrpc
ascanviewoptiontargetparamsinjectable
ascanviewoptiontargetparamsinjectable
ascanviewoptionthreadperhost
ascanviewoptionthreadperhost
ascanviewpolicies
ascanviewpolicies
ascanviewscanpolicynames
ascanviewscanpolicynames
ascanviewscanprogress
ascanviewscanprogress
gets-scan-rules-optionally-given
Gets the scan rules, optionally, of the given scan policy or scanner policy/category ID.
ascanviewscans
ascanviewscans
ascanviewstatus
ascanviewstatus