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.0.3, 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.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 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/
Clears a global custom variable.
scriptActionClearGlobalCustomVar 1 param → default
GET
/JSON/script/action/clearGlobalVar/
Clears the global variable with the given key.
scriptActionClearGlobalVar 1 param → default
GET
/JSON/script/action/clearGlobalVars/
Clears the global variables.
scriptActionClearGlobalVars → default
GET
/JSON/script/action/clearScriptCustomVar/
Clears a script custom variable.
scriptActionClearScriptCustomVar 2 params → default
GET
/JSON/script/action/clearScriptVar/
Clears the variable with the given key of the given script. Returns an API error (DOESNOTEXIST) if no script with the given name exists.
scriptActionClearScriptVar 2 params → default
GET
/JSON/script/action/clearScriptVars/
Clears the variables of the given script. Returns an API error (DOESNOTEXIST) if no script with the given name exists.
scriptActionClearScriptVars 1 param → default
GET
/JSON/script/action/disable/
Disables the script with the given name
scriptActionDisable 1 param → default
GET
/JSON/script/action/enable/
Enables the script with the given name
scriptActionEnable 1 param → default
GET
/JSON/script/action/load/
Loads a script into ZAP from the given local file, with the given name, type and engine, optionally with a description, and a charset name to read the script (the charset name is required if the scri…
scriptActionLoad 6 params → default
GET
/JSON/script/action/remove/
Removes the script with the given name
scriptActionRemove 1 param → default
GET
/JSON/script/action/runStandAloneScript/
Runs the stand alone script with the given name
scriptActionRunStandAloneScript 1 param → default
GET
/JSON/script/action/setGlobalVar/
Sets the value of the global variable with the given key.
scriptActionSetGlobalVar 2 params → default
GET
/JSON/script/action/setScriptVar/
Sets the value of the variable with the given key of the given script. Returns an API error (DOESNOTEXIST) if no script with the given name exists.
scriptActionSetScriptVar 3 params → default
GET
/JSON/script/view/globalCustomVar/
Gets the value (string representation) of a global custom variable. Returns an API error (DOESNOTEXIST) if no value was previously set.
scriptViewGlobalCustomVar 1 param → default
GET
/JSON/script/view/globalCustomVars/
Gets all the global custom variables (key/value pairs, the value is the string representation).
scriptViewGlobalCustomVars → default
GET
/JSON/script/view/globalVar/
Gets the value of the global variable with the given key. Returns an API error (DOESNOTEXIST) if no value was previously set.
scriptViewGlobalVar 1 param → default
GET
/JSON/script/view/globalVars/
Gets all the global variables (key/value pairs).
scriptViewGlobalVars → default
GET
/JSON/script/view/listEngines/
Lists the script engines available
scriptViewListEngines → default
GET
/JSON/script/view/listScripts/
Lists the scripts available, with its engine, name, description, type and error state.
scriptViewListScripts → default
GET
/JSON/script/view/listTypes/
Lists the script types available.
scriptViewListTypes → default
GET
/JSON/script/view/scriptCustomVar/
Gets the value (string representation) of a custom variable. Returns an API error (DOESNOTEXIST) if no script with the given name exists or if no value was previously set.
scriptViewScriptCustomVar 2 params → default
GET
/JSON/script/view/scriptCustomVars/
Gets all the custom variables (key/value pairs, the value is the string representation) of a script. Returns an API error (DOESNOTEXIST) if no script with the given name exists.
scriptViewScriptCustomVars 1 param → default
GET
/JSON/script/view/scriptVar/
Gets the value of the variable with the given key for the given script. Returns an API error (DOESNOTEXIST) if no script with the given name exists or if no value was previously set.
scriptViewScriptVar 2 params → default
GET
/JSON/script/view/scriptVars/
Gets all the variables (key/value pairs) of the given script. Returns an API error (DOESNOTEXIST) if no script with the given name exists.
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 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 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.