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 Network. 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.0.3, 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.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 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/
Adds an alias for the local servers/proxies.
networkActionAddAlias 2 params → default
GET
/JSON/network/action/addHttpProxyExclusion/
Adds a host to be excluded from the HTTP proxy.
networkActionAddHttpProxyExclusion 2 params → default
GET
/JSON/network/action/addLocalServer/
Adds a local server/proxy.
networkActionAddLocalServer 7 params → default
GET
/JSON/network/action/addPassThrough/
Adds an authority to pass-through the local proxies.
networkActionAddPassThrough 2 params → default
GET
/JSON/network/action/addPkcs12ClientCertificate/
Adds a client certificate contained in a PKCS12 file, the certificate is automatically set as active and used.
networkActionAddPkcs12ClientCertificate 3 params → default
GET
/JSON/network/action/addRateLimitRule/
Adds a rate limit rule
networkActionAddRateLimitRule 6 params → default
GET
/JSON/network/action/generateRootCaCert/
Generates a new Root CA certificate, used to issue server certificates.
networkActionGenerateRootCaCert → default
GET
/JSON/network/action/importRootCaCert/
Imports a Root CA certificate to be used to issue server certificates.
networkActionImportRootCaCert 1 param → default
GET
/JSON/network/action/removeAlias/
Removes an alias.
networkActionRemoveAlias 1 param → default
GET
/JSON/network/action/removeHttpProxyExclusion/
Removes an HTTP proxy exclusion.
networkActionRemoveHttpProxyExclusion 1 param → default
GET
/JSON/network/action/removeLocalServer/
Removes a local server/proxy.
networkActionRemoveLocalServer 2 params → default
GET
/JSON/network/action/removePassThrough/
Removes a pass-through.
networkActionRemovePassThrough 1 param → default
GET
/JSON/network/action/removeRateLimitRule/
Remove a rate limit rule
networkActionRemoveRateLimitRule 1 param → default
GET
/JSON/network/action/setAliasEnabled/
Sets whether or not an alias is enabled.
networkActionSetAliasEnabled 2 params → default
GET
/JSON/network/action/setConnectionTimeout/
Sets the timeout, for reads and connects.
networkActionSetConnectionTimeout 1 param → default
GET
/JSON/network/action/setDefaultUserAgent/
Sets the default user-agent.
networkActionSetDefaultUserAgent 1 param → default
GET
/JSON/network/action/setDnsTtlSuccessfulQueries/
Sets the TTL of successful DNS queries.
networkActionSetDnsTtlSuccessfulQueries 1 param → default
GET
/JSON/network/action/setHttpProxy/
Sets the HTTP proxy configuration.
networkActionSetHttpProxy 5 params → default
GET
/JSON/network/action/setHttpProxyAuthEnabled/
Sets whether or not the HTTP proxy authentication is enabled.
networkActionSetHttpProxyAuthEnabled 1 param → default
GET
/JSON/network/action/setHttpProxyEnabled/
Sets whether or not the HTTP proxy is enabled.
networkActionSetHttpProxyEnabled 1 param → default
GET
/JSON/network/action/setHttpProxyExclusionEnabled/
Sets whether or not an HTTP proxy exclusion is enabled.
networkActionSetHttpProxyExclusionEnabled 2 params → default
GET
/JSON/network/action/setPassThroughEnabled/
Sets whether or not a pass-through is enabled.
networkActionSetPassThroughEnabled 2 params → default
GET
/JSON/network/action/setRateLimitRuleEnabled/
Set enabled state for a rate limit rule.
networkActionSetRateLimitRuleEnabled 2 params → default
GET
/JSON/network/action/setRootCaCertValidity/
Sets the Root CA certificate validity. Used when generating a new Root CA certificate.
networkActionSetRootCaCertValidity 1 param → default
GET
/JSON/network/action/setServerCertValidity/
Sets the server certificate validity. Used when generating server certificates.
networkActionSetServerCertValidity 1 param → default
GET
/JSON/network/action/setSocksProxy/
Sets the SOCKS proxy configuration.
networkActionSetSocksProxy 6 params → default
GET
/JSON/network/action/setSocksProxyEnabled/
Sets whether or not the SOCKS proxy is enabled.
networkActionSetSocksProxyEnabled 1 param → default
GET
/JSON/network/action/setUseClientCertificate/
Sets whether or not to use the active client certificate.
networkActionSetUseClientCertificate 1 param → default
GET
/JSON/network/action/setUseGlobalHttpState/
Sets whether or not to use the global HTTP state.
networkActionSetUseGlobalHttpState 1 param → default
GET
/OTHER/network/other/proxy.pac/
Provides a PAC file, proxying through the main proxy.
networkOtherProxy.pac → default
GET
/OTHER/network/other/rootCaCert/
Gets the Root CA certificate used to issue server certificates. Suitable to import into client applications (e.g. browsers).
networkOtherRootCaCert → default
GET
/OTHER/network/other/setProxy/
Sets the HTTP proxy configuration.
networkOtherSetProxy 1 param → default
GET
/JSON/network/view/getAliases/
Gets the aliases used to identify the local servers/proxies.
networkViewGetAliases → default
GET
/JSON/network/view/getConnectionTimeout/
Gets the connection timeout, in seconds.
networkViewGetConnectionTimeout → default
GET
/JSON/network/view/getDefaultUserAgent/
Gets the default user-agent.
networkViewGetDefaultUserAgent → default
GET
/JSON/network/view/getDnsTtlSuccessfulQueries/
Gets the TTL (in seconds) of successful DNS queries.
networkViewGetDnsTtlSuccessfulQueries → default
GET
/JSON/network/view/getHttpProxy/
Gets the HTTP proxy.
networkViewGetHttpProxy → default
GET
/JSON/network/view/getHttpProxyExclusions/
Gets the HTTP proxy exclusions.
networkViewGetHttpProxyExclusions → default
GET
/JSON/network/view/getLocalServers/
Gets the local servers/proxies.
networkViewGetLocalServers → default
GET
/JSON/network/view/getPassThroughs/
Gets the authorities that will pass-through the local proxies.
networkViewGetPassThroughs → default
GET
/JSON/network/view/getRateLimitRules/
List of rate limit rules.
networkViewGetRateLimitRules → default
GET
/JSON/network/view/getRootCaCertValidity/
Gets the Root CA certificate validity, in days. Used when generating a new Root CA certificate.
networkViewGetRootCaCertValidity → default
GET
/JSON/network/view/getServerCertValidity/
Gets the server certificate validity, in days. Used when generating server certificates.
networkViewGetServerCertValidity → default
GET
/JSON/network/view/getSocksProxy/
Gets the SOCKS proxy.
networkViewGetSocksProxy → default
GET
/JSON/network/view/isHttpProxyAuthEnabled/
Tells whether or not the HTTP proxy authentication is enabled.
networkViewIsHttpProxyAuthEnabled → default
GET
/JSON/network/view/isHttpProxyEnabled/
Tells whether or not the HTTP proxy is enabled.
networkViewIsHttpProxyEnabled → default
GET
/JSON/network/view/isSocksProxyEnabled/
Tells whether or not the SOCKS proxy is enabled.
networkViewIsSocksProxyEnabled → default
GET
/JSON/network/view/isUseGlobalHttpState/
Tells whether or not to 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 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 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.