naftiko: 1.0.0-alpha2 info: label: ZAP API — spider description: 'ZAP API — spider. 71 operations. Lead operation: spider. Self-contained Naftiko capability covering one Owasp Zap business surface.' tags: - Owasp Zap - spider created: '2026-05-19' modified: '2026-05-19' binds: - namespace: env keys: OWASP_ZAP_API_KEY: OWASP_ZAP_API_KEY capability: consumes: - type: http namespace: owasp-zap-spider baseUri: http://zap description: ZAP API — spider business capability. Self-contained, no shared references. resources: - name: JSON-spider-action-addDomainAlwaysInScope path: /JSON/spider/action/addDomainAlwaysInScope/ operations: - name: spideractionadddomainalwaysinscope method: GET description: 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). outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-clearExcludedFromScan path: /JSON/spider/action/clearExcludedFromScan/ operations: - name: spideractionclearexcludedfromscan method: GET description: Clears the regexes of URLs excluded from the spider scans. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-disableAllDomainsAlwaysInScope path: /JSON/spider/action/disableAllDomainsAlwaysInScope/ operations: - name: spideractiondisablealldomainsalwaysinscope method: GET description: Disables all domains that are always in scope. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-enableAllDomainsAlwaysInScope path: /JSON/spider/action/enableAllDomainsAlwaysInScope/ operations: - name: spideractionenablealldomainsalwaysinscope method: GET description: Enables all domains that are always in scope. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-excludeFromScan path: /JSON/spider/action/excludeFromScan/ operations: - name: spideractionexcludefromscan method: GET description: Adds a regex of URLs that should be excluded from the spider scans. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-modifyDomainAlwaysInScope path: /JSON/spider/action/modifyDomainAlwaysInScope/ operations: - name: spideractionmodifydomainalwaysinscope method: GET description: 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. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-pause path: /JSON/spider/action/pause/ operations: - name: spideractionpause method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-pauseAllScans path: /JSON/spider/action/pauseAllScans/ operations: - name: spideractionpauseallscans method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-removeAllScans path: /JSON/spider/action/removeAllScans/ operations: - name: spideractionremoveallscans method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-removeDomainAlwaysInScope path: /JSON/spider/action/removeDomainAlwaysInScope/ operations: - name: spideractionremovedomainalwaysinscope method: GET description: Removes a domain that's always in scope, with the given index. The index can be obtained with the view domainsAlwaysInScope. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-removeScan path: /JSON/spider/action/removeScan/ operations: - name: spideractionremovescan method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-resume path: /JSON/spider/action/resume/ operations: - name: spideractionresume method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-resumeAllScans path: /JSON/spider/action/resumeAllScans/ operations: - name: spideractionresumeallscans method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-scan path: /JSON/spider/action/scan/ operations: - name: spideractionscan method: GET description: 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 paramete outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-scanAsUser path: /JSON/spider/action/scanAsUser/ operations: - name: spideractionscanasuser method: GET description: Runs the spider from the perspective of a User, obtained using the given Context ID and User ID. See 'scan' action for more details. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-setOptionAcceptCookies path: /JSON/spider/action/setOptionAcceptCookies/ operations: - name: spideractionsetoptionacceptcookies method: GET description: Sets whether or not a spider process should accept cookies while spidering. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-setOptionHandleODataParametersVisited path: /JSON/spider/action/setOptionHandleODataParametersVisited/ operations: - name: spideractionsetoptionhandleodataparametersvisited method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-setOptionHandleParameters path: /JSON/spider/action/setOptionHandleParameters/ operations: - name: spideractionsetoptionhandleparameters method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-setOptionLogoutAvoidance path: /JSON/spider/action/setOptionLogoutAvoidance/ operations: - name: spideractionsetoptionlogoutavoidance method: GET description: Sets whether or not the Spider should attempt to avoid logout related paths/functionality. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-setOptionMaxChildren path: /JSON/spider/action/setOptionMaxChildren/ operations: - name: spideractionsetoptionmaxchildren method: GET description: Sets the maximum number of child nodes (per node) that can be crawled, 0 means no limit. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-setOptionMaxDepth path: /JSON/spider/action/setOptionMaxDepth/ operations: - name: spideractionsetoptionmaxdepth method: GET description: Sets the maximum depth the spider can crawl, 0 for unlimited depth. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-setOptionMaxDuration path: /JSON/spider/action/setOptionMaxDuration/ operations: - name: spideractionsetoptionmaxduration method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-setOptionMaxParseSizeBytes path: /JSON/spider/action/setOptionMaxParseSizeBytes/ operations: - name: spideractionsetoptionmaxparsesizebytes method: GET description: Sets the maximum size, in bytes, that a response might have to be parsed. This allows the spider to skip big responses/files. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-setOptionMaxScansInUI path: /JSON/spider/action/setOptionMaxScansInUI/ operations: - name: spideractionsetoptionmaxscansinui method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-setOptionParseComments path: /JSON/spider/action/setOptionParseComments/ operations: - name: spideractionsetoptionparsecomments method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-setOptionParseDsStore path: /JSON/spider/action/setOptionParseDsStore/ operations: - name: spideractionsetoptionparsedsstore method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-setOptionParseGit path: /JSON/spider/action/setOptionParseGit/ operations: - name: spideractionsetoptionparsegit method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-setOptionParseRobotsTxt path: /JSON/spider/action/setOptionParseRobotsTxt/ operations: - name: spideractionsetoptionparserobotstxt method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-setOptionParseSVNEntries path: /JSON/spider/action/setOptionParseSVNEntries/ operations: - name: spideractionsetoptionparsesvnentries method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-setOptionParseSitemapXml path: /JSON/spider/action/setOptionParseSitemapXml/ operations: - name: spideractionsetoptionparsesitemapxml method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-setOptionPostForm path: /JSON/spider/action/setOptionPostForm/ operations: - name: spideractionsetoptionpostform method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-setOptionProcessForm path: /JSON/spider/action/setOptionProcessForm/ operations: - name: spideractionsetoptionprocessform method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-setOptionSendRefererHeader path: /JSON/spider/action/setOptionSendRefererHeader/ operations: - name: spideractionsetoptionsendrefererheader method: GET description: Sets whether or not the 'Referer' header should be sent while spidering. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-setOptionShowAdvancedDialog path: /JSON/spider/action/setOptionShowAdvancedDialog/ operations: - name: spideractionsetoptionshowadvanceddialog method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-setOptionSkipURLString path: /JSON/spider/action/setOptionSkipURLString/ operations: - name: spideractionsetoptionskipurlstring method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-setOptionThreadCount path: /JSON/spider/action/setOptionThreadCount/ operations: - name: spideractionsetoptionthreadcount method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-setOptionUserAgent path: /JSON/spider/action/setOptionUserAgent/ operations: - name: spideractionsetoptionuseragent method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-stop path: /JSON/spider/action/stop/ operations: - name: spideractionstop method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-action-stopAllScans path: /JSON/spider/action/stopAllScans/ operations: - name: spideractionstopallscans method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-view-addedNodes path: /JSON/spider/view/addedNodes/ operations: - name: spiderviewaddednodes method: GET description: Returns a list of the names of the nodes added to the Sites tree by the specified scan. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-view-allUrls path: /JSON/spider/view/allUrls/ operations: - name: spiderviewallurls method: GET description: Returns a list of unique URLs from the history table based on HTTP messages added by the Spider. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-view-domainsAlwaysInScope path: /JSON/spider/view/domainsAlwaysInScope/ operations: - name: spiderviewdomainsalwaysinscope method: GET description: '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.' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-view-excludedFromScan path: /JSON/spider/view/excludedFromScan/ operations: - name: spiderviewexcludedfromscan method: GET description: Gets the regexes of URLs excluded from the spider scans. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-view-fullResults path: /JSON/spider/view/fullResults/ operations: - name: spiderviewfullresults method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-view-optionAcceptCookies path: /JSON/spider/view/optionAcceptCookies/ operations: - name: spiderviewoptionacceptcookies method: GET description: Gets whether or not a spider process should accept cookies while spidering. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-view-optionDomainsAlwaysInScope path: /JSON/spider/view/optionDomainsAlwaysInScope/ operations: - name: spiderviewoptiondomainsalwaysinscope method: GET description: Use view domainsAlwaysInScope instead. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-view-optionDomainsAlwaysInScopeEnabled path: /JSON/spider/view/optionDomainsAlwaysInScopeEnabled/ operations: - name: spiderviewoptiondomainsalwaysinscopeenabled method: GET description: Use view domainsAlwaysInScope instead. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-view-optionHandleODataParametersVisited path: /JSON/spider/view/optionHandleODataParametersVisited/ operations: - name: spiderviewoptionhandleodataparametersvisited method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-view-optionHandleParameters path: /JSON/spider/view/optionHandleParameters/ operations: - name: spiderviewoptionhandleparameters method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-view-optionLogoutAvoidance path: /JSON/spider/view/optionLogoutAvoidance/ operations: - name: spiderviewoptionlogoutavoidance method: GET description: Gets whether or not the spider should attempt to avoid logout related paths/functionality. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-view-optionMaxChildren path: /JSON/spider/view/optionMaxChildren/ operations: - name: spiderviewoptionmaxchildren method: GET description: Gets the maximum number of child nodes (per node) that can be crawled, 0 means no limit. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-view-optionMaxDepth path: /JSON/spider/view/optionMaxDepth/ operations: - name: spiderviewoptionmaxdepth method: GET description: Gets the maximum depth the spider can crawl, 0 if unlimited. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-view-optionMaxDuration path: /JSON/spider/view/optionMaxDuration/ operations: - name: spiderviewoptionmaxduration method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-view-optionMaxParseSizeBytes path: /JSON/spider/view/optionMaxParseSizeBytes/ operations: - name: spiderviewoptionmaxparsesizebytes method: GET description: Gets the maximum size, in bytes, that a response might have to be parsed, or 0 for unlimited. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-view-optionMaxScansInUI path: /JSON/spider/view/optionMaxScansInUI/ operations: - name: spiderviewoptionmaxscansinui method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-view-optionParseComments path: /JSON/spider/view/optionParseComments/ operations: - name: spiderviewoptionparsecomments method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-view-optionParseDsStore path: /JSON/spider/view/optionParseDsStore/ operations: - name: spiderviewoptionparsedsstore method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-view-optionParseGit path: /JSON/spider/view/optionParseGit/ operations: - name: spiderviewoptionparsegit method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-view-optionParseRobotsTxt path: /JSON/spider/view/optionParseRobotsTxt/ operations: - name: spiderviewoptionparserobotstxt method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-view-optionParseSVNEntries path: /JSON/spider/view/optionParseSVNEntries/ operations: - name: spiderviewoptionparsesvnentries method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-view-optionParseSitemapXml path: /JSON/spider/view/optionParseSitemapXml/ operations: - name: spiderviewoptionparsesitemapxml method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-view-optionPostForm path: /JSON/spider/view/optionPostForm/ operations: - name: spiderviewoptionpostform method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-view-optionProcessForm path: /JSON/spider/view/optionProcessForm/ operations: - name: spiderviewoptionprocessform method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-view-optionSendRefererHeader path: /JSON/spider/view/optionSendRefererHeader/ operations: - name: spiderviewoptionsendrefererheader method: GET description: Gets whether or not the 'Referer' header should be sent while spidering. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-view-optionShowAdvancedDialog path: /JSON/spider/view/optionShowAdvancedDialog/ operations: - name: spiderviewoptionshowadvanceddialog method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-view-optionSkipURLString path: /JSON/spider/view/optionSkipURLString/ operations: - name: spiderviewoptionskipurlstring method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-view-optionThreadCount path: /JSON/spider/view/optionThreadCount/ operations: - name: spiderviewoptionthreadcount method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-view-optionUserAgent path: /JSON/spider/view/optionUserAgent/ operations: - name: spiderviewoptionuseragent method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-view-results path: /JSON/spider/view/results/ operations: - name: spiderviewresults method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-view-scans path: /JSON/spider/view/scans/ operations: - name: spiderviewscans method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. - name: JSON-spider-view-status path: /JSON/spider/view/status/ operations: - name: spiderviewstatus method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. authentication: type: apikey key: X-ZAP-API-Key value: '{{env.OWASP_ZAP_API_KEY}}' placement: header exposes: - type: rest namespace: owasp-zap-spider-rest port: 8080 description: REST adapter for ZAP API — spider. One Spectral-compliant resource per consumed operation, prefixed with /v1. resources: - path: /v1/json/spider/action/adddomainalwaysinscope name: json-spider-action-adddomainalwaysinscope description: REST surface for JSON-spider-action-addDomainAlwaysInScope. operations: - method: GET name: spideractionadddomainalwaysinscope description: 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). call: owasp-zap-spider.spideractionadddomainalwaysinscope outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/clearexcludedfromscan name: json-spider-action-clearexcludedfromscan description: REST surface for JSON-spider-action-clearExcludedFromScan. operations: - method: GET name: spideractionclearexcludedfromscan description: Clears the regexes of URLs excluded from the spider scans. call: owasp-zap-spider.spideractionclearexcludedfromscan outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/disablealldomainsalwaysinscope name: json-spider-action-disablealldomainsalwaysinscope description: REST surface for JSON-spider-action-disableAllDomainsAlwaysInScope. operations: - method: GET name: spideractiondisablealldomainsalwaysinscope description: Disables all domains that are always in scope. call: owasp-zap-spider.spideractiondisablealldomainsalwaysinscope outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/enablealldomainsalwaysinscope name: json-spider-action-enablealldomainsalwaysinscope description: REST surface for JSON-spider-action-enableAllDomainsAlwaysInScope. operations: - method: GET name: spideractionenablealldomainsalwaysinscope description: Enables all domains that are always in scope. call: owasp-zap-spider.spideractionenablealldomainsalwaysinscope outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/excludefromscan name: json-spider-action-excludefromscan description: REST surface for JSON-spider-action-excludeFromScan. operations: - method: GET name: spideractionexcludefromscan description: Adds a regex of URLs that should be excluded from the spider scans. call: owasp-zap-spider.spideractionexcludefromscan outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/modifydomainalwaysinscope name: json-spider-action-modifydomainalwaysinscope description: REST surface for JSON-spider-action-modifyDomainAlwaysInScope. operations: - method: GET name: spideractionmodifydomainalwaysinscope description: 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. call: owasp-zap-spider.spideractionmodifydomainalwaysinscope outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/pause name: json-spider-action-pause description: REST surface for JSON-spider-action-pause. operations: - method: GET name: spideractionpause description: spideractionpause call: owasp-zap-spider.spideractionpause outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/pauseallscans name: json-spider-action-pauseallscans description: REST surface for JSON-spider-action-pauseAllScans. operations: - method: GET name: spideractionpauseallscans description: spideractionpauseallscans call: owasp-zap-spider.spideractionpauseallscans outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/removeallscans name: json-spider-action-removeallscans description: REST surface for JSON-spider-action-removeAllScans. operations: - method: GET name: spideractionremoveallscans description: spideractionremoveallscans call: owasp-zap-spider.spideractionremoveallscans outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/removedomainalwaysinscope name: json-spider-action-removedomainalwaysinscope description: REST surface for JSON-spider-action-removeDomainAlwaysInScope. operations: - method: GET name: spideractionremovedomainalwaysinscope description: Removes a domain that's always in scope, with the given index. The index can be obtained with the view domainsAlwaysInScope. call: owasp-zap-spider.spideractionremovedomainalwaysinscope outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/removescan name: json-spider-action-removescan description: REST surface for JSON-spider-action-removeScan. operations: - method: GET name: spideractionremovescan description: spideractionremovescan call: owasp-zap-spider.spideractionremovescan outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/resume name: json-spider-action-resume description: REST surface for JSON-spider-action-resume. operations: - method: GET name: spideractionresume description: spideractionresume call: owasp-zap-spider.spideractionresume outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/resumeallscans name: json-spider-action-resumeallscans description: REST surface for JSON-spider-action-resumeAllScans. operations: - method: GET name: spideractionresumeallscans description: spideractionresumeallscans call: owasp-zap-spider.spideractionresumeallscans outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/scan name: json-spider-action-scan description: REST surface for JSON-spider-action-scan. operations: - method: GET name: spideractionscan description: 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 paramete call: owasp-zap-spider.spideractionscan outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/scanasuser name: json-spider-action-scanasuser description: REST surface for JSON-spider-action-scanAsUser. operations: - method: GET name: spideractionscanasuser description: Runs the spider from the perspective of a User, obtained using the given Context ID and User ID. See 'scan' action for more details. call: owasp-zap-spider.spideractionscanasuser outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/setoptionacceptcookies name: json-spider-action-setoptionacceptcookies description: REST surface for JSON-spider-action-setOptionAcceptCookies. operations: - method: GET name: spideractionsetoptionacceptcookies description: Sets whether or not a spider process should accept cookies while spidering. call: owasp-zap-spider.spideractionsetoptionacceptcookies outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/setoptionhandleodataparametersvisited name: json-spider-action-setoptionhandleodataparametersvisited description: REST surface for JSON-spider-action-setOptionHandleODataParametersVisited. operations: - method: GET name: spideractionsetoptionhandleodataparametersvisited description: spideractionsetoptionhandleodataparametersvisited call: owasp-zap-spider.spideractionsetoptionhandleodataparametersvisited outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/setoptionhandleparameters name: json-spider-action-setoptionhandleparameters description: REST surface for JSON-spider-action-setOptionHandleParameters. operations: - method: GET name: spideractionsetoptionhandleparameters description: spideractionsetoptionhandleparameters call: owasp-zap-spider.spideractionsetoptionhandleparameters outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/setoptionlogoutavoidance name: json-spider-action-setoptionlogoutavoidance description: REST surface for JSON-spider-action-setOptionLogoutAvoidance. operations: - method: GET name: spideractionsetoptionlogoutavoidance description: Sets whether or not the Spider should attempt to avoid logout related paths/functionality. call: owasp-zap-spider.spideractionsetoptionlogoutavoidance outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/setoptionmaxchildren name: json-spider-action-setoptionmaxchildren description: REST surface for JSON-spider-action-setOptionMaxChildren. operations: - method: GET name: spideractionsetoptionmaxchildren description: Sets the maximum number of child nodes (per node) that can be crawled, 0 means no limit. call: owasp-zap-spider.spideractionsetoptionmaxchildren outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/setoptionmaxdepth name: json-spider-action-setoptionmaxdepth description: REST surface for JSON-spider-action-setOptionMaxDepth. operations: - method: GET name: spideractionsetoptionmaxdepth description: Sets the maximum depth the spider can crawl, 0 for unlimited depth. call: owasp-zap-spider.spideractionsetoptionmaxdepth outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/setoptionmaxduration name: json-spider-action-setoptionmaxduration description: REST surface for JSON-spider-action-setOptionMaxDuration. operations: - method: GET name: spideractionsetoptionmaxduration description: spideractionsetoptionmaxduration call: owasp-zap-spider.spideractionsetoptionmaxduration outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/setoptionmaxparsesizebytes name: json-spider-action-setoptionmaxparsesizebytes description: REST surface for JSON-spider-action-setOptionMaxParseSizeBytes. operations: - method: GET name: spideractionsetoptionmaxparsesizebytes description: Sets the maximum size, in bytes, that a response might have to be parsed. This allows the spider to skip big responses/files. call: owasp-zap-spider.spideractionsetoptionmaxparsesizebytes outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/setoptionmaxscansinui name: json-spider-action-setoptionmaxscansinui description: REST surface for JSON-spider-action-setOptionMaxScansInUI. operations: - method: GET name: spideractionsetoptionmaxscansinui description: spideractionsetoptionmaxscansinui call: owasp-zap-spider.spideractionsetoptionmaxscansinui outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/setoptionparsecomments name: json-spider-action-setoptionparsecomments description: REST surface for JSON-spider-action-setOptionParseComments. operations: - method: GET name: spideractionsetoptionparsecomments description: spideractionsetoptionparsecomments call: owasp-zap-spider.spideractionsetoptionparsecomments outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/setoptionparsedsstore name: json-spider-action-setoptionparsedsstore description: REST surface for JSON-spider-action-setOptionParseDsStore. operations: - method: GET name: spideractionsetoptionparsedsstore description: spideractionsetoptionparsedsstore call: owasp-zap-spider.spideractionsetoptionparsedsstore outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/setoptionparsegit name: json-spider-action-setoptionparsegit description: REST surface for JSON-spider-action-setOptionParseGit. operations: - method: GET name: spideractionsetoptionparsegit description: spideractionsetoptionparsegit call: owasp-zap-spider.spideractionsetoptionparsegit outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/setoptionparserobotstxt name: json-spider-action-setoptionparserobotstxt description: REST surface for JSON-spider-action-setOptionParseRobotsTxt. operations: - method: GET name: spideractionsetoptionparserobotstxt description: spideractionsetoptionparserobotstxt call: owasp-zap-spider.spideractionsetoptionparserobotstxt outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/setoptionparsesvnentries name: json-spider-action-setoptionparsesvnentries description: REST surface for JSON-spider-action-setOptionParseSVNEntries. operations: - method: GET name: spideractionsetoptionparsesvnentries description: spideractionsetoptionparsesvnentries call: owasp-zap-spider.spideractionsetoptionparsesvnentries outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/setoptionparsesitemapxml name: json-spider-action-setoptionparsesitemapxml description: REST surface for JSON-spider-action-setOptionParseSitemapXml. operations: - method: GET name: spideractionsetoptionparsesitemapxml description: spideractionsetoptionparsesitemapxml call: owasp-zap-spider.spideractionsetoptionparsesitemapxml outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/setoptionpostform name: json-spider-action-setoptionpostform description: REST surface for JSON-spider-action-setOptionPostForm. operations: - method: GET name: spideractionsetoptionpostform description: spideractionsetoptionpostform call: owasp-zap-spider.spideractionsetoptionpostform outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/setoptionprocessform name: json-spider-action-setoptionprocessform description: REST surface for JSON-spider-action-setOptionProcessForm. operations: - method: GET name: spideractionsetoptionprocessform description: spideractionsetoptionprocessform call: owasp-zap-spider.spideractionsetoptionprocessform outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/setoptionsendrefererheader name: json-spider-action-setoptionsendrefererheader description: REST surface for JSON-spider-action-setOptionSendRefererHeader. operations: - method: GET name: spideractionsetoptionsendrefererheader description: Sets whether or not the 'Referer' header should be sent while spidering. call: owasp-zap-spider.spideractionsetoptionsendrefererheader outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/setoptionshowadvanceddialog name: json-spider-action-setoptionshowadvanceddialog description: REST surface for JSON-spider-action-setOptionShowAdvancedDialog. operations: - method: GET name: spideractionsetoptionshowadvanceddialog description: spideractionsetoptionshowadvanceddialog call: owasp-zap-spider.spideractionsetoptionshowadvanceddialog outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/setoptionskipurlstring name: json-spider-action-setoptionskipurlstring description: REST surface for JSON-spider-action-setOptionSkipURLString. operations: - method: GET name: spideractionsetoptionskipurlstring description: spideractionsetoptionskipurlstring call: owasp-zap-spider.spideractionsetoptionskipurlstring outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/setoptionthreadcount name: json-spider-action-setoptionthreadcount description: REST surface for JSON-spider-action-setOptionThreadCount. operations: - method: GET name: spideractionsetoptionthreadcount description: spideractionsetoptionthreadcount call: owasp-zap-spider.spideractionsetoptionthreadcount outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/setoptionuseragent name: json-spider-action-setoptionuseragent description: REST surface for JSON-spider-action-setOptionUserAgent. operations: - method: GET name: spideractionsetoptionuseragent description: spideractionsetoptionuseragent call: owasp-zap-spider.spideractionsetoptionuseragent outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/stop name: json-spider-action-stop description: REST surface for JSON-spider-action-stop. operations: - method: GET name: spideractionstop description: spideractionstop call: owasp-zap-spider.spideractionstop outputParameters: - type: object mapping: $. - path: /v1/json/spider/action/stopallscans name: json-spider-action-stopallscans description: REST surface for JSON-spider-action-stopAllScans. operations: - method: GET name: spideractionstopallscans description: spideractionstopallscans call: owasp-zap-spider.spideractionstopallscans outputParameters: - type: object mapping: $. - path: /v1/json/spider/view/addednodes name: json-spider-view-addednodes description: REST surface for JSON-spider-view-addedNodes. operations: - method: GET name: spiderviewaddednodes description: Returns a list of the names of the nodes added to the Sites tree by the specified scan. call: owasp-zap-spider.spiderviewaddednodes outputParameters: - type: object mapping: $. - path: /v1/json/spider/view/allurls name: json-spider-view-allurls description: REST surface for JSON-spider-view-allUrls. operations: - method: GET name: spiderviewallurls description: Returns a list of unique URLs from the history table based on HTTP messages added by the Spider. call: owasp-zap-spider.spiderviewallurls outputParameters: - type: object mapping: $. - path: /v1/json/spider/view/domainsalwaysinscope name: json-spider-view-domainsalwaysinscope description: REST surface for JSON-spider-view-domainsAlwaysInScope. operations: - method: GET name: spiderviewdomainsalwaysinscope description: '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.' call: owasp-zap-spider.spiderviewdomainsalwaysinscope outputParameters: - type: object mapping: $. - path: /v1/json/spider/view/excludedfromscan name: json-spider-view-excludedfromscan description: REST surface for JSON-spider-view-excludedFromScan. operations: - method: GET name: spiderviewexcludedfromscan description: Gets the regexes of URLs excluded from the spider scans. call: owasp-zap-spider.spiderviewexcludedfromscan outputParameters: - type: object mapping: $. - path: /v1/json/spider/view/fullresults name: json-spider-view-fullresults description: REST surface for JSON-spider-view-fullResults. operations: - method: GET name: spiderviewfullresults description: spiderviewfullresults call: owasp-zap-spider.spiderviewfullresults outputParameters: - type: object mapping: $. - path: /v1/json/spider/view/optionacceptcookies name: json-spider-view-optionacceptcookies description: REST surface for JSON-spider-view-optionAcceptCookies. operations: - method: GET name: spiderviewoptionacceptcookies description: Gets whether or not a spider process should accept cookies while spidering. call: owasp-zap-spider.spiderviewoptionacceptcookies outputParameters: - type: object mapping: $. - path: /v1/json/spider/view/optiondomainsalwaysinscope name: json-spider-view-optiondomainsalwaysinscope description: REST surface for JSON-spider-view-optionDomainsAlwaysInScope. operations: - method: GET name: spiderviewoptiondomainsalwaysinscope description: Use view domainsAlwaysInScope instead. call: owasp-zap-spider.spiderviewoptiondomainsalwaysinscope outputParameters: - type: object mapping: $. - path: /v1/json/spider/view/optiondomainsalwaysinscopeenabled name: json-spider-view-optiondomainsalwaysinscopeenabled description: REST surface for JSON-spider-view-optionDomainsAlwaysInScopeEnabled. operations: - method: GET name: spiderviewoptiondomainsalwaysinscopeenabled description: Use view domainsAlwaysInScope instead. call: owasp-zap-spider.spiderviewoptiondomainsalwaysinscopeenabled outputParameters: - type: object mapping: $. - path: /v1/json/spider/view/optionhandleodataparametersvisited name: json-spider-view-optionhandleodataparametersvisited description: REST surface for JSON-spider-view-optionHandleODataParametersVisited. operations: - method: GET name: spiderviewoptionhandleodataparametersvisited description: spiderviewoptionhandleodataparametersvisited call: owasp-zap-spider.spiderviewoptionhandleodataparametersvisited outputParameters: - type: object mapping: $. - path: /v1/json/spider/view/optionhandleparameters name: json-spider-view-optionhandleparameters description: REST surface for JSON-spider-view-optionHandleParameters. operations: - method: GET name: spiderviewoptionhandleparameters description: spiderviewoptionhandleparameters call: owasp-zap-spider.spiderviewoptionhandleparameters outputParameters: - type: object mapping: $. - path: /v1/json/spider/view/optionlogoutavoidance name: json-spider-view-optionlogoutavoidance description: REST surface for JSON-spider-view-optionLogoutAvoidance. operations: - method: GET name: spiderviewoptionlogoutavoidance description: Gets whether or not the spider should attempt to avoid logout related paths/functionality. call: owasp-zap-spider.spiderviewoptionlogoutavoidance outputParameters: - type: object mapping: $. - path: /v1/json/spider/view/optionmaxchildren name: json-spider-view-optionmaxchildren description: REST surface for JSON-spider-view-optionMaxChildren. operations: - method: GET name: spiderviewoptionmaxchildren description: Gets the maximum number of child nodes (per node) that can be crawled, 0 means no limit. call: owasp-zap-spider.spiderviewoptionmaxchildren outputParameters: - type: object mapping: $. - path: /v1/json/spider/view/optionmaxdepth name: json-spider-view-optionmaxdepth description: REST surface for JSON-spider-view-optionMaxDepth. operations: - method: GET name: spiderviewoptionmaxdepth description: Gets the maximum depth the spider can crawl, 0 if unlimited. call: owasp-zap-spider.spiderviewoptionmaxdepth outputParameters: - type: object mapping: $. - path: /v1/json/spider/view/optionmaxduration name: json-spider-view-optionmaxduration description: REST surface for JSON-spider-view-optionMaxDuration. operations: - method: GET name: spiderviewoptionmaxduration description: spiderviewoptionmaxduration call: owasp-zap-spider.spiderviewoptionmaxduration outputParameters: - type: object mapping: $. - path: /v1/json/spider/view/optionmaxparsesizebytes name: json-spider-view-optionmaxparsesizebytes description: REST surface for JSON-spider-view-optionMaxParseSizeBytes. operations: - method: GET name: spiderviewoptionmaxparsesizebytes description: Gets the maximum size, in bytes, that a response might have to be parsed, or 0 for unlimited. call: owasp-zap-spider.spiderviewoptionmaxparsesizebytes outputParameters: - type: object mapping: $. - path: /v1/json/spider/view/optionmaxscansinui name: json-spider-view-optionmaxscansinui description: REST surface for JSON-spider-view-optionMaxScansInUI. operations: - method: GET name: spiderviewoptionmaxscansinui description: spiderviewoptionmaxscansinui call: owasp-zap-spider.spiderviewoptionmaxscansinui outputParameters: - type: object mapping: $. - path: /v1/json/spider/view/optionparsecomments name: json-spider-view-optionparsecomments description: REST surface for JSON-spider-view-optionParseComments. operations: - method: GET name: spiderviewoptionparsecomments description: spiderviewoptionparsecomments call: owasp-zap-spider.spiderviewoptionparsecomments outputParameters: - type: object mapping: $. - path: /v1/json/spider/view/optionparsedsstore name: json-spider-view-optionparsedsstore description: REST surface for JSON-spider-view-optionParseDsStore. operations: - method: GET name: spiderviewoptionparsedsstore description: spiderviewoptionparsedsstore call: owasp-zap-spider.spiderviewoptionparsedsstore outputParameters: - type: object mapping: $. - path: /v1/json/spider/view/optionparsegit name: json-spider-view-optionparsegit description: REST surface for JSON-spider-view-optionParseGit. operations: - method: GET name: spiderviewoptionparsegit description: spiderviewoptionparsegit call: owasp-zap-spider.spiderviewoptionparsegit outputParameters: - type: object mapping: $. - path: /v1/json/spider/view/optionparserobotstxt name: json-spider-view-optionparserobotstxt description: REST surface for JSON-spider-view-optionParseRobotsTxt. operations: - method: GET name: spiderviewoptionparserobotstxt description: spiderviewoptionparserobotstxt call: owasp-zap-spider.spiderviewoptionparserobotstxt outputParameters: - type: object mapping: $. - path: /v1/json/spider/view/optionparsesvnentries name: json-spider-view-optionparsesvnentries description: REST surface for JSON-spider-view-optionParseSVNEntries. operations: - method: GET name: spiderviewoptionparsesvnentries description: spiderviewoptionparsesvnentries call: owasp-zap-spider.spiderviewoptionparsesvnentries outputParameters: - type: object mapping: $. - path: /v1/json/spider/view/optionparsesitemapxml name: json-spider-view-optionparsesitemapxml description: REST surface for JSON-spider-view-optionParseSitemapXml. operations: - method: GET name: spiderviewoptionparsesitemapxml description: spiderviewoptionparsesitemapxml call: owasp-zap-spider.spiderviewoptionparsesitemapxml outputParameters: - type: object mapping: $. - path: /v1/json/spider/view/optionpostform name: json-spider-view-optionpostform description: REST surface for JSON-spider-view-optionPostForm. operations: - method: GET name: spiderviewoptionpostform description: spiderviewoptionpostform call: owasp-zap-spider.spiderviewoptionpostform outputParameters: - type: object mapping: $. - path: /v1/json/spider/view/optionprocessform name: json-spider-view-optionprocessform description: REST surface for JSON-spider-view-optionProcessForm. operations: - method: GET name: spiderviewoptionprocessform description: spiderviewoptionprocessform call: owasp-zap-spider.spiderviewoptionprocessform outputParameters: - type: object mapping: $. - path: /v1/json/spider/view/optionsendrefererheader name: json-spider-view-optionsendrefererheader description: REST surface for JSON-spider-view-optionSendRefererHeader. operations: - method: GET name: spiderviewoptionsendrefererheader description: Gets whether or not the 'Referer' header should be sent while spidering. call: owasp-zap-spider.spiderviewoptionsendrefererheader outputParameters: - type: object mapping: $. - path: /v1/json/spider/view/optionshowadvanceddialog name: json-spider-view-optionshowadvanceddialog description: REST surface for JSON-spider-view-optionShowAdvancedDialog. operations: - method: GET name: spiderviewoptionshowadvanceddialog description: spiderviewoptionshowadvanceddialog call: owasp-zap-spider.spiderviewoptionshowadvanceddialog outputParameters: - type: object mapping: $. - path: /v1/json/spider/view/optionskipurlstring name: json-spider-view-optionskipurlstring description: REST surface for JSON-spider-view-optionSkipURLString. operations: - method: GET name: spiderviewoptionskipurlstring description: spiderviewoptionskipurlstring call: owasp-zap-spider.spiderviewoptionskipurlstring outputParameters: - type: object mapping: $. - path: /v1/json/spider/view/optionthreadcount name: json-spider-view-optionthreadcount description: REST surface for JSON-spider-view-optionThreadCount. operations: - method: GET name: spiderviewoptionthreadcount description: spiderviewoptionthreadcount call: owasp-zap-spider.spiderviewoptionthreadcount outputParameters: - type: object mapping: $. - path: /v1/json/spider/view/optionuseragent name: json-spider-view-optionuseragent description: REST surface for JSON-spider-view-optionUserAgent. operations: - method: GET name: spiderviewoptionuseragent description: spiderviewoptionuseragent call: owasp-zap-spider.spiderviewoptionuseragent outputParameters: - type: object mapping: $. - path: /v1/json/spider/view/results name: json-spider-view-results description: REST surface for JSON-spider-view-results. operations: - method: GET name: spiderviewresults description: spiderviewresults call: owasp-zap-spider.spiderviewresults outputParameters: - type: object mapping: $. - path: /v1/json/spider/view/scans name: json-spider-view-scans description: REST surface for JSON-spider-view-scans. operations: - method: GET name: spiderviewscans description: spiderviewscans call: owasp-zap-spider.spiderviewscans outputParameters: - type: object mapping: $. - path: /v1/json/spider/view/status name: json-spider-view-status description: REST surface for JSON-spider-view-status. operations: - method: GET name: spiderviewstatus description: spiderviewstatus call: owasp-zap-spider.spiderviewstatus outputParameters: - type: object mapping: $. - type: mcp namespace: owasp-zap-spider-mcp port: 9090 transport: http description: MCP adapter for ZAP API — spider. One tool per consumed operation, routed inline through this capability's consumes block. tools: - name: adds-new-domain-that-s-always description: 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). hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionadddomainalwaysinscope outputParameters: - type: object mapping: $. - name: clears-regexes-urls-excluded-spider description: Clears the regexes of URLs excluded from the spider scans. hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionclearexcludedfromscan outputParameters: - type: object mapping: $. - name: disables-all-domains-that-are description: Disables all domains that are always in scope. hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractiondisablealldomainsalwaysinscope outputParameters: - type: object mapping: $. - name: enables-all-domains-that-are description: Enables all domains that are always in scope. hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionenablealldomainsalwaysinscope outputParameters: - type: object mapping: $. - name: adds-regex-urls-that-should description: Adds a regex of URLs that should be excluded from the spider scans. hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionexcludefromscan outputParameters: - type: object mapping: $. - name: modifies-domain-that-s-always-scope description: 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. hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionmodifydomainalwaysinscope outputParameters: - type: object mapping: $. - name: spideractionpause description: spideractionpause hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionpause outputParameters: - type: object mapping: $. - name: spideractionpauseallscans description: spideractionpauseallscans hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionpauseallscans outputParameters: - type: object mapping: $. - name: spideractionremoveallscans description: spideractionremoveallscans hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionremoveallscans outputParameters: - type: object mapping: $. - name: removes-domain-that-s-always-scope description: Removes a domain that's always in scope, with the given index. The index can be obtained with the view domainsAlwaysInScope. hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionremovedomainalwaysinscope outputParameters: - type: object mapping: $. - name: spideractionremovescan description: spideractionremovescan hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionremovescan outputParameters: - type: object mapping: $. - name: spideractionresume description: spideractionresume hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionresume outputParameters: - type: object mapping: $. - name: spideractionresumeallscans description: spideractionresumeallscans hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionresumeallscans outputParameters: - type: object mapping: $. - name: runs-spider-against-given-url description: 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 paramete hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionscan outputParameters: - type: object mapping: $. - name: runs-spider-perspective-user-obtained description: Runs the spider from the perspective of a User, obtained using the given Context ID and User ID. See 'scan' action for more details. hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionscanasuser outputParameters: - type: object mapping: $. - name: sets-whether-not-spider-process description: Sets whether or not a spider process should accept cookies while spidering. hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionsetoptionacceptcookies outputParameters: - type: object mapping: $. - name: spideractionsetoptionhandleodataparametersvisited description: spideractionsetoptionhandleodataparametersvisited hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionsetoptionhandleodataparametersvisited outputParameters: - type: object mapping: $. - name: spideractionsetoptionhandleparameters description: spideractionsetoptionhandleparameters hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionsetoptionhandleparameters outputParameters: - type: object mapping: $. - name: sets-whether-not-spider-should description: Sets whether or not the Spider should attempt to avoid logout related paths/functionality. hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionsetoptionlogoutavoidance outputParameters: - type: object mapping: $. - name: sets-maximum-number-child-nodes description: Sets the maximum number of child nodes (per node) that can be crawled, 0 means no limit. hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionsetoptionmaxchildren outputParameters: - type: object mapping: $. - name: sets-maximum-depth-spider-can description: Sets the maximum depth the spider can crawl, 0 for unlimited depth. hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionsetoptionmaxdepth outputParameters: - type: object mapping: $. - name: spideractionsetoptionmaxduration description: spideractionsetoptionmaxduration hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionsetoptionmaxduration outputParameters: - type: object mapping: $. - name: sets-maximum-size-bytes-that description: Sets the maximum size, in bytes, that a response might have to be parsed. This allows the spider to skip big responses/files. hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionsetoptionmaxparsesizebytes outputParameters: - type: object mapping: $. - name: spideractionsetoptionmaxscansinui description: spideractionsetoptionmaxscansinui hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionsetoptionmaxscansinui outputParameters: - type: object mapping: $. - name: spideractionsetoptionparsecomments description: spideractionsetoptionparsecomments hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionsetoptionparsecomments outputParameters: - type: object mapping: $. - name: spideractionsetoptionparsedsstore description: spideractionsetoptionparsedsstore hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionsetoptionparsedsstore outputParameters: - type: object mapping: $. - name: spideractionsetoptionparsegit description: spideractionsetoptionparsegit hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionsetoptionparsegit outputParameters: - type: object mapping: $. - name: spideractionsetoptionparserobotstxt description: spideractionsetoptionparserobotstxt hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionsetoptionparserobotstxt outputParameters: - type: object mapping: $. - name: spideractionsetoptionparsesvnentries description: spideractionsetoptionparsesvnentries hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionsetoptionparsesvnentries outputParameters: - type: object mapping: $. - name: spideractionsetoptionparsesitemapxml description: spideractionsetoptionparsesitemapxml hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionsetoptionparsesitemapxml outputParameters: - type: object mapping: $. - name: spideractionsetoptionpostform description: spideractionsetoptionpostform hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionsetoptionpostform outputParameters: - type: object mapping: $. - name: spideractionsetoptionprocessform description: spideractionsetoptionprocessform hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionsetoptionprocessform outputParameters: - type: object mapping: $. - name: sets-whether-not-referer-header description: Sets whether or not the 'Referer' header should be sent while spidering. hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionsetoptionsendrefererheader outputParameters: - type: object mapping: $. - name: spideractionsetoptionshowadvanceddialog description: spideractionsetoptionshowadvanceddialog hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionsetoptionshowadvanceddialog outputParameters: - type: object mapping: $. - name: spideractionsetoptionskipurlstring description: spideractionsetoptionskipurlstring hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionsetoptionskipurlstring outputParameters: - type: object mapping: $. - name: spideractionsetoptionthreadcount description: spideractionsetoptionthreadcount hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionsetoptionthreadcount outputParameters: - type: object mapping: $. - name: spideractionsetoptionuseragent description: spideractionsetoptionuseragent hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionsetoptionuseragent outputParameters: - type: object mapping: $. - name: spideractionstop description: spideractionstop hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionstop outputParameters: - type: object mapping: $. - name: spideractionstopallscans description: spideractionstopallscans hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spideractionstopallscans outputParameters: - type: object mapping: $. - name: returns-list-names-nodes-added description: Returns a list of the names of the nodes added to the Sites tree by the specified scan. hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spiderviewaddednodes outputParameters: - type: object mapping: $. - name: returns-list-unique-urls-history description: Returns a list of unique URLs from the history table based on HTTP messages added by the Spider. hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spiderviewallurls outputParameters: - type: object mapping: $. - name: gets-all-domains-that-are description: '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.' hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spiderviewdomainsalwaysinscope outputParameters: - type: object mapping: $. - name: gets-regexes-urls-excluded-spider description: Gets the regexes of URLs excluded from the spider scans. hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spiderviewexcludedfromscan outputParameters: - type: object mapping: $. - name: spiderviewfullresults description: spiderviewfullresults hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spiderviewfullresults outputParameters: - type: object mapping: $. - name: gets-whether-not-spider-process description: Gets whether or not a spider process should accept cookies while spidering. hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spiderviewoptionacceptcookies outputParameters: - type: object mapping: $. - name: use-view-domainsalwaysinscope-instead description: Use view domainsAlwaysInScope instead. hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spiderviewoptiondomainsalwaysinscope outputParameters: - type: object mapping: $. - name: use-view-domainsalwaysinscope-instead-2 description: Use view domainsAlwaysInScope instead. hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spiderviewoptiondomainsalwaysinscopeenabled outputParameters: - type: object mapping: $. - name: spiderviewoptionhandleodataparametersvisited description: spiderviewoptionhandleodataparametersvisited hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spiderviewoptionhandleodataparametersvisited outputParameters: - type: object mapping: $. - name: spiderviewoptionhandleparameters description: spiderviewoptionhandleparameters hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spiderviewoptionhandleparameters outputParameters: - type: object mapping: $. - name: gets-whether-not-spider-should description: Gets whether or not the spider should attempt to avoid logout related paths/functionality. hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spiderviewoptionlogoutavoidance outputParameters: - type: object mapping: $. - name: gets-maximum-number-child-nodes description: Gets the maximum number of child nodes (per node) that can be crawled, 0 means no limit. hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spiderviewoptionmaxchildren outputParameters: - type: object mapping: $. - name: gets-maximum-depth-spider-can description: Gets the maximum depth the spider can crawl, 0 if unlimited. hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spiderviewoptionmaxdepth outputParameters: - type: object mapping: $. - name: spiderviewoptionmaxduration description: spiderviewoptionmaxduration hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spiderviewoptionmaxduration outputParameters: - type: object mapping: $. - name: gets-maximum-size-bytes-that description: Gets the maximum size, in bytes, that a response might have to be parsed, or 0 for unlimited. hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spiderviewoptionmaxparsesizebytes outputParameters: - type: object mapping: $. - name: spiderviewoptionmaxscansinui description: spiderviewoptionmaxscansinui hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spiderviewoptionmaxscansinui outputParameters: - type: object mapping: $. - name: spiderviewoptionparsecomments description: spiderviewoptionparsecomments hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spiderviewoptionparsecomments outputParameters: - type: object mapping: $. - name: spiderviewoptionparsedsstore description: spiderviewoptionparsedsstore hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spiderviewoptionparsedsstore outputParameters: - type: object mapping: $. - name: spiderviewoptionparsegit description: spiderviewoptionparsegit hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spiderviewoptionparsegit outputParameters: - type: object mapping: $. - name: spiderviewoptionparserobotstxt description: spiderviewoptionparserobotstxt hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spiderviewoptionparserobotstxt outputParameters: - type: object mapping: $. - name: spiderviewoptionparsesvnentries description: spiderviewoptionparsesvnentries hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spiderviewoptionparsesvnentries outputParameters: - type: object mapping: $. - name: spiderviewoptionparsesitemapxml description: spiderviewoptionparsesitemapxml hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spiderviewoptionparsesitemapxml outputParameters: - type: object mapping: $. - name: spiderviewoptionpostform description: spiderviewoptionpostform hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spiderviewoptionpostform outputParameters: - type: object mapping: $. - name: spiderviewoptionprocessform description: spiderviewoptionprocessform hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spiderviewoptionprocessform outputParameters: - type: object mapping: $. - name: gets-whether-not-referer-header description: Gets whether or not the 'Referer' header should be sent while spidering. hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spiderviewoptionsendrefererheader outputParameters: - type: object mapping: $. - name: spiderviewoptionshowadvanceddialog description: spiderviewoptionshowadvanceddialog hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spiderviewoptionshowadvanceddialog outputParameters: - type: object mapping: $. - name: spiderviewoptionskipurlstring description: spiderviewoptionskipurlstring hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spiderviewoptionskipurlstring outputParameters: - type: object mapping: $. - name: spiderviewoptionthreadcount description: spiderviewoptionthreadcount hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spiderviewoptionthreadcount outputParameters: - type: object mapping: $. - name: spiderviewoptionuseragent description: spiderviewoptionuseragent hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spiderviewoptionuseragent outputParameters: - type: object mapping: $. - name: spiderviewresults description: spiderviewresults hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spiderviewresults outputParameters: - type: object mapping: $. - name: spiderviewscans description: spiderviewscans hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spiderviewscans outputParameters: - type: object mapping: $. - name: spiderviewstatus description: spiderviewstatus hints: readOnly: true destructive: false idempotent: true call: owasp-zap-spider.spiderviewstatus outputParameters: - type: object mapping: $.