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 ajaxSpider API

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

OWASP ZAP ajaxSpider 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.0.3, 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.0.3
API Version
2.16.1
Base URL
http://zap
Authentication
API Key, API Key
License
Resource Areas
1

Authentication & Security 2

OWASP ZAP ajaxSpider 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/
Adds an allowed resource.
ajaxSpiderActionAddAllowedResource 2 params → default
GET
/JSON/ajaxSpider/action/addExcludedElement/
Adds an excluded element to a context.
ajaxSpiderActionAddExcludedElement 8 params → default
GET
/JSON/ajaxSpider/action/modifyExcludedElement/
Modifies an excluded element of a context.
ajaxSpiderActionModifyExcludedElement 9 params → default
GET
/JSON/ajaxSpider/action/removeAllowedResource/
Removes an allowed resource.
ajaxSpiderActionRemoveAllowedResource 1 param → default
GET
/JSON/ajaxSpider/action/removeExcludedElement/
Removes an excluded element from a context.
ajaxSpiderActionRemoveExcludedElement 2 params → default
GET
/JSON/ajaxSpider/action/scan/
Runs the AJAX Spider against a given target.
ajaxSpiderActionScan 4 params → default
GET
/JSON/ajaxSpider/action/scanAsUser/
Runs the AJAX Spider from the perspective of a User of the web application.
ajaxSpiderActionScanAsUser 4 params → default
GET
/JSON/ajaxSpider/action/setEnabledAllowedResource/
Sets whether or not an allowed resource is enabled.
ajaxSpiderActionSetEnabledAllowedResource 2 params → default
GET
/JSON/ajaxSpider/action/setOptionBrowserId/
Sets the configuration of the AJAX Spider to use one of the supported browsers.
ajaxSpiderActionSetOptionBrowserId 1 param → default
GET
/JSON/ajaxSpider/action/setOptionClickDefaultElems/
Sets whether or not the AJAX Spider will only click on the default HTML elements.
ajaxSpiderActionSetOptionClickDefaultElems 1 param → default
GET
/JSON/ajaxSpider/action/setOptionClickElemsOnce/
When enabled, the crawler attempts to interact with each element (e.g., by clicking) only once.
ajaxSpiderActionSetOptionClickElemsOnce 1 param → default
GET
/JSON/ajaxSpider/action/setOptionEnableExtensions/
ajaxSpiderActionSetOptionEnableExtensions 1 param → default
GET
/JSON/ajaxSpider/action/setOptionEventWait/
Sets the time to wait after an event (in milliseconds). For example: the wait delay after the cursor hovers over an element, in order for a menu to display, etc.
ajaxSpiderActionSetOptionEventWait 1 param → default
GET
/JSON/ajaxSpider/action/setOptionLogoutAvoidance/
Sets whether or not the AJAX Spider should avoid clicking logout elements.
ajaxSpiderActionSetOptionLogoutAvoidance 1 param → default
GET
/JSON/ajaxSpider/action/setOptionMaxCrawlDepth/
Sets the maximum depth that the crawler can reach.
ajaxSpiderActionSetOptionMaxCrawlDepth 1 param → default
GET
/JSON/ajaxSpider/action/setOptionMaxCrawlStates/
Sets the maximum number of states that the crawler should crawl.
ajaxSpiderActionSetOptionMaxCrawlStates 1 param → default
GET
/JSON/ajaxSpider/action/setOptionMaxDuration/
The maximum time that the crawler is allowed to run.
ajaxSpiderActionSetOptionMaxDuration 1 param → default
GET
/JSON/ajaxSpider/action/setOptionNumberOfBrowsers/
Sets the number of windows to be used by AJAX Spider.
ajaxSpiderActionSetOptionNumberOfBrowsers 1 param → default
GET
/JSON/ajaxSpider/action/setOptionRandomInputs/
When enabled, inserts random values into form fields.
ajaxSpiderActionSetOptionRandomInputs 1 param → default
GET
/JSON/ajaxSpider/action/setOptionReloadWait/
Sets the time to wait after the page is loaded before interacting with it.
ajaxSpiderActionSetOptionReloadWait 1 param → default
GET
/JSON/ajaxSpider/action/setOptionScopeCheck/
Sets the scope check.
ajaxSpiderActionSetOptionScopeCheck 1 param → default
GET
/JSON/ajaxSpider/action/stop/
Stops the AJAX Spider.
ajaxSpiderActionStop → default
GET
/JSON/ajaxSpider/view/allowedResources/
Gets the allowed resources. The allowed resources are always fetched even if out of scope, allowing to include necessary resources (e.g. scripts) from 3rd-parties.
ajaxSpiderViewAllowedResources → default
GET
/JSON/ajaxSpider/view/excludedElements/
Gets the excluded elements. The excluded elements are not clicked during crawling, for example, to prevent logging out.
ajaxSpiderViewExcludedElements 1 param → default
GET
/JSON/ajaxSpider/view/fullResults/
Gets the full crawled content detected by the AJAX Spider. Returns a set of values based on 'inScope' URLs, 'outOfScope' URLs, and 'errors' encountered during the last/current run of the AJAX Spider.
ajaxSpiderViewFullResults → default
GET
/JSON/ajaxSpider/view/numberOfResults/
Gets the number of resources found.
ajaxSpiderViewNumberOfResults → default
GET
/JSON/ajaxSpider/view/optionBrowserId/
Gets the configured browser to use for crawling.
ajaxSpiderViewOptionBrowserId → default
GET
/JSON/ajaxSpider/view/optionClickDefaultElems/
Gets the configured value for 'Click Default Elements Only', HTML elements such as 'a', 'button', 'input', all associated with some action or links on the page.
ajaxSpiderViewOptionClickDefaultElems → default
GET
/JSON/ajaxSpider/view/optionClickElemsOnce/
Gets the value configured for the AJAX Spider to know if it should click on the elements only once.
ajaxSpiderViewOptionClickElemsOnce → default
GET
/JSON/ajaxSpider/view/optionEnableExtensions/
ajaxSpiderViewOptionEnableExtensions → default
GET
/JSON/ajaxSpider/view/optionEventWait/
Gets the time to wait after an event (in milliseconds). For example: the wait delay after the cursor hovers over an element, in order for a menu to display, etc.
ajaxSpiderViewOptionEventWait → default
GET
/JSON/ajaxSpider/view/optionLogoutAvoidance/
Gets the value of the Logout Avoidance option.
ajaxSpiderViewOptionLogoutAvoidance → default
GET
/JSON/ajaxSpider/view/optionMaxCrawlDepth/
Gets the configured value for the max crawl depth.
ajaxSpiderViewOptionMaxCrawlDepth → default
GET
/JSON/ajaxSpider/view/optionMaxCrawlStates/
Gets the configured value for the maximum crawl states allowed.
ajaxSpiderViewOptionMaxCrawlStates → default
GET
/JSON/ajaxSpider/view/optionMaxDuration/
Gets the configured max duration of the crawl, the value is in minutes.
ajaxSpiderViewOptionMaxDuration → default
GET
/JSON/ajaxSpider/view/optionNumberOfBrowsers/
Gets the configured number of browsers to be used.
ajaxSpiderViewOptionNumberOfBrowsers → default
GET
/JSON/ajaxSpider/view/optionRandomInputs/
Gets if the AJAX Spider will use random values in form fields when crawling, if set to true.
ajaxSpiderViewOptionRandomInputs → default
GET
/JSON/ajaxSpider/view/optionReloadWait/
Gets the configured time to wait after reloading the page, this value is in milliseconds.
ajaxSpiderViewOptionReloadWait → default
GET
/JSON/ajaxSpider/view/optionScopeCheck/
Gets the configured scope check.
ajaxSpiderViewOptionScopeCheck → default
GET
/JSON/ajaxSpider/view/results/
Gets the current results of the crawler.
ajaxSpiderViewResults 2 params → default
GET
/JSON/ajaxSpider/view/status/
Gets the current status of the crawler. Actual values are Stopped and Running.
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 accessControl API
OWASP ZAP acsrf API
OWASP ZAP alert API
OWASP ZAP alertFilter 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 clientSpider API
Where this information came from

This is an independent, third-party profile of OWASP ZAP ajaxSpider 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.