OWASP ZAP

OWASP ZAP Spider API

The spider API from OWASP ZAP — 71 operation(s) for spider.

GitHub OpenAPI

Operations 71

GET /JSON/spider/action/addDomainAlwaysInScope/ Spider action add domain always in scope #
GET /JSON/spider/action/clearExcludedFromScan/ Spider action clear excluded from scan #
GET /JSON/spider/action/disableAllDomainsAlwaysInScope/ Spider action disable all domains always in scope #
GET /JSON/spider/action/enableAllDomainsAlwaysInScope/ Spider action enable all domains always in scope #
GET /JSON/spider/action/excludeFromScan/ Spider action exclude from scan #
GET /JSON/spider/action/modifyDomainAlwaysInScope/ Spider action modify domain always in scope #
GET /JSON/spider/action/pause/ Spider action pause #
GET /JSON/spider/action/pauseAllScans/ Spider action pause all scans #
GET /JSON/spider/action/removeAllScans/ Spider action remove all scans #
GET /JSON/spider/action/removeDomainAlwaysInScope/ Spider action remove domain always in scope #
GET /JSON/spider/action/removeScan/ Spider action remove scan #
GET /JSON/spider/action/resume/ Spider action resume #
GET /JSON/spider/action/resumeAllScans/ Spider action resume all scans #
GET /JSON/spider/action/scan/ Spider action scan #
GET /JSON/spider/action/scanAsUser/ Spider action scan as user #
GET /JSON/spider/action/setOptionAcceptCookies/ Spider action set option accept cookies #
GET /JSON/spider/action/setOptionHandleODataParametersVisited/ Spider action set option handle OData parameters visited #
GET /JSON/spider/action/setOptionHandleParameters/ Spider action set option handle parameters #
GET /JSON/spider/action/setOptionLogoutAvoidance/ Spider action set option logout avoidance #
GET /JSON/spider/action/setOptionMaxChildren/ Spider action set option max children #
GET /JSON/spider/action/setOptionMaxDepth/ Spider action set option max depth #
GET /JSON/spider/action/setOptionMaxDuration/ Spider action set option max duration #
GET /JSON/spider/action/setOptionMaxParseSizeBytes/ Spider action set option max parse size bytes #
GET /JSON/spider/action/setOptionMaxScansInUI/ Spider action set option max scans in UI #
GET /JSON/spider/action/setOptionParseComments/ Spider action set option parse comments #
GET /JSON/spider/action/setOptionParseDsStore/ Spider action set option parse ds store #
GET /JSON/spider/action/setOptionParseGit/ Spider action set option parse git #
GET /JSON/spider/action/setOptionParseRobotsTxt/ Spider action set option parse robots txt #
GET /JSON/spider/action/setOptionParseSVNEntries/ Spider action set option parse SVN entries #
GET /JSON/spider/action/setOptionParseSitemapXml/ Spider action set option parse sitemap xml #
GET /JSON/spider/action/setOptionPostForm/ Spider action set option post form #
GET /JSON/spider/action/setOptionProcessForm/ Spider action set option process form #
GET /JSON/spider/action/setOptionSendRefererHeader/ Spider action set option send referer header #
GET /JSON/spider/action/setOptionShowAdvancedDialog/ Spider action set option show advanced dialog #
GET /JSON/spider/action/setOptionSkipURLString/ Spider action set option skip URL string #
GET /JSON/spider/action/setOptionThreadCount/ Spider action set option thread count #
GET /JSON/spider/action/setOptionUserAgent/ Spider action set option user agent #
GET /JSON/spider/action/stop/ Spider action stop #
GET /JSON/spider/action/stopAllScans/ Spider action stop all scans #
GET /JSON/spider/view/addedNodes/ Spider view added nodes #
GET /JSON/spider/view/allUrls/ Spider view all urls #
GET /JSON/spider/view/domainsAlwaysInScope/ Spider view domains always in scope #
GET /JSON/spider/view/excludedFromScan/ Spider view excluded from scan #
GET /JSON/spider/view/fullResults/ Spider view full results #
GET /JSON/spider/view/optionAcceptCookies/ Spider view option accept cookies #
GET /JSON/spider/view/optionDomainsAlwaysInScope/ Spider view option domains always in scope #
GET /JSON/spider/view/optionDomainsAlwaysInScopeEnabled/ Spider view option domains always in scope enabled #
GET /JSON/spider/view/optionHandleODataParametersVisited/ Spider view option handle OData parameters visited #
GET /JSON/spider/view/optionHandleParameters/ Spider view option handle parameters #
GET /JSON/spider/view/optionLogoutAvoidance/ Spider view option logout avoidance #
GET /JSON/spider/view/optionMaxChildren/ Spider view option max children #
GET /JSON/spider/view/optionMaxDepth/ Spider view option max depth #
GET /JSON/spider/view/optionMaxDuration/ Spider view option max duration #
GET /JSON/spider/view/optionMaxParseSizeBytes/ Spider view option max parse size bytes #
GET /JSON/spider/view/optionMaxScansInUI/ Spider view option max scans in UI #
GET /JSON/spider/view/optionParseComments/ Spider view option parse comments #
GET /JSON/spider/view/optionParseDsStore/ Spider view option parse ds store #
GET /JSON/spider/view/optionParseGit/ Spider view option parse git #
GET /JSON/spider/view/optionParseRobotsTxt/ Spider view option parse robots txt #
GET /JSON/spider/view/optionParseSVNEntries/ Spider view option parse SVN entries #
GET /JSON/spider/view/optionParseSitemapXml/ Spider view option parse sitemap xml #
GET /JSON/spider/view/optionPostForm/ Spider view option post form #
GET /JSON/spider/view/optionProcessForm/ Spider view option process form #
GET /JSON/spider/view/optionSendRefererHeader/ Spider view option send referer header #
GET /JSON/spider/view/optionShowAdvancedDialog/ Spider view option show advanced dialog #
GET /JSON/spider/view/optionSkipURLString/ Spider view option skip URL string #
GET /JSON/spider/view/optionThreadCount/ Spider view option thread count #
GET /JSON/spider/view/optionUserAgent/ Spider view option user agent #
GET /JSON/spider/view/results/ Spider view results #
GET /JSON/spider/view/scans/ Spider view scans #
GET /JSON/spider/view/status/ Spider view status #

Documentation

📖
Documentation
https://www.zaproxy.org/docs/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/owasp-zap/refs/heads/main/openapi/owasp-zap-spider-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/zaproxy/zaproxy

Other Resources

🔗
API Documentation
https://www.zaproxy.org/docs/api/
🔗
GitHub API Docs
https://github.com/zaproxy/zap-api-docs

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/owasp-zap:owasp-zap-spider-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

owasp-zap-spider-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: ZAP Spider API
  description: The HTTP API for controlling and accessing ZAP.
  contact:
    name: ZAP User Group
    url: https://groups.google.com/group/zaproxy-users
    email: zaproxy-users@googlegroups.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: 2.16.1
servers:
- url: http://zap
  description: The URL while proxying through ZAP.
- url: http://{address}:{port}
  description: The URL of a Local Proxy of ZAP.
  variables:
    address:
      description: The address ZAP is listening on.
      default: 127.0.0.1
    port:
      description: The port ZAP is bound to.
      default: '8080'
security:
- {}
- apiKeyHeader: []
- apiKeyQuery: []
tags:


# --- truncated at 32 KB (32 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/owasp-zap/refs/heads/main/openapi/owasp-zap-spider-api-openapi.yml