ZAP API UI

Component: network

Allows to access and configure core networking capabilities.

Views

getAliasesGets the aliases used to identify the local servers/proxies.
getConnectionTimeoutGets the connection timeout, in seconds.
getDefaultUserAgentGets the default user-agent.
getDnsTtlSuccessfulQueriesGets the TTL (in seconds) of successful DNS queries.
getHttpProxyGets the HTTP proxy.
getHttpProxyExclusionsGets the HTTP proxy exclusions.
getLocalServersGets the local servers/proxies.
getPassThroughsGets the authorities that will pass-through the local proxies.
getRateLimitRulesList of rate limit rules.
getRootCaCertValidityGets the Root CA certificate validity, in days. Used when generating a new Root CA certificate.
getServerCertValidityGets the server certificate validity, in days. Used when generating server certificates.
getSocksProxyGets the SOCKS proxy.
isHttpProxyAuthEnabledTells whether or not the HTTP proxy authentication is enabled.
isHttpProxyEnabledTells whether or not the HTTP proxy is enabled.
isSocksProxyEnabledTells whether or not the SOCKS proxy is enabled.
isUseGlobalHttpStateTells whether or not to use global HTTP state.

Actions

addAlias (name* enabled ) Adds an alias for the local servers/proxies.
addHttpProxyExclusion (host* enabled ) Adds a host to be excluded from the HTTP proxy.
addLocalServer (address* port* api proxy behindNat decodeResponse removeAcceptEncoding ) Adds a local server/proxy.
addPassThrough (authority* enabled ) Adds an authority to pass-through the local proxies.
addPkcs12ClientCertificate (filePath* password* index ) Adds a client certificate contained in a PKCS#12 file, the certificate is automatically set as active and used.
addRateLimitRule (description* enabled* matchRegex* matchString* requestsPerSecond* groupBy* ) Adds a rate limit rule
generateRootCaCertGenerates a new Root CA certificate, used to issue server certificates.
importRootCaCert (filePath* ) Imports a Root CA certificate to be used to issue server certificates.
removeAlias (name* ) Removes an alias.
removeHttpProxyExclusion (host* ) Removes an HTTP proxy exclusion.
removeLocalServer (address* port* ) Removes a local server/proxy.
removePassThrough (authority* ) Removes a pass-through.
removeRateLimitRule (description* ) Remove a rate limit rule
setAliasEnabled (name* enabled* ) Sets whether or not an alias is enabled.
setConnectionTimeout (timeout* ) Sets the timeout, for reads and connects.
setDefaultUserAgent (userAgent* ) Sets the default user-agent.
setDnsTtlSuccessfulQueries (ttl* ) Sets the TTL of successful DNS queries.
setHttpProxy (host* port* realm username password ) Sets the HTTP proxy configuration.
setHttpProxyAuthEnabled (enabled* ) Sets whether or not the HTTP proxy authentication is enabled.
setHttpProxyEnabled (enabled* ) Sets whether or not the HTTP proxy is enabled.
setHttpProxyExclusionEnabled (host* enabled* ) Sets whether or not an HTTP proxy exclusion is enabled.
setPassThroughEnabled (authority* enabled* ) Sets whether or not a pass-through is enabled.
setRateLimitRuleEnabled (description* enabled* ) Set enabled state for a rate limit rule.
setRootCaCertValidity (validity* ) Sets the Root CA certificate validity. Used when generating a new Root CA certificate.
setServerCertValidity (validity* ) Sets the server certificate validity. Used when generating server certificates.
setSocksProxy (host* port* version useDns username password ) Sets the SOCKS proxy configuration.
setSocksProxyEnabled (enabled* ) Sets whether or not the SOCKS proxy is enabled.
setUseClientCertificate (use* ) Sets whether or not to use the active client certificate.
setUseGlobalHttpState (use* ) Sets whether or not to use the global HTTP state.

Others

proxy.pacProvides a PAC file, proxying through the main proxy.
rootCaCertGets the Root CA certificate used to issue server certificates. Suitable to import into client applications (e.g. browsers).
setProxy (proxy* ) Sets the HTTP proxy configuration.