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

The stats API from OWASP ZAP — 13 operation(s) for stats.

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

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

This API exposes 13 operations across 13 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}.

13 operations 13 paths 1 schemas 13 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 stats 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 13

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

stats 13
GET
/JSON/stats/action/clearStats/
Clears all of the statistics
statsActionClearStats 1 param → default
GET
/JSON/stats/action/setOptionInMemoryEnabled/
Sets whether in memory statistics are enabled
statsActionSetOptionInMemoryEnabled 1 param → default
GET
/JSON/stats/action/setOptionStatsdHost/
Sets the Statsd service hostname, supply an empty string to stop using a Statsd service
statsActionSetOptionStatsdHost 1 param → default
GET
/JSON/stats/action/setOptionStatsdPort/
Sets the Statsd service port
statsActionSetOptionStatsdPort 1 param → default
GET
/JSON/stats/action/setOptionStatsdPrefix/
Sets the prefix to be applied to all stats sent to the configured Statsd service
statsActionSetOptionStatsdPrefix 1 param → default
GET
/JSON/stats/view/allSitesStats/
Gets all of the site based statistics, optionally filtered by a key prefix
statsViewAllSitesStats 1 param → default
GET
/JSON/stats/view/optionInMemoryEnabled/
Returns 'true' if in memory statistics are enabled, otherwise returns 'false'
statsViewOptionInMemoryEnabled → default
GET
/JSON/stats/view/optionStatsdEnabled/
Returns 'true' if a Statsd server has been correctly configured, otherwise returns 'false'
statsViewOptionStatsdEnabled → default
GET
/JSON/stats/view/optionStatsdHost/
Gets the Statsd service hostname
statsViewOptionStatsdHost → default
GET
/JSON/stats/view/optionStatsdPort/
Gets the Statsd service port
statsViewOptionStatsdPort → default
GET
/JSON/stats/view/optionStatsdPrefix/
Gets the prefix to be applied to all stats sent to the configured Statsd service
statsViewOptionStatsdPrefix → default
GET
/JSON/stats/view/siteStats/
Gets all of the global statistics, optionally filtered by a key prefix
statsViewSiteStats 2 params → default
GET
/JSON/stats/view/stats/
Statistics
statsViewStats 1 param → 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-stats-api-openapi.yml Raw ↑

Other APIs OWASP ZAP publishes across the network.

OWASP ZAP accessControl API
OWASP ZAP acsrf API
OWASP ZAP ajaxSpider 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
Where this information came from

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