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

The network API from OWASP ZAP — 48 operation(s) for network.

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

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

48 operations 48 paths 1 schemas 48 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 Network 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 48

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

Network 48
GET
/JSON/network/action/addAlias/
Network action add alias
networkActionAddAlias 2 params → default
GET
/JSON/network/action/addHttpProxyExclusion/
Network action add http proxy exclusion
networkActionAddHttpProxyExclusion 2 params → default
GET
/JSON/network/action/addLocalServer/
Network action add local server
networkActionAddLocalServer 7 params → default
GET
/JSON/network/action/addPassThrough/
Network action add pass through
networkActionAddPassThrough 2 params → default
GET
/JSON/network/action/addPkcs12ClientCertificate/
Network action add pkcs12 client certificate
networkActionAddPkcs12ClientCertificate 3 params → default
GET
/JSON/network/action/addRateLimitRule/
Network action add rate limit rule
networkActionAddRateLimitRule 6 params → default
GET
/JSON/network/action/generateRootCaCert/
Network action generate root ca cert
networkActionGenerateRootCaCert → default
GET
/JSON/network/action/importRootCaCert/
Network action import root ca cert
networkActionImportRootCaCert 1 param → default
GET
/JSON/network/action/removeAlias/
Network action remove alias
networkActionRemoveAlias 1 param → default
GET
/JSON/network/action/removeHttpProxyExclusion/
Network action remove http proxy exclusion
networkActionRemoveHttpProxyExclusion 1 param → default
GET
/JSON/network/action/removeLocalServer/
Network action remove local server
networkActionRemoveLocalServer 2 params → default
GET
/JSON/network/action/removePassThrough/
Network action remove pass through
networkActionRemovePassThrough 1 param → default
GET
/JSON/network/action/removeRateLimitRule/
Network action remove rate limit rule
networkActionRemoveRateLimitRule 1 param → default
GET
/JSON/network/action/setAliasEnabled/
Network action set alias enabled
networkActionSetAliasEnabled 2 params → default
GET
/JSON/network/action/setConnectionTimeout/
Network action set connection timeout
networkActionSetConnectionTimeout 1 param → default
GET
/JSON/network/action/setDefaultUserAgent/
Network action set default user agent
networkActionSetDefaultUserAgent 1 param → default
GET
/JSON/network/action/setDnsTtlSuccessfulQueries/
Network action set dns ttl successful queries
networkActionSetDnsTtlSuccessfulQueries 1 param → default
GET
/JSON/network/action/setHttpProxy/
Network action set http proxy
networkActionSetHttpProxy 5 params → default
GET
/JSON/network/action/setHttpProxyAuthEnabled/
Network action set http proxy auth enabled
networkActionSetHttpProxyAuthEnabled 1 param → default
GET
/JSON/network/action/setHttpProxyEnabled/
Network action set http proxy enabled
networkActionSetHttpProxyEnabled 1 param → default
GET
/JSON/network/action/setHttpProxyExclusionEnabled/
Network action set http proxy exclusion enabled
networkActionSetHttpProxyExclusionEnabled 2 params → default
GET
/JSON/network/action/setPassThroughEnabled/
Network action set pass through enabled
networkActionSetPassThroughEnabled 2 params → default
GET
/JSON/network/action/setRateLimitRuleEnabled/
Network action set rate limit rule enabled
networkActionSetRateLimitRuleEnabled 2 params → default
GET
/JSON/network/action/setRootCaCertValidity/
Network action set root ca cert validity
networkActionSetRootCaCertValidity 1 param → default
GET
/JSON/network/action/setServerCertValidity/
Network action set server cert validity
networkActionSetServerCertValidity 1 param → default
GET
/JSON/network/action/setSocksProxy/
Network action set socks proxy
networkActionSetSocksProxy 6 params → default
GET
/JSON/network/action/setSocksProxyEnabled/
Network action set socks proxy enabled
networkActionSetSocksProxyEnabled 1 param → default
GET
/JSON/network/action/setUseClientCertificate/
Network action set use client certificate
networkActionSetUseClientCertificate 1 param → default
GET
/JSON/network/action/setUseGlobalHttpState/
Network action set use global http state
networkActionSetUseGlobalHttpState 1 param → default
GET
/OTHER/network/other/proxy.pac/
Network other proxy pac
networkOtherProxy.pac → default
GET
/OTHER/network/other/rootCaCert/
Network other root ca cert
networkOtherRootCaCert → default
GET
/OTHER/network/other/setProxy/
Network other set proxy
networkOtherSetProxy 1 param → default
GET
/JSON/network/view/getAliases/
Network view get aliases
networkViewGetAliases → default
GET
/JSON/network/view/getConnectionTimeout/
Network view get connection timeout
networkViewGetConnectionTimeout → default
GET
/JSON/network/view/getDefaultUserAgent/
Network view get default user agent
networkViewGetDefaultUserAgent → default
GET
/JSON/network/view/getDnsTtlSuccessfulQueries/
Network view get dns ttl successful queries
networkViewGetDnsTtlSuccessfulQueries → default
GET
/JSON/network/view/getHttpProxy/
Network view get http proxy
networkViewGetHttpProxy → default
GET
/JSON/network/view/getHttpProxyExclusions/
Network view get http proxy exclusions
networkViewGetHttpProxyExclusions → default
GET
/JSON/network/view/getLocalServers/
Network view get local servers
networkViewGetLocalServers → default
GET
/JSON/network/view/getPassThroughs/
Network view get pass throughs
networkViewGetPassThroughs → default
GET
/JSON/network/view/getRateLimitRules/
Network view get rate limit rules
networkViewGetRateLimitRules → default
GET
/JSON/network/view/getRootCaCertValidity/
Network view get root ca cert validity
networkViewGetRootCaCertValidity → default
GET
/JSON/network/view/getServerCertValidity/
Network view get server cert validity
networkViewGetServerCertValidity → default
GET
/JSON/network/view/getSocksProxy/
Network view get socks proxy
networkViewGetSocksProxy → default
GET
/JSON/network/view/isHttpProxyAuthEnabled/
Network view is http proxy auth enabled
networkViewIsHttpProxyAuthEnabled → default
GET
/JSON/network/view/isHttpProxyEnabled/
Network view is http proxy enabled
networkViewIsHttpProxyEnabled → default
GET
/JSON/network/view/isSocksProxyEnabled/
Network view is socks proxy enabled
networkViewIsSocksProxyEnabled → default
GET
/JSON/network/view/isUseGlobalHttpState/
Network view is use global http state
networkViewIsUseGlobalHttpState → 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-network-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 Network 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.