How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OWASP ZAP Ajax Spider API

The ajaxSpider API from OWASP ZAP — 41 operation(s) for ajaxspider.

OWASP ZAP Ajax Spider API is one of 49 APIs that OWASP ZAP publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.

This API exposes 41 operations across 41 paths, and defines 1 schema. It is described by OpenAPI 3.2.0, at version 2.16.1.

Requests are made against 2 base URLs: http://zap, http://{address}:{port}.

41 operations 41 paths 1 schemas 41 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.16.1
Base URL
http://zap
Authentication
API Key, API Key
License
Resource Areas
1

Authentication & Security 2

OWASP ZAP Ajax Spider API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-ZAP-API-Key (apiKeyHeader). An API key is passed in the query as apikey (apiKeyQuery). By default, every request must be authenticated, though some operations may also be called without credentials.

Paths & Operations 41

Across 41 paths, the API surfaces 41 operations — 41 GET. Each is listed below with its method, path, parameters, and response codes.

ajaxSpider 41
GET
/JSON/ajaxSpider/action/addAllowedResource/
Ajax spider action add allowed resource
ajaxSpiderActionAddAllowedResource 2 params → default
GET
/JSON/ajaxSpider/action/addExcludedElement/
Ajax spider action add excluded element
ajaxSpiderActionAddExcludedElement 8 params → default
GET
/JSON/ajaxSpider/action/modifyExcludedElement/
Ajax spider action modify excluded element
ajaxSpiderActionModifyExcludedElement 9 params → default
GET
/JSON/ajaxSpider/action/removeAllowedResource/
Ajax spider action remove allowed resource
ajaxSpiderActionRemoveAllowedResource 1 param → default
GET
/JSON/ajaxSpider/action/removeExcludedElement/
Ajax spider action remove excluded element
ajaxSpiderActionRemoveExcludedElement 2 params → default
GET
/JSON/ajaxSpider/action/scan/
Ajax spider action scan
ajaxSpiderActionScan 4 params → default
GET
/JSON/ajaxSpider/action/scanAsUser/
Ajax spider action scan as user
ajaxSpiderActionScanAsUser 4 params → default
GET
/JSON/ajaxSpider/action/setEnabledAllowedResource/
Ajax spider action set enabled allowed resource
ajaxSpiderActionSetEnabledAllowedResource 2 params → default
GET
/JSON/ajaxSpider/action/setOptionBrowserId/
Ajax spider action set option browser id
ajaxSpiderActionSetOptionBrowserId 1 param → default
GET
/JSON/ajaxSpider/action/setOptionClickDefaultElems/
Ajax spider action set option click default elems
ajaxSpiderActionSetOptionClickDefaultElems 1 param → default
GET
/JSON/ajaxSpider/action/setOptionClickElemsOnce/
Ajax spider action set option click elems once
ajaxSpiderActionSetOptionClickElemsOnce 1 param → default
GET
/JSON/ajaxSpider/action/setOptionEnableExtensions/
Ajax spider action set option enable extensions
ajaxSpiderActionSetOptionEnableExtensions 1 param → default
GET
/JSON/ajaxSpider/action/setOptionEventWait/
Ajax spider action set option event wait
ajaxSpiderActionSetOptionEventWait 1 param → default
GET
/JSON/ajaxSpider/action/setOptionLogoutAvoidance/
Ajax spider action set option logout avoidance
ajaxSpiderActionSetOptionLogoutAvoidance 1 param → default
GET
/JSON/ajaxSpider/action/setOptionMaxCrawlDepth/
Ajax spider action set option max crawl depth
ajaxSpiderActionSetOptionMaxCrawlDepth 1 param → default
GET
/JSON/ajaxSpider/action/setOptionMaxCrawlStates/
Ajax spider action set option max crawl states
ajaxSpiderActionSetOptionMaxCrawlStates 1 param → default
GET
/JSON/ajaxSpider/action/setOptionMaxDuration/
Ajax spider action set option max duration
ajaxSpiderActionSetOptionMaxDuration 1 param → default
GET
/JSON/ajaxSpider/action/setOptionNumberOfBrowsers/
Ajax spider action set option number of browsers
ajaxSpiderActionSetOptionNumberOfBrowsers 1 param → default
GET
/JSON/ajaxSpider/action/setOptionRandomInputs/
Ajax spider action set option random inputs
ajaxSpiderActionSetOptionRandomInputs 1 param → default
GET
/JSON/ajaxSpider/action/setOptionReloadWait/
Ajax spider action set option reload wait
ajaxSpiderActionSetOptionReloadWait 1 param → default
GET
/JSON/ajaxSpider/action/setOptionScopeCheck/
Ajax spider action set option scope check
ajaxSpiderActionSetOptionScopeCheck 1 param → default
GET
/JSON/ajaxSpider/action/stop/
Ajax spider action stop
ajaxSpiderActionStop → default
GET
/JSON/ajaxSpider/view/allowedResources/
Ajax spider view allowed resources
ajaxSpiderViewAllowedResources → default
GET
/JSON/ajaxSpider/view/excludedElements/
Ajax spider view excluded elements
ajaxSpiderViewExcludedElements 1 param → default
GET
/JSON/ajaxSpider/view/fullResults/
Ajax spider view full results
ajaxSpiderViewFullResults → default
GET
/JSON/ajaxSpider/view/numberOfResults/
Ajax spider view number of results
ajaxSpiderViewNumberOfResults → default
GET
/JSON/ajaxSpider/view/optionBrowserId/
Ajax spider view option browser id
ajaxSpiderViewOptionBrowserId → default
GET
/JSON/ajaxSpider/view/optionClickDefaultElems/
Ajax spider view option click default elems
ajaxSpiderViewOptionClickDefaultElems → default
GET
/JSON/ajaxSpider/view/optionClickElemsOnce/
Ajax spider view option click elems once
ajaxSpiderViewOptionClickElemsOnce → default
GET
/JSON/ajaxSpider/view/optionEnableExtensions/
Ajax spider view option enable extensions
ajaxSpiderViewOptionEnableExtensions → default
GET
/JSON/ajaxSpider/view/optionEventWait/
Ajax spider view option event wait
ajaxSpiderViewOptionEventWait → default
GET
/JSON/ajaxSpider/view/optionLogoutAvoidance/
Ajax spider view option logout avoidance
ajaxSpiderViewOptionLogoutAvoidance → default
GET
/JSON/ajaxSpider/view/optionMaxCrawlDepth/
Ajax spider view option max crawl depth
ajaxSpiderViewOptionMaxCrawlDepth → default
GET
/JSON/ajaxSpider/view/optionMaxCrawlStates/
Ajax spider view option max crawl states
ajaxSpiderViewOptionMaxCrawlStates → default
GET
/JSON/ajaxSpider/view/optionMaxDuration/
Ajax spider view option max duration
ajaxSpiderViewOptionMaxDuration → default
GET
/JSON/ajaxSpider/view/optionNumberOfBrowsers/
Ajax spider view option number of browsers
ajaxSpiderViewOptionNumberOfBrowsers → default
GET
/JSON/ajaxSpider/view/optionRandomInputs/
Ajax spider view option random inputs
ajaxSpiderViewOptionRandomInputs → default
GET
/JSON/ajaxSpider/view/optionReloadWait/
Ajax spider view option reload wait
ajaxSpiderViewOptionReloadWait → default
GET
/JSON/ajaxSpider/view/optionScopeCheck/
Ajax spider view option scope check
ajaxSpiderViewOptionScopeCheck → default
GET
/JSON/ajaxSpider/view/results/
Ajax spider view results
ajaxSpiderViewResults 2 params → default
GET
/JSON/ajaxSpider/view/status/
Ajax spider view status
ajaxSpiderViewStatus → default

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is ErrorJson (3 properties). Each schema is shown below with its type and property counts.

ErrorJson
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

owasp-zap-ajaxspider-api-openapi.yml Raw ↑

Other APIs OWASP ZAP publishes across the network.

OWASP ZAP Acsrf API
OWASP ZAP Alert API
OWASP ZAP Alert Filter API
OWASP ZAP Ascan API
OWASP ZAP Authentication API
OWASP ZAP Authorization API
OWASP ZAP Automation API
OWASP ZAP Autoupdate API
OWASP ZAP Break API
OWASP ZAP Client API
OWASP ZAP Client Spider API
OWASP ZAP Context API
Where this information came from

This is an independent, third-party profile of OWASP ZAP Ajax Spider API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.