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

The hud API from OWASP ZAP — 37 operation(s) for hud.

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

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

37 operations 37 paths 1 schemas 37 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 Hud 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 37

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

hud 37
GET
/JSON/hud/action/log/
Hud action log
hudActionLog 1 param → default
GET
/JSON/hud/action/recordRequest/
Hud action record request
hudActionRecordRequest 2 params → default
GET
/JSON/hud/action/resetTutorialTasks/
Hud action reset tutorial tasks
hudActionResetTutorialTasks → default
GET
/JSON/hud/action/setOptionBaseDirectory/
Hud action set option base directory
hudActionSetOptionBaseDirectory 1 param → default
GET
/JSON/hud/action/setOptionDevelopmentMode/
Hud action set option development mode
hudActionSetOptionDevelopmentMode 1 param → default
GET
/JSON/hud/action/setOptionEnableOnDomainMsgs/
Hud action set option enable on domain msgs
hudActionSetOptionEnableOnDomainMsgs 1 param → default
GET
/JSON/hud/action/setOptionEnabledForDaemon/
Hud action set option enabled for daemon
hudActionSetOptionEnabledForDaemon 1 param → default
GET
/JSON/hud/action/setOptionEnabledForDesktop/
Hud action set option enabled for desktop
hudActionSetOptionEnabledForDesktop 1 param → default
GET
/JSON/hud/action/setOptionInScopeOnly/
Hud action set option in scope only
hudActionSetOptionInScopeOnly 1 param → default
GET
/JSON/hud/action/setOptionRemoveCSP/
Hud action set option remove CSP
hudActionSetOptionRemoveCSP 1 param → default
GET
/JSON/hud/action/setOptionShowWelcomeScreen/
Hud action set option show welcome screen
hudActionSetOptionShowWelcomeScreen 1 param → default
GET
/JSON/hud/action/setOptionSkipTutorialTasks/
Hud action set option skip tutorial tasks
hudActionSetOptionSkipTutorialTasks 1 param → default
GET
/JSON/hud/action/setOptionTutorialTaskDone/
Hud action set option tutorial task done
hudActionSetOptionTutorialTaskDone 1 param → default
GET
/JSON/hud/action/setOptionTutorialTestMode/
Hud action set option tutorial test mode
hudActionSetOptionTutorialTestMode 1 param → default
GET
/JSON/hud/action/setUiOption/
Hud action set ui option
hudActionSetUiOption 2 params → default
GET
/OTHER/hud/other/changesInHtml/
Hud other changes in html
hudOtherChangesInHtml → default
GET
/JSON/hud/view/getUiOption/
Hud view get ui option
hudViewGetUiOption 1 param → default
GET
/JSON/hud/view/heartbeat/
Hud view heartbeat
hudViewHeartbeat → default
GET
/JSON/hud/view/hudAlertData/
Hud view hud alert data
hudViewHudAlertData 1 param → default
GET
/JSON/hud/view/optionAllowUnsafeEval/
Hud view option allow unsafe eval
hudViewOptionAllowUnsafeEval → default
GET
/JSON/hud/view/optionBaseDirectory/
Hud view option base directory
hudViewOptionBaseDirectory → default
GET
/JSON/hud/view/optionDevelopmentMode/
Hud view option development mode
hudViewOptionDevelopmentMode → default
GET
/JSON/hud/view/optionEnableOnDomainMsgs/
Hud view option enable on domain msgs
hudViewOptionEnableOnDomainMsgs → default
GET
/JSON/hud/view/optionEnableTelemetry/
Hud view option enable telemetry
hudViewOptionEnableTelemetry → default
GET
/JSON/hud/view/optionEnabledForDaemon/
Hud view option enabled for daemon
hudViewOptionEnabledForDaemon → default
GET
/JSON/hud/view/optionEnabledForDesktop/
Hud view option enabled for desktop
hudViewOptionEnabledForDesktop → default
GET
/JSON/hud/view/optionInScopeOnly/
Hud view option in scope only
hudViewOptionInScopeOnly → default
GET
/JSON/hud/view/optionRemoveCSP/
Hud view option remove CSP
hudViewOptionRemoveCSP → default
GET
/JSON/hud/view/optionShowWelcomeScreen/
Hud view option show welcome screen
hudViewOptionShowWelcomeScreen → default
GET
/JSON/hud/view/optionSkipTutorialTasks/
Hud view option skip tutorial tasks
hudViewOptionSkipTutorialTasks → default
GET
/JSON/hud/view/optionTutorialHost/
Hud view option tutorial host
hudViewOptionTutorialHost → default
GET
/JSON/hud/view/optionTutorialPort/
Hud view option tutorial port
hudViewOptionTutorialPort → default
GET
/JSON/hud/view/optionTutorialTasksDone/
Hud view option tutorial tasks done
hudViewOptionTutorialTasksDone → default
GET
/JSON/hud/view/optionTutorialTestMode/
Hud view option tutorial test mode
hudViewOptionTutorialTestMode → default
GET
/JSON/hud/view/optionTutorialUpdates/
Hud view option tutorial updates
hudViewOptionTutorialUpdates → default
GET
/JSON/hud/view/tutorialUpdates/
Hud view tutorial updates
hudViewTutorialUpdates → default
GET
/JSON/hud/view/upgradedDomains/
Hud view upgraded domains
hudViewUpgradedDomains → 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-hud-api-openapi.yml Raw ↑

Other APIs OWASP ZAP publishes across the network.

OWASP ZAP Acsrf API
OWASP ZAP Ajax Spider 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
Where this information came from

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