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

The script API from OWASP ZAP — 24 operation(s) for script.

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

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

24 operations 24 paths 1 schemas 24 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 Script 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 24

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

Script 24
GET
/JSON/script/action/clearGlobalCustomVar/
Script action clear global custom var
scriptActionClearGlobalCustomVar 1 param → default
GET
/JSON/script/action/clearGlobalVar/
Script action clear global var
scriptActionClearGlobalVar 1 param → default
GET
/JSON/script/action/clearGlobalVars/
Script action clear global vars
scriptActionClearGlobalVars → default
GET
/JSON/script/action/clearScriptCustomVar/
Script action clear script custom var
scriptActionClearScriptCustomVar 2 params → default
GET
/JSON/script/action/clearScriptVar/
Script action clear script var
scriptActionClearScriptVar 2 params → default
GET
/JSON/script/action/clearScriptVars/
Script action clear script vars
scriptActionClearScriptVars 1 param → default
GET
/JSON/script/action/disable/
Script action disable
scriptActionDisable 1 param → default
GET
/JSON/script/action/enable/
Script action enable
scriptActionEnable 1 param → default
GET
/JSON/script/action/load/
Script action load
scriptActionLoad 6 params → default
GET
/JSON/script/action/remove/
Script action remove
scriptActionRemove 1 param → default
GET
/JSON/script/action/runStandAloneScript/
Script action run stand alone script
scriptActionRunStandAloneScript 1 param → default
GET
/JSON/script/action/setGlobalVar/
Script action set global var
scriptActionSetGlobalVar 2 params → default
GET
/JSON/script/action/setScriptVar/
Script action set script var
scriptActionSetScriptVar 3 params → default
GET
/JSON/script/view/globalCustomVar/
Script view global custom var
scriptViewGlobalCustomVar 1 param → default
GET
/JSON/script/view/globalCustomVars/
Script view global custom vars
scriptViewGlobalCustomVars → default
GET
/JSON/script/view/globalVar/
Script view global var
scriptViewGlobalVar 1 param → default
GET
/JSON/script/view/globalVars/
Script view global vars
scriptViewGlobalVars → default
GET
/JSON/script/view/listEngines/
Script view list engines
scriptViewListEngines → default
GET
/JSON/script/view/listScripts/
Script view list scripts
scriptViewListScripts → default
GET
/JSON/script/view/listTypes/
Script view list types
scriptViewListTypes → default
GET
/JSON/script/view/scriptCustomVar/
Script view script custom var
scriptViewScriptCustomVar 2 params → default
GET
/JSON/script/view/scriptCustomVars/
Script view script custom vars
scriptViewScriptCustomVars 1 param → default
GET
/JSON/script/view/scriptVar/
Script view script var
scriptViewScriptVar 2 params → default
GET
/JSON/script/view/scriptVars/
Script view script vars
scriptViewScriptVars 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-script-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 Script 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.