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

The autoupdate API from OWASP ZAP — 32 operation(s) for autoupdate.

OWASP ZAP autoupdate 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 Auto-Update. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.

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

32 operations 32 paths 1 schemas 32 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 autoupdate 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 32

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

autoupdate 32
GET
/JSON/autoupdate/action/downloadLatestRelease/
Downloads the latest release, if any
autoupdateActionDownloadLatestRelease → default
GET
/JSON/autoupdate/action/installAddon/
Installs or updates the specified add-on, returning when complete (i.e. not asynchronously)
autoupdateActionInstallAddon 1 param → default
GET
/JSON/autoupdate/action/installLocalAddon/
autoupdateActionInstallLocalAddon 1 param → default
GET
/JSON/autoupdate/action/setOptionCheckAddonUpdates/
autoupdateActionSetOptionCheckAddonUpdates 1 param → default
GET
/JSON/autoupdate/action/setOptionCheckOnStart/
autoupdateActionSetOptionCheckOnStart 1 param → default
GET
/JSON/autoupdate/action/setOptionDownloadNewRelease/
autoupdateActionSetOptionDownloadNewRelease 1 param → default
GET
/JSON/autoupdate/action/setOptionInstallAddonUpdates/
autoupdateActionSetOptionInstallAddonUpdates 1 param → default
GET
/JSON/autoupdate/action/setOptionInstallScannerRules/
autoupdateActionSetOptionInstallScannerRules 1 param → default
GET
/JSON/autoupdate/action/setOptionReportAlphaAddons/
autoupdateActionSetOptionReportAlphaAddons 1 param → default
GET
/JSON/autoupdate/action/setOptionReportBetaAddons/
autoupdateActionSetOptionReportBetaAddons 1 param → default
GET
/JSON/autoupdate/action/setOptionReportReleaseAddons/
autoupdateActionSetOptionReportReleaseAddons 1 param → default
GET
/JSON/autoupdate/action/uninstallAddon/
Uninstalls the specified add-on
autoupdateActionUninstallAddon 1 param → default
GET
/JSON/autoupdate/view/installedAddons/
Return a list of all of the installed add-ons
autoupdateViewInstalledAddons → default
GET
/JSON/autoupdate/view/isLatestVersion/
Returns 'true' if ZAP is on the latest version
autoupdateViewIsLatestVersion → default
GET
/JSON/autoupdate/view/latestVersionNumber/
Returns the latest version number
autoupdateViewLatestVersionNumber → default
GET
/JSON/autoupdate/view/localAddons/
Returns a list with all local add-ons, installed or not.
autoupdateViewLocalAddons → default
GET
/JSON/autoupdate/view/marketplaceAddons/
Return a list of all of the add-ons on the ZAP Marketplace (this information is read once and then cached)
autoupdateViewMarketplaceAddons → default
GET
/JSON/autoupdate/view/newAddons/
Return a list of any add-ons that have been added to the Marketplace since the last check for updates
autoupdateViewNewAddons → default
GET
/JSON/autoupdate/view/optionAddonDirectories/
autoupdateViewOptionAddonDirectories → default
GET
/JSON/autoupdate/view/optionCheckAddonUpdates/
autoupdateViewOptionCheckAddonUpdates → default
GET
/JSON/autoupdate/view/optionCheckOnStart/
autoupdateViewOptionCheckOnStart → default
GET
/JSON/autoupdate/view/optionDayLastChecked/
autoupdateViewOptionDayLastChecked → default
GET
/JSON/autoupdate/view/optionDayLastInstallWarned/
autoupdateViewOptionDayLastInstallWarned → default
GET
/JSON/autoupdate/view/optionDayLastUpdateWarned/
autoupdateViewOptionDayLastUpdateWarned → default
GET
/JSON/autoupdate/view/optionDownloadDirectory/
autoupdateViewOptionDownloadDirectory → default
GET
/JSON/autoupdate/view/optionDownloadNewRelease/
autoupdateViewOptionDownloadNewRelease → default
GET
/JSON/autoupdate/view/optionInstallAddonUpdates/
autoupdateViewOptionInstallAddonUpdates → default
GET
/JSON/autoupdate/view/optionInstallScannerRules/
autoupdateViewOptionInstallScannerRules → default
GET
/JSON/autoupdate/view/optionReportAlphaAddons/
autoupdateViewOptionReportAlphaAddons → default
GET
/JSON/autoupdate/view/optionReportBetaAddons/
autoupdateViewOptionReportBetaAddons → default
GET
/JSON/autoupdate/view/optionReportReleaseAddons/
autoupdateViewOptionReportReleaseAddons → default
GET
/JSON/autoupdate/view/updatedAddons/
Return a list of any add-ons that have been changed in the Marketplace since the last check for updates
autoupdateViewUpdatedAddons → 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-autoupdate-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 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 autoupdate 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.