Package org.zaproxy.clientapi.gen

Class Core

java.lang.Object

org.zaproxy.clientapi.gen.deprecated.CoreDeprecated

org.zaproxy.clientapi.gen.Core

public class Core
extends CoreDeprecated

This file was automatically generated.

Constructor Summary

Constructors

Constructor	Description
Core(ClientApi api)

Method Summary

Modifier and Type	Method	Description
ApiResponse	accessUrl(String url, String followredirects)	Convenient and simple action to access a URL, optionally following redirections.
ApiResponse	addProxyChainExcludedDomain(String value, String isregex, String isenabled)	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	alert(String id)	Deprecated. Use the API endpoint with the same name in the 'alert' component instead.
ApiResponse	alerts(String baseurl, String start, String count, String riskid)	Deprecated. Use the API endpoint with the same name in the 'alert' component instead.
ApiResponse	alertsSummary(String baseurl)	Deprecated. Use the API endpoint with the same name in the 'alert' component instead.
ApiResponse	childNodes(String url)	Gets the child nodes underneath the specified URL in the Sites tree
ApiResponse	clearExcludedFromProxy()	Clears the regexes of URLs excluded from the local proxies.
ApiResponse	createSbomZip(String filepath)	Create a zip file of the ZAP core and add-on SBOMs
ApiResponse	deleteAlert(String id)	Deprecated. Use the API endpoint with the same name in the 'alert' component instead.
ApiResponse	deleteAllAlerts()	Deprecated. Use the API endpoint with the same name in the 'alert' component instead.
ApiResponse	deleteSiteNode(String url, String method, String postdata)	Deletes the site node found in the Sites Tree on the basis of the URL, HTTP method, and post data (if applicable and specified).
ApiResponse	disableAllProxyChainExcludedDomains()	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	disableClientCertificate()	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	enableAllProxyChainExcludedDomains()	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	enablePKCS12ClientCertificate(String filepath, String password, String index)	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	excludedFromProxy()	Gets the regular expressions, applied to URLs, to exclude from the local proxies.
ApiResponse	excludeFromProxy(String regex)	Adds a regex of URLs that should be excluded from the local proxies.
byte[]	fileDownload(String filename)	Download a file from the transfer directory
byte[]	fileUpload(String filename, String filecontents)	Upload a file to the transfer directory.
ApiResponse	generateRootCA()	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	getLogLevel(String name)	The detailed logging config, optionally filtered based on a name (ex: starts with).
ApiResponse	homeDirectory()	Deprecated.
ApiResponse	hosts()	Gets the name of the hosts accessed through/by ZAP
byte[]	htmlreport()	Deprecated. Use the 'generate' API endpoint the 'reports' component instead.
byte[]	jsonreport()	Deprecated. Use the 'generate' API endpoint the 'reports' component instead.
ApiResponse	loadSession(String name)	Loads the session with the given name.
byte[]	mdreport()	Deprecated. Use the 'generate' API endpoint the 'reports' component instead.
ApiResponse	message(String id)	Gets the HTTP message with the given ID.
byte[]	messageHar(String id)	Deprecated. Use the API endpoints in the 'exim' add-on instead.
ApiResponse	messages(String baseurl, String start, String count)	Gets the HTTP messages sent by ZAP, request and response, optionally filtered by URL and paginated with 'start' position and 'count' of messages
ApiResponse	messagesById(String ids)	Gets the HTTP messages with the given IDs.
byte[]	messagesHar(String baseurl, String start, String count)	Deprecated. Use the API endpoints in the 'exim' add-on instead.
byte[]	messagesHarById(String ids)	Deprecated. Use the API endpoints in the 'exim' add-on instead.
ApiResponse	mode()	Gets the mode
ApiResponse	modifyProxyChainExcludedDomain(String idx, String value, String isregex, String isenabled)	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	newSession(String name, String overwrite)	Creates a new session, optionally overwriting existing files.
ApiResponse	numberOfAlerts(String baseurl, String riskid)	Deprecated. Use the API endpoint with the same name in the 'alert' component instead.
ApiResponse	numberOfMessages(String baseurl)	Gets the number of messages, optionally filtering by URL
ApiResponse	optionAlertOverridesFilePath()	Gets the path to the file with alert overrides.
ApiResponse	optionDefaultUserAgent()	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	optionDnsTtlSuccessfulQueries()	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	optionHttpState()	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	optionHttpStateEnabled()	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	optionMaximumAlertInstances()	Gets the maximum number of alert instances to include in a report.
ApiResponse	optionMergeRelatedAlerts()	Gets whether or not related alerts will be merged in any reports generated.
ApiResponse	optionProxyChainName()	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	optionProxyChainPassword()	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	optionProxyChainPort()	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	optionProxyChainPrompt()	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	optionProxyChainRealm()	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	optionProxyChainSkipName()	Deprecated.
ApiResponse	optionProxyChainUserName()	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	optionProxyExcludedDomains()	Deprecated.
ApiResponse	optionProxyExcludedDomainsEnabled()	Deprecated.
ApiResponse	optionSingleCookieRequestHeader()	Deprecated. Option no longer in effective use.
ApiResponse	optionTimeoutInSecs()	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	optionUseProxyChain()	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	optionUseProxyChainAuth()	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	optionUseSocksProxy()	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	proxyChainExcludedDomains()	Deprecated. Use the API endpoints in the 'network' component instead.
byte[]	proxypac()	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	removeProxyChainExcludedDomain(String idx)	Deprecated. Use the API endpoints in the 'network' component instead.
byte[]	rootcert()	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	runGarbageCollection()
ApiResponse	saveSession(String name, String overwrite)	Saves the session.
byte[]	sendHarRequest(String request, String followredirects)	Deprecated. Use the API endpoints in the 'exim' add-on instead.
ApiResponse	sendRequest(String request, String followredirects)	Sends the HTTP request, optionally following redirections.
ApiResponse	sessionLocation()	Gets the location of the current session file
ApiResponse	setHomeDirectory(String dir)
ApiResponse	setLogLevel(String name, String loglevel)	Sets the logging level for a given logger name.
ApiResponse	setMode(String mode)	Sets the mode, which may be one of [safe, protect, standard, attack]
ApiResponse	setOptionAlertOverridesFilePath(String filepath)	Sets (or clears, if empty) the path to the file with alert overrides.
ApiResponse	setOptionDefaultUserAgent(String string)	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	setOptionDnsTtlSuccessfulQueries(int i)	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	setOptionHttpStateEnabled(boolean bool)	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	setOptionMaximumAlertInstances(String numberofinstances)	Sets the maximum number of alert instances to include in a report.
ApiResponse	setOptionMergeRelatedAlerts(String enabled)	Sets whether or not related alerts will be merged in any reports generated.
ApiResponse	setOptionProxyChainName(String string)	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	setOptionProxyChainPassword(String string)	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	setOptionProxyChainPort(int i)	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	setOptionProxyChainPrompt(boolean bool)	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	setOptionProxyChainRealm(String string)	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	setOptionProxyChainSkipName(String string)	Deprecated. Option no longer in effective use.
ApiResponse	setOptionProxyChainUserName(String string)	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	setOptionSingleCookieRequestHeader(boolean bool)	Deprecated. Option no longer in effective use.
ApiResponse	setOptionTimeoutInSecs(int i)	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	setOptionUseProxyChain(boolean bool)	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	setOptionUseProxyChainAuth(boolean bool)	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	setOptionUseSocksProxy(boolean bool)	Deprecated. Use the API endpoints in the 'network' component instead.
byte[]	setproxy(String proxy)	Deprecated. Use the API endpoints in the 'network' component instead.
ApiResponse	shutdown()	Shuts down ZAP
ApiResponse	sites()	Gets the sites accessed through/by ZAP (scheme and domain)
ApiResponse	snapshotSession(String name, String overwrite)	Snapshots the session, optionally with the given name, and overwriting existing files.
ApiResponse	urls(String baseurl)	Gets the URLs accessed through/by ZAP, optionally filtering by (base) URL.
ApiResponse	version()	Gets ZAP version
byte[]	xmlreport()	Deprecated. Use the 'generate' API endpoint the 'reports' component instead.
ApiResponse	zapHomePath()	Gets the path to ZAP's home directory.

Methods inherited from class org.zaproxy.clientapi.gen.deprecated.CoreDeprecated

accessUrl, alerts, clearExcludedFromProxy, deleteAllAlerts, deleteSiteNode, excludeFromProxy, generateRootCA, htmlreport, loadSession, messageHar, messagesHar, newSession, numberOfAlerts, proxypac, rootcert, runGarbageCollection, saveSession, sendHarRequest, sendRequest, setHomeDirectory, setMode, setOptionDefaultUserAgent, setOptionHttpStateEnabled, setOptionProxyChainName, setOptionProxyChainPassword, setOptionProxyChainPort, setOptionProxyChainPrompt, setOptionProxyChainRealm, setOptionProxyChainSkipName, setOptionProxyChainUserName, setOptionSingleCookieRequestHeader, setOptionTimeoutInSecs, setOptionUseProxyChain, setOptionUseProxyChainAuth, setproxy, shutdown, snapshotSession, snapshotSession, urls, xmlreport

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Core

public Core(ClientApi api)

Method Details

hosts

public ApiResponse hosts()
                  throws ClientApiException

Gets the name of the hosts accessed through/by ZAP

Throws:

ClientApiException

sites

public ApiResponse sites()
                  throws ClientApiException

Gets the sites accessed through/by ZAP (scheme and domain)

Throws:

ClientApiException

urls

public ApiResponse urls(String baseurl)
                 throws ClientApiException

Gets the URLs accessed through/by ZAP, optionally filtering by (base) URL.

Throws:

ClientApiException

childNodes

public ApiResponse childNodes(String url)
                       throws ClientApiException

Gets the child nodes underneath the specified URL in the Sites tree

Throws:

ClientApiException

message

public ApiResponse message(String id)
                    throws ClientApiException

Gets the HTTP message with the given ID. Returns the ID, request/response headers and bodies, cookies, note, type, RTT, and timestamp.

Throws:

ClientApiException

messages

public ApiResponse messages(String baseurl,
 String start,
 String count)
                     throws ClientApiException

Gets the HTTP messages sent by ZAP, request and response, optionally filtered by URL and paginated with 'start' position and 'count' of messages

Throws:

ClientApiException

messagesById

public ApiResponse messagesById(String ids)
                         throws ClientApiException

Gets the HTTP messages with the given IDs.

Throws:

ClientApiException

numberOfMessages

public ApiResponse numberOfMessages(String baseurl)
                             throws ClientApiException

Gets the number of messages, optionally filtering by URL

Throws:

ClientApiException

mode

public ApiResponse mode()
                 throws ClientApiException

Gets the mode

Throws:

ClientApiException

version

public ApiResponse version()
                    throws ClientApiException

Gets ZAP version

Throws:

ClientApiException

excludedFromProxy

public ApiResponse excludedFromProxy()
                              throws ClientApiException

Gets the regular expressions, applied to URLs, to exclude from the local proxies.

Throws:

ClientApiException

sessionLocation

public ApiResponse sessionLocation()
                            throws ClientApiException

Gets the location of the current session file

Throws:

ClientApiException

proxyChainExcludedDomains

@Deprecated
public ApiResponse proxyChainExcludedDomains()
                                      throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Gets all the domains that are excluded from the outgoing proxy. For each domain the following are shown: the index, the value (domain), if enabled, and if specified as a regex.

Throws:

ClientApiException

zapHomePath

public ApiResponse zapHomePath()
                        throws ClientApiException

Gets the path to ZAP's home directory.

Throws:

ClientApiException

optionMaximumAlertInstances

public ApiResponse optionMaximumAlertInstances()
                                        throws ClientApiException

Gets the maximum number of alert instances to include in a report.

Throws:

ClientApiException

optionMergeRelatedAlerts

public ApiResponse optionMergeRelatedAlerts()
                                     throws ClientApiException

Gets whether or not related alerts will be merged in any reports generated.

Throws:

ClientApiException

optionAlertOverridesFilePath

public ApiResponse optionAlertOverridesFilePath()
                                         throws ClientApiException

Gets the path to the file with alert overrides.

Throws:

ClientApiException

homeDirectory

@Deprecated
public ApiResponse homeDirectory()
                          throws ClientApiException

Deprecated.

Throws:

ClientApiException

optionProxyChainSkipName

@Deprecated
public ApiResponse optionProxyChainSkipName()
                                     throws ClientApiException

Deprecated.

Use view proxyChainExcludedDomains instead.

Throws:

ClientApiException

optionProxyExcludedDomains

@Deprecated
public ApiResponse optionProxyExcludedDomains()
                                       throws ClientApiException

Deprecated.

Use view proxyChainExcludedDomains instead.

Throws:

ClientApiException

optionProxyExcludedDomainsEnabled

@Deprecated
public ApiResponse optionProxyExcludedDomainsEnabled()
                                              throws ClientApiException

Deprecated.

Use view proxyChainExcludedDomains instead.

Throws:

ClientApiException

alert

@Deprecated
public ApiResponse alert(String id)
                  throws ClientApiException

Deprecated.

Use the API endpoint with the same name in the 'alert' component instead.

Gets the alert with the given ID, the corresponding HTTP message can be obtained with the 'messageId' field and 'message' API method

Throws:

ClientApiException

alerts

@Deprecated
public ApiResponse alerts(String baseurl,
 String start,
 String count,
 String riskid)
                   throws ClientApiException

Deprecated.

Use the API endpoint with the same name in the 'alert' component instead.

Gets the alerts raised by ZAP, optionally filtering by URL or riskId, and paginating with 'start' position and 'count' of alerts

Throws:

ClientApiException

alertsSummary

@Deprecated
public ApiResponse alertsSummary(String baseurl)
                          throws ClientApiException

Deprecated.

Use the API endpoint with the same name in the 'alert' component instead.

Gets number of alerts grouped by each risk level, optionally filtering by URL

Throws:

ClientApiException

numberOfAlerts

@Deprecated
public ApiResponse numberOfAlerts(String baseurl,
 String riskid)
                           throws ClientApiException

Deprecated.

Use the API endpoint with the same name in the 'alert' component instead.

Gets the number of alerts, optionally filtering by URL or riskId

Throws:

ClientApiException

getLogLevel

public ApiResponse getLogLevel(String name)
                        throws ClientApiException

The detailed logging config, optionally filtered based on a name (ex: starts with).

Throws:

ClientApiException

optionDefaultUserAgent

@Deprecated
public ApiResponse optionDefaultUserAgent()
                                   throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Gets the user agent that ZAP should use when creating HTTP messages (for example, spider messages or CONNECT requests to outgoing proxy).

Throws:

ClientApiException

optionDnsTtlSuccessfulQueries

@Deprecated
public ApiResponse optionDnsTtlSuccessfulQueries()
                                          throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Gets the TTL (in seconds) of successful DNS queries.

Throws:

ClientApiException

optionHttpState

@Deprecated
public ApiResponse optionHttpState()
                            throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Throws:

ClientApiException

optionHttpStateEnabled

@Deprecated
public ApiResponse optionHttpStateEnabled()
                                   throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Throws:

ClientApiException

optionProxyChainName

@Deprecated
public ApiResponse optionProxyChainName()
                                 throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Throws:

ClientApiException

optionProxyChainPassword

@Deprecated
public ApiResponse optionProxyChainPassword()
                                     throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Throws:

ClientApiException

optionProxyChainPort

@Deprecated
public ApiResponse optionProxyChainPort()
                                 throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Throws:

ClientApiException

optionProxyChainPrompt

@Deprecated
public ApiResponse optionProxyChainPrompt()
                                   throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Throws:

ClientApiException

optionProxyChainRealm

@Deprecated
public ApiResponse optionProxyChainRealm()
                                  throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Throws:

ClientApiException

optionProxyChainUserName

@Deprecated
public ApiResponse optionProxyChainUserName()
                                     throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Throws:

ClientApiException

optionSingleCookieRequestHeader

@Deprecated
public ApiResponse optionSingleCookieRequestHeader()
                                            throws ClientApiException

Deprecated.

Option no longer in effective use.

Throws:

ClientApiException

optionTimeoutInSecs

@Deprecated
public ApiResponse optionTimeoutInSecs()
                                throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Gets the connection time out (in seconds).

Throws:

ClientApiException

optionUseProxyChain

@Deprecated
public ApiResponse optionUseProxyChain()
                                throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Throws:

ClientApiException

optionUseProxyChainAuth

@Deprecated
public ApiResponse optionUseProxyChainAuth()
                                    throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Throws:

ClientApiException

optionUseSocksProxy

@Deprecated
public ApiResponse optionUseSocksProxy()
                                throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Gets whether or not the SOCKS proxy should be used.

Throws:

ClientApiException

accessUrl

public ApiResponse accessUrl(String url,
 String followredirects)
                      throws ClientApiException

Convenient and simple action to access a URL, optionally following redirections. Returns the request sent and response received and followed redirections, if any. Other actions are available which offer more control on what is sent, like, 'sendRequest' or 'sendHarRequest'.

Throws:

ClientApiException

shutdown

public ApiResponse shutdown()
                     throws ClientApiException

Shuts down ZAP

Throws:

ClientApiException

newSession

public ApiResponse newSession(String name,
 String overwrite)
                       throws ClientApiException

Creates a new session, optionally overwriting existing files. If a relative path is specified it will be resolved against the "session" directory in ZAP "home" dir.

Throws:

ClientApiException

loadSession

public ApiResponse loadSession(String name)
                        throws ClientApiException

Loads the session with the given name. If a relative path is specified it will be resolved against the "session" directory in ZAP "home" dir.

Throws:

ClientApiException

saveSession

public ApiResponse saveSession(String name,
 String overwrite)
                        throws ClientApiException

Saves the session.

Throws:

ClientApiException

snapshotSession

public ApiResponse snapshotSession(String name,
 String overwrite)
                            throws ClientApiException

Snapshots the session, optionally with the given name, and overwriting existing files. If no name is specified the name of the current session with a timestamp appended is used. If a relative path is specified it will be resolved against the "session" directory in ZAP "home" dir.

Throws:

ClientApiException

clearExcludedFromProxy

public ApiResponse clearExcludedFromProxy()
                                   throws ClientApiException

Clears the regexes of URLs excluded from the local proxies.

Throws:

ClientApiException

excludeFromProxy

public ApiResponse excludeFromProxy(String regex)
                             throws ClientApiException

Adds a regex of URLs that should be excluded from the local proxies.

Throws:

ClientApiException

setHomeDirectory

public ApiResponse setHomeDirectory(String dir)
                             throws ClientApiException

Throws:

ClientApiException

setMode

public ApiResponse setMode(String mode)
                    throws ClientApiException

Sets the mode, which may be one of [safe, protect, standard, attack]

Throws:

ClientApiException

generateRootCA

@Deprecated
public ApiResponse generateRootCA()
                           throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Generates a new Root CA certificate for the local proxies.

Throws:

ClientApiException

sendRequest

public ApiResponse sendRequest(String request,
 String followredirects)
                        throws ClientApiException

Sends the HTTP request, optionally following redirections. Returns the request sent and response received and followed redirections, if any. The Mode is enforced when sending the request (and following redirections), custom manual requests are not allowed in 'Safe' mode nor in 'Protected' mode if out of scope.

Throws:

ClientApiException

runGarbageCollection

public ApiResponse runGarbageCollection()
                                 throws ClientApiException

Throws:

ClientApiException

deleteSiteNode

public ApiResponse deleteSiteNode(String url,
 String method,
 String postdata)
                           throws ClientApiException

Deletes the site node found in the Sites Tree on the basis of the URL, HTTP method, and post data (if applicable and specified).

Throws:

ClientApiException

addProxyChainExcludedDomain

@Deprecated
public ApiResponse addProxyChainExcludedDomain(String value,
 String isregex,
 String isenabled)
                                        throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Adds a domain to be excluded from the outgoing proxy, using the specified value. Optionally sets if the new entry is enabled (default, true) and whether or not the new value is specified as a regex (default, false).

Throws:

ClientApiException

modifyProxyChainExcludedDomain

@Deprecated
public ApiResponse modifyProxyChainExcludedDomain(String idx,
 String value,
 String isregex,
 String isenabled)
                                           throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Modifies a domain excluded from the outgoing proxy. Allows to modify the value, if enabled or if a regex. The domain is selected with its index, which can be obtained with the view proxyChainExcludedDomains.

Throws:

ClientApiException

removeProxyChainExcludedDomain

@Deprecated
public ApiResponse removeProxyChainExcludedDomain(String idx)
                                           throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Removes a domain excluded from the outgoing proxy, with the given index. The index can be obtained with the view proxyChainExcludedDomains.

Throws:

ClientApiException

enableAllProxyChainExcludedDomains

@Deprecated
public ApiResponse enableAllProxyChainExcludedDomains()
                                               throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Enables all domains excluded from the outgoing proxy.

Throws:

ClientApiException

disableAllProxyChainExcludedDomains

@Deprecated
public ApiResponse disableAllProxyChainExcludedDomains()
                                                throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Disables all domains excluded from the outgoing proxy.

Throws:

ClientApiException

setOptionMaximumAlertInstances

public ApiResponse setOptionMaximumAlertInstances(String numberofinstances)
                                           throws ClientApiException

Sets the maximum number of alert instances to include in a report. A value of zero is treated as unlimited.

Throws:

ClientApiException

setOptionMergeRelatedAlerts

public ApiResponse setOptionMergeRelatedAlerts(String enabled)
                                        throws ClientApiException

Sets whether or not related alerts will be merged in any reports generated.

Throws:

ClientApiException

setOptionAlertOverridesFilePath

public ApiResponse setOptionAlertOverridesFilePath(String filepath)
                                            throws ClientApiException

Sets (or clears, if empty) the path to the file with alert overrides.

Throws:

ClientApiException

enablePKCS12ClientCertificate

@Deprecated
public ApiResponse enablePKCS12ClientCertificate(String filepath,
 String password,
 String index)
                                          throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Enables use of a PKCS12 client certificate for the certificate with the given file system path, password, and optional index.

Throws:

ClientApiException

disableClientCertificate

@Deprecated
public ApiResponse disableClientCertificate()
                                     throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Disables the option for use of client certificates.

Throws:

ClientApiException

createSbomZip

public ApiResponse createSbomZip(String filepath)
                          throws ClientApiException

Create a zip file of the ZAP core and add-on SBOMs

Throws:

ClientApiException

deleteAllAlerts

@Deprecated
public ApiResponse deleteAllAlerts()
                            throws ClientApiException

Deprecated.

Use the API endpoint with the same name in the 'alert' component instead.

Deletes all alerts of the current session.

Throws:

ClientApiException

deleteAlert

@Deprecated
public ApiResponse deleteAlert(String id)
                        throws ClientApiException

Deprecated.

Use the API endpoint with the same name in the 'alert' component instead.

Deletes the alert with the given ID.

Throws:

ClientApiException

setLogLevel

public ApiResponse setLogLevel(String name,
 String loglevel)
                        throws ClientApiException

Sets the logging level for a given logger name.

Throws:

ClientApiException

setOptionDefaultUserAgent

@Deprecated
public ApiResponse setOptionDefaultUserAgent(String string)
                                      throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Sets the user agent that ZAP should use when creating HTTP messages (for example, spider messages or CONNECT requests to outgoing proxy).

Throws:

ClientApiException

setOptionDnsTtlSuccessfulQueries

@Deprecated
public ApiResponse setOptionDnsTtlSuccessfulQueries(int i)
                                             throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Sets the TTL (in seconds) of successful DNS queries (applies after ZAP restart).

Throws:

ClientApiException

setOptionHttpStateEnabled

@Deprecated
public ApiResponse setOptionHttpStateEnabled(boolean bool)
                                      throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Throws:

ClientApiException

setOptionProxyChainName

@Deprecated
public ApiResponse setOptionProxyChainName(String string)
                                    throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Throws:

ClientApiException

setOptionProxyChainPassword

@Deprecated
public ApiResponse setOptionProxyChainPassword(String string)
                                        throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Throws:

ClientApiException

setOptionProxyChainPort

@Deprecated
public ApiResponse setOptionProxyChainPort(int i)
                                    throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Throws:

ClientApiException

setOptionProxyChainPrompt

@Deprecated
public ApiResponse setOptionProxyChainPrompt(boolean bool)
                                      throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Throws:

ClientApiException

setOptionProxyChainRealm

@Deprecated
public ApiResponse setOptionProxyChainRealm(String string)
                                     throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Throws:

ClientApiException

setOptionProxyChainSkipName

@Deprecated
public ApiResponse setOptionProxyChainSkipName(String string)
                                        throws ClientApiException

Deprecated.

Option no longer in effective use.

Use actions [add|modify|remove]ProxyChainExcludedDomain instead.

Throws:

ClientApiException

setOptionProxyChainUserName

@Deprecated
public ApiResponse setOptionProxyChainUserName(String string)
                                        throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Throws:

ClientApiException

setOptionSingleCookieRequestHeader

@Deprecated
public ApiResponse setOptionSingleCookieRequestHeader(boolean bool)
                                               throws ClientApiException

Deprecated.

Option no longer in effective use.

Throws:

ClientApiException

setOptionTimeoutInSecs

@Deprecated
public ApiResponse setOptionTimeoutInSecs(int i)
                                   throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Sets the connection time out (in seconds).

Throws:

ClientApiException

setOptionUseProxyChain

@Deprecated
public ApiResponse setOptionUseProxyChain(boolean bool)
                                   throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Sets whether or not the outgoing proxy should be used. The address/hostname of the outgoing proxy must be set to enable this option.

Throws:

ClientApiException

setOptionUseProxyChainAuth

@Deprecated
public ApiResponse setOptionUseProxyChainAuth(boolean bool)
                                       throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Throws:

ClientApiException

setOptionUseSocksProxy

@Deprecated
public ApiResponse setOptionUseSocksProxy(boolean bool)
                                   throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Sets whether or not the SOCKS proxy should be used.

Throws:

ClientApiException

proxypac

@Deprecated
public byte[] proxypac()
                throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Throws:

ClientApiException

rootcert

@Deprecated
public byte[] rootcert()
                throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Gets the Root CA certificate used by the local proxies.

Throws:

ClientApiException

setproxy

@Deprecated
public byte[] setproxy(String proxy)
                throws ClientApiException

Deprecated.

Use the API endpoints in the 'network' component instead.

Throws:

ClientApiException

xmlreport

@Deprecated
public byte[] xmlreport()
                 throws ClientApiException

Deprecated.

Use the 'generate' API endpoint the 'reports' component instead.

Generates a report in XML format

Throws:

ClientApiException

htmlreport

@Deprecated
public byte[] htmlreport()
                  throws ClientApiException

Deprecated.

Use the 'generate' API endpoint the 'reports' component instead.

Generates a report in HTML format

Throws:

ClientApiException

jsonreport

@Deprecated
public byte[] jsonreport()
                  throws ClientApiException

Deprecated.

Use the 'generate' API endpoint the 'reports' component instead.

Generates a report in JSON format

Throws:

ClientApiException

mdreport

@Deprecated
public byte[] mdreport()
                throws ClientApiException

Deprecated.

Use the 'generate' API endpoint the 'reports' component instead.

Generates a report in Markdown format

Throws:

ClientApiException

messageHar

@Deprecated
public byte[] messageHar(String id)
                  throws ClientApiException

Deprecated.

Use the API endpoints in the 'exim' add-on instead.

Gets the message with the given ID in HAR format

Throws:

ClientApiException

messagesHar

@Deprecated
public byte[] messagesHar(String baseurl,
 String start,
 String count)
                   throws ClientApiException

Deprecated.

Use the API endpoints in the 'exim' add-on instead.

Gets the HTTP messages sent through/by ZAP, in HAR format, optionally filtered by URL and paginated with 'start' position and 'count' of messages

Throws:

ClientApiException

messagesHarById

@Deprecated
public byte[] messagesHarById(String ids)
                       throws ClientApiException

Deprecated.

Use the API endpoints in the 'exim' add-on instead.

Gets the HTTP messages with the given IDs, in HAR format.

Throws:

ClientApiException

sendHarRequest

@Deprecated
public byte[] sendHarRequest(String request,
 String followredirects)
                      throws ClientApiException

Deprecated.

Use the API endpoints in the 'exim' add-on instead.

Sends the first HAR request entry, optionally following redirections. Returns, in HAR format, the request sent and response received and followed redirections, if any. The Mode is enforced when sending the request (and following redirections), custom manual requests are not allowed in 'Safe' mode nor in 'Protected' mode if out of scope.

Throws:

ClientApiException

fileDownload

public byte[] fileDownload(String filename)
                    throws ClientApiException

Download a file from the transfer directory

Throws:

ClientApiException

fileUpload

public byte[] fileUpload(String filename,
 String filecontents)
                  throws ClientApiException

Upload a file to the transfer directory. Only POST requests accepted with encodings of "multipart/form-data" or "application/x-www-form-urlencoded".

Throws:

ClientApiException