default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
autoupdateActionInstallLocalAddon
- +coreActionSetOptionUseProxyChain
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/autoupdate/action/installLocalAddon/?file=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/action/setOptionUseProxyChain/?Boolean=true \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/autoupdate/action/installLocalAddon/?file=string");
+URL obj = new URL("http://zap/JSON/core/action/setOptionUseProxyChain/?Boolean=true");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -6140,35 +24924,114 @@ curl -X GET http://zap/JSON/autoupdate/action/installLoc
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/autoupdate/action/installLocalAddon/', params={
- 'file': 'string'
+r = requests.get('http://zap/JSON/core/action/setOptionUseProxyChain/', params={
+ 'Boolean': 'true'
}, headers = headers)
-print r.json()
+print(r.json())
+
+GET /JSON/core/action/setOptionUseProxyChain/
Use the API endpoints in the 'network' component instead.
+ +Parameters
+ +| Name | +In | +Type | +Required | +Description | +
|---|---|---|---|---|
| Boolean | +query | +boolean | +true | +none | +
++Example responses
+ +default Response
+
{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+Responses
+ +| Status | +Meaning | +Description | +Schema | +
|---|---|---|---|
| default | +Default | +Error of JSON endpoints. | +ErrorJson | +
coreActionSetOptionUseProxyChainAuth
+ + +++Code samples
+
# You can also use wget
+curl -X GET http://zap/JSON/core/action/setOptionUseProxyChainAuth/?Boolean=true \
+ -H 'Accept: application/json'
-require 'rest-client'
-require 'json'
+URL obj = new URL("http://zap/JSON/core/action/setOptionUseProxyChainAuth/?Boolean=true");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+import requests
headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/autoupdate/action/installLocalAddon/',
- params: {
- 'file' => 'string'
-}, headers: headers
+r = requests.get('http://zap/JSON/core/action/setOptionUseProxyChainAuth/', params={
+ 'Boolean': 'true'
+}, headers = headers)
-p JSON.parse(result)
+print(r.json())
GET /JSON/autoupdate/action/installLocalAddon/
GET /JSON/core/action/setOptionUseProxyChainAuth/
Parameters
+Use the API endpoints in the 'network' component instead.
+ +Parameters
| file | +Boolean | query | -string | +boolean | true | none |
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
autoupdateActionUninstallAddon
- +coreActionSetOptionUseSocksProxy
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/autoupdate/action/uninstallAddon/?id=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/action/setOptionUseSocksProxy/?Boolean=true \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/autoupdate/action/uninstallAddon/?id=string");
+URL obj = new URL("http://zap/JSON/core/action/setOptionUseSocksProxy/?Boolean=true");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -6247,37 +25110,183 @@ curl -X GET http://zap/JSON/autoupdate/action/uninstallA
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/autoupdate/action/uninstallAddon/', params={
- 'id': 'string'
+r = requests.get('http://zap/JSON/core/action/setOptionUseSocksProxy/', params={
+ 'Boolean': 'true'
}, headers = headers)
-print r.json()
+print(r.json())
+
+GET /JSON/core/action/setOptionUseSocksProxy/
Use the API endpoints in the 'network' component instead.
+ +Parameters
+ +| Name | +In | +Type | +Required | +Description | +
|---|---|---|---|---|
| Boolean | +query | +boolean | +true | +true if the SOCKS proxy should be used, false otherwise. | +
++Example responses
+ +default Response
+
{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+Responses
+ +| Status | +Meaning | +Description | +Schema | +
|---|---|---|---|
| default | +Default | +Error of JSON endpoints. | +ErrorJson | +
coreActionShutdown
+ + +++Code samples
+
# You can also use wget
+curl -X GET http://zap/JSON/core/action/shutdown/ \
+ -H 'Accept: application/json'
-require 'rest-client'
-require 'json'
+URL obj = new URL("http://zap/JSON/core/action/shutdown/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+import requests
headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/autoupdate/action/uninstallAddon/',
- params: {
- 'id' => 'string'
-}, headers: headers
+r = requests.get('http://zap/JSON/core/action/shutdown/', headers = headers)
-p JSON.parse(result)
+print(r.json())
GET /JSON/autoupdate/action/uninstallAddon/
GET /JSON/core/action/shutdown/
Uninstalls the specified add-on
+Shuts down ZAP
-Parameters
+++Example responses
+ +default Response
+
{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+Responses
+ +| Status | +Meaning | +Description | +Schema | +
|---|---|---|---|
| default | +Default | +Error of JSON endpoints. | +ErrorJson | +
coreActionSnapshotSession
+ + +++Code samples
+
# You can also use wget
+curl -X GET http://zap/JSON/core/action/snapshotSession/ \
+ -H 'Accept: application/json'
+
+URL obj = new URL("http://zap/JSON/core/action/snapshotSession/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/core/action/snapshotSession/', headers = headers)
+
+print(r.json())
+
+GET /JSON/core/action/snapshotSession/
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.
+ +Parameters
| id | +name | query | string | -true | +false | +none | +
| overwrite | +query | +string | +false | none |
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
autoupdateActionSetOptionCheckAddonUpdates
- +coreOtherFileDownload
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/autoupdate/action/setOptionCheckAddonUpdates/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/OTHER/core/other/fileDownload/?fileName=string \
+ -H 'Accept: */*'
-URL obj = new URL("http://zap/JSON/autoupdate/action/setOptionCheckAddonUpdates/?Boolean=string");
+URL obj = new URL("http://zap/OTHER/core/other/fileDownload/?fileName=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -6356,35 +25372,21 @@ curl -X GET http://zap/JSON/autoupdate/action/setOptionC
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': '*/*'
}
-r = requests.get('http://zap/JSON/autoupdate/action/setOptionCheckAddonUpdates/', params={
- 'Boolean': 'string'
+r = requests.get('http://zap/OTHER/core/other/fileDownload/', params={
+ 'fileName': 'string'
}, headers = headers)
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/autoupdate/action/setOptionCheckAddonUpdates/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.content)
GET /JSON/autoupdate/action/setOptionCheckAddonUpdates/
GET /OTHER/core/other/fileDownload/
Parameters
+Download a file from the transfer directory
+ +Parameters
| Boolean | +fileName | query | string | true | -none | +The name of the file, may include subdirectories |
-Example responses
- -default Response
{
- "message": "string",
- "code": 100
-}
-Responses
+ +Responses
| default | Default | -unexpected error | -Error | +Error of OTHER endpoints. | +None |
Response Schema
+ -autoupdateActionSetOptionCheckOnStart
- +coreOtherFileUpload
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/autoupdate/action/setOptionCheckOnStart/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/OTHER/core/other/fileUpload/?fileName=string&fileContents=string \
+ -H 'Accept: */*'
-URL obj = new URL("http://zap/JSON/autoupdate/action/setOptionCheckOnStart/?Boolean=string");
+URL obj = new URL("http://zap/OTHER/core/other/fileUpload/?fileName=string&fileContents=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -6463,35 +25460,21 @@ curl -X GET http://zap/JSON/autoupdate/action/setOptionC
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': '*/*'
}
-r = requests.get('http://zap/JSON/autoupdate/action/setOptionCheckOnStart/', params={
- 'Boolean': 'string'
+r = requests.get('http://zap/OTHER/core/other/fileUpload/', params={
+ 'fileName': 'string', 'fileContents': 'string'
}, headers = headers)
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/autoupdate/action/setOptionCheckOnStart/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.content)
GET /JSON/autoupdate/action/setOptionCheckOnStart/
GET /OTHER/core/other/fileUpload/
Parameters
+Upload a file to the transfer directory. Only POST requests accepted with encodings of "multipart/form-data" or "application/x-www-form-urlencoded".
+ +Parameters
| Boolean | +fileName | query | string | true | -none | +The name of the file, may include subdirectories. | +
| fileContents | +query | +string | +true | +The contents of the file. |
-Example responses
- -default Response
{
- "message": "string",
- "code": 100
-}
-Responses
+ +Responses
| default | Default | -unexpected error | -Error | +Error of OTHER endpoints. | +None |
Response Schema
+ -autoupdateActionSetOptionDownloadNewRelease
- +coreOtherHtmlreport
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/autoupdate/action/setOptionDownloadNewRelease/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/OTHER/core/other/htmlreport/ \
+ -H 'Accept: */*'
-URL obj = new URL("http://zap/JSON/autoupdate/action/setOptionDownloadNewRelease/?Boolean=string");
+URL obj = new URL("http://zap/OTHER/core/other/htmlreport/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -6570,65 +25555,23 @@ curl -X GET http://zap/JSON/autoupdate/action/setOptionD
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/autoupdate/action/setOptionDownloadNewRelease/', params={
- 'Boolean': 'string'
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': '*/*'
}
-result = RestClient.get 'http://zap/JSON/autoupdate/action/setOptionDownloadNewRelease/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
+r = requests.get('http://zap/OTHER/core/other/htmlreport/', headers = headers)
-p JSON.parse(result)
+print(r.content)
GET /JSON/autoupdate/action/setOptionDownloadNewRelease/
Parameters
+GET /OTHER/core/other/htmlreport/
| Name | -In | -Type | -Required | -Description | -
|---|---|---|---|---|
| Boolean | -query | -string | -true | -none | -
Use the 'generate' API endpoint the 'reports' component instead.
-Example responses
- -default Response
{
- "message": "string",
- "code": 100
-}
-Responses
+ +Responses
| default | Default | -unexpected error | -Error | +Error of OTHER endpoints. | +None |
Response Schema
+ -autoupdateActionSetOptionInstallAddonUpdates
- +coreOtherJsonreport
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/autoupdate/action/setOptionInstallAddonUpdates/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/OTHER/core/other/jsonreport/ \
+ -H 'Accept: */*'
-URL obj = new URL("http://zap/JSON/autoupdate/action/setOptionInstallAddonUpdates/?Boolean=string");
+URL obj = new URL("http://zap/OTHER/core/other/jsonreport/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -6677,65 +25621,23 @@ curl -X GET http://zap/JSON/autoupdate/action/setOptionI
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/autoupdate/action/setOptionInstallAddonUpdates/', params={
- 'Boolean': 'string'
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': '*/*'
}
-result = RestClient.get 'http://zap/JSON/autoupdate/action/setOptionInstallAddonUpdates/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
+r = requests.get('http://zap/OTHER/core/other/jsonreport/', headers = headers)
-p JSON.parse(result)
+print(r.content)
GET /JSON/autoupdate/action/setOptionInstallAddonUpdates/
Parameters
+GET /OTHER/core/other/jsonreport/
| Name | -In | -Type | -Required | -Description | -
|---|---|---|---|---|
| Boolean | -query | -string | -true | -none | -
Use the 'generate' API endpoint the 'reports' component instead.
-Example responses
- -default Response
{
- "message": "string",
- "code": 100
-}
-Responses
+ +Responses
| default | Default | -unexpected error | -Error | +Error of OTHER endpoints. | +None |
Response Schema
+ -autoupdateActionSetOptionInstallScannerRules
- +coreOtherMdreport
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/autoupdate/action/setOptionInstallScannerRules/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/OTHER/core/other/mdreport/ \
+ -H 'Accept: */*'
-URL obj = new URL("http://zap/JSON/autoupdate/action/setOptionInstallScannerRules/?Boolean=string");
+URL obj = new URL("http://zap/OTHER/core/other/mdreport/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -6784,65 +25687,23 @@ curl -X GET http://zap/JSON/autoupdate/action/setOptionI
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/autoupdate/action/setOptionInstallScannerRules/', params={
- 'Boolean': 'string'
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': '*/*'
}
-result = RestClient.get 'http://zap/JSON/autoupdate/action/setOptionInstallScannerRules/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
+r = requests.get('http://zap/OTHER/core/other/mdreport/', headers = headers)
-p JSON.parse(result)
+print(r.content)
GET /JSON/autoupdate/action/setOptionInstallScannerRules/
Parameters
+GET /OTHER/core/other/mdreport/
| Name | -In | -Type | -Required | -Description | -
|---|---|---|---|---|
| Boolean | -query | -string | -true | -none | -
Use the 'generate' API endpoint the 'reports' component instead.
-Example responses
- -default Response
{
- "message": "string",
- "code": 100
-}
-Responses
+ +Responses
| default | Default | -unexpected error | -Error | +Error of OTHER endpoints. | +None |
Response Schema
+ -autoupdateActionSetOptionReportAlphaAddons
- +coreOtherMessageHar
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/autoupdate/action/setOptionReportAlphaAddons/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/OTHER/core/other/messageHar/?id=string \
+ -H 'Accept: */*'
-URL obj = new URL("http://zap/JSON/autoupdate/action/setOptionReportAlphaAddons/?Boolean=string");
+URL obj = new URL("http://zap/OTHER/core/other/messageHar/?id=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -6891,35 +25753,21 @@ curl -X GET http://zap/JSON/autoupdate/action/setOptionR
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': '*/*'
}
-r = requests.get('http://zap/JSON/autoupdate/action/setOptionReportAlphaAddons/', params={
- 'Boolean': 'string'
+r = requests.get('http://zap/OTHER/core/other/messageHar/', params={
+ 'id': 'string'
}, headers = headers)
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/autoupdate/action/setOptionReportAlphaAddons/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.content)
GET /JSON/autoupdate/action/setOptionReportAlphaAddons/
GET /OTHER/core/other/messageHar/
Parameters
+Use the API endpoints in the 'exim' add-on instead.
+ +Parameters
| Boolean | +id | query | string | true | @@ -6941,15 +25789,9 @@ curl -X GET http://zap/JSON/autoupdate/action/setOptionR
| default | Default | -unexpected error | -Error | +Error of OTHER endpoints. | +None |
Response Schema
+ -autoupdateActionSetOptionReportBetaAddons
- +coreOtherMessagesHar
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/autoupdate/action/setOptionReportBetaAddons/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/OTHER/core/other/messagesHar/ \
+ -H 'Accept: */*'
-URL obj = new URL("http://zap/JSON/autoupdate/action/setOptionReportBetaAddons/?Boolean=string");
+URL obj = new URL("http://zap/OTHER/core/other/messagesHar/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -6998,35 +25841,19 @@ curl -X GET http://zap/JSON/autoupdate/action/setOptionR
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': '*/*'
}
-r = requests.get('http://zap/JSON/autoupdate/action/setOptionReportBetaAddons/', params={
- 'Boolean': 'string'
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/autoupdate/action/setOptionReportBetaAddons/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
+r = requests.get('http://zap/OTHER/core/other/messagesHar/', headers = headers)
-p JSON.parse(result)
+print(r.content)
GET /JSON/autoupdate/action/setOptionReportBetaAddons/
GET /OTHER/core/other/messagesHar/
Parameters
+Use the API endpoints in the 'exim' add-on instead.
+ +Parameters
| Boolean | +baseurl | query | string | -true | +false | +none | +
| start | +query | +string | +false | +none | +||
| count | +query | +string | +false | none |
-Example responses
- -default Response
{
- "message": "string",
- "code": 100
-}
-Responses
+ +Responses
| default | Default | -unexpected error | -Error | +Error of OTHER endpoints. | +None |
Response Schema
+ -autoupdateActionSetOptionReportReleaseAddons
- +coreOtherMessagesHarById
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/autoupdate/action/setOptionReportReleaseAddons/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/OTHER/core/other/messagesHarById/?ids=string \
+ -H 'Accept: */*'
-URL obj = new URL("http://zap/JSON/autoupdate/action/setOptionReportReleaseAddons/?Boolean=string");
+URL obj = new URL("http://zap/OTHER/core/other/messagesHarById/?ids=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -7105,35 +25941,21 @@ curl -X GET http://zap/JSON/autoupdate/action/setOptionR
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': '*/*'
}
-r = requests.get('http://zap/JSON/autoupdate/action/setOptionReportReleaseAddons/', params={
- 'Boolean': 'string'
+r = requests.get('http://zap/OTHER/core/other/messagesHarById/', params={
+ 'ids': 'string'
}, headers = headers)
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/autoupdate/action/setOptionReportReleaseAddons/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.content)
GET /JSON/autoupdate/action/setOptionReportReleaseAddons/
GET /OTHER/core/other/messagesHarById/
Parameters
+Use the API endpoints in the 'exim' add-on instead.
+ +Parameters
| Boolean | +ids | query | string | true | @@ -7155,15 +25977,9 @@ curl -X GET http://zap/JSON/autoupdate/action/setOptionR
| default | Default | -unexpected error | -Error | +Error of OTHER endpoints. | +None |
Response Schema
+ - -spider
-spiderViewStatus
- +coreOtherProxy.pac
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/status/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/OTHER/core/other/proxy.pac/ \
+ -H 'Accept: */*'
-URL obj = new URL("http://zap/JSON/spider/view/status/");
+URL obj = new URL("http://zap/OTHER/core/other/proxy.pac/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -7214,64 +26029,23 @@ curl -X GET http://zap/JSON/spider/view/status/ import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/spider/view/status/', params={
-
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': '*/*'
}
-result = RestClient.get 'http://zap/JSON/spider/view/status/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/OTHER/core/other/proxy.pac/', headers = headers)
-p JSON.parse(result)
+print(r.content)
GET /JSON/spider/view/status/
Parameters
+GET /OTHER/core/other/proxy.pac/
| Name | -In | -Type | -Required | -Description | -
|---|---|---|---|---|
| scanId | -query | -integer | -false | -none | -
Use the API endpoints in the 'network' component instead.
-Example responses
- -default Response
{
- "message": "string",
- "code": 100
-}
-Responses
+ +Responses
| default | Default | -unexpected error | -Error | +Error of OTHER endpoints. | +None |
Response Schema
+ -spiderViewResults
- +coreOtherRootcert
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/results/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/OTHER/core/other/rootcert/ \
+ -H 'Accept: */*'
-URL obj = new URL("http://zap/JSON/spider/view/results/");
+URL obj = new URL("http://zap/OTHER/core/other/rootcert/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -7320,64 +26095,23 @@ curl -X GET http://zap/JSON/spider/view/results/ import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/spider/view/results/', params={
-
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': '*/*'
}
-result = RestClient.get 'http://zap/JSON/spider/view/results/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/OTHER/core/other/rootcert/', headers = headers)
-p JSON.parse(result)
+print(r.content)
GET /JSON/spider/view/results/
Parameters
+GET /OTHER/core/other/rootcert/
| Name | -In | -Type | -Required | -Description | -
|---|---|---|---|---|
| scanId | -query | -integer | -false | -none | -
Use the API endpoints in the 'network' component instead.
-Example responses
- -default Response
{
- "message": "string",
- "code": 100
-}
-Responses
+ +Responses
| default | Default | -unexpected error | -Error | +Error of OTHER endpoints. | +None |
Response Schema
+ -spiderViewFullResults
- +coreOtherSendHarRequest
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/fullResults/?scanId=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/OTHER/core/other/sendHarRequest/?request=string \
+ -H 'Accept: */*'
-URL obj = new URL("http://zap/JSON/spider/view/fullResults/?scanId=0");
+URL obj = new URL("http://zap/OTHER/core/other/sendHarRequest/?request=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -7426,35 +26161,21 @@ curl -X GET http://zap/JSON/spider/view/fullResults/?sca
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': '*/*'
}
-r = requests.get('http://zap/JSON/spider/view/fullResults/', params={
- 'scanId': '0'
+r = requests.get('http://zap/OTHER/core/other/sendHarRequest/', params={
+ 'request': 'string'
}, headers = headers)
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/spider/view/fullResults/',
- params: {
- 'scanId' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.content)
GET /JSON/spider/view/fullResults/
GET /OTHER/core/other/sendHarRequest/
Parameters
+Use the API endpoints in the 'exim' add-on instead.
+ +Parameters
| scanId | +request | query | -integer | +string | true | none |
| followRedirects | +query | +string | +false | +none | +
-Example responses
- -default Response
{
- "message": "string",
- "code": 100
-}
-Responses
+ +Responses
| default | Default | -unexpected error | -Error | +Error of OTHER endpoints. | +None |
Response Schema
+ -spiderViewScans
- +coreOtherSetproxy
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/scans/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/OTHER/core/other/setproxy/?proxy=string \
+ -H 'Accept: */*'
-URL obj = new URL("http://zap/JSON/spider/view/scans/");
+URL obj = new URL("http://zap/OTHER/core/other/setproxy/?proxy=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -7533,44 +26256,45 @@ curl -X GET http://zap/JSON/spider/view/scans/ import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': '*/*'
}
-r = requests.get('http://zap/JSON/spider/view/scans/', params={
-
+r = requests.get('http://zap/OTHER/core/other/setproxy/', params={
+ 'proxy': 'string'
}, headers = headers)
-print r.json()
-
-require 'rest-client'
-require 'json'
+print(r.content)
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+GET /OTHER/core/other/setproxy/
Use the API endpoints in the 'network' component instead.
-p JSON.parse(result) +Parameters
- -GET /JSON/spider/view/scans/
| Name | +In | +Type | +Required | +Description | +
|---|---|---|---|---|
| proxy | +query | +string | +true | +none | +
-Example responses
- -default Response
{
- "message": "string",
- "code": 100
-}
-Responses
+ +Responses
| default | Default | -unexpected error | -Error | +Error of OTHER endpoints. | +None |
Response Schema
+ -spiderViewExcludedFromScan
- +coreOtherXmlreport
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/excludedFromScan/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/OTHER/core/other/xmlreport/ \
+ -H 'Accept: */*'
-URL obj = new URL("http://zap/JSON/spider/view/excludedFromScan/");
+URL obj = new URL("http://zap/OTHER/core/other/xmlreport/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -7619,46 +26344,23 @@ curl -X GET http://zap/JSON/spider/view/excludedFromScan
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/spider/view/excludedFromScan/', params={
-
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': '*/*'
}
-result = RestClient.get 'http://zap/JSON/spider/view/excludedFromScan/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/OTHER/core/other/xmlreport/', headers = headers)
-p JSON.parse(result)
+print(r.content)
GET /JSON/spider/view/excludedFromScan/
GET /OTHER/core/other/xmlreport/
Gets the regexes of URLs excluded from the spider scans.
+Use the 'generate' API endpoint the 'reports' component instead.
-Example responses
- -default Response
{
- "message": "string",
- "code": 100
-}
-Responses
+ +Responses
| default | Default | -unexpected error | -Error | +Error of OTHER endpoints. | +None |
Response Schema
+ -spiderViewAllUrls
- +coreViewAlert
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/allUrls/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/alert/?id=string \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/view/allUrls/");
+URL obj = new URL("http://zap/JSON/core/view/alert/?id=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -7707,34 +26410,39 @@ curl -X GET http://zap/JSON/spider/view/allUrls/ import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/view/allUrls/', params={
-
+r = requests.get('http://zap/JSON/core/view/alert/', params={
+ 'id': 'string'
}, headers = headers)
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+print(r.json())
-result = RestClient.get 'http://zap/JSON/spider/view/allUrls/',
- params: {
- }, headers: headers
+GET /JSON/core/view/alert/
Use the API endpoint with the same name in the 'alert' component instead.
- -GET /JSON/spider/view/allUrls/
Parameters
-Returns a list of unique URLs from the history table based on HTTP messages added by the Spider.
+| Name | +In | +Type | +Required | +Description | +
|---|---|---|---|---|
| id | +query | +string | +true | +none | +
Example responses
@@ -7742,11 +26450,12 @@ curl -X GET http://zap/JSON/spider/view/allUrls/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderViewAddedNodes
- +coreViewAlerts
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/addedNodes/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/alerts/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/view/addedNodes/");
+URL obj = new URL("http://zap/JSON/core/view/alerts/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -7795,36 +26503,19 @@ curl -X GET http://zap/JSON/spider/view/addedNodes/ import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/spider/view/addedNodes/', params={
-
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/spider/view/addedNodes/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/core/view/alerts/', headers = headers)
-p JSON.parse(result)
+print(r.json())
GET /JSON/spider/view/addedNodes/
GET /JSON/core/view/alerts/
Returns a list of the names of the nodes added to the Sites tree by the specified scan.
+Use the API endpoint with the same name in the 'alert' component instead.
-Parameters
+Parameters
| scanId | +baseurl | query | -integer | +string | +false | +The highest URL in the Sites tree under which alerts should be included. | +|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| start | +query | +string | +false | +none | +|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| count | +query | +string | +false | +none | +|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| riskId | +query | +string | false | none |
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderViewDomainsAlwaysInScope
- +coreViewAlertsSummary
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/domainsAlwaysInScope/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/alertsSummary/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/view/domainsAlwaysInScope/");
+URL obj = new URL("http://zap/JSON/core/view/alertsSummary/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -7903,34 +26615,37 @@ curl -X GET http://zap/JSON/spider/view/domainsAlwaysInS
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/view/domainsAlwaysInScope/', params={
-
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
+r = requests.get('http://zap/JSON/core/view/alertsSummary/', headers = headers)
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+print(r.json())
-result = RestClient.get 'http://zap/JSON/spider/view/domainsAlwaysInScope/',
- params: {
- }, headers: headers
+GET /JSON/core/view/alertsSummary/
Use the API endpoint with the same name in the 'alert' component instead.
- -GET /JSON/spider/view/domainsAlwaysInScope/
Parameters
-Gets all the domains that are always in scope. For each domain the following are shown: the index, the value (domain), if enabled, and if specified as a regex.
+| Name | +In | +Type | +Required | +Description | +
|---|---|---|---|---|
| baseurl | +query | +string | +false | +The highest URL in the Sites tree under which alerts should be included. | +
Example responses
@@ -7938,11 +26653,12 @@ curl -X GET http://zap/JSON/spider/view/domainsAlwaysInSdefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderViewOptionDomainsAlwaysInScope
- +coreViewChildNodes
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/optionDomainsAlwaysInScope/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/childNodes/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/view/optionDomainsAlwaysInScope/");
+URL obj = new URL("http://zap/JSON/core/view/childNodes/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -7991,34 +26706,37 @@ curl -X GET http://zap/JSON/spider/view/optionDomainsAlw
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/view/optionDomainsAlwaysInScope/', params={
+r = requests.get('http://zap/JSON/core/view/childNodes/', headers = headers)
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+print(r.json())
-result = RestClient.get 'http://zap/JSON/spider/view/optionDomainsAlwaysInScope/',
- params: {
- }, headers: headers
+GET /JSON/core/view/childNodes/
Gets the child nodes underneath the specified URL in the Sites tree
- -GET /JSON/spider/view/optionDomainsAlwaysInScope/
Parameters
-Use view domainsAlwaysInScope instead.
+| Name | +In | +Type | +Required | +Description | +
|---|---|---|---|---|
| url | +query | +string | +false | +none | +
Example responses
@@ -8026,11 +26744,12 @@ curl -X GET http://zap/JSON/spider/view/optionDomainsAlwdefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderViewOptionDomainsAlwaysInScopeEnabled
- +coreViewExcludedFromProxy
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/optionDomainsAlwaysInScopeEnabled/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/excludedFromProxy/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/view/optionDomainsAlwaysInScopeEnabled/");
+URL obj = new URL("http://zap/JSON/core/view/excludedFromProxy/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -8079,34 +26797,17 @@ curl -X GET http://zap/JSON/spider/view/optionDomainsAlw
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/spider/view/optionDomainsAlwaysInScopeEnabled/', params={
-
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/spider/view/optionDomainsAlwaysInScopeEnabled/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/core/view/excludedFromProxy/', headers = headers)
-p JSON.parse(result)
+print(r.json())
GET /JSON/spider/view/optionDomainsAlwaysInScopeEnabled/
GET /JSON/core/view/excludedFromProxy/
Use view domainsAlwaysInScope instead.
+Gets the regular expressions, applied to URLs, to exclude from the local proxies.
Example responses
@@ -8114,11 +26815,12 @@ curl -X GET http://zap/JSON/spider/view/optionDomainsAlwdefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderViewOptionHandleParameters
- +coreViewHomeDirectory
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/optionHandleParameters/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/homeDirectory/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/view/optionHandleParameters/");
+URL obj = new URL("http://zap/JSON/core/view/homeDirectory/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -8167,32 +26868,15 @@ curl -X GET http://zap/JSON/spider/view/optionHandlePara
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/spider/view/optionHandleParameters/', params={
-
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/spider/view/optionHandleParameters/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/core/view/homeDirectory/', headers = headers)
-p JSON.parse(result)
+print(r.json())
GET /JSON/spider/view/optionHandleParameters/
GET /JSON/core/view/homeDirectory/
Example responses
@@ -8200,11 +26884,12 @@ curl -X GET http://zap/JSON/spider/view/optionHandleParadefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderViewOptionMaxChildren
- +coreViewHosts
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/optionMaxChildren/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/hosts/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/view/optionMaxChildren/");
+URL obj = new URL("http://zap/JSON/core/view/hosts/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -8253,34 +26937,17 @@ curl -X GET http://zap/JSON/spider/view/optionMaxChildre
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/spider/view/optionMaxChildren/', params={
-
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/spider/view/optionMaxChildren/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/core/view/hosts/', headers = headers)
-p JSON.parse(result)
+print(r.json())
GET /JSON/spider/view/optionMaxChildren/
GET /JSON/core/view/hosts/
Gets the maximum number of child nodes (per node) that can be crawled, 0 means no limit.
+Gets the name of the hosts accessed through/by ZAP
Example responses
@@ -8288,11 +26955,12 @@ curl -X GET http://zap/JSON/spider/view/optionMaxChildredefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderViewOptionMaxDepth
- +coreViewMessage
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/optionMaxDepth/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/message/?id=string \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/view/optionMaxDepth/");
+URL obj = new URL("http://zap/JSON/core/view/message/?id=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -8341,34 +27008,39 @@ curl -X GET http://zap/JSON/spider/view/optionMaxDepth/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/view/optionMaxDepth/', params={
-
+r = requests.get('http://zap/JSON/core/view/message/', params={
+ 'id': 'string'
}, headers = headers)
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+print(r.json())
-result = RestClient.get 'http://zap/JSON/spider/view/optionMaxDepth/',
- params: {
- }, headers: headers
+GET /JSON/core/view/message/
Gets the HTTP message with the given ID. Returns the ID, request/response headers and bodies, cookies, note, type, RTT, and timestamp.
- -GET /JSON/spider/view/optionMaxDepth/
Parameters
-Gets the maximum depth the spider can crawl, 0 if unlimited.
+| Name | +In | +Type | +Required | +Description | +
|---|---|---|---|---|
| id | +query | +string | +true | +none | +
Example responses
@@ -8376,11 +27048,12 @@ curl -X GET http://zap/JSON/spider/view/optionMaxDepth/default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderViewOptionMaxDuration
- +coreViewMessages
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/optionMaxDuration/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/messages/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/view/optionMaxDuration/");
+URL obj = new URL("http://zap/JSON/core/view/messages/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -8429,32 +27101,51 @@ curl -X GET http://zap/JSON/spider/view/optionMaxDuratio
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/view/optionMaxDuration/', params={
-
-}, headers = headers)
-
-print r.json()
+r = requests.get('http://zap/JSON/core/view/messages/', headers = headers)
-require 'rest-client'
-require 'json'
+print(r.json())
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+GET /JSON/core/view/messages/
Gets the HTTP messages sent by ZAP, request and response, optionally filtered by URL and paginated with 'start' position and 'count' of messages
-p JSON.parse(result) +Parameters
- -GET /JSON/spider/view/optionMaxDuration/
| Name | +In | +Type | +Required | +Description | +
|---|---|---|---|---|
| baseurl | +query | +string | +false | +The highest URL in the Sites tree under which messages should be included. | +
| start | +query | +string | +false | +none | +
| count | +query | +string | +false | +none | +
Example responses
@@ -8462,11 +27153,12 @@ curl -X GET http://zap/JSON/spider/view/optionMaxDuratiodefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderViewOptionMaxParseSizeBytes
- +coreViewMessagesById
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/optionMaxParseSizeBytes/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/messagesById/?ids=string \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/view/optionMaxParseSizeBytes/");
+URL obj = new URL("http://zap/JSON/core/view/messagesById/?ids=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -8515,34 +27206,39 @@ curl -X GET http://zap/JSON/spider/view/optionMaxParseSi
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/view/optionMaxParseSizeBytes/', params={
-
+r = requests.get('http://zap/JSON/core/view/messagesById/', params={
+ 'ids': 'string'
}, headers = headers)
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+print(r.json())
-result = RestClient.get 'http://zap/JSON/spider/view/optionMaxParseSizeBytes/',
- params: {
- }, headers: headers
+GET /JSON/core/view/messagesById/
Gets the HTTP messages with the given IDs.
- -GET /JSON/spider/view/optionMaxParseSizeBytes/
Parameters
-Gets the maximum size, in bytes, that a response might have to be parsed.
+| Name | +In | +Type | +Required | +Description | +
|---|---|---|---|---|
| ids | +query | +string | +true | +none | +
Example responses
@@ -8550,11 +27246,12 @@ curl -X GET http://zap/JSON/spider/view/optionMaxParseSidefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderViewOptionMaxScansInUI
- +coreViewMode
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/optionMaxScansInUI/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/mode/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/view/optionMaxScansInUI/");
+URL obj = new URL("http://zap/JSON/core/view/mode/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -8603,32 +27299,17 @@ curl -X GET http://zap/JSON/spider/view/optionMaxScansIn
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/spider/view/optionMaxScansInUI/', params={
-
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/spider/view/optionMaxScansInUI/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/core/view/mode/', headers = headers)
-p JSON.parse(result)
+print(r.json())
GET /JSON/spider/view/optionMaxScansInUI/
GET /JSON/core/view/mode/
Gets the mode
Example responses
@@ -8636,11 +27317,12 @@ curl -X GET http://zap/JSON/spider/view/optionMaxScansIndefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderViewOptionRequestWaitTime
- +coreViewNumberOfAlerts
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/optionRequestWaitTime/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/numberOfAlerts/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/view/optionRequestWaitTime/");
+URL obj = new URL("http://zap/JSON/core/view/numberOfAlerts/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -8689,32 +27370,44 @@ curl -X GET http://zap/JSON/spider/view/optionRequestWai
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/view/optionRequestWaitTime/', params={
-
-}, headers = headers)
-
-print r.json()
+r = requests.get('http://zap/JSON/core/view/numberOfAlerts/', headers = headers)
-require 'rest-client'
-require 'json'
+print(r.json())
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+GET /JSON/core/view/numberOfAlerts/
Use the API endpoint with the same name in the 'alert' component instead.
-p JSON.parse(result) +Parameters
- -GET /JSON/spider/view/optionRequestWaitTime/
| Name | +In | +Type | +Required | +Description | +
|---|---|---|---|---|
| baseurl | +query | +string | +false | +The highest URL in the Sites tree under which alerts should be included. | +
| riskId | +query | +string | +false | +none | +
Example responses
@@ -8722,11 +27415,12 @@ curl -X GET http://zap/JSON/spider/view/optionRequestWaidefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderViewOptionScope
- +coreViewNumberOfMessages
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/optionScope/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/numberOfMessages/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/view/optionScope/");
+URL obj = new URL("http://zap/JSON/core/view/numberOfMessages/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -8775,32 +27468,37 @@ curl -X GET http://zap/JSON/spider/view/optionScope/ import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/view/optionScope/', params={
+r = requests.get('http://zap/JSON/core/view/numberOfMessages/', headers = headers)
-}, headers = headers)
-
-print r.json()
+print(r.json())
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+GET /JSON/core/view/numberOfMessages/
Gets the number of messages, optionally filtering by URL
-p JSON.parse(result) +Parameters
- -GET /JSON/spider/view/optionScope/
| Name | +In | +Type | +Required | +Description | +
|---|---|---|---|---|
| baseurl | +query | +string | +false | +The highest URL in the Sites tree under which messages should be included. | +
Example responses
@@ -8808,11 +27506,12 @@ curl -X GET http://zap/JSON/spider/view/optionScope/default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderViewOptionScopeText
- +coreViewOptionAlertOverridesFilePath
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/optionScopeText/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/optionAlertOverridesFilePath/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/view/optionScopeText/");
+URL obj = new URL("http://zap/JSON/core/view/optionAlertOverridesFilePath/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -8861,32 +27559,17 @@ curl -X GET http://zap/JSON/spider/view/optionScopeText/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/spider/view/optionScopeText/', params={
-
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/spider/view/optionScopeText/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/core/view/optionAlertOverridesFilePath/', headers = headers)
-p JSON.parse(result)
+print(r.json())
GET /JSON/spider/view/optionScopeText/
GET /JSON/core/view/optionAlertOverridesFilePath/
Gets the path to the file with alert overrides.
Example responses
@@ -8894,11 +27577,12 @@ curl -X GET http://zap/JSON/spider/view/optionScopeText/default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderViewOptionSkipURLString
- +coreViewOptionDefaultUserAgent
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/optionSkipURLString/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/optionDefaultUserAgent/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/view/optionSkipURLString/");
+URL obj = new URL("http://zap/JSON/core/view/optionDefaultUserAgent/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -8947,32 +27630,17 @@ curl -X GET http://zap/JSON/spider/view/optionSkipURLStr
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/spider/view/optionSkipURLString/', params={
-
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/spider/view/optionSkipURLString/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/core/view/optionDefaultUserAgent/', headers = headers)
-p JSON.parse(result)
+print(r.json())
GET /JSON/spider/view/optionSkipURLString/
GET /JSON/core/view/optionDefaultUserAgent/
Use the API endpoints in the 'network' component instead.
Example responses
@@ -8980,11 +27648,12 @@ curl -X GET http://zap/JSON/spider/view/optionSkipURLStrdefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderViewOptionThreadCount
- +coreViewOptionDnsTtlSuccessfulQueries
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/optionThreadCount/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/optionDnsTtlSuccessfulQueries/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/view/optionThreadCount/");
+URL obj = new URL("http://zap/JSON/core/view/optionDnsTtlSuccessfulQueries/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -9033,32 +27701,17 @@ curl -X GET http://zap/JSON/spider/view/optionThreadCoun
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/view/optionThreadCount/', params={
+r = requests.get('http://zap/JSON/core/view/optionDnsTtlSuccessfulQueries/', headers = headers)
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/spider/view/optionThreadCount/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
GET /JSON/spider/view/optionThreadCount/
GET /JSON/core/view/optionDnsTtlSuccessfulQueries/
Use the API endpoints in the 'network' component instead.
Example responses
@@ -9066,11 +27719,12 @@ curl -X GET http://zap/JSON/spider/view/optionThreadCoundefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderViewOptionUserAgent
- +coreViewOptionHttpState
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/optionUserAgent/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/optionHttpState/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/view/optionUserAgent/");
+URL obj = new URL("http://zap/JSON/core/view/optionHttpState/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -9119,32 +27772,17 @@ curl -X GET http://zap/JSON/spider/view/optionUserAgent/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/spider/view/optionUserAgent/', params={
-
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/spider/view/optionUserAgent/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/core/view/optionHttpState/', headers = headers)
-p JSON.parse(result)
+print(r.json())
GET /JSON/spider/view/optionUserAgent/
GET /JSON/core/view/optionHttpState/
Use the API endpoints in the 'network' component instead.
Example responses
@@ -9152,11 +27790,12 @@ curl -X GET http://zap/JSON/spider/view/optionUserAgent/default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderViewOptionAcceptCookies
- +coreViewOptionHttpStateEnabled
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/optionAcceptCookies/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/optionHttpStateEnabled/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/view/optionAcceptCookies/");
+URL obj = new URL("http://zap/JSON/core/view/optionHttpStateEnabled/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -9205,34 +27843,17 @@ curl -X GET http://zap/JSON/spider/view/optionAcceptCook
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/spider/view/optionAcceptCookies/', params={
-
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/spider/view/optionAcceptCookies/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/core/view/optionHttpStateEnabled/', headers = headers)
-p JSON.parse(result)
+print(r.json())
GET /JSON/spider/view/optionAcceptCookies/
GET /JSON/core/view/optionHttpStateEnabled/
Gets whether or not a spider process should accept cookies while spidering.
+Use the API endpoints in the 'network' component instead.
Example responses
@@ -9240,11 +27861,12 @@ curl -X GET http://zap/JSON/spider/view/optionAcceptCookdefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderViewOptionHandleODataParametersVisited
- +coreViewOptionMaximumAlertInstances
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/optionHandleODataParametersVisited/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/optionMaximumAlertInstances/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/view/optionHandleODataParametersVisited/");
+URL obj = new URL("http://zap/JSON/core/view/optionMaximumAlertInstances/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -9293,32 +27914,17 @@ curl -X GET http://zap/JSON/spider/view/optionHandleODat
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/spider/view/optionHandleODataParametersVisited/', params={
-
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/spider/view/optionHandleODataParametersVisited/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/core/view/optionMaximumAlertInstances/', headers = headers)
-p JSON.parse(result)
+print(r.json())
GET /JSON/spider/view/optionHandleODataParametersVisited/
GET /JSON/core/view/optionMaximumAlertInstances/
Gets the maximum number of alert instances to include in a report.
Example responses
@@ -9326,11 +27932,12 @@ curl -X GET http://zap/JSON/spider/view/optionHandleODatdefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderViewOptionParseComments
- +coreViewOptionMergeRelatedAlerts
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/optionParseComments/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/optionMergeRelatedAlerts/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/view/optionParseComments/");
+URL obj = new URL("http://zap/JSON/core/view/optionMergeRelatedAlerts/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -9379,32 +27985,17 @@ curl -X GET http://zap/JSON/spider/view/optionParseComme
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/spider/view/optionParseComments/', params={
-
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/spider/view/optionParseComments/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/core/view/optionMergeRelatedAlerts/', headers = headers)
-p JSON.parse(result)
+print(r.json())
GET /JSON/spider/view/optionParseComments/
GET /JSON/core/view/optionMergeRelatedAlerts/
Gets whether or not related alerts will be merged in any reports generated.
Example responses
@@ -9412,11 +28003,12 @@ curl -X GET http://zap/JSON/spider/view/optionParseCommedefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderViewOptionParseGit
- +coreViewOptionProxyChainName
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/optionParseGit/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/optionProxyChainName/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/view/optionParseGit/");
+URL obj = new URL("http://zap/JSON/core/view/optionProxyChainName/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -9465,32 +28056,17 @@ curl -X GET http://zap/JSON/spider/view/optionParseGit/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/spider/view/optionParseGit/', params={
-
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/spider/view/optionParseGit/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/core/view/optionProxyChainName/', headers = headers)
-p JSON.parse(result)
+print(r.json())
GET /JSON/spider/view/optionParseGit/
GET /JSON/core/view/optionProxyChainName/
Use the API endpoints in the 'network' component instead.
Example responses
@@ -9498,11 +28074,12 @@ curl -X GET http://zap/JSON/spider/view/optionParseGit/default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderViewOptionParseRobotsTxt
- +coreViewOptionProxyChainPassword
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/optionParseRobotsTxt/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/optionProxyChainPassword/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/view/optionParseRobotsTxt/");
+URL obj = new URL("http://zap/JSON/core/view/optionProxyChainPassword/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -9551,32 +28127,17 @@ curl -X GET http://zap/JSON/spider/view/optionParseRobot
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/view/optionParseRobotsTxt/', params={
+r = requests.get('http://zap/JSON/core/view/optionProxyChainPassword/', headers = headers)
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/spider/view/optionParseRobotsTxt/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
GET /JSON/spider/view/optionParseRobotsTxt/
GET /JSON/core/view/optionProxyChainPassword/
Use the API endpoints in the 'network' component instead.
Example responses
@@ -9584,11 +28145,12 @@ curl -X GET http://zap/JSON/spider/view/optionParseRobotdefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderViewOptionParseSVNEntries
- +coreViewOptionProxyChainPort
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/optionParseSVNEntries/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/optionProxyChainPort/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/view/optionParseSVNEntries/");
+URL obj = new URL("http://zap/JSON/core/view/optionProxyChainPort/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -9637,32 +28198,17 @@ curl -X GET http://zap/JSON/spider/view/optionParseSVNEn
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/spider/view/optionParseSVNEntries/', params={
-
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/spider/view/optionParseSVNEntries/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/core/view/optionProxyChainPort/', headers = headers)
-p JSON.parse(result)
+print(r.json())
GET /JSON/spider/view/optionParseSVNEntries/
GET /JSON/core/view/optionProxyChainPort/
Use the API endpoints in the 'network' component instead.
Example responses
@@ -9670,11 +28216,12 @@ curl -X GET http://zap/JSON/spider/view/optionParseSVNEndefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderViewOptionParseSitemapXml
- +coreViewOptionProxyChainPrompt
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/optionParseSitemapXml/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/optionProxyChainPrompt/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/view/optionParseSitemapXml/");
+URL obj = new URL("http://zap/JSON/core/view/optionProxyChainPrompt/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -9723,32 +28269,17 @@ curl -X GET http://zap/JSON/spider/view/optionParseSitem
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/spider/view/optionParseSitemapXml/', params={
-
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/spider/view/optionParseSitemapXml/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/core/view/optionProxyChainPrompt/', headers = headers)
-p JSON.parse(result)
+print(r.json())
GET /JSON/spider/view/optionParseSitemapXml/
GET /JSON/core/view/optionProxyChainPrompt/
Use the API endpoints in the 'network' component instead.
Example responses
@@ -9756,11 +28287,12 @@ curl -X GET http://zap/JSON/spider/view/optionParseSitemdefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderViewOptionPostForm
- +coreViewOptionProxyChainRealm
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/optionPostForm/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/optionProxyChainRealm/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/view/optionPostForm/");
+URL obj = new URL("http://zap/JSON/core/view/optionProxyChainRealm/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -9809,32 +28340,17 @@ curl -X GET http://zap/JSON/spider/view/optionPostForm/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/spider/view/optionPostForm/', params={
-
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/spider/view/optionPostForm/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/core/view/optionProxyChainRealm/', headers = headers)
-p JSON.parse(result)
+print(r.json())
GET /JSON/spider/view/optionPostForm/
GET /JSON/core/view/optionProxyChainRealm/
Use the API endpoints in the 'network' component instead.
Example responses
@@ -9842,11 +28358,12 @@ curl -X GET http://zap/JSON/spider/view/optionPostForm/default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderViewOptionProcessForm
- +coreViewOptionProxyChainSkipName
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/optionProcessForm/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/optionProxyChainSkipName/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/view/optionProcessForm/");
+URL obj = new URL("http://zap/JSON/core/view/optionProxyChainSkipName/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -9895,32 +28411,17 @@ curl -X GET http://zap/JSON/spider/view/optionProcessFor
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/spider/view/optionProcessForm/', params={
-
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/spider/view/optionProcessForm/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/core/view/optionProxyChainSkipName/', headers = headers)
-p JSON.parse(result)
+print(r.json())
GET /JSON/spider/view/optionProcessForm/
GET /JSON/core/view/optionProxyChainSkipName/
Use view proxyChainExcludedDomains instead.
Example responses
@@ -9928,11 +28429,12 @@ curl -X GET http://zap/JSON/spider/view/optionProcessFordefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderViewOptionSendRefererHeader
- +coreViewOptionProxyChainUserName
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/optionSendRefererHeader/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/optionProxyChainUserName/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/view/optionSendRefererHeader/");
+URL obj = new URL("http://zap/JSON/core/view/optionProxyChainUserName/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -9981,34 +28482,17 @@ curl -X GET http://zap/JSON/spider/view/optionSendRefere
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/spider/view/optionSendRefererHeader/', params={
-
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/spider/view/optionSendRefererHeader/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/core/view/optionProxyChainUserName/', headers = headers)
-p JSON.parse(result)
+print(r.json())
GET /JSON/spider/view/optionSendRefererHeader/
GET /JSON/core/view/optionProxyChainUserName/
Gets whether or not the 'Referer' header should be sent while spidering.
+Use the API endpoints in the 'network' component instead.
Example responses
@@ -10016,11 +28500,12 @@ curl -X GET http://zap/JSON/spider/view/optionSendReferedefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderViewOptionShowAdvancedDialog
- +coreViewOptionProxyExcludedDomains
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/view/optionShowAdvancedDialog/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/optionProxyExcludedDomains/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/view/optionShowAdvancedDialog/");
+URL obj = new URL("http://zap/JSON/core/view/optionProxyExcludedDomains/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -10069,32 +28553,17 @@ curl -X GET http://zap/JSON/spider/view/optionShowAdvanc
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/spider/view/optionShowAdvancedDialog/', params={
-
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/spider/view/optionShowAdvancedDialog/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/core/view/optionProxyExcludedDomains/', headers = headers)
-p JSON.parse(result)
+print(r.json())
GET /JSON/spider/view/optionShowAdvancedDialog/
GET /JSON/core/view/optionProxyExcludedDomains/
Use view proxyChainExcludedDomains instead.
Example responses
@@ -10102,11 +28571,12 @@ curl -X GET http://zap/JSON/spider/view/optionShowAdvancdefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderActionScan
- +coreViewOptionProxyExcludedDomainsEnabled
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/scan/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/optionProxyExcludedDomainsEnabled/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/action/scan/");
+URL obj = new URL("http://zap/JSON/core/view/optionProxyExcludedDomainsEnabled/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -10155,82 +28624,17 @@ curl -X GET http://zap/JSON/spider/action/scan/ import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/spider/action/scan/', params={
-
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/spider/action/scan/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/core/view/optionProxyExcludedDomainsEnabled/', headers = headers)
-p JSON.parse(result)
+print(r.json())
GET /JSON/spider/action/scan/
Runs the spider against the given URL (or context). Optionally, the 'maxChildren' parameter can be set to limit the number of children scanned, the 'recurse' parameter can be used to prevent the spider from seeding recursively, the parameter 'contextName' can be used to constrain the scan to a Context and the parameter 'subtreeOnly' allows to restrict the spider under a site's subtree (using the specified 'url').
- -Parameters
+GET /JSON/core/view/optionProxyExcludedDomainsEnabled/
| Name | -In | -Type | -Required | -Description | -
|---|---|---|---|---|
| url | -query | -string | -false | -none | -
| maxChildren | -query | -integer | -false | -none | -
| recurse | -query | -boolean | -false | -none | -
| contextName | -query | -string | -false | -none | -
| subtreeOnly | -query | -boolean | -false | -none | -
Use view proxyChainExcludedDomains instead.
Example responses
@@ -10238,11 +28642,12 @@ curl -X GET http://zap/JSON/spider/action/scan/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderActionScanAsUser
- +coreViewOptionSingleCookieRequestHeader
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/scanAsUser/?contextId=0&userId=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/optionSingleCookieRequestHeader/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/action/scanAsUser/?contextId=0&userId=0");
+URL obj = new URL("http://zap/JSON/core/view/optionSingleCookieRequestHeader/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -10291,91 +28695,17 @@ curl -X GET http://zap/JSON/spider/action/scanAsUser/?co
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/spider/action/scanAsUser/', params={
- 'contextId': '0', 'userId': '0'
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/spider/action/scanAsUser/',
- params: {
- 'contextId' => 'integer',
-'userId' => 'integer'
-}, headers: headers
+r = requests.get('http://zap/JSON/core/view/optionSingleCookieRequestHeader/', headers = headers)
-p JSON.parse(result)
+print(r.json())
GET /JSON/spider/action/scanAsUser/
Runs the spider from the perspective of a User, obtained using the given Context ID and User ID. See 'scan' action for more details.
- -Parameters
+GET /JSON/core/view/optionSingleCookieRequestHeader/
| Name | -In | -Type | -Required | -Description | -
|---|---|---|---|---|
| contextId | -query | -integer | -true | -none | -
| userId | -query | -integer | -true | -none | -
| url | -query | -string | -false | -none | -
| maxChildren | -query | -integer | -false | -none | -
| recurse | -query | -boolean | -false | -none | -
| subtreeOnly | -query | -boolean | -false | -none | -
Option no longer in effective use.
Example responses
@@ -10383,11 +28713,12 @@ curl -X GET http://zap/JSON/spider/action/scanAsUser/?codefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderActionPause
- +coreViewOptionTimeoutInSecs
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/pause/?scanId=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/optionTimeoutInSecs/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/action/pause/?scanId=0");
+URL obj = new URL("http://zap/JSON/core/view/optionTimeoutInSecs/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -10436,53 +28766,17 @@ curl -X GET http://zap/JSON/spider/action/pause/?scanId<
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/spider/action/pause/', params={
- 'scanId': '0'
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/spider/action/pause/',
- params: {
- 'scanId' => 'integer'
-}, headers: headers
+r = requests.get('http://zap/JSON/core/view/optionTimeoutInSecs/', headers = headers)
-p JSON.parse(result)
+print(r.json())
GET /JSON/spider/action/pause/
Parameters
+GET /JSON/core/view/optionTimeoutInSecs/
| Name | -In | -Type | -Required | -Description | -
|---|---|---|---|---|
| scanId | -query | -integer | -true | -none | -
Use the API endpoints in the 'network' component instead.
Example responses
@@ -10490,11 +28784,12 @@ curl -X GET http://zap/JSON/spider/action/pause/?scanId<default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderActionResume
- +coreViewOptionUseProxyChain
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/resume/?scanId=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/optionUseProxyChain/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/action/resume/?scanId=0");
+URL obj = new URL("http://zap/JSON/core/view/optionUseProxyChain/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -10543,53 +28837,17 @@ curl -X GET http://zap/JSON/spider/action/resume/?scanId
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/spider/action/resume/', params={
- 'scanId': '0'
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/spider/action/resume/',
- params: {
- 'scanId' => 'integer'
-}, headers: headers
+r = requests.get('http://zap/JSON/core/view/optionUseProxyChain/', headers = headers)
-p JSON.parse(result)
+print(r.json())
GET /JSON/spider/action/resume/
Parameters
+GET /JSON/core/view/optionUseProxyChain/
| Name | -In | -Type | -Required | -Description | -
|---|---|---|---|---|
| scanId | -query | -integer | -true | -none | -
Use the API endpoints in the 'network' component instead.
Example responses
@@ -10597,11 +28855,12 @@ curl -X GET http://zap/JSON/spider/action/resume/?scanIddefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderActionStop
- +coreViewOptionUseProxyChainAuth
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/stop/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/optionUseProxyChainAuth/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/action/stop/");
+URL obj = new URL("http://zap/JSON/core/view/optionUseProxyChainAuth/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -10650,52 +28908,17 @@ curl -X GET http://zap/JSON/spider/action/stop/ import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/spider/action/stop/', params={
-
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/spider/action/stop/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/core/view/optionUseProxyChainAuth/', headers = headers)
-p JSON.parse(result)
+print(r.json())
GET /JSON/spider/action/stop/
Parameters
+GET /JSON/core/view/optionUseProxyChainAuth/
| Name | -In | -Type | -Required | -Description | -
|---|---|---|---|---|
| scanId | -query | -integer | -false | -none | -
Use the API endpoints in the 'network' component instead.
Example responses
@@ -10703,11 +28926,12 @@ curl -X GET http://zap/JSON/spider/action/stop/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderActionRemoveScan
- +coreViewOptionUseSocksProxy
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/removeScan/?scanId=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/optionUseSocksProxy/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/action/removeScan/?scanId=0");
+URL obj = new URL("http://zap/JSON/core/view/optionUseSocksProxy/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -10756,65 +28979,101 @@ curl -X GET http://zap/JSON/spider/action/removeScan/?sc
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/action/removeScan/', params={
- 'scanId': '0'
-}, headers = headers)
-
-print r.json()
+r = requests.get('http://zap/JSON/core/view/optionUseSocksProxy/', headers = headers)
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+print(r.json())
-result = RestClient.get 'http://zap/JSON/spider/action/removeScan/',
- params: {
- 'scanId' => 'integer'
-}, headers: headers
+GET /JSON/core/view/optionUseSocksProxy/
Use the API endpoints in the 'network' component instead.
- -GET /JSON/spider/action/removeScan/
++Example responses
-Parameters
+default Response
+
{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+Responses
| Name | -In | -Type | -Required | +Status | +Meaning | Description | +Schema | |
|---|---|---|---|---|---|---|---|---|
| scanId | -query | -integer | -true | -none | +default | +Default | +Error of JSON endpoints. | +ErrorJson |
coreViewProxyChainExcludedDomains
+ + +++Code samples
+
# You can also use wget
+curl -X GET http://zap/JSON/core/view/proxyChainExcludedDomains/ \
+ -H 'Accept: application/json'
+
+URL obj = new URL("http://zap/JSON/core/view/proxyChainExcludedDomains/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/core/view/proxyChainExcludedDomains/', headers = headers)
+
+print(r.json())
+
+GET /JSON/core/view/proxyChainExcludedDomains/
Use the API endpoints in the 'network' component instead.
+Example responses
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderActionPauseAllScans
- +coreViewSessionLocation
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/pauseAllScans/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/sessionLocation/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/action/pauseAllScans/");
+URL obj = new URL("http://zap/JSON/core/view/sessionLocation/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -10863,32 +29121,17 @@ curl -X GET http://zap/JSON/spider/action/pauseAllScans/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/spider/action/pauseAllScans/', params={
-
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/spider/action/pauseAllScans/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/core/view/sessionLocation/', headers = headers)
-p JSON.parse(result)
+print(r.json())
GET /JSON/spider/action/pauseAllScans/
GET /JSON/core/view/sessionLocation/
Gets the location of the current session file
Example responses
@@ -10896,11 +29139,12 @@ curl -X GET http://zap/JSON/spider/action/pauseAllScans/default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderActionResumeAllScans
- +coreViewSites
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/resumeAllScans/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/sites/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/action/resumeAllScans/");
+URL obj = new URL("http://zap/JSON/core/view/sites/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -10949,32 +29192,17 @@ curl -X GET http://zap/JSON/spider/action/resumeAllScans
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/action/resumeAllScans/', params={
-
-}, headers = headers)
-
-print r.json()
+r = requests.get('http://zap/JSON/core/view/sites/', headers = headers)
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/spider/action/resumeAllScans/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
GET /JSON/spider/action/resumeAllScans/
GET /JSON/core/view/sites/
Gets the sites accessed through/by ZAP (scheme and domain)
Example responses
@@ -10982,11 +29210,12 @@ curl -X GET http://zap/JSON/spider/action/resumeAllScansdefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderActionStopAllScans
- +coreViewUrls
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/stopAllScans/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/urls/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/action/stopAllScans/");
+URL obj = new URL("http://zap/JSON/core/view/urls/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -11035,32 +29263,37 @@ curl -X GET http://zap/JSON/spider/action/stopAllScans/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/action/stopAllScans/', params={
-
-}, headers = headers)
-
-print r.json()
+r = requests.get('http://zap/JSON/core/view/urls/', headers = headers)
-require 'rest-client'
-require 'json'
+print(r.json())
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+GET /JSON/core/view/urls/
Gets the URLs accessed through/by ZAP, optionally filtering by (base) URL.
-p JSON.parse(result) +Parameters
- -GET /JSON/spider/action/stopAllScans/
| Name | +In | +Type | +Required | +Description | +
|---|---|---|---|---|
| baseurl | +query | +string | +false | +The highest URL in the Sites tree under which URLs should be included. | +
Example responses
@@ -11068,11 +29301,12 @@ curl -X GET http://zap/JSON/spider/action/stopAllScans/default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderActionRemoveAllScans
- +coreViewVersion
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/removeAllScans/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/version/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/action/removeAllScans/");
+URL obj = new URL("http://zap/JSON/core/view/version/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -11121,32 +29354,17 @@ curl -X GET http://zap/JSON/spider/action/removeAllScans
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/spider/action/removeAllScans/', params={
-
-}, headers = headers)
-
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/spider/action/removeAllScans/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/core/view/version/', headers = headers)
-p JSON.parse(result)
+print(r.json())
GET /JSON/spider/action/removeAllScans/
GET /JSON/core/view/version/
Gets ZAP version
Example responses
@@ -11154,11 +29372,12 @@ curl -X GET http://zap/JSON/spider/action/removeAllScansdefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderActionClearExcludedFromScan
- +coreViewZapHomePath
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/clearExcludedFromScan/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/core/view/zapHomePath/ \
+ -H 'Accept: application/json'
-URL obj = new URL("http://zap/JSON/spider/action/clearExcludedFromScan/");
+URL obj = new URL("http://zap/JSON/core/view/zapHomePath/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -11207,34 +29425,17 @@ curl -X GET http://zap/JSON/spider/action/clearExcludedF
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/action/clearExcludedFromScan/', params={
-
-}, headers = headers)
+r = requests.get('http://zap/JSON/core/view/zapHomePath/', headers = headers)
-print r.json()
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/spider/action/clearExcludedFromScan/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
GET /JSON/spider/action/clearExcludedFromScan/
GET /JSON/core/view/zapHomePath/
Clears the regexes of URLs excluded from the spider scans.
+Gets the path to ZAP's home directory.
Example responses
@@ -11242,11 +29443,12 @@ curl -X GET http://zap/JSON/spider/action/clearExcludedFdefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Responses
+Responses
| default | Default | -unexpected error | -Error | +Error of JSON endpoints. | +ErrorJson |
spiderActionExcludeFromScan
- + +dev
+devOtherOpenapi
+Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/excludeFromScan/?regex=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/OTHER/dev/other/openapi/ \
+ -H 'Accept: */*'
-URL obj = new URL("http://zap/JSON/spider/action/excludeFromScan/?regex=string");
+URL obj = new URL("http://zap/OTHER/dev/other/openapi/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -11295,37 +29498,89 @@ curl -X GET http://zap/JSON/spider/action/excludeFromSca
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': '*/*'
}
-r = requests.get('http://zap/JSON/spider/action/excludeFromScan/', params={
- 'regex': 'string'
-}, headers = headers)
+r = requests.get('http://zap/OTHER/dev/other/openapi/', headers = headers)
+
+print(r.content)
+
+GET /OTHER/dev/other/openapi/
Provides the OpenAPI definition of the ZAP API, in YAML format.
+ +++ +Example responses
+
Responses
+ +| Status | +Meaning | +Description | +Schema | +
|---|---|---|---|
| default | +Default | +Error of OTHER endpoints. | +None | +
Response Schema
-require 'rest-client'
-require 'json'
+
+
+exim
+eximActionImportHar
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/exim/action/importHar/?filePath=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/exim/action/importHar/?filePath=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
import requests
headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/spider/action/excludeFromScan/',
- params: {
- 'regex' => 'string'
-}, headers: headers
+r = requests.get('http://zap/JSON/exim/action/importHar/', params={
+ 'filePath': 'string'
+}, headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/spider/action/excludeFromScan/
+GET /JSON/exim/action/importHar/
-Adds a regex of URLs that should be excluded from the spider scans.
+Imports a HAR file.
-Parameters
+Parameters
@@ -11337,7 +29592,7 @@ curl -X GET http://zap/JSON/spider/action/excludeFromSca
-regex
+filePath
query
string
true
@@ -11351,11 +29606,12 @@ curl -X GET http://zap/JSON/spider/action/excludeFromSca
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -11368,27 +29624,26 @@ curl -X GET http://zap/JSON/spider/action/excludeFromSca
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-spiderActionAddDomainAlwaysInScope
-
+eximActionImportModsec2Logs
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/addDomainAlwaysInScope/?value=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/exim/action/importModsec2Logs/?filePath=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/spider/action/addDomainAlwaysInScope/?value=string");
+
URL obj = new URL("http://zap/JSON/exim/action/importModsec2Logs/?filePath=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -11404,37 +29659,21 @@ curl -X GET http://zap/JSON/spider/action/addDomainAlway
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/action/addDomainAlwaysInScope/', params={
- 'value': 'string'
+r = requests.get('http://zap/JSON/exim/action/importModsec2Logs/', params={
+ 'filePath': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/spider/action/addDomainAlwaysInScope/',
- params: {
- 'value' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/spider/action/addDomainAlwaysInScope/
+GET /JSON/exim/action/importModsec2Logs/
-Adds a new domain that's always in scope, 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).
+Imports ModSecurity2 logs from the file with the given file system path.
-Parameters
+Parameters
@@ -11446,26 +29685,12 @@ curl -X GET http://zap/JSON/spider/action/addDomainAlway
-value
+filePath
query
string
true
none
-
-isRegex
-query
-boolean
-false
-none
-
-
-isEnabled
-query
-boolean
-false
-none
-
@@ -11474,11 +29699,12 @@ curl -X GET http://zap/JSON/spider/action/addDomainAlway
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -11491,27 +29717,26 @@ curl -X GET http://zap/JSON/spider/action/addDomainAlway
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-spiderActionModifyDomainAlwaysInScope
-
+eximActionImportUrls
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/modifyDomainAlwaysInScope/?idx=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/exim/action/importUrls/?filePath=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/spider/action/modifyDomainAlwaysInScope/?idx=0");
+
URL obj = new URL("http://zap/JSON/exim/action/importUrls/?filePath=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -11527,37 +29752,21 @@ curl -X GET http://zap/JSON/spider/action/modifyDomainAl
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/action/modifyDomainAlwaysInScope/', params={
- 'idx': '0'
+r = requests.get('http://zap/JSON/exim/action/importUrls/', params={
+ 'filePath': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/spider/action/modifyDomainAlwaysInScope/',
- params: {
- 'idx' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/spider/action/modifyDomainAlwaysInScope/
+GET /JSON/exim/action/importUrls/
-Modifies a domain that's always in scope. 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 domainsAlwaysInScope.
+Imports URLs (one per line) from the file with the given file system path.
-Parameters
+Parameters
@@ -11569,31 +29778,10 @@ curl -X GET http://zap/JSON/spider/action/modifyDomainAl
-idx
-query
-integer
-true
-none
-
-
-value
+filePath
query
string
-false
-none
-
-
-isRegex
-query
-boolean
-false
-none
-
-
-isEnabled
-query
-boolean
-false
+true
none
@@ -11604,11 +29792,12 @@ curl -X GET http://zap/JSON/spider/action/modifyDomainAl
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -11621,27 +29810,26 @@ curl -X GET http://zap/JSON/spider/action/modifyDomainAl
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-spiderActionRemoveDomainAlwaysInScope
-
+eximActionImportZapLogs
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/removeDomainAlwaysInScope/?idx=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/exim/action/importZapLogs/?filePath=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/spider/action/removeDomainAlwaysInScope/?idx=0");
+
URL obj = new URL("http://zap/JSON/exim/action/importZapLogs/?filePath=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -11657,37 +29845,21 @@ curl -X GET http://zap/JSON/spider/action/removeDomainAl
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/action/removeDomainAlwaysInScope/', params={
- 'idx': '0'
+r = requests.get('http://zap/JSON/exim/action/importZapLogs/', params={
+ 'filePath': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/spider/action/removeDomainAlwaysInScope/',
- params: {
- 'idx' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/spider/action/removeDomainAlwaysInScope/
+GET /JSON/exim/action/importZapLogs/
-Removes a domain that's always in scope, with the given index. The index can be obtained with the view domainsAlwaysInScope.
+Imports previously exported ZAP messages from the file with the given file system path.
-Parameters
+Parameters
@@ -11699,9 +29871,9 @@ curl -X GET http://zap/JSON/spider/action/removeDomainAl
-idx
+filePath
query
-integer
+string
true
none
@@ -11713,11 +29885,12 @@ curl -X GET http://zap/JSON/spider/action/removeDomainAl
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -11730,27 +29903,26 @@ curl -X GET http://zap/JSON/spider/action/removeDomainAl
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-spiderActionEnableAllDomainsAlwaysInScope
-
+eximOtherExportHar
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/enableAllDomainsAlwaysInScope/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/OTHER/exim/other/exportHar/ \
+ -H 'Accept: */*'
-
URL obj = new URL("http://zap/JSON/spider/action/enableAllDomainsAlwaysInScope/");
+
URL obj = new URL("http://zap/OTHER/exim/other/exportHar/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -11766,46 +29938,57 @@ curl -X GET http://zap/JSON/spider/action/enableAllDomai
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': '*/*'
}
-r = requests.get('http://zap/JSON/spider/action/enableAllDomainsAlwaysInScope/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
+r = requests.get('http://zap/OTHER/exim/other/exportHar/', headers = headers)
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+print(r.content)
-result = RestClient.get 'http://zap/JSON/spider/action/enableAllDomainsAlwaysInScope/',
- params: {
- }, headers: headers
+
+GET /OTHER/exim/other/exportHar/
-p JSON.parse(result)
+Gets the HTTP messages sent through/by ZAP, in HAR format, optionally filtered by URL and paginated with 'start' position and 'count' of messages
-
-GET /JSON/spider/action/enableAllDomainsAlwaysInScope/
+Parameters
-Enables all domains that are always in scope.
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+baseurl
+query
+string
+false
+The URL below which messages should be included.
+
+
+start
+query
+string
+false
+The position (or offset) within the results to use as a starting position for the information returned.
+
+
+count
+query
+string
+false
+The number of results to return.
+
+
Example responses
-
-default Response
-{
- "message": "string",
- "code": 100
-}
-
-Responses
+
+Responses
@@ -11818,27 +30001,28 @@ curl -X GET http://zap/JSON/spider/action/enableAllDomai
default
Default
-unexpected error
-Error
+Error of OTHER endpoints.
+None
+Response Schema
+
-spiderActionDisableAllDomainsAlwaysInScope
-
+eximOtherExportHarById
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/disableAllDomainsAlwaysInScope/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/OTHER/exim/other/exportHarById/?ids=string \
+ -H 'Accept: */*'
-
URL obj = new URL("http://zap/JSON/spider/action/disableAllDomainsAlwaysInScope/");
+
URL obj = new URL("http://zap/OTHER/exim/other/exportHarById/?ids=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -11854,46 +30038,45 @@ curl -X GET http://zap/JSON/spider/action/disableAllDoma
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': '*/*'
}
-r = requests.get('http://zap/JSON/spider/action/disableAllDomainsAlwaysInScope/', params={
-
+r = requests.get('http://zap/OTHER/exim/other/exportHarById/', params={
+ 'ids': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
+print(r.content)
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/spider/action/disableAllDomainsAlwaysInScope/',
- params: {
- }, headers: headers
+
+GET /OTHER/exim/other/exportHarById/
-p JSON.parse(result)
+Gets the HTTP messages with the given IDs, in HAR format.
-
-GET /JSON/spider/action/disableAllDomainsAlwaysInScope/
+Parameters
-Disables all domains that are always in scope.
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+ids
+query
+string
+true
+The ID (number(s)) of the message(s) to be returned.
+
+
Example responses
-
-default Response
-{
- "message": "string",
- "code": 100
-}
-
-Responses
+
+Responses
@@ -11906,27 +30089,28 @@ curl -X GET http://zap/JSON/spider/action/disableAllDoma
default
Default
-unexpected error
-Error
+Error of OTHER endpoints.
+None
+Response Schema
+
-spiderActionSetOptionHandleParameters
-
+eximOtherSendHarRequest
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/setOptionHandleParameters/?String=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/OTHER/exim/other/sendHarRequest/?request=string \
+ -H 'Accept: */*'
-
URL obj = new URL("http://zap/JSON/spider/action/setOptionHandleParameters/?String=string");
+
URL obj = new URL("http://zap/OTHER/exim/other/sendHarRequest/?request=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -11942,35 +30126,21 @@ curl -X GET http://zap/JSON/spider/action/setOptionHandl
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': '*/*'
}
-r = requests.get('http://zap/JSON/spider/action/setOptionHandleParameters/', params={
- 'String': 'string'
+r = requests.get('http://zap/OTHER/exim/other/sendHarRequest/', params={
+ 'request': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/spider/action/setOptionHandleParameters/',
- params: {
- 'String' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.content)
-GET /JSON/spider/action/setOptionHandleParameters/
+GET /OTHER/exim/other/sendHarRequest/
-Parameters
+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.
+
+Parameters
@@ -11982,25 +30152,26 @@ curl -X GET http://zap/JSON/spider/action/setOptionHandl
-String
+request
query
string
true
-none
+The raw JSON of a HAR request.
+
+
+followRedirects
+query
+string
+false
+True if redirects should be followed, false otherwise.
Example responses
-
-default Response
-{
- "message": "string",
- "code": 100
-}
-
-Responses
+
+Responses
@@ -12013,27 +30184,30 @@ curl -X GET http://zap/JSON/spider/action/setOptionHandl
default
Default
-unexpected error
-Error
+Error of OTHER endpoints.
+None
+Response Schema
+
-spiderActionSetOptionScopeString
-
+
+forcedUser
+forcedUserActionSetForcedUser
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/setOptionScopeString/?String=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/forcedUser/action/setForcedUser/?contextId=string&userId=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/spider/action/setOptionScopeString/?String=string");
+
URL obj = new URL("http://zap/JSON/forcedUser/action/setForcedUser/?contextId=string&userId=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -12049,37 +30223,21 @@ curl -X GET http://zap/JSON/spider/action/setOptionScope
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/action/setOptionScopeString/', params={
- 'String': 'string'
+r = requests.get('http://zap/JSON/forcedUser/action/setForcedUser/', params={
+ 'contextId': 'string', 'userId': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/spider/action/setOptionScopeString/',
- params: {
- 'String' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/spider/action/setOptionScopeString/
+GET /JSON/forcedUser/action/setForcedUser/
-Use actions [add|modify|remove]DomainAlwaysInScope instead.
+Sets the user (ID) that should be used in 'forced user' mode for the given context (ID)
-Parameters
+Parameters
@@ -12091,7 +30249,14 @@ curl -X GET http://zap/JSON/spider/action/setOptionScope
-String
+contextId
+query
+string
+true
+none
+
+
+userId
query
string
true
@@ -12105,11 +30270,12 @@ curl -X GET http://zap/JSON/spider/action/setOptionScope
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -12122,27 +30288,26 @@ curl -X GET http://zap/JSON/spider/action/setOptionScope
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-spiderActionSetOptionSkipURLString
-
+forcedUserActionSetForcedUserModeEnabled
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/setOptionSkipURLString/?String=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/forcedUser/action/setForcedUserModeEnabled/?boolean=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/spider/action/setOptionSkipURLString/?String=string");
+
URL obj = new URL("http://zap/JSON/forcedUser/action/setForcedUserModeEnabled/?boolean=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -12158,35 +30323,21 @@ curl -X GET http://zap/JSON/spider/action/setOptionSkipU
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/action/setOptionSkipURLString/', params={
- 'String': 'string'
+r = requests.get('http://zap/JSON/forcedUser/action/setForcedUserModeEnabled/', params={
+ 'boolean': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/spider/action/setOptionSkipURLString/',
- params: {
- 'String' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/spider/action/setOptionSkipURLString/
+GET /JSON/forcedUser/action/setForcedUserModeEnabled/
-Parameters
+Sets if 'forced user' mode should be enabled or not
+
+Parameters
@@ -12198,7 +30349,7 @@ curl -X GET http://zap/JSON/spider/action/setOptionSkipU
-String
+boolean
query
string
true
@@ -12212,11 +30363,12 @@ curl -X GET http://zap/JSON/spider/action/setOptionSkipU
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -12229,27 +30381,26 @@ curl -X GET http://zap/JSON/spider/action/setOptionSkipU
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-spiderActionSetOptionUserAgent
-
+forcedUserViewGetForcedUser
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/setOptionUserAgent/?String=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/forcedUser/view/getForcedUser/?contextId=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/spider/action/setOptionUserAgent/?String=string");
+
URL obj = new URL("http://zap/JSON/forcedUser/view/getForcedUser/?contextId=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -12265,35 +30416,21 @@ curl -X GET http://zap/JSON/spider/action/setOptionUserA
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/action/setOptionUserAgent/', params={
- 'String': 'string'
+r = requests.get('http://zap/JSON/forcedUser/view/getForcedUser/', params={
+ 'contextId': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/spider/action/setOptionUserAgent/',
- params: {
- 'String' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/spider/action/setOptionUserAgent/
+GET /JSON/forcedUser/view/getForcedUser/
-Parameters
+Gets the user (ID) set as 'forced user' for the given context (ID)
+
+Parameters
@@ -12305,7 +30442,7 @@ curl -X GET http://zap/JSON/spider/action/setOptionUserA
-String
+contextId
query
string
true
@@ -12319,11 +30456,12 @@ curl -X GET http://zap/JSON/spider/action/setOptionUserA
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -12336,27 +30474,26 @@ curl -X GET http://zap/JSON/spider/action/setOptionUserA
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-spiderActionSetOptionAcceptCookies
-
+forcedUserViewIsForcedUserModeEnabled
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/setOptionAcceptCookies/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/forcedUser/view/isForcedUserModeEnabled/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/spider/action/setOptionAcceptCookies/?Boolean=string");
+
URL obj = new URL("http://zap/JSON/forcedUser/view/isForcedUserModeEnabled/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -12372,55 +30509,17 @@ curl -X GET http://zap/JSON/spider/action/setOptionAccep
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/action/setOptionAcceptCookies/', params={
- 'Boolean': 'string'
-}, headers = headers)
-
-print r.json()
+r = requests.get('http://zap/JSON/forcedUser/view/isForcedUserModeEnabled/', headers = headers)
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/spider/action/setOptionAcceptCookies/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/spider/action/setOptionAcceptCookies/
-
-Sets whether or not a spider process should accept cookies while spidering.
-
-Parameters
+GET /JSON/forcedUser/view/isForcedUserModeEnabled/
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-Boolean
-query
-string
-true
-none
-
-
+Returns 'true' if 'forced user' mode is enabled, 'false' otherwise
Example responses
@@ -12428,11 +30527,12 @@ curl -X GET http://zap/JSON/spider/action/setOptionAccep
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -12445,27 +30545,28 @@ curl -X GET http://zap/JSON/spider/action/setOptionAccep
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-spiderActionSetOptionHandleODataParametersVisited
-
+
+graphql
+graphqlActionImportFile
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/setOptionHandleODataParametersVisited/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/graphql/action/importFile/?endurl=string&file=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/spider/action/setOptionHandleODataParametersVisited/?Boolean=string");
+
URL obj = new URL("http://zap/JSON/graphql/action/importFile/?endurl=string&file=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -12481,35 +30582,21 @@ curl -X GET http://zap/JSON/spider/action/setOptionHandl
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/action/setOptionHandleODataParametersVisited/', params={
- 'Boolean': 'string'
+r = requests.get('http://zap/JSON/graphql/action/importFile/', params={
+ 'endurl': 'string', 'file': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/spider/action/setOptionHandleODataParametersVisited/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/spider/action/setOptionHandleODataParametersVisited/
+GET /JSON/graphql/action/importFile/
-Parameters
+Imports a GraphQL Schema from a File.
+
+Parameters
@@ -12521,11 +30608,18 @@ curl -X GET http://zap/JSON/spider/action/setOptionHandl
-Boolean
+endurl
query
string
true
-none
+The Endpoint URL.
+
+
+file
+query
+string
+true
+The File That Contains the GraphQL Schema.
@@ -12535,11 +30629,12 @@ curl -X GET http://zap/JSON/spider/action/setOptionHandl
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -12552,27 +30647,26 @@ curl -X GET http://zap/JSON/spider/action/setOptionHandl
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-spiderActionSetOptionMaxChildren
-
+graphqlActionImportUrl
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/setOptionMaxChildren/?Integer=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/graphql/action/importUrl/?endurl=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/spider/action/setOptionMaxChildren/?Integer=0");
+
URL obj = new URL("http://zap/JSON/graphql/action/importUrl/?endurl=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -12588,37 +30682,21 @@ curl -X GET http://zap/JSON/spider/action/setOptionMaxCh
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/action/setOptionMaxChildren/', params={
- 'Integer': '0'
+r = requests.get('http://zap/JSON/graphql/action/importUrl/', params={
+ 'endurl': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/spider/action/setOptionMaxChildren/',
- params: {
- 'Integer' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/spider/action/setOptionMaxChildren/
+GET /JSON/graphql/action/importUrl/
-Sets the maximum number of child nodes (per node) that can be crawled, 0 means no limit.
+Imports a GraphQL Schema from a URL.
-Parameters
+Parameters
@@ -12630,11 +30708,18 @@ curl -X GET http://zap/JSON/spider/action/setOptionMaxCh
-Integer
+endurl
query
-integer
+string
true
-none
+The Endpoint URL.
+
+
+url
+query
+string
+false
+The URL Locating the GraphQL Schema.
@@ -12644,11 +30729,12 @@ curl -X GET http://zap/JSON/spider/action/setOptionMaxCh
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -12661,27 +30747,26 @@ curl -X GET http://zap/JSON/spider/action/setOptionMaxCh
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-spiderActionSetOptionMaxDepth
-
+graphqlActionSetOptionArgsType
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/setOptionMaxDepth/?Integer=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/graphql/action/setOptionArgsType/?String=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/spider/action/setOptionMaxDepth/?Integer=0");
+
URL obj = new URL("http://zap/JSON/graphql/action/setOptionArgsType/?String=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -12697,37 +30782,21 @@ curl -X GET http://zap/JSON/spider/action/setOptionMaxDe
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/action/setOptionMaxDepth/', params={
- 'Integer': '0'
+r = requests.get('http://zap/JSON/graphql/action/setOptionArgsType/', params={
+ 'String': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/spider/action/setOptionMaxDepth/',
- params: {
- 'Integer' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/spider/action/setOptionMaxDepth/
+GET /JSON/graphql/action/setOptionArgsType/
-Sets the maximum depth the spider can crawl, 0 for unlimited depth.
+Sets how arguments are specified.
-Parameters
+Parameters
@@ -12739,11 +30808,11 @@ curl -X GET http://zap/JSON/spider/action/setOptionMaxDe
-Integer
+String
query
-integer
+string
true
-none
+Can be "INLINE", "VARIABLES", or "BOTH".
@@ -12753,11 +30822,12 @@ curl -X GET http://zap/JSON/spider/action/setOptionMaxDe
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -12770,27 +30840,26 @@ curl -X GET http://zap/JSON/spider/action/setOptionMaxDe
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-spiderActionSetOptionMaxDuration
-
+graphqlActionSetOptionLenientMaxQueryDepthEnabled
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/setOptionMaxDuration/?Integer=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/graphql/action/setOptionLenientMaxQueryDepthEnabled/?Boolean=true \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/spider/action/setOptionMaxDuration/?Integer=0");
+
URL obj = new URL("http://zap/JSON/graphql/action/setOptionLenientMaxQueryDepthEnabled/?Boolean=true");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -12806,35 +30875,21 @@ curl -X GET http://zap/JSON/spider/action/setOptionMaxDu
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/action/setOptionMaxDuration/', params={
- 'Integer': '0'
+r = requests.get('http://zap/JSON/graphql/action/setOptionLenientMaxQueryDepthEnabled/', params={
+ 'Boolean': 'true'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/spider/action/setOptionMaxDuration/',
- params: {
- 'Integer' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/spider/action/setOptionMaxDuration/
+GET /JSON/graphql/action/setOptionLenientMaxQueryDepthEnabled/
-Parameters
+Sets whether or not Maximum Query Depth is enforced leniently.
+
+Parameters
@@ -12846,11 +30901,11 @@ curl -X GET http://zap/JSON/spider/action/setOptionMaxDu
-Integer
+Boolean
query
-integer
+boolean
true
-none
+Enforce Leniently (true or false).
@@ -12860,11 +30915,12 @@ curl -X GET http://zap/JSON/spider/action/setOptionMaxDu
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -12877,27 +30933,26 @@ curl -X GET http://zap/JSON/spider/action/setOptionMaxDu
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-spiderActionSetOptionMaxParseSizeBytes
-
+graphqlActionSetOptionMaxAdditionalQueryDepth
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/setOptionMaxParseSizeBytes/?Integer=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/graphql/action/setOptionMaxAdditionalQueryDepth/?Integer=0 \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/spider/action/setOptionMaxParseSizeBytes/?Integer=0");
+
URL obj = new URL("http://zap/JSON/graphql/action/setOptionMaxAdditionalQueryDepth/?Integer=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -12913,37 +30968,21 @@ curl -X GET http://zap/JSON/spider/action/setOptionMaxPa
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/action/setOptionMaxParseSizeBytes/', params={
+r = requests.get('http://zap/JSON/graphql/action/setOptionMaxAdditionalQueryDepth/', params={
'Integer': '0'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/spider/action/setOptionMaxParseSizeBytes/',
- params: {
- 'Integer' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/spider/action/setOptionMaxParseSizeBytes/
+GET /JSON/graphql/action/setOptionMaxAdditionalQueryDepth/
-Sets the maximum size, in bytes, that a response might have to be parsed. This allows the spider to skip big responses/files.
+Sets the maximum additional query generation depth (used if enforced leniently).
-Parameters
+Parameters
@@ -12959,7 +30998,7 @@ curl -X GET http://zap/JSON/spider/action/setOptionMaxPa
query
integer
true
-none
+The Maximum Additional Depth.
@@ -12969,11 +31008,12 @@ curl -X GET http://zap/JSON/spider/action/setOptionMaxPa
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -12986,27 +31026,26 @@ curl -X GET http://zap/JSON/spider/action/setOptionMaxPa
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-spiderActionSetOptionMaxScansInUI
-
+graphqlActionSetOptionMaxArgsDepth
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/setOptionMaxScansInUI/?Integer=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/graphql/action/setOptionMaxArgsDepth/?Integer=0 \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/spider/action/setOptionMaxScansInUI/?Integer=0");
+
URL obj = new URL("http://zap/JSON/graphql/action/setOptionMaxArgsDepth/?Integer=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -13022,35 +31061,21 @@ curl -X GET http://zap/JSON/spider/action/setOptionMaxSc
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/action/setOptionMaxScansInUI/', params={
+r = requests.get('http://zap/JSON/graphql/action/setOptionMaxArgsDepth/', params={
'Integer': '0'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/spider/action/setOptionMaxScansInUI/',
- params: {
- 'Integer' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/spider/action/setOptionMaxScansInUI/
+GET /JSON/graphql/action/setOptionMaxArgsDepth/
-Parameters
+Sets the maximum arguments generation depth.
+
+Parameters
@@ -13066,7 +31091,7 @@ curl -X GET http://zap/JSON/spider/action/setOptionMaxSc
query
integer
true
-none
+The Maximum Depth.
@@ -13076,11 +31101,12 @@ curl -X GET http://zap/JSON/spider/action/setOptionMaxSc
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -13093,27 +31119,26 @@ curl -X GET http://zap/JSON/spider/action/setOptionMaxSc
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-spiderActionSetOptionParseComments
-
+graphqlActionSetOptionMaxQueryDepth
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/setOptionParseComments/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/graphql/action/setOptionMaxQueryDepth/?Integer=0 \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/spider/action/setOptionParseComments/?Boolean=string");
+
URL obj = new URL("http://zap/JSON/graphql/action/setOptionMaxQueryDepth/?Integer=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -13129,142 +31154,21 @@ curl -X GET http://zap/JSON/spider/action/setOptionParse
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/action/setOptionParseComments/', params={
- 'Boolean': 'string'
+r = requests.get('http://zap/JSON/graphql/action/setOptionMaxQueryDepth/', params={
+ 'Integer': '0'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/spider/action/setOptionParseComments/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/spider/action/setOptionParseComments/
-
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-Boolean
-query
-string
-true
-none
-
-
-
-
-Example responses
-
-default Response
-
-{
- "message": "string",
- "code": 100
-}
-
-Responses
-
-
-
-Status
-Meaning
-Description
-Schema
-
-
-
-default
-Default
-unexpected error
-Error
-
-
-
-
-spiderActionSetOptionParseGit
-
-
-
-Code samples
-
-# You can also use wget
-curl -X GET http://zap/JSON/spider/action/setOptionParseGit/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
-
-
URL obj = new URL("http://zap/JSON/spider/action/setOptionParseGit/?Boolean=string");
-HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("GET");
-int responseCode = con.getResponseCode();
-BufferedReader in = new BufferedReader(
- new InputStreamReader(con.getInputStream()));
-String inputLine;
-StringBuffer response = new StringBuffer();
-while ((inputLine = in.readLine()) != null) {
- response.append(inputLine);
-}
-in.close();
-System.out.println(response.toString());
-
-
import requests
-headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/spider/action/setOptionParseGit/', params={
- 'Boolean': 'string'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
+GET /JSON/graphql/action/setOptionMaxQueryDepth/
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/spider/action/setOptionParseGit/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+Sets the maximum query generation depth.
-
-GET /JSON/spider/action/setOptionParseGit/
-
-Parameters
+Parameters
@@ -13276,11 +31180,11 @@ curl -X GET http://zap/JSON/spider/action/setOptionParse
-Boolean
+Integer
query
-string
+integer
true
-none
+The Maximum Depth.
@@ -13290,11 +31194,12 @@ curl -X GET http://zap/JSON/spider/action/setOptionParse
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -13307,27 +31212,26 @@ curl -X GET http://zap/JSON/spider/action/setOptionParse
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-spiderActionSetOptionParseRobotsTxt
-
+graphqlActionSetOptionOptionalArgsEnabled
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/setOptionParseRobotsTxt/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/graphql/action/setOptionOptionalArgsEnabled/?Boolean=true \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/spider/action/setOptionParseRobotsTxt/?Boolean=string");
+
URL obj = new URL("http://zap/JSON/graphql/action/setOptionOptionalArgsEnabled/?Boolean=true");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -13343,35 +31247,21 @@ curl -X GET http://zap/JSON/spider/action/setOptionParse
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/action/setOptionParseRobotsTxt/', params={
- 'Boolean': 'string'
+r = requests.get('http://zap/JSON/graphql/action/setOptionOptionalArgsEnabled/', params={
+ 'Boolean': 'true'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/spider/action/setOptionParseRobotsTxt/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/spider/action/setOptionParseRobotsTxt/
+GET /JSON/graphql/action/setOptionOptionalArgsEnabled/
-Parameters
+Sets whether or not Optional Arguments should be specified.
+
+Parameters
@@ -13385,9 +31275,9 @@ curl -X GET http://zap/JSON/spider/action/setOptionParse
Boolean
query
-string
+boolean
true
-none
+Specify Optional Arguments (true or false).
@@ -13397,11 +31287,12 @@ curl -X GET http://zap/JSON/spider/action/setOptionParse
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -13414,27 +31305,26 @@ curl -X GET http://zap/JSON/spider/action/setOptionParse
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-spiderActionSetOptionParseSVNEntries
-
+graphqlActionSetOptionQueryGenEnabled
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/setOptionParseSVNEntries/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/graphql/action/setOptionQueryGenEnabled/?Boolean=true \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/spider/action/setOptionParseSVNEntries/?Boolean=string");
+
URL obj = new URL("http://zap/JSON/graphql/action/setOptionQueryGenEnabled/?Boolean=true");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -13450,35 +31340,21 @@ curl -X GET http://zap/JSON/spider/action/setOptionParse
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/action/setOptionParseSVNEntries/', params={
- 'Boolean': 'string'
+r = requests.get('http://zap/JSON/graphql/action/setOptionQueryGenEnabled/', params={
+ 'Boolean': 'true'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/spider/action/setOptionParseSVNEntries/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/spider/action/setOptionParseSVNEntries/
+GET /JSON/graphql/action/setOptionQueryGenEnabled/
-Parameters
+Sets whether the query generator is enabled.
+
+Parameters
@@ -13492,9 +31368,9 @@ curl -X GET http://zap/JSON/spider/action/setOptionParse
Boolean
query
-string
+boolean
true
-none
+Enable query generation (true or false).
@@ -13504,11 +31380,12 @@ curl -X GET http://zap/JSON/spider/action/setOptionParse
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -13521,27 +31398,26 @@ curl -X GET http://zap/JSON/spider/action/setOptionParse
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-spiderActionSetOptionParseSitemapXml
-
+graphqlActionSetOptionQuerySplitType
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/setOptionParseSitemapXml/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/graphql/action/setOptionQuerySplitType/?String=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/spider/action/setOptionParseSitemapXml/?Boolean=string");
+
URL obj = new URL("http://zap/JSON/graphql/action/setOptionQuerySplitType/?String=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -13557,35 +31433,21 @@ curl -X GET http://zap/JSON/spider/action/setOptionParse
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/action/setOptionParseSitemapXml/', params={
- 'Boolean': 'string'
+r = requests.get('http://zap/JSON/graphql/action/setOptionQuerySplitType/', params={
+ 'String': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/spider/action/setOptionParseSitemapXml/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/spider/action/setOptionParseSitemapXml/
+GET /JSON/graphql/action/setOptionQuerySplitType/
-Parameters
+Sets the level for which a single query is generated.
+
+Parameters
@@ -13597,11 +31459,11 @@ curl -X GET http://zap/JSON/spider/action/setOptionParse
-Boolean
+String
query
string
true
-none
+Can be "LEAF", "ROOT_FIELD", or "OPERATION".
@@ -13611,11 +31473,12 @@ curl -X GET http://zap/JSON/spider/action/setOptionParse
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -13628,27 +31491,26 @@ curl -X GET http://zap/JSON/spider/action/setOptionParse
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-spiderActionSetOptionPostForm
-
+graphqlActionSetOptionRequestMethod
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/setOptionPostForm/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/graphql/action/setOptionRequestMethod/?String=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/spider/action/setOptionPostForm/?Boolean=string");
+
URL obj = new URL("http://zap/JSON/graphql/action/setOptionRequestMethod/?String=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -13664,35 +31526,21 @@ curl -X GET http://zap/JSON/spider/action/setOptionPostF
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/action/setOptionPostForm/', params={
- 'Boolean': 'string'
+r = requests.get('http://zap/JSON/graphql/action/setOptionRequestMethod/', params={
+ 'String': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/spider/action/setOptionPostForm/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/spider/action/setOptionPostForm/
+GET /JSON/graphql/action/setOptionRequestMethod/
-Parameters
+Sets the request method.
+
+Parameters
@@ -13704,11 +31552,11 @@ curl -X GET http://zap/JSON/spider/action/setOptionPostF
-Boolean
+String
query
string
true
-none
+Can be "POST_JSON", "POST_GRAPHQL", or "GET".
@@ -13718,11 +31566,12 @@ curl -X GET http://zap/JSON/spider/action/setOptionPostF
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -13735,27 +31584,26 @@ curl -X GET http://zap/JSON/spider/action/setOptionPostF
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-spiderActionSetOptionProcessForm
-
+graphqlViewOptionArgsType
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/setOptionProcessForm/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/graphql/view/optionArgsType/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/spider/action/setOptionProcessForm/?Boolean=string");
+
URL obj = new URL("http://zap/JSON/graphql/view/optionArgsType/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -13771,53 +31619,17 @@ curl -X GET http://zap/JSON/spider/action/setOptionProce
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/spider/action/setOptionProcessForm/', params={
- 'Boolean': 'string'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/spider/action/setOptionProcessForm/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
+r = requests.get('http://zap/JSON/graphql/view/optionArgsType/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/spider/action/setOptionProcessForm/
-
-Parameters
+GET /JSON/graphql/view/optionArgsType/
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-Boolean
-query
-string
-true
-none
-
-
+Returns how arguments are currently specified.
Example responses
@@ -13825,11 +31637,12 @@ curl -X GET http://zap/JSON/spider/action/setOptionProce
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -13842,27 +31655,26 @@ curl -X GET http://zap/JSON/spider/action/setOptionProce
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-spiderActionSetOptionRequestWaitTime
-
+graphqlViewOptionLenientMaxQueryDepthEnabled
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/setOptionRequestWaitTime/?Integer=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/graphql/view/optionLenientMaxQueryDepthEnabled/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/spider/action/setOptionRequestWaitTime/?Integer=0");
+
URL obj = new URL("http://zap/JSON/graphql/view/optionLenientMaxQueryDepthEnabled/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -13878,53 +31690,17 @@ curl -X GET http://zap/JSON/spider/action/setOptionReque
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/action/setOptionRequestWaitTime/', params={
- 'Integer': '0'
-}, headers = headers)
+r = requests.get('http://zap/JSON/graphql/view/optionLenientMaxQueryDepthEnabled/', headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/spider/action/setOptionRequestWaitTime/',
- params: {
- 'Integer' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/spider/action/setOptionRequestWaitTime/
+GET /JSON/graphql/view/optionLenientMaxQueryDepthEnabled/
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-Integer
-query
-integer
-true
-none
-
-
+Returns whether or not lenient maximum query generation depth is enabled.
Example responses
@@ -13932,11 +31708,12 @@ curl -X GET http://zap/JSON/spider/action/setOptionReque
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -13949,27 +31726,26 @@ curl -X GET http://zap/JSON/spider/action/setOptionReque
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-spiderActionSetOptionSendRefererHeader
-
+graphqlViewOptionMaxAdditionalQueryDepth
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/setOptionSendRefererHeader/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/graphql/view/optionMaxAdditionalQueryDepth/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/spider/action/setOptionSendRefererHeader/?Boolean=string");
+
URL obj = new URL("http://zap/JSON/graphql/view/optionMaxAdditionalQueryDepth/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -13985,55 +31761,17 @@ curl -X GET http://zap/JSON/spider/action/setOptionSendR
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/spider/action/setOptionSendRefererHeader/', params={
- 'Boolean': 'string'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/spider/action/setOptionSendRefererHeader/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
+r = requests.get('http://zap/JSON/graphql/view/optionMaxAdditionalQueryDepth/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/spider/action/setOptionSendRefererHeader/
-
-Sets whether or not the 'Referer' header should be sent while spidering.
+GET /JSON/graphql/view/optionMaxAdditionalQueryDepth/
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-Boolean
-query
-string
-true
-none
-
-
+Returns the current maximum additional query generation depth.
Example responses
@@ -14041,11 +31779,12 @@ curl -X GET http://zap/JSON/spider/action/setOptionSendR
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -14058,27 +31797,26 @@ curl -X GET http://zap/JSON/spider/action/setOptionSendR
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-spiderActionSetOptionShowAdvancedDialog
-
+graphqlViewOptionMaxArgsDepth
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/setOptionShowAdvancedDialog/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/graphql/view/optionMaxArgsDepth/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/spider/action/setOptionShowAdvancedDialog/?Boolean=string");
+
URL obj = new URL("http://zap/JSON/graphql/view/optionMaxArgsDepth/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -14094,53 +31832,17 @@ curl -X GET http://zap/JSON/spider/action/setOptionShowA
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/action/setOptionShowAdvancedDialog/', params={
- 'Boolean': 'string'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+r = requests.get('http://zap/JSON/graphql/view/optionMaxArgsDepth/', headers = headers)
-result = RestClient.get 'http://zap/JSON/spider/action/setOptionShowAdvancedDialog/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/spider/action/setOptionShowAdvancedDialog/
+GET /JSON/graphql/view/optionMaxArgsDepth/
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-Boolean
-query
-string
-true
-none
-
-
+Returns the current maximum arguments generation depth.
Example responses
@@ -14148,11 +31850,12 @@ curl -X GET http://zap/JSON/spider/action/setOptionShowA
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -14165,27 +31868,26 @@ curl -X GET http://zap/JSON/spider/action/setOptionShowA
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-spiderActionSetOptionThreadCount
-
+graphqlViewOptionMaxQueryDepth
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/spider/action/setOptionThreadCount/?Integer=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/graphql/view/optionMaxQueryDepth/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/spider/action/setOptionThreadCount/?Integer=0");
+
URL obj = new URL("http://zap/JSON/graphql/view/optionMaxQueryDepth/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -14201,65 +31903,101 @@ curl -X GET http://zap/JSON/spider/action/setOptionThrea
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/spider/action/setOptionThreadCount/', params={
- 'Integer': '0'
-}, headers = headers)
-
-print r.json()
+r = requests.get('http://zap/JSON/graphql/view/optionMaxQueryDepth/', headers = headers)
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+print(r.json())
-result = RestClient.get 'http://zap/JSON/spider/action/setOptionThreadCount/',
- params: {
- 'Integer' => 'integer'
-}, headers: headers
+
+GET /JSON/graphql/view/optionMaxQueryDepth/
-p JSON.parse(result)
+Returns the current maximum query generation depth.
-
-GET /JSON/spider/action/setOptionThreadCount/
+
+Example responses
-Parameters
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
-Name
-In
-Type
-Required
+Status
+Meaning
Description
+Schema
-Integer
-query
-integer
-true
-none
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+graphqlViewOptionOptionalArgsEnabled
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/graphql/view/optionOptionalArgsEnabled/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/graphql/view/optionOptionalArgsEnabled/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/graphql/view/optionOptionalArgsEnabled/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/graphql/view/optionOptionalArgsEnabled/
+
+Returns whether or not optional arguments are currently specified.
+
Example responses
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -14272,29 +32010,26 @@ curl -X GET http://zap/JSON/spider/action/setOptionThrea
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-
-core
-coreViewHosts
-
+graphqlViewOptionQueryGenEnabled
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/hosts/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/graphql/view/optionQueryGenEnabled/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/hosts/");
+
URL obj = new URL("http://zap/JSON/graphql/view/optionQueryGenEnabled/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -14310,34 +32045,17 @@ curl -X GET http://zap/JSON/core/view/hosts/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/core/view/hosts/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/core/view/hosts/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/graphql/view/optionQueryGenEnabled/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/view/hosts/
+GET /JSON/graphql/view/optionQueryGenEnabled/
-Gets the name of the hosts accessed through/by ZAP
+Returns whether the query generator is enabled.
Example responses
@@ -14345,11 +32063,12 @@ curl -X GET http://zap/JSON/core/view/hosts/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -14362,27 +32081,26 @@ curl -X GET http://zap/JSON/core/view/hosts/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewSites
-
+graphqlViewOptionQuerySplitType
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/sites/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/graphql/view/optionQuerySplitType/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/sites/");
+
URL obj = new URL("http://zap/JSON/graphql/view/optionQuerySplitType/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -14396,36 +32114,19 @@ curl -X GET http://zap/JSON/core/view/sites/ in.close();
System.out.println(response.toString());
-
import requests
-headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/core/view/sites/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
+
import requests
headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/core/view/sites/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/graphql/view/optionQuerySplitType/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/view/sites/
+GET /JSON/graphql/view/optionQuerySplitType/
-Gets the sites accessed through/by ZAP (scheme and domain)
+Returns the current level for which a single query is generated.
Example responses
@@ -14433,11 +32134,12 @@ curl -X GET http://zap/JSON/core/view/sites/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -14450,27 +32152,26 @@ curl -X GET http://zap/JSON/core/view/sites/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewUrls
-
+graphqlViewOptionRequestMethod
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/urls/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/graphql/view/optionRequestMethod/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/urls/");
+
URL obj = new URL("http://zap/JSON/graphql/view/optionRequestMethod/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -14486,54 +32187,17 @@ curl -X GET http://zap/JSON/core/view/urls/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/core/view/urls/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/core/view/urls/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/graphql/view/optionRequestMethod/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/view/urls/
-
-Gets the URLs accessed through/by ZAP, optionally filtering by (base) URL.
-
-Parameters
+GET /JSON/graphql/view/optionRequestMethod/
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-baseurl
-query
-string
-false
-none
-
-
+Returns the current request method.
Example responses
@@ -14541,11 +32205,12 @@ curl -X GET http://zap/JSON/core/view/urls/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -14558,27 +32223,28 @@ curl -X GET http://zap/JSON/core/view/urls/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewChildNodes
-
+
+httpSessions
+httpSessionsActionAddDefaultSessionToken
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/childNodes/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/httpSessions/action/addDefaultSessionToken/?sessionToken=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/childNodes/");
+
URL obj = new URL("http://zap/JSON/httpSessions/action/addDefaultSessionToken/?sessionToken=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -14594,36 +32260,21 @@ curl -X GET http://zap/JSON/core/view/childNodes/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/view/childNodes/', params={
-
+r = requests.get('http://zap/JSON/httpSessions/action/addDefaultSessionToken/', params={
+ 'sessionToken': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/view/childNodes/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/view/childNodes/
+GET /JSON/httpSessions/action/addDefaultSessionToken/
-Gets the child nodes underneath the specified URL in the Sites tree
+Adds a default session token with the given name and enabled state.
-Parameters
+Parameters
@@ -14635,7 +32286,14 @@ curl -X GET http://zap/JSON/core/view/childNodes/
-url
+sessionToken
+query
+string
+true
+none
+
+
+tokenEnabled
query
string
false
@@ -14649,11 +32307,12 @@ curl -X GET http://zap/JSON/core/view/childNodes/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -14666,27 +32325,26 @@ curl -X GET http://zap/JSON/core/view/childNodes/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewMessage
-
+httpSessionsActionAddSessionToken
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/message/?id=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/httpSessions/action/addSessionToken/?site=string&sessionToken=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/message/?id=0");
+
URL obj = new URL("http://zap/JSON/httpSessions/action/addSessionToken/?site=string&sessionToken=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -14702,37 +32360,21 @@ curl -X GET http://zap/JSON/core/view/message/?id
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/view/message/', params={
- 'id': '0'
+r = requests.get('http://zap/JSON/httpSessions/action/addSessionToken/', params={
+ 'site': 'string', 'sessionToken': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/view/message/',
- params: {
- 'id' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/view/message/
+GET /JSON/httpSessions/action/addSessionToken/
-Gets the HTTP message with the given ID. Returns the ID, request/response headers and bodies, cookies, note, type, RTT, and timestamp.
+Adds the session token to the given site.
-Parameters
+Parameters
@@ -14744,9 +32386,16 @@ curl -X GET http://zap/JSON/core/view/message/?id
-id
+site
query
-integer
+string
+true
+none
+
+
+sessionToken
+query
+string
true
none
@@ -14758,11 +32407,12 @@ curl -X GET http://zap/JSON/core/view/message/?iddefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -14775,27 +32425,26 @@ curl -X GET http://zap/JSON/core/view/message/?id
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewMessages
-
+httpSessionsActionCreateEmptySession
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/messages/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/httpSessions/action/createEmptySession/?site=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/messages/");
+
URL obj = new URL("http://zap/JSON/httpSessions/action/createEmptySession/?site=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -14811,36 +32460,21 @@ curl -X GET http://zap/JSON/core/view/messages/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/view/messages/', params={
-
+r = requests.get('http://zap/JSON/httpSessions/action/createEmptySession/', params={
+ 'site': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/view/messages/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/view/messages/
+GET /JSON/httpSessions/action/createEmptySession/
-Gets the HTTP messages sent by ZAP, request and response, optionally filtered by URL and paginated with 'start' position and 'count' of messages
+Creates an empty session for the given site. Optionally with the given name.
-Parameters
+Parameters
@@ -14852,23 +32486,16 @@ curl -X GET http://zap/JSON/core/view/messages/
-baseurl
+site
query
string
-false
-none
-
-
-start
-query
-integer
-false
+true
none
-count
+session
query
-integer
+string
false
none
@@ -14880,11 +32507,12 @@ curl -X GET http://zap/JSON/core/view/messages/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -14897,27 +32525,26 @@ curl -X GET http://zap/JSON/core/view/messages/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewMessagesById
-
+httpSessionsActionRemoveDefaultSessionToken
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/messagesById/?ids=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/httpSessions/action/removeDefaultSessionToken/?sessionToken=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/messagesById/?ids=string");
+
URL obj = new URL("http://zap/JSON/httpSessions/action/removeDefaultSessionToken/?sessionToken=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -14933,37 +32560,21 @@ curl -X GET http://zap/JSON/core/view/messagesById/?ids<
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/view/messagesById/', params={
- 'ids': 'string'
+r = requests.get('http://zap/JSON/httpSessions/action/removeDefaultSessionToken/', params={
+ 'sessionToken': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/view/messagesById/',
- params: {
- 'ids' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/view/messagesById/
+GET /JSON/httpSessions/action/removeDefaultSessionToken/
-Gets the HTTP messages with the given IDs.
+Removes the default session token with the given name.
-Parameters
+Parameters
@@ -14975,7 +32586,7 @@ curl -X GET http://zap/JSON/core/view/messagesById/?ids<
-ids
+sessionToken
query
string
true
@@ -14989,11 +32600,12 @@ curl -X GET http://zap/JSON/core/view/messagesById/?ids<
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -15006,27 +32618,26 @@ curl -X GET http://zap/JSON/core/view/messagesById/?ids<
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewNumberOfMessages
-
+httpSessionsActionRemoveSession
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/numberOfMessages/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/httpSessions/action/removeSession/?site=string&session=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/numberOfMessages/");
+
URL obj = new URL("http://zap/JSON/httpSessions/action/removeSession/?site=string&session=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -15042,36 +32653,21 @@ curl -X GET http://zap/JSON/core/view/numberOfMessages/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/view/numberOfMessages/', params={
-
+r = requests.get('http://zap/JSON/httpSessions/action/removeSession/', params={
+ 'site': 'string', 'session': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/view/numberOfMessages/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/view/numberOfMessages/
+GET /JSON/httpSessions/action/removeSession/
-Gets the number of messages, optionally filtering by URL
+Removes the session from the given site.
-Parameters
+Parameters
@@ -15083,10 +32679,17 @@ curl -X GET http://zap/JSON/core/view/numberOfMessages/
-baseurl
+site
query
string
-false
+true
+none
+
+
+session
+query
+string
+true
none
@@ -15097,11 +32700,12 @@ curl -X GET http://zap/JSON/core/view/numberOfMessages/
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -15114,27 +32718,26 @@ curl -X GET http://zap/JSON/core/view/numberOfMessages/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewMode
-
+httpSessionsActionRemoveSessionToken
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/mode/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/httpSessions/action/removeSessionToken/?site=string&sessionToken=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/mode/");
+
URL obj = new URL("http://zap/JSON/httpSessions/action/removeSessionToken/?site=string&sessionToken=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -15150,34 +32753,46 @@ curl -X GET http://zap/JSON/core/view/mode/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/view/mode/', params={
-
+r = requests.get('http://zap/JSON/httpSessions/action/removeSessionToken/', params={
+ 'site': 'string', 'sessionToken': 'string'
}, headers = headers)
-print r.json()
+print(r.json())
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/view/mode/',
- params: {
- }, headers: headers
+
+GET /JSON/httpSessions/action/removeSessionToken/
-p JSON.parse(result)
+Removes the session token from the given site.
-
-GET /JSON/core/view/mode/
+Parameters
-Gets the mode
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+site
+query
+string
+true
+none
+
+
+sessionToken
+query
+string
+true
+none
+
+
Example responses
@@ -15185,11 +32800,12 @@ curl -X GET http://zap/JSON/core/view/mode/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -15202,27 +32818,26 @@ curl -X GET http://zap/JSON/core/view/mode/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewVersion
-
+httpSessionsActionRenameSession
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/version/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/httpSessions/action/renameSession/?site=string&oldSessionName=string&newSessionName=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/version/");
+
URL obj = new URL("http://zap/JSON/httpSessions/action/renameSession/?site=string&oldSessionName=string&newSessionName=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -15238,34 +32853,53 @@ curl -X GET http://zap/JSON/core/view/version/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/view/version/', params={
-
+r = requests.get('http://zap/JSON/httpSessions/action/renameSession/', params={
+ 'site': 'string', 'oldSessionName': 'string', 'newSessionName': 'string'
}, headers = headers)
-print r.json()
+print(r.json())
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/view/version/',
- params: {
- }, headers: headers
+
+GET /JSON/httpSessions/action/renameSession/
-p JSON.parse(result)
+Renames the session of the given site.
-
-GET /JSON/core/view/version/
+Parameters
-Gets ZAP version
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+site
+query
+string
+true
+none
+
+
+oldSessionName
+query
+string
+true
+none
+
+
+newSessionName
+query
+string
+true
+none
+
+
Example responses
@@ -15273,11 +32907,12 @@ curl -X GET http://zap/JSON/core/view/version/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -15290,27 +32925,26 @@ curl -X GET http://zap/JSON/core/view/version/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewExcludedFromProxy
-
+httpSessionsActionSetActiveSession
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/excludedFromProxy/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/httpSessions/action/setActiveSession/?site=string&session=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/excludedFromProxy/");
+
URL obj = new URL("http://zap/JSON/httpSessions/action/setActiveSession/?site=string&session=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -15326,34 +32960,46 @@ curl -X GET http://zap/JSON/core/view/excludedFromProxy/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/view/excludedFromProxy/', params={
-
+r = requests.get('http://zap/JSON/httpSessions/action/setActiveSession/', params={
+ 'site': 'string', 'session': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
+print(r.json())
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/view/excludedFromProxy/',
- params: {
- }, headers: headers
+
+GET /JSON/httpSessions/action/setActiveSession/
-p JSON.parse(result)
+Sets the given session as active for the given site.
-
-GET /JSON/core/view/excludedFromProxy/
+Parameters
-Gets the regular expressions, applied to URLs, to exclude from the local proxies.
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+site
+query
+string
+true
+none
+
+
+session
+query
+string
+true
+none
+
+
Example responses
@@ -15361,11 +33007,12 @@ curl -X GET http://zap/JSON/core/view/excludedFromProxy/
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -15378,27 +33025,26 @@ curl -X GET http://zap/JSON/core/view/excludedFromProxy/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewHomeDirectory
-
+httpSessionsActionSetDefaultSessionTokenEnabled
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/homeDirectory/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/httpSessions/action/setDefaultSessionTokenEnabled/?sessionToken=string&tokenEnabled=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/homeDirectory/");
+
URL obj = new URL("http://zap/JSON/httpSessions/action/setDefaultSessionTokenEnabled/?sessionToken=string&tokenEnabled=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -15414,32 +33060,46 @@ curl -X GET http://zap/JSON/core/view/homeDirectory/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/view/homeDirectory/', params={
-
+r = requests.get('http://zap/JSON/httpSessions/action/setDefaultSessionTokenEnabled/', params={
+ 'sessionToken': 'string', 'tokenEnabled': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
+print(r.json())
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+
+GET /JSON/httpSessions/action/setDefaultSessionTokenEnabled/
-result = RestClient.get 'http://zap/JSON/core/view/homeDirectory/',
- params: {
- }, headers: headers
+Sets whether or not the default session token with the given name is enabled.
-p JSON.parse(result)
+Parameters
-
-GET /JSON/core/view/homeDirectory/
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+sessionToken
+query
+string
+true
+none
+
+
+tokenEnabled
+query
+string
+true
+none
+
+
Example responses
@@ -15447,11 +33107,12 @@ curl -X GET http://zap/JSON/core/view/homeDirectory/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -15464,27 +33125,26 @@ curl -X GET http://zap/JSON/core/view/homeDirectory/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewSessionLocation
-
+httpSessionsActionSetSessionTokenValue
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/sessionLocation/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/httpSessions/action/setSessionTokenValue/?site=string&session=string&sessionToken=string&tokenValue=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/sessionLocation/");
+
URL obj = new URL("http://zap/JSON/httpSessions/action/setSessionTokenValue/?site=string&session=string&sessionToken=string&tokenValue=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -15500,34 +33160,60 @@ curl -X GET http://zap/JSON/core/view/sessionLocation/ <
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/view/sessionLocation/', params={
-
+r = requests.get('http://zap/JSON/httpSessions/action/setSessionTokenValue/', params={
+ 'site': 'string', 'session': 'string', 'sessionToken': 'string', 'tokenValue': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+print(r.json())
-result = RestClient.get 'http://zap/JSON/core/view/sessionLocation/',
- params: {
- }, headers: headers
+
+GET /JSON/httpSessions/action/setSessionTokenValue/
-p JSON.parse(result)
+Sets the value of the session token of the given session for the given site.
-
-GET /JSON/core/view/sessionLocation/
+Parameters
-Gets the location of the current session file
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+site
+query
+string
+true
+none
+
+
+session
+query
+string
+true
+none
+
+
+sessionToken
+query
+string
+true
+none
+
+
+tokenValue
+query
+string
+true
+none
+
+
Example responses
@@ -15535,11 +33221,12 @@ curl -X GET http://zap/JSON/core/view/sessionLocation/ <
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -15552,27 +33239,26 @@ curl -X GET http://zap/JSON/core/view/sessionLocation/ <
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewProxyChainExcludedDomains
-
+httpSessionsActionUnsetActiveSession
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/proxyChainExcludedDomains/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/httpSessions/action/unsetActiveSession/?site=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/proxyChainExcludedDomains/");
+
URL obj = new URL("http://zap/JSON/httpSessions/action/unsetActiveSession/?site=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -15588,34 +33274,39 @@ curl -X GET http://zap/JSON/core/view/proxyChainExcluded
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/view/proxyChainExcludedDomains/', params={
-
+r = requests.get('http://zap/JSON/httpSessions/action/unsetActiveSession/', params={
+ 'site': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
+print(r.json())
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/view/proxyChainExcludedDomains/',
- params: {
- }, headers: headers
+
+GET /JSON/httpSessions/action/unsetActiveSession/
-p JSON.parse(result)
+Unsets the active session of the given site.
-
-GET /JSON/core/view/proxyChainExcludedDomains/
+Parameters
-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.
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+site
+query
+string
+true
+none
+
+
Example responses
@@ -15623,11 +33314,12 @@ curl -X GET http://zap/JSON/core/view/proxyChainExcluded
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -15640,27 +33332,26 @@ curl -X GET http://zap/JSON/core/view/proxyChainExcluded
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewOptionProxyChainSkipName
-
+httpSessionsViewActiveSession
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/optionProxyChainSkipName/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/httpSessions/view/activeSession/?site=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/optionProxyChainSkipName/");
+
URL obj = new URL("http://zap/JSON/httpSessions/view/activeSession/?site=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -15676,34 +33367,39 @@ curl -X GET http://zap/JSON/core/view/optionProxyChainSk
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/view/optionProxyChainSkipName/', params={
-
+r = requests.get('http://zap/JSON/httpSessions/view/activeSession/', params={
+ 'site': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
+print(r.json())
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/view/optionProxyChainSkipName/',
- params: {
- }, headers: headers
+
+GET /JSON/httpSessions/view/activeSession/
-p JSON.parse(result)
+Gets the name of the active session for the given site.
-
-GET /JSON/core/view/optionProxyChainSkipName/
+Parameters
-Use view proxyChainExcludedDomains instead.
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+site
+query
+string
+true
+none
+
+
Example responses
@@ -15711,11 +33407,12 @@ curl -X GET http://zap/JSON/core/view/optionProxyChainSk
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -15728,27 +33425,26 @@ curl -X GET http://zap/JSON/core/view/optionProxyChainSk
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewOptionProxyExcludedDomains
-
+httpSessionsViewDefaultSessionTokens
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/optionProxyExcludedDomains/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/httpSessions/view/defaultSessionTokens/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/optionProxyExcludedDomains/");
+
URL obj = new URL("http://zap/JSON/httpSessions/view/defaultSessionTokens/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -15764,34 +33460,17 @@ curl -X GET http://zap/JSON/core/view/optionProxyExclude
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/core/view/optionProxyExcludedDomains/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/core/view/optionProxyExcludedDomains/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/httpSessions/view/defaultSessionTokens/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/view/optionProxyExcludedDomains/
+GET /JSON/httpSessions/view/defaultSessionTokens/
-Use view proxyChainExcludedDomains instead.
+Gets the default session tokens.
Example responses
@@ -15799,11 +33478,12 @@ curl -X GET http://zap/JSON/core/view/optionProxyExclude
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -15816,27 +33496,26 @@ curl -X GET http://zap/JSON/core/view/optionProxyExclude
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewOptionProxyExcludedDomainsEnabled
-
+httpSessionsViewSessionTokens
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/optionProxyExcludedDomainsEnabled/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/httpSessions/view/sessionTokens/?site=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/optionProxyExcludedDomainsEnabled/");
+
URL obj = new URL("http://zap/JSON/httpSessions/view/sessionTokens/?site=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -15852,34 +33531,39 @@ curl -X GET http://zap/JSON/core/view/optionProxyExclude
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/view/optionProxyExcludedDomainsEnabled/', params={
-
+r = requests.get('http://zap/JSON/httpSessions/view/sessionTokens/', params={
+ 'site': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+print(r.json())
-result = RestClient.get 'http://zap/JSON/core/view/optionProxyExcludedDomainsEnabled/',
- params: {
- }, headers: headers
+
+GET /JSON/httpSessions/view/sessionTokens/
-p JSON.parse(result)
+Gets the names of the session tokens for the given site.
-
-GET /JSON/core/view/optionProxyExcludedDomainsEnabled/
+Parameters
-Use view proxyChainExcludedDomains instead.
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+site
+query
+string
+true
+none
+
+
Example responses
@@ -15887,11 +33571,12 @@ curl -X GET http://zap/JSON/core/view/optionProxyExclude
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -15904,27 +33589,26 @@ curl -X GET http://zap/JSON/core/view/optionProxyExclude
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewZapHomePath
-
+httpSessionsViewSessions
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/zapHomePath/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/httpSessions/view/sessions/?site=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/zapHomePath/");
+
URL obj = new URL("http://zap/JSON/httpSessions/view/sessions/?site=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -15940,34 +33624,46 @@ curl -X GET http://zap/JSON/core/view/zapHomePath/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/view/zapHomePath/', params={
-
+r = requests.get('http://zap/JSON/httpSessions/view/sessions/', params={
+ 'site': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+print(r.json())
-result = RestClient.get 'http://zap/JSON/core/view/zapHomePath/',
- params: {
- }, headers: headers
+
+GET /JSON/httpSessions/view/sessions/
-p JSON.parse(result)
+Gets the sessions for the given site. Optionally returning just the session with the given name.
-
-GET /JSON/core/view/zapHomePath/
+Parameters
-Gets the path to ZAP's home directory.
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+site
+query
+string
+true
+none
+
+
+session
+query
+string
+false
+none
+
+
Example responses
@@ -15975,11 +33671,12 @@ curl -X GET http://zap/JSON/core/view/zapHomePath/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -15992,27 +33689,26 @@ curl -X GET http://zap/JSON/core/view/zapHomePath/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewOptionMaximumAlertInstances
-
+httpSessionsViewSites
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/optionMaximumAlertInstances/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/httpSessions/view/sites/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/optionMaximumAlertInstances/");
+
URL obj = new URL("http://zap/JSON/httpSessions/view/sites/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -16028,34 +33724,17 @@ curl -X GET http://zap/JSON/core/view/optionMaximumAlert
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/core/view/optionMaximumAlertInstances/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/core/view/optionMaximumAlertInstances/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/httpSessions/view/sites/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/view/optionMaximumAlertInstances/
+GET /JSON/httpSessions/view/sites/
-Gets the maximum number of alert instances to include in a report.
+Gets all of the sites that have sessions.
Example responses
@@ -16063,11 +33742,12 @@ curl -X GET http://zap/JSON/core/view/optionMaximumAlert
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -16080,27 +33760,28 @@ curl -X GET http://zap/JSON/core/view/optionMaximumAlert
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewOptionMergeRelatedAlerts
-
+
+keyboard
+keyboardOtherCheatsheetActionOrder
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/optionMergeRelatedAlerts/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/OTHER/keyboard/other/cheatsheetActionOrder/ \
+ -H 'Accept: */*'
-
URL obj = new URL("http://zap/JSON/core/view/optionMergeRelatedAlerts/");
+
URL obj = new URL("http://zap/OTHER/keyboard/other/cheatsheetActionOrder/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -16116,46 +33797,43 @@ curl -X GET http://zap/JSON/core/view/optionMergeRelated
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': '*/*'
}
-r = requests.get('http://zap/JSON/core/view/optionMergeRelatedAlerts/', params={
-
-}, headers = headers)
-
-print r.json()
+r = requests.get('http://zap/OTHER/keyboard/other/cheatsheetActionOrder/', headers = headers)
-
require 'rest-client'
-require 'json'
+print(r.content)
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/view/optionMergeRelatedAlerts/',
- params: {
- }, headers: headers
+
+GET /OTHER/keyboard/other/cheatsheetActionOrder/
-p JSON.parse(result)
+Lists the keyboard shortcuts sorted by action, optionally, showing actions without shortcut set.
-
-GET /JSON/core/view/optionMergeRelatedAlerts/
+Parameters
-Gets whether or not related alerts will be merged in any reports generated.
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+incUnset
+query
+string
+false
+none
+
+
Example responses
-
-default Response
-{
- "message": "string",
- "code": 100
-}
-
-Responses
+
+Responses
@@ -16168,27 +33846,28 @@ curl -X GET http://zap/JSON/core/view/optionMergeRelated
default
Default
-unexpected error
-Error
+Error of OTHER endpoints.
+None
+Response Schema
+
-coreViewOptionAlertOverridesFilePath
-
+keyboardOtherCheatsheetKeyOrder
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/optionAlertOverridesFilePath/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/OTHER/keyboard/other/cheatsheetKeyOrder/ \
+ -H 'Accept: */*'
-
URL obj = new URL("http://zap/JSON/core/view/optionAlertOverridesFilePath/");
+
URL obj = new URL("http://zap/OTHER/keyboard/other/cheatsheetKeyOrder/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -16204,46 +33883,43 @@ curl -X GET http://zap/JSON/core/view/optionAlertOverrid
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': '*/*'
}
-r = requests.get('http://zap/JSON/core/view/optionAlertOverridesFilePath/', params={
+r = requests.get('http://zap/OTHER/keyboard/other/cheatsheetKeyOrder/', headers = headers)
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+print(r.content)
-result = RestClient.get 'http://zap/JSON/core/view/optionAlertOverridesFilePath/',
- params: {
- }, headers: headers
+
+GET /OTHER/keyboard/other/cheatsheetKeyOrder/
-p JSON.parse(result)
+Lists the keyboard shortcuts sorted by keyboard shortcut, optionally, showing actions without shortcut set.
-
-GET /JSON/core/view/optionAlertOverridesFilePath/
+Parameters
-Gets the path to the file with alert overrides.
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+incUnset
+query
+string
+false
+none
+
+
Example responses
-
-default Response
-{
- "message": "string",
- "code": 100
-}
-
-Responses
+
+Responses
@@ -16256,27 +33932,30 @@ curl -X GET http://zap/JSON/core/view/optionAlertOverrid
default
Default
-unexpected error
-Error
+Error of OTHER endpoints.
+None
+Response Schema
+
-coreViewAlert
-
+
+localProxies
+localProxiesActionAddAdditionalProxy
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/alert/?id=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/localProxies/action/addAdditionalProxy/?address=string&port=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/alert/?id=0");
+
URL obj = new URL("http://zap/JSON/localProxies/action/addAdditionalProxy/?address=string&port=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -16292,37 +33971,21 @@ curl -X GET http://zap/JSON/core/view/alert/?id
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/view/alert/', params={
- 'id': '0'
+r = requests.get('http://zap/JSON/localProxies/action/addAdditionalProxy/', params={
+ 'address': 'string', 'port': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/view/alert/',
- params: {
- 'id' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/view/alert/
+GET /JSON/localProxies/action/addAdditionalProxy/
-Gets the alert with the given ID, the corresponding HTTP message can be obtained with the 'messageId' field and 'message' API method
+Use the API endpoints in the 'network' component instead.
-Parameters
+Parameters
@@ -16334,12 +33997,40 @@ curl -X GET http://zap/JSON/core/view/alert/?id
-id
+address
query
-integer
+string
+true
+none
+
+
+port
+query
+string
true
none
+
+behindNat
+query
+string
+false
+none
+
+
+alwaysDecodeZip
+query
+string
+false
+none
+
+
+removeUnsupportedEncodings
+query
+string
+false
+none
+
@@ -16348,11 +34039,12 @@ curl -X GET http://zap/JSON/core/view/alert/?iddefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -16365,27 +34057,26 @@ curl -X GET http://zap/JSON/core/view/alert/?id
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewAlerts
-
+localProxiesActionRemoveAdditionalProxy
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/alerts/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/localProxies/action/removeAdditionalProxy/?address=string&port=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/alerts/");
+
URL obj = new URL("http://zap/JSON/localProxies/action/removeAdditionalProxy/?address=string&port=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -16401,36 +34092,21 @@ curl -X GET http://zap/JSON/core/view/alerts/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/view/alerts/', params={
-
+r = requests.get('http://zap/JSON/localProxies/action/removeAdditionalProxy/', params={
+ 'address': 'string', 'port': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/view/alerts/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/view/alerts/
+GET /JSON/localProxies/action/removeAdditionalProxy/
-Gets the alerts raised by ZAP, optionally filtering by URL or riskId, and paginating with 'start' position and 'count' of alerts
+Use the API endpoints in the 'network' component instead.
-Parameters
+Parameters
@@ -16442,31 +34118,17 @@ curl -X GET http://zap/JSON/core/view/alerts/
-baseurl
+address
query
string
-false
-none
-
-
-start
-query
-integer
-false
-none
-
-
-count
-query
-integer
-false
+true
none
-riskId
+port
query
string
-false
+true
none
@@ -16477,11 +34139,12 @@ curl -X GET http://zap/JSON/core/view/alerts/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -16494,27 +34157,26 @@ curl -X GET http://zap/JSON/core/view/alerts/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewAlertsSummary
-
+localProxiesViewAdditionalProxies
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/alertsSummary/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/localProxies/view/additionalProxies/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/alertsSummary/");
+
URL obj = new URL("http://zap/JSON/localProxies/view/additionalProxies/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -16530,54 +34192,17 @@ curl -X GET http://zap/JSON/core/view/alertsSummary/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/core/view/alertsSummary/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/core/view/alertsSummary/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/localProxies/view/additionalProxies/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/view/alertsSummary/
-
-Gets number of alerts grouped by each risk level, optionally filtering by URL
-
-Parameters
+GET /JSON/localProxies/view/additionalProxies/
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-baseurl
-query
-string
-false
-none
-
-
+Use the API endpoints in the 'network' component instead.
Example responses
@@ -16585,11 +34210,12 @@ curl -X GET http://zap/JSON/core/view/alertsSummary/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -16602,27 +34228,28 @@ curl -X GET http://zap/JSON/core/view/alertsSummary/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewNumberOfAlerts
-
+
+network
+networkActionAddAlias
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/numberOfAlerts/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/action/addAlias/?name=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/numberOfAlerts/");
+
URL obj = new URL("http://zap/JSON/network/action/addAlias/?name=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -16638,36 +34265,21 @@ curl -X GET http://zap/JSON/core/view/numberOfAlerts/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/view/numberOfAlerts/', params={
-
+r = requests.get('http://zap/JSON/network/action/addAlias/', params={
+ 'name': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/view/numberOfAlerts/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/view/numberOfAlerts/
+GET /JSON/network/action/addAlias/
-Gets the number of alerts, optionally filtering by URL or riskId
+Adds an alias for the local servers/proxies.
-Parameters
+Parameters
@@ -16679,18 +34291,18 @@ curl -X GET http://zap/JSON/core/view/numberOfAlerts/
-baseurl
+name
query
string
-false
-none
+true
+The name of the alias.
-riskId
+enabled
query
string
false
-none
+The enabled state, true or false.
@@ -16700,11 +34312,12 @@ curl -X GET http://zap/JSON/core/view/numberOfAlerts/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -16717,27 +34330,26 @@ curl -X GET http://zap/JSON/core/view/numberOfAlerts/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewOptionDefaultUserAgent
-
+networkActionAddHttpProxyExclusion
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/optionDefaultUserAgent/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/action/addHttpProxyExclusion/?host=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/optionDefaultUserAgent/");
+
URL obj = new URL("http://zap/JSON/network/action/addHttpProxyExclusion/?host=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -16753,34 +34365,46 @@ curl -X GET http://zap/JSON/core/view/optionDefaultUserA
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/view/optionDefaultUserAgent/', params={
-
+r = requests.get('http://zap/JSON/network/action/addHttpProxyExclusion/', params={
+ 'host': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+print(r.json())
-result = RestClient.get 'http://zap/JSON/core/view/optionDefaultUserAgent/',
- params: {
- }, headers: headers
+
+GET /JSON/network/action/addHttpProxyExclusion/
-p JSON.parse(result)
+Adds a host to be excluded from the HTTP proxy.
-
-GET /JSON/core/view/optionDefaultUserAgent/
+Parameters
-Gets the user agent that ZAP should use when creating HTTP messages (for example, spider messages or CONNECT requests to outgoing proxy).
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+host
+query
+string
+true
+The value of the host, a regular expression.
+
+
+enabled
+query
+string
+false
+The enabled state, true or false.
+
+
Example responses
@@ -16788,11 +34412,12 @@ curl -X GET http://zap/JSON/core/view/optionDefaultUserA
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -16805,27 +34430,26 @@ curl -X GET http://zap/JSON/core/view/optionDefaultUserA
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewOptionDnsTtlSuccessfulQueries
-
+networkActionAddLocalServer
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/optionDnsTtlSuccessfulQueries/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/action/addLocalServer/?address=string&port=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/optionDnsTtlSuccessfulQueries/");
+
URL obj = new URL("http://zap/JSON/network/action/addLocalServer/?address=string&port=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -16841,34 +34465,81 @@ curl -X GET http://zap/JSON/core/view/optionDnsTtlSucces
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/view/optionDnsTtlSuccessfulQueries/', params={
-
+r = requests.get('http://zap/JSON/network/action/addLocalServer/', params={
+ 'address': 'string', 'port': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+print(r.json())
-result = RestClient.get 'http://zap/JSON/core/view/optionDnsTtlSuccessfulQueries/',
- params: {
- }, headers: headers
+
+GET /JSON/network/action/addLocalServer/
-p JSON.parse(result)
+Adds a local server/proxy.
-
-GET /JSON/core/view/optionDnsTtlSuccessfulQueries/
+Parameters
-Gets the TTL (in seconds) of successful DNS queries.
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+address
+query
+string
+true
+The address of the local server/proxy.
+
+
+port
+query
+string
+true
+The port of the local server/proxy.
+
+
+api
+query
+string
+false
+If the ZAP API is available, true or false.
+
+
+proxy
+query
+string
+false
+If the local server should proxy, true or false.
+
+
+behindNat
+query
+string
+false
+If the local server is behind NAT, true or false.
+
+
+decodeResponse
+query
+string
+false
+If the response should be decoded, true or false.
+
+
+removeAcceptEncoding
+query
+string
+false
+If the request header Accept-Encoding should be removed, true or false.
+
+
Example responses
@@ -16876,11 +34547,12 @@ curl -X GET http://zap/JSON/core/view/optionDnsTtlSucces
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -16893,27 +34565,26 @@ curl -X GET http://zap/JSON/core/view/optionDnsTtlSucces
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewOptionHttpState
-
+networkActionAddPassThrough
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/optionHttpState/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/action/addPassThrough/?authority=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/optionHttpState/");
+
URL obj = new URL("http://zap/JSON/network/action/addPassThrough/?authority=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -16929,32 +34600,46 @@ curl -X GET http://zap/JSON/core/view/optionHttpState/ <
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/view/optionHttpState/', params={
-
+r = requests.get('http://zap/JSON/network/action/addPassThrough/', params={
+ 'authority': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
+print(r.json())
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+
+GET /JSON/network/action/addPassThrough/
-result = RestClient.get 'http://zap/JSON/core/view/optionHttpState/',
- params: {
- }, headers: headers
+Adds an authority to pass-through the local proxies.
-p JSON.parse(result)
+Parameters
-
-GET /JSON/core/view/optionHttpState/
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+authority
+query
+string
+true
+The value of the authority, can be a regular expression.
+
+
+enabled
+query
+string
+false
+The enabled state, true or false.
+
+
Example responses
@@ -16962,11 +34647,12 @@ curl -X GET http://zap/JSON/core/view/optionHttpState/ <
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -16979,27 +34665,26 @@ curl -X GET http://zap/JSON/core/view/optionHttpState/ <
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewOptionProxyChainName
-
+networkActionAddPkcs12ClientCertificate
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/optionProxyChainName/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/action/addPkcs12ClientCertificate/?filePath=string&password=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/optionProxyChainName/");
+
URL obj = new URL("http://zap/JSON/network/action/addPkcs12ClientCertificate/?filePath=string&password=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -17015,32 +34700,53 @@ curl -X GET http://zap/JSON/core/view/optionProxyChainNa
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/view/optionProxyChainName/', params={
-
+r = requests.get('http://zap/JSON/network/action/addPkcs12ClientCertificate/', params={
+ 'filePath': 'string', 'password': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
+print(r.json())
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+
+GET /JSON/network/action/addPkcs12ClientCertificate/
-result = RestClient.get 'http://zap/JSON/core/view/optionProxyChainName/',
- params: {
- }, headers: headers
+Adds a client certificate contained in a PKCS#12 file, the certificate is automatically set as active and used.
-p JSON.parse(result)
+Parameters
-
-GET /JSON/core/view/optionProxyChainName/
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+filePath
+query
+string
+true
+The file path.
+
+
+password
+query
+string
+true
+The password for the file.
+
+
+index
+query
+string
+false
+The index of the certificate in the file, defaults to 0.
+
+
Example responses
@@ -17048,11 +34754,12 @@ curl -X GET http://zap/JSON/core/view/optionProxyChainNa
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -17065,27 +34772,26 @@ curl -X GET http://zap/JSON/core/view/optionProxyChainNa
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewOptionProxyChainPassword
-
+networkActionAddRateLimitRule
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/optionProxyChainPassword/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/action/addRateLimitRule/?description=string&enabled=string&matchRegex=string&matchString=string&requestsPerSecond=string&groupBy=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/optionProxyChainPassword/");
+
URL obj = new URL("http://zap/JSON/network/action/addRateLimitRule/?description=string&enabled=string&matchRegex=string&matchString=string&requestsPerSecond=string&groupBy=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -17101,32 +34807,74 @@ curl -X GET http://zap/JSON/core/view/optionProxyChainPa
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/view/optionProxyChainPassword/', params={
-
+r = requests.get('http://zap/JSON/network/action/addRateLimitRule/', params={
+ 'description': 'string', 'enabled': 'string', 'matchRegex': 'string', 'matchString': 'string', 'requestsPerSecond': 'string', 'groupBy': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
+print(r.json())
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+
+GET /JSON/network/action/addRateLimitRule/
-result = RestClient.get 'http://zap/JSON/core/view/optionProxyChainPassword/',
- params: {
- }, headers: headers
+Adds a rate limit rule
-p JSON.parse(result)
+Parameters
-
-GET /JSON/core/view/optionProxyChainPassword/
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+description
+query
+string
+true
+A description that allows you to identify the rule. Each rule must have a unique description.
+
+
+enabled
+query
+string
+true
+The enabled state, true or false.
+
+
+matchRegex
+query
+string
+true
+Regex used to match the host.
+
+
+matchString
+query
+string
+true
+Plain string match is handled based on DNS conventions. If the string has one or two components.
+
+
+requestsPerSecond
+query
+string
+true
+The maximum number of requests per second.
+
+
+groupBy
+query
+string
+true
+How to group hosts when applying rate limiting: rule or host
+
+
Example responses
@@ -17134,11 +34882,12 @@ curl -X GET http://zap/JSON/core/view/optionProxyChainPa
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -17151,27 +34900,26 @@ curl -X GET http://zap/JSON/core/view/optionProxyChainPa
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewOptionProxyChainPort
-
+networkActionGenerateRootCaCert
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/optionProxyChainPort/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/action/generateRootCaCert/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/optionProxyChainPort/");
+
URL obj = new URL("http://zap/JSON/network/action/generateRootCaCert/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -17187,32 +34935,17 @@ curl -X GET http://zap/JSON/core/view/optionProxyChainPo
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/core/view/optionProxyChainPort/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/core/view/optionProxyChainPort/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/network/action/generateRootCaCert/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/view/optionProxyChainPort/
+GET /JSON/network/action/generateRootCaCert/
+
+Generates a new Root CA certificate, used to issue server certificates.
Example responses
@@ -17220,11 +34953,12 @@ curl -X GET http://zap/JSON/core/view/optionProxyChainPo
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -17237,27 +34971,26 @@ curl -X GET http://zap/JSON/core/view/optionProxyChainPo
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewOptionProxyChainRealm
-
+networkActionImportRootCaCert
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/optionProxyChainRealm/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/action/importRootCaCert/?filePath=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/optionProxyChainRealm/");
+
URL obj = new URL("http://zap/JSON/network/action/importRootCaCert/?filePath=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -17273,32 +35006,39 @@ curl -X GET http://zap/JSON/core/view/optionProxyChainRe
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/view/optionProxyChainRealm/', params={
-
+r = requests.get('http://zap/JSON/network/action/importRootCaCert/', params={
+ 'filePath': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
+print(r.json())
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+
+GET /JSON/network/action/importRootCaCert/
-result = RestClient.get 'http://zap/JSON/core/view/optionProxyChainRealm/',
- params: {
- }, headers: headers
+Imports a Root CA certificate to be used to issue server certificates.
-p JSON.parse(result)
+Parameters
-
-GET /JSON/core/view/optionProxyChainRealm/
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+filePath
+query
+string
+true
+The file system path to the PEM file, containing the certificate and private key.
+
+
Example responses
@@ -17306,11 +35046,12 @@ curl -X GET http://zap/JSON/core/view/optionProxyChainRe
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -17323,27 +35064,26 @@ curl -X GET http://zap/JSON/core/view/optionProxyChainRe
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewOptionProxyChainUserName
-
+networkActionRemoveAlias
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/optionProxyChainUserName/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/action/removeAlias/?name=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/optionProxyChainUserName/");
+
URL obj = new URL("http://zap/JSON/network/action/removeAlias/?name=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -17359,32 +35099,39 @@ curl -X GET http://zap/JSON/core/view/optionProxyChainUs
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/view/optionProxyChainUserName/', params={
-
+r = requests.get('http://zap/JSON/network/action/removeAlias/', params={
+ 'name': 'string'
}, headers = headers)
-print r.json()
+print(r.json())
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+
+GET /JSON/network/action/removeAlias/
-result = RestClient.get 'http://zap/JSON/core/view/optionProxyChainUserName/',
- params: {
- }, headers: headers
+Removes an alias.
-p JSON.parse(result)
+Parameters
-
-GET /JSON/core/view/optionProxyChainUserName/
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+name
+query
+string
+true
+The name of the alias.
+
+
Example responses
@@ -17392,11 +35139,12 @@ curl -X GET http://zap/JSON/core/view/optionProxyChainUs
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -17409,27 +35157,26 @@ curl -X GET http://zap/JSON/core/view/optionProxyChainUs
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewOptionTimeoutInSecs
-
+networkActionRemoveHttpProxyExclusion
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/optionTimeoutInSecs/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/action/removeHttpProxyExclusion/?host=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/optionTimeoutInSecs/");
+
URL obj = new URL("http://zap/JSON/network/action/removeHttpProxyExclusion/?host=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -17445,34 +35192,39 @@ curl -X GET http://zap/JSON/core/view/optionTimeoutInSec
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/view/optionTimeoutInSecs/', params={
-
+r = requests.get('http://zap/JSON/network/action/removeHttpProxyExclusion/', params={
+ 'host': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+print(r.json())
-result = RestClient.get 'http://zap/JSON/core/view/optionTimeoutInSecs/',
- params: {
- }, headers: headers
+
+GET /JSON/network/action/removeHttpProxyExclusion/
-p JSON.parse(result)
+Removes an HTTP proxy exclusion.
-
-GET /JSON/core/view/optionTimeoutInSecs/
+Parameters
-Gets the connection time out, in seconds.
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+host
+query
+string
+true
+The value of the host.
+
+
Example responses
@@ -17480,11 +35232,12 @@ curl -X GET http://zap/JSON/core/view/optionTimeoutInSec
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -17497,27 +35250,26 @@ curl -X GET http://zap/JSON/core/view/optionTimeoutInSec
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewOptionHttpStateEnabled
-
+networkActionRemoveLocalServer
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/optionHttpStateEnabled/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/action/removeLocalServer/?address=string&port=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/optionHttpStateEnabled/");
+
URL obj = new URL("http://zap/JSON/network/action/removeLocalServer/?address=string&port=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -17533,32 +35285,46 @@ curl -X GET http://zap/JSON/core/view/optionHttpStateEna
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/view/optionHttpStateEnabled/', params={
-
+r = requests.get('http://zap/JSON/network/action/removeLocalServer/', params={
+ 'address': 'string', 'port': 'string'
}, headers = headers)
-print r.json()
+print(r.json())
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+
+GET /JSON/network/action/removeLocalServer/
-result = RestClient.get 'http://zap/JSON/core/view/optionHttpStateEnabled/',
- params: {
- }, headers: headers
+Removes a local server/proxy.
-p JSON.parse(result)
+Parameters
-
-GET /JSON/core/view/optionHttpStateEnabled/
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+address
+query
+string
+true
+The address of the local server/proxy.
+
+
+port
+query
+string
+true
+The port of the local server/proxy.
+
+
Example responses
@@ -17566,11 +35332,12 @@ curl -X GET http://zap/JSON/core/view/optionHttpStateEna
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -17583,27 +35350,26 @@ curl -X GET http://zap/JSON/core/view/optionHttpStateEna
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewOptionProxyChainPrompt
-
+networkActionRemovePassThrough
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/optionProxyChainPrompt/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/action/removePassThrough/?authority=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/optionProxyChainPrompt/");
+
URL obj = new URL("http://zap/JSON/network/action/removePassThrough/?authority=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -17619,32 +35385,39 @@ curl -X GET http://zap/JSON/core/view/optionProxyChainPr
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/view/optionProxyChainPrompt/', params={
-
+r = requests.get('http://zap/JSON/network/action/removePassThrough/', params={
+ 'authority': 'string'
}, headers = headers)
-print r.json()
+print(r.json())
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+
+GET /JSON/network/action/removePassThrough/
-result = RestClient.get 'http://zap/JSON/core/view/optionProxyChainPrompt/',
- params: {
- }, headers: headers
+Removes a pass-through.
-p JSON.parse(result)
+Parameters
-
-GET /JSON/core/view/optionProxyChainPrompt/
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+authority
+query
+string
+true
+The value of the authority.
+
+
Example responses
@@ -17652,11 +35425,12 @@ curl -X GET http://zap/JSON/core/view/optionProxyChainPr
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -17669,27 +35443,26 @@ curl -X GET http://zap/JSON/core/view/optionProxyChainPr
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewOptionSingleCookieRequestHeader
-
+networkActionRemoveRateLimitRule
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/optionSingleCookieRequestHeader/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/action/removeRateLimitRule/?description=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/optionSingleCookieRequestHeader/");
+
URL obj = new URL("http://zap/JSON/network/action/removeRateLimitRule/?description=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -17705,32 +35478,39 @@ curl -X GET http://zap/JSON/core/view/optionSingleCookie
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/view/optionSingleCookieRequestHeader/', params={
-
+r = requests.get('http://zap/JSON/network/action/removeRateLimitRule/', params={
+ 'description': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
+print(r.json())
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+
+GET /JSON/network/action/removeRateLimitRule/
-result = RestClient.get 'http://zap/JSON/core/view/optionSingleCookieRequestHeader/',
- params: {
- }, headers: headers
+Remove a rate limit rule
-p JSON.parse(result)
+Parameters
-
-GET /JSON/core/view/optionSingleCookieRequestHeader/
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+description
+query
+string
+true
+The description of the rule to remove.
+
+
Example responses
@@ -17738,11 +35518,12 @@ curl -X GET http://zap/JSON/core/view/optionSingleCookie
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -17755,27 +35536,26 @@ curl -X GET http://zap/JSON/core/view/optionSingleCookie
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewOptionUseProxyChain
-
+networkActionSetAliasEnabled
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/optionUseProxyChain/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/action/setAliasEnabled/?name=string&enabled=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/optionUseProxyChain/");
+
URL obj = new URL("http://zap/JSON/network/action/setAliasEnabled/?name=string&enabled=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -17791,32 +35571,46 @@ curl -X GET http://zap/JSON/core/view/optionUseProxyChai
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/view/optionUseProxyChain/', params={
-
+r = requests.get('http://zap/JSON/network/action/setAliasEnabled/', params={
+ 'name': 'string', 'enabled': 'string'
}, headers = headers)
-print r.json()
+print(r.json())
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+
+GET /JSON/network/action/setAliasEnabled/
-result = RestClient.get 'http://zap/JSON/core/view/optionUseProxyChain/',
- params: {
- }, headers: headers
+Sets whether or not an alias is enabled.
-p JSON.parse(result)
+Parameters
-
-GET /JSON/core/view/optionUseProxyChain/
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+name
+query
+string
+true
+The name of the alias.
+
+
+enabled
+query
+string
+true
+The enabled state, true or false.
+
+
Example responses
@@ -17824,11 +35618,12 @@ curl -X GET http://zap/JSON/core/view/optionUseProxyChai
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -17841,27 +35636,26 @@ curl -X GET http://zap/JSON/core/view/optionUseProxyChai
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreViewOptionUseProxyChainAuth
-
+networkActionSetConnectionTimeout
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/view/optionUseProxyChainAuth/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/action/setConnectionTimeout/?timeout=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/view/optionUseProxyChainAuth/");
+
URL obj = new URL("http://zap/JSON/network/action/setConnectionTimeout/?timeout=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -17877,32 +35671,39 @@ curl -X GET http://zap/JSON/core/view/optionUseProxyChai
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/view/optionUseProxyChainAuth/', params={
-
+r = requests.get('http://zap/JSON/network/action/setConnectionTimeout/', params={
+ 'timeout': 'string'
}, headers = headers)
-print r.json()
+print(r.json())
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+
+GET /JSON/network/action/setConnectionTimeout/
-result = RestClient.get 'http://zap/JSON/core/view/optionUseProxyChainAuth/',
- params: {
- }, headers: headers
+Sets the timeout, for reads and connects.
-p JSON.parse(result)
+Parameters
-
-GET /JSON/core/view/optionUseProxyChainAuth/
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+timeout
+query
+string
+true
+The timeout, in seconds.
+
+
Example responses
@@ -17910,11 +35711,12 @@ curl -X GET http://zap/JSON/core/view/optionUseProxyChai
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -17927,27 +35729,26 @@ curl -X GET http://zap/JSON/core/view/optionUseProxyChai
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionAccessUrl
-
+networkActionSetDefaultUserAgent
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/accessUrl/?url=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/action/setDefaultUserAgent/?userAgent=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/accessUrl/?url=string");
+
URL obj = new URL("http://zap/JSON/network/action/setDefaultUserAgent/?userAgent=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -17963,37 +35764,21 @@ curl -X GET http://zap/JSON/core/action/accessUrl/?url
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/action/accessUrl/', params={
- 'url': 'string'
+r = requests.get('http://zap/JSON/network/action/setDefaultUserAgent/', params={
+ 'userAgent': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/action/accessUrl/',
- params: {
- 'url' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/action/accessUrl/
+GET /JSON/network/action/setDefaultUserAgent/
-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'.
+Sets the default user-agent.
-Parameters
+Parameters
@@ -18005,18 +35790,11 @@ curl -X GET http://zap/JSON/core/action/accessUrl/?url
-url
+userAgent
query
string
true
-none
-
-
-followRedirects
-query
-boolean
-false
-none
+The default user-agent.
@@ -18026,11 +35804,12 @@ curl -X GET http://zap/JSON/core/action/accessUrl/?urldefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -18043,27 +35822,26 @@ curl -X GET http://zap/JSON/core/action/accessUrl/?url
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionShutdown
-
+networkActionSetDnsTtlSuccessfulQueries
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/shutdown/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/action/setDnsTtlSuccessfulQueries/?ttl=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/shutdown/");
+
URL obj = new URL("http://zap/JSON/network/action/setDnsTtlSuccessfulQueries/?ttl=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -18079,34 +35857,39 @@ curl -X GET http://zap/JSON/core/action/shutdown/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/action/shutdown/', params={
-
+r = requests.get('http://zap/JSON/network/action/setDnsTtlSuccessfulQueries/', params={
+ 'ttl': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+print(r.json())
-result = RestClient.get 'http://zap/JSON/core/action/shutdown/',
- params: {
- }, headers: headers
+
+GET /JSON/network/action/setDnsTtlSuccessfulQueries/
-p JSON.parse(result)
+Sets the TTL of successful DNS queries.
-
-GET /JSON/core/action/shutdown/
+Parameters
-Shuts down ZAP
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+ttl
+query
+string
+true
+The TTL, in seconds. Negative number, cache forever. Zero, disables caching. Positive number, the number of seconds the successful DNS queries will be cached.
+
+
Example responses
@@ -18114,11 +35897,12 @@ curl -X GET http://zap/JSON/core/action/shutdown/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -18131,27 +35915,26 @@ curl -X GET http://zap/JSON/core/action/shutdown/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionNewSession
-
+networkActionSetHttpProxy
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/newSession/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/action/setHttpProxy/?host=string&port=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/newSession/");
+
URL obj = new URL("http://zap/JSON/network/action/setHttpProxy/?host=string&port=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -18167,36 +35950,21 @@ curl -X GET http://zap/JSON/core/action/newSession/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/action/newSession/', params={
-
+r = requests.get('http://zap/JSON/network/action/setHttpProxy/', params={
+ 'host': 'string', 'port': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/action/newSession/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/action/newSession/
+GET /JSON/network/action/setHttpProxy/
-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.
+Sets the HTTP proxy configuration.
-Parameters
+Parameters
@@ -18208,18 +35976,39 @@ curl -X GET http://zap/JSON/core/action/newSession/
-name
+host
+query
+string
+true
+The host, name or address.
+
+
+port
+query
+string
+true
+The port.
+
+
+realm
query
string
false
-none
+The authentication realm.
-overwrite
+username
query
-boolean
+string
false
-none
+The user name.
+
+
+password
+query
+string
+false
+The password.
@@ -18229,11 +36018,12 @@ curl -X GET http://zap/JSON/core/action/newSession/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -18246,27 +36036,26 @@ curl -X GET http://zap/JSON/core/action/newSession/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionLoadSession
-
+networkActionSetHttpProxyAuthEnabled
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/loadSession/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/action/setHttpProxyAuthEnabled/?enabled=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/loadSession/");
+
URL obj = new URL("http://zap/JSON/network/action/setHttpProxyAuthEnabled/?enabled=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -18282,36 +36071,21 @@ curl -X GET http://zap/JSON/core/action/loadSession/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/action/loadSession/', params={
-
+r = requests.get('http://zap/JSON/network/action/setHttpProxyAuthEnabled/', params={
+ 'enabled': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/action/loadSession/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/action/loadSession/
+GET /JSON/network/action/setHttpProxyAuthEnabled/
-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.
+Sets whether or not the HTTP proxy authentication is enabled.
-Parameters
+Parameters
@@ -18323,11 +36097,11 @@ curl -X GET http://zap/JSON/core/action/loadSession/
-name
+enabled
query
string
-false
-none
+true
+The enabled state, true or false.
@@ -18337,11 +36111,12 @@ curl -X GET http://zap/JSON/core/action/loadSession/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -18354,27 +36129,26 @@ curl -X GET http://zap/JSON/core/action/loadSession/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionSaveSession
-
+networkActionSetHttpProxyEnabled
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/saveSession/?name=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/action/setHttpProxyEnabled/?enabled=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/saveSession/?name=string");
+
URL obj = new URL("http://zap/JSON/network/action/setHttpProxyEnabled/?enabled=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -18390,37 +36164,21 @@ curl -X GET http://zap/JSON/core/action/saveSession/?nam
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/action/saveSession/', params={
- 'name': 'string'
+r = requests.get('http://zap/JSON/network/action/setHttpProxyEnabled/', params={
+ 'enabled': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/action/saveSession/',
- params: {
- 'name' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/action/saveSession/
+GET /JSON/network/action/setHttpProxyEnabled/
-Saves the session with the name supplied, optionally overwriting existing files. If a relative path is specified it will be resolved against the "session" directory in ZAP "home" dir.
+Sets whether or not the HTTP proxy is enabled.
-Parameters
+Parameters
@@ -18432,18 +36190,11 @@ curl -X GET http://zap/JSON/core/action/saveSession/?nam
-name
+enabled
query
string
true
-none
-
-
-overwrite
-query
-boolean
-false
-none
+The enabled state, true or false.
@@ -18453,11 +36204,12 @@ curl -X GET http://zap/JSON/core/action/saveSession/?nam
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -18470,27 +36222,26 @@ curl -X GET http://zap/JSON/core/action/saveSession/?nam
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionSnapshotSession
-
+networkActionSetHttpProxyExclusionEnabled
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/snapshotSession/?name=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/action/setHttpProxyExclusionEnabled/?host=string&enabled=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/snapshotSession/?name=string");
+
URL obj = new URL("http://zap/JSON/network/action/setHttpProxyExclusionEnabled/?host=string&enabled=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -18506,37 +36257,21 @@ curl -X GET http://zap/JSON/core/action/snapshotSession/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/action/snapshotSession/', params={
- 'name': 'string'
+r = requests.get('http://zap/JSON/network/action/setHttpProxyExclusionEnabled/', params={
+ 'host': 'string', 'enabled': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/action/snapshotSession/',
- params: {
- 'name' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/action/snapshotSession/
+GET /JSON/network/action/setHttpProxyExclusionEnabled/
-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.
+Sets whether or not an HTTP proxy exclusion is enabled.
-Parameters
+Parameters
@@ -18548,18 +36283,18 @@ curl -X GET http://zap/JSON/core/action/snapshotSession/
-name
+host
query
string
true
-none
+The value of the host.
-overwrite
+enabled
query
-boolean
-false
-none
+string
+true
+The enabled state, true or false.
@@ -18569,11 +36304,12 @@ curl -X GET http://zap/JSON/core/action/snapshotSession/
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -18586,27 +36322,26 @@ curl -X GET http://zap/JSON/core/action/snapshotSession/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionClearExcludedFromProxy
-
+networkActionSetPassThroughEnabled
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/clearExcludedFromProxy/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/action/setPassThroughEnabled/?authority=string&enabled=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/clearExcludedFromProxy/");
+
URL obj = new URL("http://zap/JSON/network/action/setPassThroughEnabled/?authority=string&enabled=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -18622,34 +36357,46 @@ curl -X GET http://zap/JSON/core/action/clearExcludedFro
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/action/clearExcludedFromProxy/', params={
-
+r = requests.get('http://zap/JSON/network/action/setPassThroughEnabled/', params={
+ 'authority': 'string', 'enabled': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+print(r.json())
-result = RestClient.get 'http://zap/JSON/core/action/clearExcludedFromProxy/',
- params: {
- }, headers: headers
+
+GET /JSON/network/action/setPassThroughEnabled/
-p JSON.parse(result)
+Sets whether or not a pass-through is enabled.
-
-GET /JSON/core/action/clearExcludedFromProxy/
+Parameters
-Clears the regexes of URLs excluded from the local proxies.
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+authority
+query
+string
+true
+The value of the authority.
+
+
+enabled
+query
+string
+true
+The enabled state, true or false.
+
+
Example responses
@@ -18657,11 +36404,12 @@ curl -X GET http://zap/JSON/core/action/clearExcludedFro
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -18674,27 +36422,26 @@ curl -X GET http://zap/JSON/core/action/clearExcludedFro
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionExcludeFromProxy
-
+networkActionSetRateLimitRuleEnabled
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/excludeFromProxy/?regex=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/action/setRateLimitRuleEnabled/?description=string&enabled=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/excludeFromProxy/?regex=string");
+
URL obj = new URL("http://zap/JSON/network/action/setRateLimitRuleEnabled/?description=string&enabled=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -18710,37 +36457,21 @@ curl -X GET http://zap/JSON/core/action/excludeFromProxy
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/action/excludeFromProxy/', params={
- 'regex': 'string'
+r = requests.get('http://zap/JSON/network/action/setRateLimitRuleEnabled/', params={
+ 'description': 'string', 'enabled': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/action/excludeFromProxy/',
- params: {
- 'regex' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/action/excludeFromProxy/
+GET /JSON/network/action/setRateLimitRuleEnabled/
-Adds a regex of URLs that should be excluded from the local proxies.
+Set enabled state for a rate limit rule.
-Parameters
+Parameters
@@ -18752,11 +36483,18 @@ curl -X GET http://zap/JSON/core/action/excludeFromProxy
-regex
+description
query
string
true
-none
+The description of the rule to modify.
+
+
+enabled
+query
+string
+true
+The enabled state, true or false.
@@ -18766,11 +36504,12 @@ curl -X GET http://zap/JSON/core/action/excludeFromProxy
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -18783,27 +36522,26 @@ curl -X GET http://zap/JSON/core/action/excludeFromProxy
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionSetHomeDirectory
-
+networkActionSetRootCaCertValidity
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/setHomeDirectory/?dir=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/action/setRootCaCertValidity/?validity=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/setHomeDirectory/?dir=string");
+
URL obj = new URL("http://zap/JSON/network/action/setRootCaCertValidity/?validity=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -18819,35 +36557,21 @@ curl -X GET http://zap/JSON/core/action/setHomeDirectory
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/action/setHomeDirectory/', params={
- 'dir': 'string'
+r = requests.get('http://zap/JSON/network/action/setRootCaCertValidity/', params={
+ 'validity': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/action/setHomeDirectory/',
- params: {
- 'dir' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/action/setHomeDirectory/
+GET /JSON/network/action/setRootCaCertValidity/
-Parameters
+Sets the Root CA certificate validity. Used when generating a new Root CA certificate.
+
+Parameters
@@ -18859,11 +36583,11 @@ curl -X GET http://zap/JSON/core/action/setHomeDirectory
-dir
+validity
query
string
true
-none
+The number of days that the generated Root CA certificate will be valid for.
@@ -18873,11 +36597,12 @@ curl -X GET http://zap/JSON/core/action/setHomeDirectory
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -18890,27 +36615,26 @@ curl -X GET http://zap/JSON/core/action/setHomeDirectory
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionSetMode
-
+networkActionSetServerCertValidity
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/setMode/?mode=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/action/setServerCertValidity/?validity=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/setMode/?mode=string");
+
URL obj = new URL("http://zap/JSON/network/action/setServerCertValidity/?validity=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -18926,37 +36650,21 @@ curl -X GET http://zap/JSON/core/action/setMode/?mode
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/action/setMode/', params={
- 'mode': 'string'
+r = requests.get('http://zap/JSON/network/action/setServerCertValidity/', params={
+ 'validity': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/action/setMode/',
- params: {
- 'mode' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/action/setMode/
+GET /JSON/network/action/setServerCertValidity/
-Sets the mode, which may be one of [safe, protect, standard, attack]
+Sets the server certificate validity. Used when generating server certificates.
-Parameters
+Parameters
@@ -18968,11 +36676,11 @@ curl -X GET http://zap/JSON/core/action/setMode/?mode
-mode
+validity
query
string
true
-none
+The number of days that the generated server certificates will be valid for.
@@ -18982,11 +36690,12 @@ curl -X GET http://zap/JSON/core/action/setMode/?modedefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -18999,27 +36708,26 @@ curl -X GET http://zap/JSON/core/action/setMode/?mode
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionGenerateRootCA
-
+networkActionSetSocksProxy
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/generateRootCA/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/action/setSocksProxy/?host=string&port=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/generateRootCA/");
+
URL obj = new URL("http://zap/JSON/network/action/setSocksProxy/?host=string&port=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -19035,34 +36743,74 @@ curl -X GET http://zap/JSON/core/action/generateRootCA/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/action/generateRootCA/', params={
-
+r = requests.get('http://zap/JSON/network/action/setSocksProxy/', params={
+ 'host': 'string', 'port': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+print(r.json())
-result = RestClient.get 'http://zap/JSON/core/action/generateRootCA/',
- params: {
- }, headers: headers
+
+GET /JSON/network/action/setSocksProxy/
-p JSON.parse(result)
+Sets the SOCKS proxy configuration.
-
-GET /JSON/core/action/generateRootCA/
+Parameters
-Generates a new Root CA certificate for the local proxies.
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+host
+query
+string
+true
+The host, name or address.
+
+
+port
+query
+string
+true
+The port.
+
+
+version
+query
+string
+false
+The SOCKS version.
+
+
+useDns
+query
+string
+false
+If the names should be resolved by the SOCKS proxy, true or false.
+
+
+username
+query
+string
+false
+The user name.
+
+
+password
+query
+string
+false
+The password.
+
+
Example responses
@@ -19070,11 +36818,12 @@ curl -X GET http://zap/JSON/core/action/generateRootCA/
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -19087,27 +36836,26 @@ curl -X GET http://zap/JSON/core/action/generateRootCA/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionSendRequest
-
+networkActionSetSocksProxyEnabled
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/sendRequest/?request=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/action/setSocksProxyEnabled/?enabled=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/sendRequest/?request=string");
+
URL obj = new URL("http://zap/JSON/network/action/setSocksProxyEnabled/?enabled=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -19123,37 +36871,21 @@ curl -X GET http://zap/JSON/core/action/sendRequest/?req
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/action/sendRequest/', params={
- 'request': 'string'
+r = requests.get('http://zap/JSON/network/action/setSocksProxyEnabled/', params={
+ 'enabled': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/action/sendRequest/',
- params: {
- 'request' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/action/sendRequest/
+GET /JSON/network/action/setSocksProxyEnabled/
-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.
+Sets whether or not the SOCKS proxy is enabled.
-Parameters
+Parameters
@@ -19165,18 +36897,11 @@ curl -X GET http://zap/JSON/core/action/sendRequest/?req
-request
+enabled
query
string
true
-none
-
-
-followRedirects
-query
-boolean
-false
-none
+The enabled state, true or false.
@@ -19186,11 +36911,12 @@ curl -X GET http://zap/JSON/core/action/sendRequest/?req
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -19203,27 +36929,26 @@ curl -X GET http://zap/JSON/core/action/sendRequest/?req
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionRunGarbageCollection
-
+networkActionSetUseClientCertificate
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/runGarbageCollection/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/action/setUseClientCertificate/?use=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/runGarbageCollection/");
+
URL obj = new URL("http://zap/JSON/network/action/setUseClientCertificate/?use=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -19239,32 +36964,39 @@ curl -X GET http://zap/JSON/core/action/runGarbageCollec
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/action/runGarbageCollection/', params={
-
+r = requests.get('http://zap/JSON/network/action/setUseClientCertificate/', params={
+ 'use': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
+print(r.json())
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+
+GET /JSON/network/action/setUseClientCertificate/
-result = RestClient.get 'http://zap/JSON/core/action/runGarbageCollection/',
- params: {
- }, headers: headers
+Sets whether or not to use the active client certificate.
-p JSON.parse(result)
+Parameters
-
-GET /JSON/core/action/runGarbageCollection/
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+use
+query
+string
+true
+The use state, true or false.
+
+
Example responses
@@ -19272,11 +37004,12 @@ curl -X GET http://zap/JSON/core/action/runGarbageCollec
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -19289,27 +37022,26 @@ curl -X GET http://zap/JSON/core/action/runGarbageCollec
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionDeleteSiteNode
-
+networkActionSetUseGlobalHttpState
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/deleteSiteNode/?url=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/action/setUseGlobalHttpState/?use=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/deleteSiteNode/?url=string");
+
URL obj = new URL("http://zap/JSON/network/action/setUseGlobalHttpState/?use=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -19325,37 +37057,21 @@ curl -X GET http://zap/JSON/core/action/deleteSiteNode/?
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/action/deleteSiteNode/', params={
- 'url': 'string'
+r = requests.get('http://zap/JSON/network/action/setUseGlobalHttpState/', params={
+ 'use': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/action/deleteSiteNode/',
- params: {
- 'url' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/action/deleteSiteNode/
+GET /JSON/network/action/setUseGlobalHttpState/
-Deletes the site node found in the Sites Tree on the basis of the URL, HTTP method, and post data (if applicable and specified).
+Sets whether or not to use the global HTTP state.
-Parameters
+Parameters
@@ -19367,25 +37083,11 @@ curl -X GET http://zap/JSON/core/action/deleteSiteNode/?
-url
+use
query
string
true
-none
-
-
-method
-query
-string
-false
-none
-
-
-postData
-query
-string
-false
-none
+The use state, true or false.
@@ -19395,11 +37097,12 @@ curl -X GET http://zap/JSON/core/action/deleteSiteNode/?
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -19412,27 +37115,26 @@ curl -X GET http://zap/JSON/core/action/deleteSiteNode/?
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionAddProxyChainExcludedDomain
-
+networkOtherProxy.pac
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/addProxyChainExcludedDomain/?value=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/OTHER/network/other/proxy.pac/ \
+ -H 'Accept: */*'
-
URL obj = new URL("http://zap/JSON/core/action/addProxyChainExcludedDomain/?value=string");
+
URL obj = new URL("http://zap/OTHER/network/other/proxy.pac/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -19448,81 +37150,23 @@ curl -X GET http://zap/JSON/core/action/addProxyChainExc
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': '*/*'
}
-r = requests.get('http://zap/JSON/core/action/addProxyChainExcludedDomain/', params={
- 'value': 'string'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/action/addProxyChainExcludedDomain/',
- params: {
- 'value' => 'string'
-}, headers: headers
+r = requests.get('http://zap/OTHER/network/other/proxy.pac/', headers = headers)
-p JSON.parse(result)
+print(r.content)
-GET /JSON/core/action/addProxyChainExcludedDomain/
-
-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).
+GET /OTHER/network/other/proxy.pac/
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-value
-query
-string
-true
-none
-
-
-isRegex
-query
-boolean
-false
-none
-
-
-isEnabled
-query
-boolean
-false
-none
-
-
+Provides a PAC file, proxying through the main proxy.
Example responses
-
-default Response
-{
- "message": "string",
- "code": 100
-}
-
-Responses
+
+Responses
@@ -19535,27 +37179,28 @@ curl -X GET http://zap/JSON/core/action/addProxyChainExc
default
Default
-unexpected error
-Error
+Error of OTHER endpoints.
+None
+Response Schema
+
-coreActionModifyProxyChainExcludedDomain
-
+networkOtherRootCaCert
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/modifyProxyChainExcludedDomain/?idx=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/OTHER/network/other/rootCaCert/ \
+ -H 'Accept: */*'
-
URL obj = new URL("http://zap/JSON/core/action/modifyProxyChainExcludedDomain/?idx=0");
+
URL obj = new URL("http://zap/OTHER/network/other/rootCaCert/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -19571,88 +37216,23 @@ curl -X GET http://zap/JSON/core/action/modifyProxyChain
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': '*/*'
}
-r = requests.get('http://zap/JSON/core/action/modifyProxyChainExcludedDomain/', params={
- 'idx': '0'
-}, headers = headers)
-
-print r.json()
+r = requests.get('http://zap/OTHER/network/other/rootCaCert/', headers = headers)
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/action/modifyProxyChainExcludedDomain/',
- params: {
- 'idx' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.content)
-GET /JSON/core/action/modifyProxyChainExcludedDomain/
+GET /OTHER/network/other/rootCaCert/
-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.
-
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-idx
-query
-integer
-true
-none
-
-
-value
-query
-string
-false
-none
-
-
-isRegex
-query
-boolean
-false
-none
-
-
-isEnabled
-query
-boolean
-false
-none
-
-
+Gets the Root CA certificate used to issue server certificates. Suitable to import into client applications (e.g. browsers).
Example responses
-
-default Response
-{
- "message": "string",
- "code": 100
-}
-
-Responses
+
+Responses
@@ -19665,27 +37245,28 @@ curl -X GET http://zap/JSON/core/action/modifyProxyChain
default
Default
-unexpected error
-Error
+Error of OTHER endpoints.
+None
+Response Schema
+
-coreActionRemoveProxyChainExcludedDomain
-
+networkOtherSetProxy
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/removeProxyChainExcludedDomain/?idx=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/OTHER/network/other/setProxy/?proxy=string \
+ -H 'Accept: */*'
-
URL obj = new URL("http://zap/JSON/core/action/removeProxyChainExcludedDomain/?idx=0");
+
URL obj = new URL("http://zap/OTHER/network/other/setProxy/?proxy=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -19701,37 +37282,21 @@ curl -X GET http://zap/JSON/core/action/removeProxyChain
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': '*/*'
}
-r = requests.get('http://zap/JSON/core/action/removeProxyChainExcludedDomain/', params={
- 'idx': '0'
+r = requests.get('http://zap/OTHER/network/other/setProxy/', params={
+ 'proxy': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/action/removeProxyChainExcludedDomain/',
- params: {
- 'idx' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.content)
-GET /JSON/core/action/removeProxyChainExcludedDomain/
+GET /OTHER/network/other/setProxy/
-Removes a domain excluded from the outgoing proxy, with the given index. The index can be obtained with the view proxyChainExcludedDomains.
+Sets the HTTP proxy configuration.
-Parameters
+Parameters
@@ -19743,25 +37308,19 @@ curl -X GET http://zap/JSON/core/action/removeProxyChain
-idx
+proxy
query
-integer
+string
true
-none
+The JSON object containing the HTTP proxy configuration.
Example responses
-
-default Response
-{
- "message": "string",
- "code": 100
-}
-
-Responses
+
+Responses
@@ -19774,27 +37333,28 @@ curl -X GET http://zap/JSON/core/action/removeProxyChain
default
Default
-unexpected error
-Error
+Error of OTHER endpoints.
+None
+Response Schema
+
-coreActionEnableAllProxyChainExcludedDomains
-
+networkViewGetAliases
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/enableAllProxyChainExcludedDomains/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/view/getAliases/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/enableAllProxyChainExcludedDomains/");
+
URL obj = new URL("http://zap/JSON/network/view/getAliases/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -19810,34 +37370,17 @@ curl -X GET http://zap/JSON/core/action/enableAllProxyCh
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/core/action/enableAllProxyChainExcludedDomains/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/core/action/enableAllProxyChainExcludedDomains/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/network/view/getAliases/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/action/enableAllProxyChainExcludedDomains/
+GET /JSON/network/view/getAliases/
-Enables all domains excluded from the outgoing proxy.
+Gets the aliases used to identify the local servers/proxies.
Example responses
@@ -19845,11 +37388,12 @@ curl -X GET http://zap/JSON/core/action/enableAllProxyCh
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -19862,27 +37406,26 @@ curl -X GET http://zap/JSON/core/action/enableAllProxyCh
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionDisableAllProxyChainExcludedDomains
-
+networkViewGetConnectionTimeout
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/disableAllProxyChainExcludedDomains/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/view/getConnectionTimeout/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/disableAllProxyChainExcludedDomains/");
+
URL obj = new URL("http://zap/JSON/network/view/getConnectionTimeout/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -19898,34 +37441,17 @@ curl -X GET http://zap/JSON/core/action/disableAllProxyC
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/action/disableAllProxyChainExcludedDomains/', params={
+r = requests.get('http://zap/JSON/network/view/getConnectionTimeout/', headers = headers)
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/action/disableAllProxyChainExcludedDomains/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/action/disableAllProxyChainExcludedDomains/
+GET /JSON/network/view/getConnectionTimeout/
-Disables all domains excluded from the outgoing proxy.
+Gets the connection timeout, in seconds.
Example responses
@@ -19933,11 +37459,12 @@ curl -X GET http://zap/JSON/core/action/disableAllProxyC
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -19950,27 +37477,26 @@ curl -X GET http://zap/JSON/core/action/disableAllProxyC
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionSetOptionMaximumAlertInstances
-
+networkViewGetDefaultUserAgent
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/setOptionMaximumAlertInstances/?numberOfInstances=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/view/getDefaultUserAgent/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/setOptionMaximumAlertInstances/?numberOfInstances=0");
+
URL obj = new URL("http://zap/JSON/network/view/getDefaultUserAgent/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -19986,55 +37512,17 @@ curl -X GET http://zap/JSON/core/action/setOptionMaximum
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/action/setOptionMaximumAlertInstances/', params={
- 'numberOfInstances': '0'
-}, headers = headers)
+r = requests.get('http://zap/JSON/network/view/getDefaultUserAgent/', headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/action/setOptionMaximumAlertInstances/',
- params: {
- 'numberOfInstances' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/action/setOptionMaximumAlertInstances/
-
-Sets the maximum number of alert instances to include in a report. A value of zero is treated as unlimited.
+GET /JSON/network/view/getDefaultUserAgent/
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-numberOfInstances
-query
-integer
-true
-none
-
-
+Gets the default user-agent.
Example responses
@@ -20042,11 +37530,12 @@ curl -X GET http://zap/JSON/core/action/setOptionMaximum
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -20059,27 +37548,26 @@ curl -X GET http://zap/JSON/core/action/setOptionMaximum
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionSetOptionMergeRelatedAlerts
-
+networkViewGetDnsTtlSuccessfulQueries
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/setOptionMergeRelatedAlerts/?enabled=true \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/view/getDnsTtlSuccessfulQueries/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/setOptionMergeRelatedAlerts/?enabled=true");
+
URL obj = new URL("http://zap/JSON/network/view/getDnsTtlSuccessfulQueries/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -20095,55 +37583,17 @@ curl -X GET http://zap/JSON/core/action/setOptionMergeRe
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/action/setOptionMergeRelatedAlerts/', params={
- 'enabled': 'true'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+r = requests.get('http://zap/JSON/network/view/getDnsTtlSuccessfulQueries/', headers = headers)
-result = RestClient.get 'http://zap/JSON/core/action/setOptionMergeRelatedAlerts/',
- params: {
- 'enabled' => 'boolean'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/action/setOptionMergeRelatedAlerts/
-
-Sets whether or not related alerts will be merged in any reports generated.
+GET /JSON/network/view/getDnsTtlSuccessfulQueries/
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-enabled
-query
-boolean
-true
-none
-
-
+Gets the TTL (in seconds) of successful DNS queries.
Example responses
@@ -20151,11 +37601,12 @@ curl -X GET http://zap/JSON/core/action/setOptionMergeRe
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -20168,27 +37619,26 @@ curl -X GET http://zap/JSON/core/action/setOptionMergeRe
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionSetOptionAlertOverridesFilePath
-
+networkViewGetHttpProxy
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/setOptionAlertOverridesFilePath/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/view/getHttpProxy/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/setOptionAlertOverridesFilePath/");
+
URL obj = new URL("http://zap/JSON/network/view/getHttpProxy/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -20204,54 +37654,17 @@ curl -X GET http://zap/JSON/core/action/setOptionAlertOv
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/core/action/setOptionAlertOverridesFilePath/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/core/action/setOptionAlertOverridesFilePath/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/network/view/getHttpProxy/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/action/setOptionAlertOverridesFilePath/
-
-Sets (or clears, if empty) the path to the file with alert overrides.
+GET /JSON/network/view/getHttpProxy/
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-filePath
-query
-string
-false
-none
-
-
+Gets the HTTP proxy.
Example responses
@@ -20259,11 +37672,12 @@ curl -X GET http://zap/JSON/core/action/setOptionAlertOv
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -20276,27 +37690,26 @@ curl -X GET http://zap/JSON/core/action/setOptionAlertOv
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionEnablePKCS12ClientCertificate
-
+networkViewGetHttpProxyExclusions
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/enablePKCS12ClientCertificate/?filePath=string&password=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/view/getHttpProxyExclusions/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/enablePKCS12ClientCertificate/?filePath=string&password=string");
+
URL obj = new URL("http://zap/JSON/network/view/getHttpProxyExclusions/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -20312,82 +37725,101 @@ curl -X GET http://zap/JSON/core/action/enablePKCS12Clie
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/action/enablePKCS12ClientCertificate/', params={
- 'filePath': 'string', 'password': 'string'
-}, headers = headers)
+r = requests.get('http://zap/JSON/network/view/getHttpProxyExclusions/', headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/action/enablePKCS12ClientCertificate/',
- params: {
- 'filePath' => 'string',
-'password' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/action/enablePKCS12ClientCertificate/
+GET /JSON/network/view/getHttpProxyExclusions/
-Enables use of a PKCS12 client certificate for the certificate with the given file system path, password, and optional index.
+Gets the HTTP proxy exclusions.
-Parameters
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
-Name
-In
-Type
-Required
+Status
+Meaning
Description
+Schema
-filePath
-query
-string
-true
-none
-
-
-password
-query
-string
-true
-none
-
-
-index
-query
-string
-false
-none
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+networkViewGetLocalServers
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/network/view/getLocalServers/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/network/view/getLocalServers/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/network/view/getLocalServers/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/network/view/getLocalServers/
+
+Gets the local servers/proxies.
+
Example responses
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -20400,27 +37832,26 @@ curl -X GET http://zap/JSON/core/action/enablePKCS12Clie
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionDisableClientCertificate
-
+networkViewGetPassThroughs
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/disableClientCertificate/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/view/getPassThroughs/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/disableClientCertificate/");
+
URL obj = new URL("http://zap/JSON/network/view/getPassThroughs/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -20436,34 +37867,17 @@ curl -X GET http://zap/JSON/core/action/disableClientCer
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/action/disableClientCertificate/', params={
-
-}, headers = headers)
-
-print r.json()
+r = requests.get('http://zap/JSON/network/view/getPassThroughs/', headers = headers)
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/action/disableClientCertificate/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/action/disableClientCertificate/
+GET /JSON/network/view/getPassThroughs/
-Disables the option for use of client certificates.
+Gets the authorities that will pass-through the local proxies.
Example responses
@@ -20471,11 +37885,12 @@ curl -X GET http://zap/JSON/core/action/disableClientCer
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -20488,27 +37903,26 @@ curl -X GET http://zap/JSON/core/action/disableClientCer
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionDeleteAllAlerts
-
+networkViewGetRateLimitRules
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/deleteAllAlerts/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/view/getRateLimitRules/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/deleteAllAlerts/");
+
URL obj = new URL("http://zap/JSON/network/view/getRateLimitRules/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -20524,34 +37938,17 @@ curl -X GET http://zap/JSON/core/action/deleteAllAlerts/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/core/action/deleteAllAlerts/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/core/action/deleteAllAlerts/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/network/view/getRateLimitRules/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/action/deleteAllAlerts/
+GET /JSON/network/view/getRateLimitRules/
-Deletes all alerts of the current session.
+List of rate limit rules.
Example responses
@@ -20559,11 +37956,12 @@ curl -X GET http://zap/JSON/core/action/deleteAllAlerts/
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -20576,27 +37974,26 @@ curl -X GET http://zap/JSON/core/action/deleteAllAlerts/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionDeleteAlert
-
+networkViewGetRootCaCertValidity
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/deleteAlert/?id=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/view/getRootCaCertValidity/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/deleteAlert/?id=0");
+
URL obj = new URL("http://zap/JSON/network/view/getRootCaCertValidity/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -20612,55 +38009,17 @@ curl -X GET http://zap/JSON/core/action/deleteAlert/?id<
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/action/deleteAlert/', params={
- 'id': '0'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+r = requests.get('http://zap/JSON/network/view/getRootCaCertValidity/', headers = headers)
-result = RestClient.get 'http://zap/JSON/core/action/deleteAlert/',
- params: {
- 'id' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/action/deleteAlert/
-
-Deletes the alert with the given ID.
+GET /JSON/network/view/getRootCaCertValidity/
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-id
-query
-integer
-true
-none
-
-
+Gets the Root CA certificate validity, in days. Used when generating a new Root CA certificate.
Example responses
@@ -20668,11 +38027,12 @@ curl -X GET http://zap/JSON/core/action/deleteAlert/?id<
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -20685,27 +38045,26 @@ curl -X GET http://zap/JSON/core/action/deleteAlert/?id<
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionSetOptionDefaultUserAgent
-
+networkViewGetServerCertValidity
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/setOptionDefaultUserAgent/?String=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/view/getServerCertValidity/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/setOptionDefaultUserAgent/?String=string");
+
URL obj = new URL("http://zap/JSON/network/view/getServerCertValidity/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -20721,55 +38080,17 @@ curl -X GET http://zap/JSON/core/action/setOptionDefault
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/action/setOptionDefaultUserAgent/', params={
- 'String': 'string'
-}, headers = headers)
-
-print r.json()
+r = requests.get('http://zap/JSON/network/view/getServerCertValidity/', headers = headers)
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/action/setOptionDefaultUserAgent/',
- params: {
- 'String' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/action/setOptionDefaultUserAgent/
+GET /JSON/network/view/getServerCertValidity/
-Sets the user agent that ZAP should use when creating HTTP messages (for example, spider messages or CONNECT requests to outgoing proxy).
-
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-String
-query
-string
-true
-none
-
-
+Gets the server certificate validity, in days. Used when generating server certificates.
Example responses
@@ -20777,11 +38098,12 @@ curl -X GET http://zap/JSON/core/action/setOptionDefault
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -20794,27 +38116,26 @@ curl -X GET http://zap/JSON/core/action/setOptionDefault
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionSetOptionProxyChainName
-
+networkViewGetSocksProxy
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/setOptionProxyChainName/?String=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/view/getSocksProxy/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/setOptionProxyChainName/?String=string");
+
URL obj = new URL("http://zap/JSON/network/view/getSocksProxy/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -20830,53 +38151,17 @@ curl -X GET http://zap/JSON/core/action/setOptionProxyCh
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/action/setOptionProxyChainName/', params={
- 'String': 'string'
-}, headers = headers)
-
-print r.json()
+r = requests.get('http://zap/JSON/network/view/getSocksProxy/', headers = headers)
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/action/setOptionProxyChainName/',
- params: {
- 'String' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/action/setOptionProxyChainName/
+GET /JSON/network/view/getSocksProxy/
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-String
-query
-string
-true
-none
-
-
+Gets the SOCKS proxy.
Example responses
@@ -20884,11 +38169,12 @@ curl -X GET http://zap/JSON/core/action/setOptionProxyCh
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -20901,27 +38187,26 @@ curl -X GET http://zap/JSON/core/action/setOptionProxyCh
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionSetOptionProxyChainPassword
-
+networkViewIsHttpProxyAuthEnabled
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/setOptionProxyChainPassword/?String=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/view/isHttpProxyAuthEnabled/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/setOptionProxyChainPassword/?String=string");
+
URL obj = new URL("http://zap/JSON/network/view/isHttpProxyAuthEnabled/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -20937,53 +38222,17 @@ curl -X GET http://zap/JSON/core/action/setOptionProxyCh
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/action/setOptionProxyChainPassword/', params={
- 'String': 'string'
-}, headers = headers)
-
-print r.json()
+r = requests.get('http://zap/JSON/network/view/isHttpProxyAuthEnabled/', headers = headers)
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/action/setOptionProxyChainPassword/',
- params: {
- 'String' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/action/setOptionProxyChainPassword/
+GET /JSON/network/view/isHttpProxyAuthEnabled/
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-String
-query
-string
-true
-none
-
-
+Tells whether or not the HTTP proxy authentication is enabled.
Example responses
@@ -20991,11 +38240,12 @@ curl -X GET http://zap/JSON/core/action/setOptionProxyCh
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -21008,27 +38258,26 @@ curl -X GET http://zap/JSON/core/action/setOptionProxyCh
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionSetOptionProxyChainRealm
-
+networkViewIsHttpProxyEnabled
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/setOptionProxyChainRealm/?String=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/view/isHttpProxyEnabled/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/setOptionProxyChainRealm/?String=string");
+
URL obj = new URL("http://zap/JSON/network/view/isHttpProxyEnabled/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -21044,53 +38293,17 @@ curl -X GET http://zap/JSON/core/action/setOptionProxyCh
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/action/setOptionProxyChainRealm/', params={
- 'String': 'string'
-}, headers = headers)
+r = requests.get('http://zap/JSON/network/view/isHttpProxyEnabled/', headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/action/setOptionProxyChainRealm/',
- params: {
- 'String' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/action/setOptionProxyChainRealm/
-
-Parameters
+GET /JSON/network/view/isHttpProxyEnabled/
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-String
-query
-string
-true
-none
-
-
+Tells whether or not the HTTP proxy is enabled.
Example responses
@@ -21098,11 +38311,12 @@ curl -X GET http://zap/JSON/core/action/setOptionProxyCh
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -21115,27 +38329,26 @@ curl -X GET http://zap/JSON/core/action/setOptionProxyCh
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionSetOptionProxyChainSkipName
-
+networkViewIsSocksProxyEnabled
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/setOptionProxyChainSkipName/?String=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/view/isSocksProxyEnabled/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/setOptionProxyChainSkipName/?String=string");
+
URL obj = new URL("http://zap/JSON/network/view/isSocksProxyEnabled/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -21151,55 +38364,17 @@ curl -X GET http://zap/JSON/core/action/setOptionProxyCh
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/action/setOptionProxyChainSkipName/', params={
- 'String': 'string'
-}, headers = headers)
-
-print r.json()
+r = requests.get('http://zap/JSON/network/view/isSocksProxyEnabled/', headers = headers)
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/action/setOptionProxyChainSkipName/',
- params: {
- 'String' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/action/setOptionProxyChainSkipName/
+GET /JSON/network/view/isSocksProxyEnabled/
-Use actions [add|modify|remove]ProxyChainExcludedDomain instead.
-
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-String
-query
-string
-true
-none
-
-
+Tells whether or not the SOCKS proxy is enabled.
Example responses
@@ -21207,11 +38382,12 @@ curl -X GET http://zap/JSON/core/action/setOptionProxyCh
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -21224,27 +38400,26 @@ curl -X GET http://zap/JSON/core/action/setOptionProxyCh
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionSetOptionProxyChainUserName
-
+networkViewIsUseGlobalHttpState
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/setOptionProxyChainUserName/?String=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/network/view/isUseGlobalHttpState/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/setOptionProxyChainUserName/?String=string");
+
URL obj = new URL("http://zap/JSON/network/view/isUseGlobalHttpState/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -21260,53 +38435,17 @@ curl -X GET http://zap/JSON/core/action/setOptionProxyCh
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/action/setOptionProxyChainUserName/', params={
- 'String': 'string'
-}, headers = headers)
-
-print r.json()
+r = requests.get('http://zap/JSON/network/view/isUseGlobalHttpState/', headers = headers)
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/action/setOptionProxyChainUserName/',
- params: {
- 'String' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/action/setOptionProxyChainUserName/
+GET /JSON/network/view/isUseGlobalHttpState/
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-String
-query
-string
-true
-none
-
-
+Tells whether or not to use global HTTP state.
Example responses
@@ -21314,11 +38453,12 @@ curl -X GET http://zap/JSON/core/action/setOptionProxyCh
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -21331,27 +38471,28 @@ curl -X GET http://zap/JSON/core/action/setOptionProxyCh
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionSetOptionDnsTtlSuccessfulQueries
-
+
+openapi
+openapiActionImportFile
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/setOptionDnsTtlSuccessfulQueries/?Integer=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/openapi/action/importFile/?file=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/setOptionDnsTtlSuccessfulQueries/?Integer=0");
+
URL obj = new URL("http://zap/JSON/openapi/action/importFile/?file=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -21367,37 +38508,21 @@ curl -X GET http://zap/JSON/core/action/setOptionDnsTtlS
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/action/setOptionDnsTtlSuccessfulQueries/', params={
- 'Integer': '0'
+r = requests.get('http://zap/JSON/openapi/action/importFile/', params={
+ 'file': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/action/setOptionDnsTtlSuccessfulQueries/',
- params: {
- 'Integer' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/action/setOptionDnsTtlSuccessfulQueries/
+GET /JSON/openapi/action/importFile/
-Sets the TTL (in seconds) of successful DNS queries (applies after ZAP restart).
+Imports an OpenAPI definition from a local file.
-Parameters
+Parameters
@@ -21409,10 +38534,24 @@ curl -X GET http://zap/JSON/core/action/setOptionDnsTtlS
-Integer
+file
query
-integer
+string
true
+The file that contains the OpenAPI definition.
+
+
+target
+query
+string
+false
+The Target URL to override the server URL present in the definition.
+
+
+contextId
+query
+string
+false
none
@@ -21423,11 +38562,12 @@ curl -X GET http://zap/JSON/core/action/setOptionDnsTtlS
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -21440,27 +38580,26 @@ curl -X GET http://zap/JSON/core/action/setOptionDnsTtlS
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionSetOptionHttpStateEnabled
-
+openapiActionImportUrl
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/setOptionHttpStateEnabled/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/openapi/action/importUrl/?url=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/setOptionHttpStateEnabled/?Boolean=string");
+
URL obj = new URL("http://zap/JSON/openapi/action/importUrl/?url=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -21476,35 +38615,21 @@ curl -X GET http://zap/JSON/core/action/setOptionHttpSta
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/action/setOptionHttpStateEnabled/', params={
- 'Boolean': 'string'
+r = requests.get('http://zap/JSON/openapi/action/importUrl/', params={
+ 'url': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/action/setOptionHttpStateEnabled/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/action/setOptionHttpStateEnabled/
+GET /JSON/openapi/action/importUrl/
-Parameters
+Imports an OpenAPI definition from a URL.
+
+Parameters
@@ -21516,10 +38641,24 @@ curl -X GET http://zap/JSON/core/action/setOptionHttpSta
-Boolean
+url
query
string
true
+The URL locating the OpenAPI definition.
+
+
+hostOverride
+query
+string
+false
+The Target URL (called hostOverride for historical reasons) to override the server URL present in the definition.
+
+
+contextId
+query
+string
+false
none
@@ -21530,11 +38669,12 @@ curl -X GET http://zap/JSON/core/action/setOptionHttpSta
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -21547,27 +38687,28 @@ curl -X GET http://zap/JSON/core/action/setOptionHttpSta
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionSetOptionProxyChainPort
-
+
+paramDigger
+paramDiggerActionHelloWorld
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/setOptionProxyChainPort/?Integer=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/paramDigger/action/helloWorld/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/setOptionProxyChainPort/?Integer=0");
+
URL obj = new URL("http://zap/JSON/paramDigger/action/helloWorld/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -21583,53 +38724,15 @@ curl -X GET http://zap/JSON/core/action/setOptionProxyCh
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/core/action/setOptionProxyChainPort/', params={
- 'Integer': '0'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/core/action/setOptionProxyChainPort/',
- params: {
- 'Integer' => 'integer'
-}, headers: headers
+r = requests.get('http://zap/JSON/paramDigger/action/helloWorld/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/action/setOptionProxyChainPort/
-
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-Integer
-query
-integer
-true
-none
-
-
+GET /JSON/paramDigger/action/helloWorld/
Example responses
@@ -21637,11 +38740,12 @@ curl -X GET http://zap/JSON/core/action/setOptionProxyCh
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -21654,27 +38758,28 @@ curl -X GET http://zap/JSON/core/action/setOptionProxyCh
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionSetOptionProxyChainPrompt
-
+
+pnh
+pnhActionMonitor
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/setOptionProxyChainPrompt/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/pnh/action/monitor/?id=string&message=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/setOptionProxyChainPrompt/?Boolean=string");
+
URL obj = new URL("http://zap/JSON/pnh/action/monitor/?id=string&message=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -21690,35 +38795,19 @@ curl -X GET http://zap/JSON/core/action/setOptionProxyCh
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/action/setOptionProxyChainPrompt/', params={
- 'Boolean': 'string'
+r = requests.get('http://zap/JSON/pnh/action/monitor/', params={
+ 'id': 'string', 'message': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/action/setOptionProxyChainPrompt/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/action/setOptionProxyChainPrompt/
+GET /JSON/pnh/action/monitor/
-Parameters
+Parameters
@@ -21730,7 +38819,14 @@ curl -X GET http://zap/JSON/core/action/setOptionProxyCh
-Boolean
+id
+query
+string
+true
+none
+
+
+message
query
string
true
@@ -21744,11 +38840,12 @@ curl -X GET http://zap/JSON/core/action/setOptionProxyCh
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -21761,27 +38858,26 @@ curl -X GET http://zap/JSON/core/action/setOptionProxyCh
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionSetOptionSingleCookieRequestHeader
-
+pnhActionOracle
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/setOptionSingleCookieRequestHeader/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/pnh/action/oracle/?id=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/setOptionSingleCookieRequestHeader/?Boolean=string");
+
URL obj = new URL("http://zap/JSON/pnh/action/oracle/?id=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -21797,35 +38893,19 @@ curl -X GET http://zap/JSON/core/action/setOptionSingleC
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/action/setOptionSingleCookieRequestHeader/', params={
- 'Boolean': 'string'
+r = requests.get('http://zap/JSON/pnh/action/oracle/', params={
+ 'id': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/action/setOptionSingleCookieRequestHeader/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/action/setOptionSingleCookieRequestHeader/
+GET /JSON/pnh/action/oracle/
-Parameters
+Parameters
@@ -21837,7 +38917,7 @@ curl -X GET http://zap/JSON/core/action/setOptionSingleC
-Boolean
+id
query
string
true
@@ -21851,11 +38931,12 @@ curl -X GET http://zap/JSON/core/action/setOptionSingleC
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -21868,27 +38949,26 @@ curl -X GET http://zap/JSON/core/action/setOptionSingleC
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionSetOptionTimeoutInSecs
-
+pnhActionStartMonitoring
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/setOptionTimeoutInSecs/?Integer=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/pnh/action/startMonitoring/?url=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/setOptionTimeoutInSecs/?Integer=0");
+
URL obj = new URL("http://zap/JSON/pnh/action/startMonitoring/?url=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -21904,37 +38984,19 @@ curl -X GET http://zap/JSON/core/action/setOptionTimeout
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/action/setOptionTimeoutInSecs/', params={
- 'Integer': '0'
+r = requests.get('http://zap/JSON/pnh/action/startMonitoring/', params={
+ 'url': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/action/setOptionTimeoutInSecs/',
- params: {
- 'Integer' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/action/setOptionTimeoutInSecs/
+GET /JSON/pnh/action/startMonitoring/
-Sets the connection time out, in seconds.
-
-Parameters
+Parameters
@@ -21946,9 +39008,9 @@ curl -X GET http://zap/JSON/core/action/setOptionTimeout
-Integer
+url
query
-integer
+string
true
none
@@ -21960,11 +39022,12 @@ curl -X GET http://zap/JSON/core/action/setOptionTimeout
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -21977,27 +39040,26 @@ curl -X GET http://zap/JSON/core/action/setOptionTimeout
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionSetOptionUseProxyChain
-
+pnhActionStopMonitoring
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/setOptionUseProxyChain/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/pnh/action/stopMonitoring/?id=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/core/action/setOptionUseProxyChain/?Boolean=string");
+
URL obj = new URL("http://zap/JSON/pnh/action/stopMonitoring/?id=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -22013,37 +39075,19 @@ curl -X GET http://zap/JSON/core/action/setOptionUseProx
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/core/action/setOptionUseProxyChain/', params={
- 'Boolean': 'string'
+r = requests.get('http://zap/JSON/pnh/action/stopMonitoring/', params={
+ 'id': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/action/setOptionUseProxyChain/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/core/action/setOptionUseProxyChain/
-
-Sets whether or not the outgoing proxy should be used. The address/hostname of the outgoing proxy must be set to enable this option.
+GET /JSON/pnh/action/stopMonitoring/
-Parameters
+Parameters
@@ -22055,7 +39099,7 @@ curl -X GET http://zap/JSON/core/action/setOptionUseProx
-Boolean
+id
query
string
true
@@ -22069,11 +39113,12 @@ curl -X GET http://zap/JSON/core/action/setOptionUseProx
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -22086,27 +39131,26 @@ curl -X GET http://zap/JSON/core/action/setOptionUseProx
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreActionSetOptionUseProxyChainAuth
-
+pnhOtherFx_pnh.xpi
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/core/action/setOptionUseProxyChainAuth/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/OTHER/pnh/other/fx_pnh.xpi/ \
+ -H 'Accept: */*'
-
URL obj = new URL("http://zap/JSON/core/action/setOptionUseProxyChainAuth/?Boolean=string");
+
URL obj = new URL("http://zap/OTHER/pnh/other/fx_pnh.xpi/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -22122,65 +39166,21 @@ curl -X GET http://zap/JSON/core/action/setOptionUseProx
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': '*/*'
}
-r = requests.get('http://zap/JSON/core/action/setOptionUseProxyChainAuth/', params={
- 'Boolean': 'string'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/core/action/setOptionUseProxyChainAuth/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
+r = requests.get('http://zap/OTHER/pnh/other/fx_pnh.xpi/', headers = headers)
-p JSON.parse(result)
+print(r.content)
-GET /JSON/core/action/setOptionUseProxyChainAuth/
-
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-Boolean
-query
-string
-true
-none
-
-
+GET /OTHER/pnh/other/fx_pnh.xpi/
Example responses
-
-default Response
-{
- "message": "string",
- "code": 100
-}
-
-Responses
+
+Responses
@@ -22193,27 +39193,28 @@ curl -X GET http://zap/JSON/core/action/setOptionUseProx
default
Default
-unexpected error
-Error
+Error of OTHER endpoints.
+None
+Response Schema
+
-coreOtherProxy.pac
-
+pnhOtherManifest
+
Code samples
# You can also use wget
-curl -X GET http://zap/OTHER/core/other/proxy.pac/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/OTHER/pnh/other/manifest/ \
+ -H 'Accept: */*'
-
URL obj = new URL("http://zap/OTHER/core/other/proxy.pac/");
+
URL obj = new URL("http://zap/OTHER/pnh/other/manifest/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -22229,44 +39230,21 @@ curl -X GET http://zap/OTHER/core/other/proxy.pac/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': '*/*'
}
-r = requests.get('http://zap/OTHER/core/other/proxy.pac/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
+r = requests.get('http://zap/OTHER/pnh/other/manifest/', headers = headers)
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/OTHER/core/other/proxy.pac/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.content)
-GET /OTHER/core/other/proxy.pac/
+GET /OTHER/pnh/other/manifest/
Example responses
-
-default Response
-{
- "message": "string",
- "code": 100
-}
-
-Responses
+
+Responses
@@ -22279,27 +39257,28 @@ curl -X GET http://zap/OTHER/core/other/proxy.pac/
default
Default
-unexpected error
-Error
+Error of OTHER endpoints.
+None
+Response Schema
+
-coreOtherRootcert
-
+pnhOtherPnh
+
Code samples
# You can also use wget
-curl -X GET http://zap/OTHER/core/other/rootcert/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/OTHER/pnh/other/pnh/ \
+ -H 'Accept: */*'
-
URL obj = new URL("http://zap/OTHER/core/other/rootcert/");
+
URL obj = new URL("http://zap/OTHER/pnh/other/pnh/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -22315,46 +39294,21 @@ curl -X GET http://zap/OTHER/core/other/rootcert/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/OTHER/core/other/rootcert/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': '*/*'
}
-result = RestClient.get 'http://zap/OTHER/core/other/rootcert/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/OTHER/pnh/other/pnh/', headers = headers)
-p JSON.parse(result)
+print(r.content)
-GET /OTHER/core/other/rootcert/
-
-Gets the Root CA certificate used by the local proxies.
+GET /OTHER/pnh/other/pnh/
Example responses
-
-default Response
-{
- "message": "string",
- "code": 100
-}
-
-Responses
+
+Responses
@@ -22367,27 +39321,28 @@ curl -X GET http://zap/OTHER/core/other/rootcert/
default
Default
-unexpected error
-Error
+Error of OTHER endpoints.
+None
+Response Schema
+
-coreOtherSetproxy
-
+pnhOtherService
+
Code samples
# You can also use wget
-curl -X GET http://zap/OTHER/core/other/setproxy/?proxy=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/OTHER/pnh/other/service/ \
+ -H 'Accept: */*'
-
URL obj = new URL("http://zap/OTHER/core/other/setproxy/?proxy=string");
+
URL obj = new URL("http://zap/OTHER/pnh/other/service/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -22403,65 +39358,21 @@ curl -X GET http://zap/OTHER/core/other/setproxy/?proxy<
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': '*/*'
}
-r = requests.get('http://zap/OTHER/core/other/setproxy/', params={
- 'proxy': 'string'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+r = requests.get('http://zap/OTHER/pnh/other/service/', headers = headers)
-result = RestClient.get 'http://zap/OTHER/core/other/setproxy/',
- params: {
- 'proxy' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.content)
-GET /OTHER/core/other/setproxy/
-
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-proxy
-query
-string
-true
-none
-
-
+GET /OTHER/pnh/other/service/
Example responses
-
-default Response
-{
- "message": "string",
- "code": 100
-}
-
-Responses
+
+Responses
@@ -22474,27 +39385,30 @@ curl -X GET http://zap/OTHER/core/other/setproxy/?proxy<
default
Default
-unexpected error
-Error
+Error of OTHER endpoints.
+None
+Response Schema
+
-coreOtherXmlreport
-
+
+postman
+postmanActionImportFile
+
Code samples
# You can also use wget
-curl -X GET http://zap/OTHER/core/other/xmlreport/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/postman/action/importFile/?file=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/OTHER/core/other/xmlreport/");
+
URL obj = new URL("http://zap/JSON/postman/action/importFile/?file=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -22510,34 +39424,44 @@ curl -X GET http://zap/OTHER/core/other/xmlreport/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/OTHER/core/other/xmlreport/', params={
-
+r = requests.get('http://zap/JSON/postman/action/importFile/', params={
+ 'file': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/OTHER/core/other/xmlreport/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /OTHER/core/other/xmlreport/
+GET /JSON/postman/action/importFile/
-Generates a report in XML format
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+file
+query
+string
+true
+none
+
+
+endpointUrl
+query
+string
+false
+none
+
+
Example responses
@@ -22545,11 +39469,12 @@ curl -X GET http://zap/OTHER/core/other/xmlreport/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -22562,27 +39487,26 @@ curl -X GET http://zap/OTHER/core/other/xmlreport/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreOtherHtmlreport
-
+postmanActionImportUrl
+
Code samples
# You can also use wget
-curl -X GET http://zap/OTHER/core/other/htmlreport/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/postman/action/importUrl/?url=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/OTHER/core/other/htmlreport/");
+
URL obj = new URL("http://zap/JSON/postman/action/importUrl/?url=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -22598,34 +39522,44 @@ curl -X GET http://zap/OTHER/core/other/htmlreport/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/OTHER/core/other/htmlreport/', params={
-
+r = requests.get('http://zap/JSON/postman/action/importUrl/', params={
+ 'url': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/OTHER/core/other/htmlreport/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /OTHER/core/other/htmlreport/
+GET /JSON/postman/action/importUrl/
-Generates a report in HTML format
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+url
+query
+string
+true
+none
+
+
+endpointUrl
+query
+string
+false
+none
+
+
Example responses
@@ -22633,11 +39567,12 @@ curl -X GET http://zap/OTHER/core/other/htmlreport/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -22650,27 +39585,28 @@ curl -X GET http://zap/OTHER/core/other/htmlreport/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreOtherJsonreport
-
+
+pscan
+pscanActionClearQueue
+
Code samples
# You can also use wget
-curl -X GET http://zap/OTHER/core/other/jsonreport/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/pscan/action/clearQueue/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/OTHER/core/other/jsonreport/");
+
URL obj = new URL("http://zap/JSON/pscan/action/clearQueue/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -22686,34 +39622,17 @@ curl -X GET http://zap/OTHER/core/other/jsonreport/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/OTHER/core/other/jsonreport/', params={
+r = requests.get('http://zap/JSON/pscan/action/clearQueue/', headers = headers)
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/OTHER/core/other/jsonreport/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /OTHER/core/other/jsonreport/
+GET /JSON/pscan/action/clearQueue/
-Generates a report in JSON format
+Clears the passive scan queue.
Example responses
@@ -22721,11 +39640,12 @@ curl -X GET http://zap/OTHER/core/other/jsonreport/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -22738,27 +39658,26 @@ curl -X GET http://zap/OTHER/core/other/jsonreport/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreOtherMdreport
-
+pscanActionDisableAllScanners
+
Code samples
# You can also use wget
-curl -X GET http://zap/OTHER/core/other/mdreport/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/pscan/action/disableAllScanners/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/OTHER/core/other/mdreport/");
+
URL obj = new URL("http://zap/JSON/pscan/action/disableAllScanners/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -22774,34 +39693,17 @@ curl -X GET http://zap/OTHER/core/other/mdreport/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/OTHER/core/other/mdreport/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/OTHER/core/other/mdreport/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/pscan/action/disableAllScanners/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /OTHER/core/other/mdreport/
+GET /JSON/pscan/action/disableAllScanners/
-Generates a report in Markdown format
+Disables all passive scan rules
Example responses
@@ -22809,11 +39711,12 @@ curl -X GET http://zap/OTHER/core/other/mdreport/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -22826,27 +39729,26 @@ curl -X GET http://zap/OTHER/core/other/mdreport/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreOtherMessageHar
-
+pscanActionDisableAllTags
+
Code samples
# You can also use wget
-curl -X GET http://zap/OTHER/core/other/messageHar/?id=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/pscan/action/disableAllTags/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/OTHER/core/other/messageHar/?id=0");
+
URL obj = new URL("http://zap/JSON/pscan/action/disableAllTags/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -22862,55 +39764,17 @@ curl -X GET http://zap/OTHER/core/other/messageHar/?id
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/OTHER/core/other/messageHar/', params={
- 'id': '0'
-}, headers = headers)
-
-print r.json()
+r = requests.get('http://zap/JSON/pscan/action/disableAllTags/', headers = headers)
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/OTHER/core/other/messageHar/',
- params: {
- 'id' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /OTHER/core/other/messageHar/
+GET /JSON/pscan/action/disableAllTags/
-Gets the message with the given ID in HAR format
-
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-id
-query
-integer
-true
-none
-
-
+Disables all passive scan tags.
Example responses
@@ -22918,11 +39782,12 @@ curl -X GET http://zap/OTHER/core/other/messageHar/?iddefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -22935,27 +39800,26 @@ curl -X GET http://zap/OTHER/core/other/messageHar/?id
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreOtherMessagesHar
-
+pscanActionDisableScanners
+
Code samples
# You can also use wget
-curl -X GET http://zap/OTHER/core/other/messagesHar/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/pscan/action/disableScanners/?ids=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/OTHER/core/other/messagesHar/");
+
URL obj = new URL("http://zap/JSON/pscan/action/disableScanners/?ids=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -22971,36 +39835,21 @@ curl -X GET http://zap/OTHER/core/other/messagesHar/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/OTHER/core/other/messagesHar/', params={
-
+r = requests.get('http://zap/JSON/pscan/action/disableScanners/', params={
+ 'ids': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/OTHER/core/other/messagesHar/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /OTHER/core/other/messagesHar/
+GET /JSON/pscan/action/disableScanners/
-Gets the HTTP messages sent through/by ZAP, in HAR format, optionally filtered by URL and paginated with 'start' position and 'count' of messages
+Disables all passive scan rules with the given IDs (comma separated list of IDs)
-Parameters
+Parameters
@@ -23012,24 +39861,10 @@ curl -X GET http://zap/OTHER/core/other/messagesHar/
-baseurl
+ids
query
string
-false
-none
-
-
-start
-query
-integer
-false
-none
-
-
-count
-query
-integer
-false
+true
none
@@ -23040,11 +39875,12 @@ curl -X GET http://zap/OTHER/core/other/messagesHar/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -23057,27 +39893,26 @@ curl -X GET http://zap/OTHER/core/other/messagesHar/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreOtherMessagesHarById
-
+pscanActionEnableAllScanners
+
Code samples
# You can also use wget
-curl -X GET http://zap/OTHER/core/other/messagesHarById/?ids=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/pscan/action/enableAllScanners/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/OTHER/core/other/messagesHarById/?ids=string");
+
URL obj = new URL("http://zap/JSON/pscan/action/enableAllScanners/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -23093,55 +39928,17 @@ curl -X GET http://zap/OTHER/core/other/messagesHarById/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/OTHER/core/other/messagesHarById/', params={
- 'ids': 'string'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/OTHER/core/other/messagesHarById/',
- params: {
- 'ids' => 'string'
-}, headers: headers
+r = requests.get('http://zap/JSON/pscan/action/enableAllScanners/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /OTHER/core/other/messagesHarById/
-
-Gets the HTTP messages with the given IDs, in HAR format.
-
-Parameters
+GET /JSON/pscan/action/enableAllScanners/
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-ids
-query
-string
-true
-none
-
-
+Enables all passive scan rules
Example responses
@@ -23149,11 +39946,12 @@ curl -X GET http://zap/OTHER/core/other/messagesHarById/
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -23166,27 +39964,26 @@ curl -X GET http://zap/OTHER/core/other/messagesHarById/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-coreOtherSendHarRequest
-
+pscanActionEnableAllTags
+
Code samples
# You can also use wget
-curl -X GET http://zap/OTHER/core/other/sendHarRequest/?request=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/pscan/action/enableAllTags/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/OTHER/core/other/sendHarRequest/?request=string");
+
URL obj = new URL("http://zap/JSON/pscan/action/enableAllTags/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -23202,62 +39999,17 @@ curl -X GET http://zap/OTHER/core/other/sendHarRequest/?
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/OTHER/core/other/sendHarRequest/', params={
- 'request': 'string'
-}, headers = headers)
-
-print r.json()
+r = requests.get('http://zap/JSON/pscan/action/enableAllTags/', headers = headers)
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/OTHER/core/other/sendHarRequest/',
- params: {
- 'request' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /OTHER/core/other/sendHarRequest/
-
-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.
+GET /JSON/pscan/action/enableAllTags/
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-request
-query
-string
-true
-none
-
-
-followRedirects
-query
-boolean
-false
-none
-
-
+Enables all passive scan tags.
Example responses
@@ -23265,11 +40017,12 @@ curl -X GET http://zap/OTHER/core/other/sendHarRequest/?
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -23282,29 +40035,26 @@ curl -X GET http://zap/OTHER/core/other/sendHarRequest/?
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-
-params
-paramsViewParams
-
+pscanActionEnableScanners
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/params/view/params/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/pscan/action/enableScanners/?ids=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/params/view/params/");
+
URL obj = new URL("http://zap/JSON/pscan/action/enableScanners/?ids=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -23320,36 +40070,21 @@ curl -X GET http://zap/JSON/params/view/params/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/params/view/params/', params={
-
+r = requests.get('http://zap/JSON/pscan/action/enableScanners/', params={
+ 'ids': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/params/view/params/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/params/view/params/
+GET /JSON/pscan/action/enableScanners/
-Shows the parameters for the specified site, or for all sites if the site is not specified
+Enables all passive scan rules with the given IDs (comma separated list of IDs)
-Parameters
+Parameters
@@ -23361,10 +40096,10 @@ curl -X GET http://zap/JSON/params/view/params/
-site
+ids
query
string
-false
+true
none
@@ -23375,11 +40110,12 @@ curl -X GET http://zap/JSON/params/view/params/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -23392,29 +40128,26 @@ curl -X GET http://zap/JSON/params/view/params/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-
-ascan
-ascanViewStatus
-
+pscanActionSetEnabled
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/status/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/pscan/action/setEnabled/?enabled=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/status/");
+
URL obj = new URL("http://zap/JSON/pscan/action/setEnabled/?enabled=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -23430,34 +40163,21 @@ curl -X GET http://zap/JSON/ascan/view/status/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/view/status/', params={
-
+r = requests.get('http://zap/JSON/pscan/action/setEnabled/', params={
+ 'enabled': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/view/status/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/view/status/
+GET /JSON/pscan/action/setEnabled/
-Parameters
+Sets whether or not the passive scanning is enabled (Note: the enabled state is not persisted).
+
+Parameters
@@ -23469,10 +40189,10 @@ curl -X GET http://zap/JSON/ascan/view/status/
-scanId
+enabled
query
-integer
-false
+string
+true
none
@@ -23483,11 +40203,12 @@ curl -X GET http://zap/JSON/ascan/view/status/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -23500,27 +40221,26 @@ curl -X GET http://zap/JSON/ascan/view/status/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanViewScanProgress
-
+pscanActionSetMaxAlertsPerRule
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/scanProgress/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/pscan/action/setMaxAlertsPerRule/?maxAlerts=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/scanProgress/");
+
URL obj = new URL("http://zap/JSON/pscan/action/setMaxAlertsPerRule/?maxAlerts=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -23536,34 +40256,21 @@ curl -X GET http://zap/JSON/ascan/view/scanProgress/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/view/scanProgress/', params={
-
+r = requests.get('http://zap/JSON/pscan/action/setMaxAlertsPerRule/', params={
+ 'maxAlerts': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/view/scanProgress/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/view/scanProgress/
+GET /JSON/pscan/action/setMaxAlertsPerRule/
-Parameters
+Sets the maximum number of alerts a passive scan rule should raise.
+
+Parameters
@@ -23575,10 +40282,10 @@ curl -X GET http://zap/JSON/ascan/view/scanProgress/
-scanId
+maxAlerts
query
-integer
-false
+string
+true
none
@@ -23589,11 +40296,12 @@ curl -X GET http://zap/JSON/ascan/view/scanProgress/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -23606,27 +40314,26 @@ curl -X GET http://zap/JSON/ascan/view/scanProgress/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanViewMessagesIds
-
+pscanActionSetScanOnlyInScope
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/messagesIds/?scanId=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/pscan/action/setScanOnlyInScope/?onlyInScope=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/messagesIds/?scanId=0");
+
URL obj = new URL("http://zap/JSON/pscan/action/setScanOnlyInScope/?onlyInScope=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -23642,37 +40349,21 @@ curl -X GET http://zap/JSON/ascan/view/messagesIds/?scan
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/view/messagesIds/', params={
- 'scanId': '0'
+r = requests.get('http://zap/JSON/pscan/action/setScanOnlyInScope/', params={
+ 'onlyInScope': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/view/messagesIds/',
- params: {
- 'scanId' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/view/messagesIds/
+GET /JSON/pscan/action/setScanOnlyInScope/
-Gets the IDs of the messages sent during the scan with the given ID. A message can be obtained with 'message' core view.
+Sets whether or not the passive scan should be performed only on messages that are in scope.
-Parameters
+Parameters
@@ -23684,9 +40375,9 @@ curl -X GET http://zap/JSON/ascan/view/messagesIds/?scan
-scanId
+onlyInScope
query
-integer
+string
true
none
@@ -23698,11 +40389,12 @@ curl -X GET http://zap/JSON/ascan/view/messagesIds/?scan
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -23715,27 +40407,26 @@ curl -X GET http://zap/JSON/ascan/view/messagesIds/?scan
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanViewAlertsIds
-
+pscanActionSetScannerAlertThreshold
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/alertsIds/?scanId=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/pscan/action/setScannerAlertThreshold/?id=string&alertThreshold=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/alertsIds/?scanId=0");
+
URL obj = new URL("http://zap/JSON/pscan/action/setScannerAlertThreshold/?id=string&alertThreshold=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -23751,37 +40442,21 @@ curl -X GET http://zap/JSON/ascan/view/alertsIds/?scanId
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/view/alertsIds/', params={
- 'scanId': '0'
+r = requests.get('http://zap/JSON/pscan/action/setScannerAlertThreshold/', params={
+ 'id': 'string', 'alertThreshold': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/view/alertsIds/',
- params: {
- 'scanId' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/view/alertsIds/
+GET /JSON/pscan/action/setScannerAlertThreshold/
-Gets the IDs of the alerts raised during the scan with the given ID. An alert can be obtained with 'alert' core view.
+Sets the alert threshold of the passive scan rule with the given ID, accepted values for alert threshold: OFF, DEFAULT, LOW, MEDIUM and HIGH
-Parameters
+Parameters
@@ -23793,9 +40468,16 @@ curl -X GET http://zap/JSON/ascan/view/alertsIds/?scanId
-scanId
+id
query
-integer
+string
+true
+none
+
+
+alertThreshold
+query
+string
true
none
@@ -23807,11 +40489,12 @@ curl -X GET http://zap/JSON/ascan/view/alertsIds/?scanId
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -23824,27 +40507,26 @@ curl -X GET http://zap/JSON/ascan/view/alertsIds/?scanId
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanViewScans
-
+pscanViewCurrentRule
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/scans/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/pscan/view/currentRule/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/scans/");
+
URL obj = new URL("http://zap/JSON/pscan/view/currentRule/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -23860,32 +40542,17 @@ curl -X GET http://zap/JSON/ascan/view/scans/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/view/scans/', params={
+r = requests.get('http://zap/JSON/pscan/view/currentRule/', headers = headers)
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/view/scans/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/view/scans/
+GET /JSON/pscan/view/currentRule/
+
+Use the currentTasks view instead.
Example responses
@@ -23893,11 +40560,12 @@ curl -X GET http://zap/JSON/ascan/view/scans/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -23910,27 +40578,26 @@ curl -X GET http://zap/JSON/ascan/view/scans/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanViewScanPolicyNames
-
+pscanViewCurrentTasks
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/scanPolicyNames/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/pscan/view/currentTasks/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/scanPolicyNames/");
+
URL obj = new URL("http://zap/JSON/pscan/view/currentTasks/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -23946,32 +40613,17 @@ curl -X GET http://zap/JSON/ascan/view/scanPolicyNames/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/view/scanPolicyNames/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+r = requests.get('http://zap/JSON/pscan/view/currentTasks/', headers = headers)
-result = RestClient.get 'http://zap/JSON/ascan/view/scanPolicyNames/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/view/scanPolicyNames/
+GET /JSON/pscan/view/currentTasks/
+
+Show information about the passive scan tasks currently being run (if any).
Example responses
@@ -23979,11 +40631,12 @@ curl -X GET http://zap/JSON/ascan/view/scanPolicyNames/
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -23996,27 +40649,26 @@ curl -X GET http://zap/JSON/ascan/view/scanPolicyNames/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanViewExcludedFromScan
-
+pscanViewMaxAlertsPerRule
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/excludedFromScan/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/pscan/view/maxAlertsPerRule/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/excludedFromScan/");
+
URL obj = new URL("http://zap/JSON/pscan/view/maxAlertsPerRule/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -24032,34 +40684,17 @@ curl -X GET http://zap/JSON/ascan/view/excludedFromScan/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/ascan/view/excludedFromScan/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/ascan/view/excludedFromScan/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/pscan/view/maxAlertsPerRule/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/view/excludedFromScan/
+GET /JSON/pscan/view/maxAlertsPerRule/
-Gets the regexes of URLs excluded from the active scans.
+Gets the maximum number of alerts a passive scan rule should raise.
Example responses
@@ -24067,11 +40702,12 @@ curl -X GET http://zap/JSON/ascan/view/excludedFromScan/
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -24084,27 +40720,26 @@ curl -X GET http://zap/JSON/ascan/view/excludedFromScan/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanViewScanners
-
+pscanViewRecordsToScan
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/scanners/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/pscan/view/recordsToScan/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/scanners/");
+
URL obj = new URL("http://zap/JSON/pscan/view/recordsToScan/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -24120,61 +40755,17 @@ curl -X GET http://zap/JSON/ascan/view/scanners/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/view/scanners/', params={
+r = requests.get('http://zap/JSON/pscan/view/recordsToScan/', headers = headers)
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/view/scanners/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/view/scanners/
-
-Gets the scanners, optionally, of the given scan policy and/or scanner policy/category ID.
-
-Parameters
+GET /JSON/pscan/view/recordsToScan/
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-scanPolicyName
-query
-string
-false
-none
-
-
-policyId
-query
-integer
-false
-none
-
-
+The number of records the passive scanner still has to scan
Example responses
@@ -24182,11 +40773,12 @@ curl -X GET http://zap/JSON/ascan/view/scanners/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -24199,27 +40791,26 @@ curl -X GET http://zap/JSON/ascan/view/scanners/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanViewPolicies
-
+pscanViewScanOnlyInScope
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/policies/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/pscan/view/scanOnlyInScope/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/policies/");
+
URL obj = new URL("http://zap/JSON/pscan/view/scanOnlyInScope/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -24235,59 +40826,17 @@ curl -X GET http://zap/JSON/ascan/view/policies/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/ascan/view/policies/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/ascan/view/policies/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/pscan/view/scanOnlyInScope/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/view/policies/
-
-Parameters
+GET /JSON/pscan/view/scanOnlyInScope/
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-scanPolicyName
-query
-string
-false
-none
-
-
-policyId
-query
-integer
-false
-none
-
-
+Tells whether or not the passive scan should be performed only on messages that are in scope.
Example responses
@@ -24295,11 +40844,12 @@ curl -X GET http://zap/JSON/ascan/view/policies/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -24312,27 +40862,26 @@ curl -X GET http://zap/JSON/ascan/view/policies/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanViewAttackModeQueue
-
+pscanViewScanners
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/attackModeQueue/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/pscan/view/scanners/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/attackModeQueue/");
+
URL obj = new URL("http://zap/JSON/pscan/view/scanners/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -24348,32 +40897,17 @@ curl -X GET http://zap/JSON/ascan/view/attackModeQueue/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/ascan/view/attackModeQueue/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/ascan/view/attackModeQueue/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/pscan/view/scanners/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/view/attackModeQueue/
+GET /JSON/pscan/view/scanners/
+
+Lists all passive scan rules with their ID, name, enabled state, and alert threshold.
Example responses
@@ -24381,11 +40915,12 @@ curl -X GET http://zap/JSON/ascan/view/attackModeQueue/
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -24398,27 +40933,28 @@ curl -X GET http://zap/JSON/ascan/view/attackModeQueue/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanViewExcludedParams
-
+
+quickstartlaunch
+quickstartlaunchOtherStartPage
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/excludedParams/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/OTHER/quickstartlaunch/other/startPage/ \
+ -H 'Accept: */*'
-
URL obj = new URL("http://zap/JSON/ascan/view/excludedParams/");
+
URL obj = new URL("http://zap/OTHER/quickstartlaunch/other/startPage/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -24434,46 +40970,21 @@ curl -X GET http://zap/JSON/ascan/view/excludedParams/ <
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/ascan/view/excludedParams/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': '*/*'
}
-result = RestClient.get 'http://zap/JSON/ascan/view/excludedParams/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/OTHER/quickstartlaunch/other/startPage/', headers = headers)
-p JSON.parse(result)
+print(r.content)
-GET /JSON/ascan/view/excludedParams/
-
-Gets all the parameters that are excluded. For each parameter the following are shown: the name, the URL, and the parameter type.
+GET /OTHER/quickstartlaunch/other/startPage/
Example responses
-
-default Response
-{
- "message": "string",
- "code": 100
-}
-
-Responses
+
+Responses
@@ -24486,27 +40997,30 @@ curl -X GET http://zap/JSON/ascan/view/excludedParams/ <
default
Default
-unexpected error
-Error
+Error of OTHER endpoints.
+None
+Response Schema
+
-ascanViewOptionExcludedParamList
-
+
+replacer
+replacerActionAddRule
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/optionExcludedParamList/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/replacer/action/addRule/?description=string&enabled=string&matchType=string&matchRegex=string&matchString=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/optionExcludedParamList/");
+
URL obj = new URL("http://zap/JSON/replacer/action/addRule/?description=string&enabled=string&matchType=string&matchRegex=string&matchString=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -24522,34 +41036,88 @@ curl -X GET http://zap/JSON/ascan/view/optionExcludedPar
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/view/optionExcludedParamList/', params={
-
+r = requests.get('http://zap/JSON/replacer/action/addRule/', params={
+ 'description': 'string', 'enabled': 'string', 'matchType': 'string', 'matchRegex': 'string', 'matchString': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+print(r.json())
-result = RestClient.get 'http://zap/JSON/ascan/view/optionExcludedParamList/',
- params: {
- }, headers: headers
+
+GET /JSON/replacer/action/addRule/
-p JSON.parse(result)
+Adds a replacer rule. For the parameters: desc is a user friendly description, enabled is true or false, matchType is one of [REQ_HEADER, REQ_HEADER_STR, REQ_BODY_STR, RESP_HEADER, RESP_HEADER_STR, RESP_BODY_STR], matchRegex should be true if the matchString should be treated as a regex otherwise false, matchString is the string that will be matched against, replacement is the replacement string, initiators may be blank (for all initiators) or a comma separated list of integers as defined in HttpSender
-
-GET /JSON/ascan/view/optionExcludedParamList/
+Parameters
-Use view excludedParams instead.
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+description
+query
+string
+true
+none
+
+
+enabled
+query
+string
+true
+none
+
+
+matchType
+query
+string
+true
+none
+
+
+matchRegex
+query
+string
+true
+none
+
+
+matchString
+query
+string
+true
+none
+
+
+replacement
+query
+string
+false
+none
+
+
+initiators
+query
+string
+false
+none
+
+
+url
+query
+string
+false
+A regular expression to match the URL of the message, if empty the rule applies to all messages.
+
+
Example responses
@@ -24557,11 +41125,12 @@ curl -X GET http://zap/JSON/ascan/view/optionExcludedPar
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -24574,27 +41143,26 @@ curl -X GET http://zap/JSON/ascan/view/optionExcludedPar
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanViewExcludedParamTypes
-
+replacerActionRemoveRule
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/excludedParamTypes/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/replacer/action/removeRule/?description=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/excludedParamTypes/");
+
URL obj = new URL("http://zap/JSON/replacer/action/removeRule/?description=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -24610,34 +41178,39 @@ curl -X GET http://zap/JSON/ascan/view/excludedParamType
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/view/excludedParamTypes/', params={
-
+r = requests.get('http://zap/JSON/replacer/action/removeRule/', params={
+ 'description': 'string'
}, headers = headers)
-print r.json()
+print(r.json())
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+
+GET /JSON/replacer/action/removeRule/
-result = RestClient.get 'http://zap/JSON/ascan/view/excludedParamTypes/',
- params: {
- }, headers: headers
+Removes the rule with the given description
-p JSON.parse(result)
+Parameters
-
-GET /JSON/ascan/view/excludedParamTypes/
-
-Gets all the types of excluded parameters. For each type the following are shown: the ID and the name.
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+description
+query
+string
+true
+none
+
+
Example responses
@@ -24645,11 +41218,12 @@ curl -X GET http://zap/JSON/ascan/view/excludedParamType
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -24662,27 +41236,26 @@ curl -X GET http://zap/JSON/ascan/view/excludedParamType
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanViewOptionAttackPolicy
-
+replacerActionSetEnabled
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/optionAttackPolicy/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/replacer/action/setEnabled/?description=string&bool=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/optionAttackPolicy/");
+
URL obj = new URL("http://zap/JSON/replacer/action/setEnabled/?description=string&bool=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -24698,32 +41271,46 @@ curl -X GET http://zap/JSON/ascan/view/optionAttackPolic
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/view/optionAttackPolicy/', params={
-
+r = requests.get('http://zap/JSON/replacer/action/setEnabled/', params={
+ 'description': 'string', 'bool': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
+print(r.json())
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+
+GET /JSON/replacer/action/setEnabled/
-result = RestClient.get 'http://zap/JSON/ascan/view/optionAttackPolicy/',
- params: {
- }, headers: headers
+Enables or disables the rule with the given description based on the bool parameter
-p JSON.parse(result)
+Parameters
-
-GET /JSON/ascan/view/optionAttackPolicy/
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+description
+query
+string
+true
+none
+
+
+bool
+query
+string
+true
+none
+
+
Example responses
@@ -24731,11 +41318,12 @@ curl -X GET http://zap/JSON/ascan/view/optionAttackPolic
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -24748,27 +41336,26 @@ curl -X GET http://zap/JSON/ascan/view/optionAttackPolic
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanViewOptionDefaultPolicy
-
+replacerViewRules
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/optionDefaultPolicy/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/replacer/view/rules/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/optionDefaultPolicy/");
+
URL obj = new URL("http://zap/JSON/replacer/view/rules/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -24784,32 +41371,17 @@ curl -X GET http://zap/JSON/ascan/view/optionDefaultPoli
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/ascan/view/optionDefaultPolicy/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/ascan/view/optionDefaultPolicy/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/replacer/view/rules/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/view/optionDefaultPolicy/
+GET /JSON/replacer/view/rules/
+
+Returns full details of all of the rules
Example responses
@@ -24817,11 +41389,12 @@ curl -X GET http://zap/JSON/ascan/view/optionDefaultPoli
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -24834,27 +41407,28 @@ curl -X GET http://zap/JSON/ascan/view/optionDefaultPoli
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanViewOptionDelayInMs
-
+
+reports
+reportsActionGenerate
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/optionDelayInMs/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/reports/action/generate/?title=string&template=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/optionDelayInMs/");
+
URL obj = new URL("http://zap/JSON/reports/action/generate/?title=string&template=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -24870,32 +41444,123 @@ curl -X GET http://zap/JSON/ascan/view/optionDelayInMs/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/view/optionDelayInMs/', params={
-
+r = requests.get('http://zap/JSON/reports/action/generate/', params={
+ 'title': 'string', 'template': 'string'
}, headers = headers)
-print r.json()
+print(r.json())
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+
+GET /JSON/reports/action/generate/
-result = RestClient.get 'http://zap/JSON/ascan/view/optionDelayInMs/',
- params: {
- }, headers: headers
+Generate a report with the supplied parameters.
-p JSON.parse(result)
+Parameters
-
-GET /JSON/ascan/view/optionDelayInMs/
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+title
+query
+string
+true
+Report Title
+
+
+template
+query
+string
+true
+Report Template
+
+
+theme
+query
+string
+false
+Report Theme
+
+
+description
+query
+string
+false
+Report Description
+
+
+contexts
+query
+string
+false
+The name of the contexts to be included in the report, separated by '
+
+
+sites
+query
+string
+false
+The site URLs that should be included in the report, separated by '
+
+
+sections
+query
+string
+false
+The report sections that should be included, separated by '
+
+
+includedConfidences
+query
+string
+false
+Confidences that should be included in the report, separated by '
+
+
+includedRisks
+query
+string
+false
+Risks that should be included in the report, separated by '
+
+
+reportFileName
+query
+string
+false
+The file name of the generated report. This value overrides the reportFileNamePattern parameter.
+
+
+reportFileNamePattern
+query
+string
+false
+Report File Name Pattern.
+
+
+reportDir
+query
+string
+false
+Path to directory in which the generated report should be placed.
+
+
+display
+query
+string
+false
+Display the generated report. Either "true" or "false".
+
+
Example responses
@@ -24903,11 +41568,12 @@ curl -X GET http://zap/JSON/ascan/view/optionDelayInMs/
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -24920,27 +41586,26 @@ curl -X GET http://zap/JSON/ascan/view/optionDelayInMs/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanViewOptionHandleAntiCSRFTokens
-
+reportsViewTemplateDetails
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/optionHandleAntiCSRFTokens/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/reports/view/templateDetails/?template=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/optionHandleAntiCSRFTokens/");
+
URL obj = new URL("http://zap/JSON/reports/view/templateDetails/?template=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -24956,32 +41621,39 @@ curl -X GET http://zap/JSON/ascan/view/optionHandleAntiC
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/view/optionHandleAntiCSRFTokens/', params={
-
+r = requests.get('http://zap/JSON/reports/view/templateDetails/', params={
+ 'template': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
+print(r.json())
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+
+GET /JSON/reports/view/templateDetails/
-result = RestClient.get 'http://zap/JSON/ascan/view/optionHandleAntiCSRFTokens/',
- params: {
- }, headers: headers
+View details of the specified template.
-p JSON.parse(result)
+Parameters
-
-GET /JSON/ascan/view/optionHandleAntiCSRFTokens/
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+template
+query
+string
+true
+Template Label
+
+
Example responses
@@ -24989,11 +41661,12 @@ curl -X GET http://zap/JSON/ascan/view/optionHandleAntiC
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -25006,27 +41679,26 @@ curl -X GET http://zap/JSON/ascan/view/optionHandleAntiC
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanViewOptionHostPerScan
-
+reportsViewTemplates
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/optionHostPerScan/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/reports/view/templates/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/optionHostPerScan/");
+
URL obj = new URL("http://zap/JSON/reports/view/templates/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -25042,32 +41714,17 @@ curl -X GET http://zap/JSON/ascan/view/optionHostPerScan
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/ascan/view/optionHostPerScan/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/ascan/view/optionHostPerScan/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/reports/view/templates/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/view/optionHostPerScan/
+GET /JSON/reports/view/templates/
+
+View available templates.
Example responses
@@ -25075,11 +41732,12 @@ curl -X GET http://zap/JSON/ascan/view/optionHostPerScan
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -25092,27 +41750,28 @@ curl -X GET http://zap/JSON/ascan/view/optionHostPerScan
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanViewOptionMaxChartTimeInMins
-
+
+retest
+retestActionRetest
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/optionMaxChartTimeInMins/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/retest/action/retest/?alertIds=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/optionMaxChartTimeInMins/");
+
URL obj = new URL("http://zap/JSON/retest/action/retest/?alertIds=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -25128,32 +41787,37 @@ curl -X GET http://zap/JSON/ascan/view/optionMaxChartTim
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/view/optionMaxChartTimeInMins/', params={
-
+r = requests.get('http://zap/JSON/retest/action/retest/', params={
+ 'alertIds': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+print(r.json())
-result = RestClient.get 'http://zap/JSON/ascan/view/optionMaxChartTimeInMins/',
- params: {
- }, headers: headers
+
+GET /JSON/retest/action/retest/
-p JSON.parse(result)
+Parameters
-
-GET /JSON/ascan/view/optionMaxChartTimeInMins/
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+alertIds
+query
+string
+true
+none
+
+
Example responses
@@ -25161,11 +41825,12 @@ curl -X GET http://zap/JSON/ascan/view/optionMaxChartTim
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -25178,27 +41843,28 @@ curl -X GET http://zap/JSON/ascan/view/optionMaxChartTim
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanViewOptionMaxResultsToList
-
+
+reveal
+revealActionSetReveal
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/optionMaxResultsToList/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/reveal/action/setReveal/?reveal=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/optionMaxResultsToList/");
+
URL obj = new URL("http://zap/JSON/reveal/action/setReveal/?reveal=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -25214,32 +41880,39 @@ curl -X GET http://zap/JSON/ascan/view/optionMaxResultsT
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/view/optionMaxResultsToList/', params={
-
+r = requests.get('http://zap/JSON/reveal/action/setReveal/', params={
+ 'reveal': 'string'
}, headers = headers)
-print r.json()
+print(r.json())
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+
+GET /JSON/reveal/action/setReveal/
-result = RestClient.get 'http://zap/JSON/ascan/view/optionMaxResultsToList/',
- params: {
- }, headers: headers
+Sets if shows hidden fields and enables disabled fields
-p JSON.parse(result)
+Parameters
-
-GET /JSON/ascan/view/optionMaxResultsToList/
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+reveal
+query
+string
+true
+none
+
+
Example responses
@@ -25247,11 +41920,12 @@ curl -X GET http://zap/JSON/ascan/view/optionMaxResultsT
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -25264,27 +41938,26 @@ curl -X GET http://zap/JSON/ascan/view/optionMaxResultsT
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanViewOptionMaxRuleDurationInMins
-
+revealViewReveal
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/optionMaxRuleDurationInMins/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/reveal/view/reveal/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/optionMaxRuleDurationInMins/");
+
URL obj = new URL("http://zap/JSON/reveal/view/reveal/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -25300,32 +41973,17 @@ curl -X GET http://zap/JSON/ascan/view/optionMaxRuleDura
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/ascan/view/optionMaxRuleDurationInMins/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/ascan/view/optionMaxRuleDurationInMins/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/reveal/view/reveal/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/view/optionMaxRuleDurationInMins/
+GET /JSON/reveal/view/reveal/
+
+Tells if shows hidden fields and enables disabled fields
Example responses
@@ -25333,11 +41991,12 @@ curl -X GET http://zap/JSON/ascan/view/optionMaxRuleDura
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -25350,27 +42009,28 @@ curl -X GET http://zap/JSON/ascan/view/optionMaxRuleDura
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanViewOptionMaxScanDurationInMins
-
+
+revisit
+revisitActionRevisitSiteOff
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/optionMaxScanDurationInMins/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/revisit/action/revisitSiteOff/?site=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/optionMaxScanDurationInMins/");
+
URL obj = new URL("http://zap/JSON/revisit/action/revisitSiteOff/?site=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -25386,32 +42046,37 @@ curl -X GET http://zap/JSON/ascan/view/optionMaxScanDura
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/view/optionMaxScanDurationInMins/', params={
-
+r = requests.get('http://zap/JSON/revisit/action/revisitSiteOff/', params={
+ 'site': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
+print(r.json())
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/view/optionMaxScanDurationInMins/',
- params: {
- }, headers: headers
+
+GET /JSON/revisit/action/revisitSiteOff/
-p JSON.parse(result)
+Parameters
-
-GET /JSON/ascan/view/optionMaxScanDurationInMins/
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+site
+query
+string
+true
+none
+
+
Example responses
@@ -25419,11 +42084,12 @@ curl -X GET http://zap/JSON/ascan/view/optionMaxScanDura
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -25436,27 +42102,26 @@ curl -X GET http://zap/JSON/ascan/view/optionMaxScanDura
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanViewOptionMaxScansInUI
-
+revisitActionRevisitSiteOn
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/optionMaxScansInUI/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/revisit/action/revisitSiteOn/?site=string&startTime=string&endTime=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/optionMaxScansInUI/");
+
URL obj = new URL("http://zap/JSON/revisit/action/revisitSiteOn/?site=string&startTime=string&endTime=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -25472,32 +42137,51 @@ curl -X GET http://zap/JSON/ascan/view/optionMaxScansInU
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/view/optionMaxScansInUI/', params={
-
+r = requests.get('http://zap/JSON/revisit/action/revisitSiteOn/', params={
+ 'site': 'string', 'startTime': 'string', 'endTime': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+print(r.json())
-result = RestClient.get 'http://zap/JSON/ascan/view/optionMaxScansInUI/',
- params: {
- }, headers: headers
+
+GET /JSON/revisit/action/revisitSiteOn/
-p JSON.parse(result)
+Parameters
-
-GET /JSON/ascan/view/optionMaxScansInUI/
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+site
+query
+string
+true
+none
+
+
+startTime
+query
+string
+true
+none
+
+
+endTime
+query
+string
+true
+none
+
+
Example responses
@@ -25505,11 +42189,12 @@ curl -X GET http://zap/JSON/ascan/view/optionMaxScansInU
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -25522,27 +42207,26 @@ curl -X GET http://zap/JSON/ascan/view/optionMaxScansInU
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanViewOptionTargetParamsEnabledRPC
-
+revisitViewRevisitList
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/optionTargetParamsEnabledRPC/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/revisit/view/revisitList/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/optionTargetParamsEnabledRPC/");
+
URL obj = new URL("http://zap/JSON/revisit/view/revisitList/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -25558,32 +42242,15 @@ curl -X GET http://zap/JSON/ascan/view/optionTargetParam
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/ascan/view/optionTargetParamsEnabledRPC/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/ascan/view/optionTargetParamsEnabledRPC/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/revisit/view/revisitList/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/view/optionTargetParamsEnabledRPC/
+GET /JSON/revisit/view/revisitList/
Example responses
@@ -25591,11 +42258,12 @@ curl -X GET http://zap/JSON/ascan/view/optionTargetParam
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -25608,27 +42276,28 @@ curl -X GET http://zap/JSON/ascan/view/optionTargetParam
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanViewOptionTargetParamsInjectable
-
+
+ruleConfig
+ruleConfigActionResetAllRuleConfigValues
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/optionTargetParamsInjectable/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/ruleConfig/action/resetAllRuleConfigValues/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/optionTargetParamsInjectable/");
+
URL obj = new URL("http://zap/JSON/ruleConfig/action/resetAllRuleConfigValues/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -25644,32 +42313,17 @@ curl -X GET http://zap/JSON/ascan/view/optionTargetParam
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/ascan/view/optionTargetParamsInjectable/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/ascan/view/optionTargetParamsInjectable/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/ruleConfig/action/resetAllRuleConfigValues/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/view/optionTargetParamsInjectable/
+GET /JSON/ruleConfig/action/resetAllRuleConfigValues/
+
+Reset all of the rule configurations
Example responses
@@ -25677,11 +42331,12 @@ curl -X GET http://zap/JSON/ascan/view/optionTargetParam
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -25694,27 +42349,26 @@ curl -X GET http://zap/JSON/ascan/view/optionTargetParam
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanViewOptionThreadPerHost
-
+ruleConfigActionResetRuleConfigValue
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/optionThreadPerHost/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/ruleConfig/action/resetRuleConfigValue/?key=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/optionThreadPerHost/");
+
URL obj = new URL("http://zap/JSON/ruleConfig/action/resetRuleConfigValue/?key=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -25730,32 +42384,39 @@ curl -X GET http://zap/JSON/ascan/view/optionThreadPerHo
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/view/optionThreadPerHost/', params={
-
+r = requests.get('http://zap/JSON/ruleConfig/action/resetRuleConfigValue/', params={
+ 'key': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
+print(r.json())
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+
+GET /JSON/ruleConfig/action/resetRuleConfigValue/
-result = RestClient.get 'http://zap/JSON/ascan/view/optionThreadPerHost/',
- params: {
- }, headers: headers
+Reset the specified rule configuration, which must already exist
-p JSON.parse(result)
+Parameters
-
-GET /JSON/ascan/view/optionThreadPerHost/
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+key
+query
+string
+true
+none
+
+
Example responses
@@ -25763,11 +42424,12 @@ curl -X GET http://zap/JSON/ascan/view/optionThreadPerHo
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -25780,27 +42442,26 @@ curl -X GET http://zap/JSON/ascan/view/optionThreadPerHo
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanViewOptionAddQueryParam
-
+ruleConfigActionSetRuleConfigValue
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/optionAddQueryParam/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/ruleConfig/action/setRuleConfigValue/?key=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/optionAddQueryParam/");
+
URL obj = new URL("http://zap/JSON/ruleConfig/action/setRuleConfigValue/?key=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -25816,34 +42477,46 @@ curl -X GET http://zap/JSON/ascan/view/optionAddQueryPar
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/view/optionAddQueryParam/', params={
-
+r = requests.get('http://zap/JSON/ruleConfig/action/setRuleConfigValue/', params={
+ 'key': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+print(r.json())
-result = RestClient.get 'http://zap/JSON/ascan/view/optionAddQueryParam/',
- params: {
- }, headers: headers
+
+GET /JSON/ruleConfig/action/setRuleConfigValue/
-p JSON.parse(result)
+Set the specified rule configuration, which must already exist
-
-GET /JSON/ascan/view/optionAddQueryParam/
+Parameters
-Tells whether or not the active scanner should add a query parameter to GET request that don't have parameters to start with.
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+key
+query
+string
+true
+none
+
+
+value
+query
+string
+false
+none
+
+
Example responses
@@ -25851,11 +42524,12 @@ curl -X GET http://zap/JSON/ascan/view/optionAddQueryPar
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -25868,27 +42542,26 @@ curl -X GET http://zap/JSON/ascan/view/optionAddQueryPar
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanViewOptionAllowAttackOnStart
-
+ruleConfigViewAllRuleConfigs
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/optionAllowAttackOnStart/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/ruleConfig/view/allRuleConfigs/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/optionAllowAttackOnStart/");
+
URL obj = new URL("http://zap/JSON/ruleConfig/view/allRuleConfigs/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -25904,32 +42577,17 @@ curl -X GET http://zap/JSON/ascan/view/optionAllowAttack
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/ascan/view/optionAllowAttackOnStart/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/ascan/view/optionAllowAttackOnStart/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/ruleConfig/view/allRuleConfigs/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/view/optionAllowAttackOnStart/
+GET /JSON/ruleConfig/view/allRuleConfigs/
+
+Show all of the rule configurations
Example responses
@@ -25937,11 +42595,12 @@ curl -X GET http://zap/JSON/ascan/view/optionAllowAttack
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -25954,27 +42613,26 @@ curl -X GET http://zap/JSON/ascan/view/optionAllowAttack
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanViewOptionInjectPluginIdInHeader
-
+ruleConfigViewRuleConfigValue
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/optionInjectPluginIdInHeader/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/ruleConfig/view/ruleConfigValue/?key=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/optionInjectPluginIdInHeader/");
+
URL obj = new URL("http://zap/JSON/ruleConfig/view/ruleConfigValue/?key=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -25990,34 +42648,39 @@ curl -X GET http://zap/JSON/ascan/view/optionInjectPlugi
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/view/optionInjectPluginIdInHeader/', params={
-
+r = requests.get('http://zap/JSON/ruleConfig/view/ruleConfigValue/', params={
+ 'key': 'string'
}, headers = headers)
-print r.json()
+print(r.json())
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/view/optionInjectPluginIdInHeader/',
- params: {
- }, headers: headers
+
+GET /JSON/ruleConfig/view/ruleConfigValue/
-p JSON.parse(result)
+Show the specified rule configuration
-
-GET /JSON/ascan/view/optionInjectPluginIdInHeader/
+Parameters
-Tells whether or not the active scanner should inject the HTTP request header X-ZAP-Scan-ID, with the ID of the scanner that's sending the requests.
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+key
+query
+string
+true
+none
+
+
Example responses
@@ -26025,11 +42688,12 @@ curl -X GET http://zap/JSON/ascan/view/optionInjectPlugi
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -26042,27 +42706,28 @@ curl -X GET http://zap/JSON/ascan/view/optionInjectPlugi
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanViewOptionPromptInAttackMode
-
+
+script
+scriptActionClearGlobalCustomVar
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/optionPromptInAttackMode/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/script/action/clearGlobalCustomVar/?varKey=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/optionPromptInAttackMode/");
+
URL obj = new URL("http://zap/JSON/script/action/clearGlobalCustomVar/?varKey=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -26078,32 +42743,39 @@ curl -X GET http://zap/JSON/ascan/view/optionPromptInAtt
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/view/optionPromptInAttackMode/', params={
-
+r = requests.get('http://zap/JSON/script/action/clearGlobalCustomVar/', params={
+ 'varKey': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
+print(r.json())
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+
+GET /JSON/script/action/clearGlobalCustomVar/
-result = RestClient.get 'http://zap/JSON/ascan/view/optionPromptInAttackMode/',
- params: {
- }, headers: headers
+Clears a global custom variable.
-p JSON.parse(result)
+Parameters
-
-GET /JSON/ascan/view/optionPromptInAttackMode/
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+varKey
+query
+string
+true
+The key of the variable.
+
+
Example responses
@@ -26111,11 +42783,12 @@ curl -X GET http://zap/JSON/ascan/view/optionPromptInAtt
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -26128,27 +42801,26 @@ curl -X GET http://zap/JSON/ascan/view/optionPromptInAtt
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanViewOptionPromptToClearFinishedScans
-
+scriptActionClearGlobalVar
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/optionPromptToClearFinishedScans/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/script/action/clearGlobalVar/?varKey=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/optionPromptToClearFinishedScans/");
+
URL obj = new URL("http://zap/JSON/script/action/clearGlobalVar/?varKey=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -26164,32 +42836,39 @@ curl -X GET http://zap/JSON/ascan/view/optionPromptToCle
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/view/optionPromptToClearFinishedScans/', params={
-
+r = requests.get('http://zap/JSON/script/action/clearGlobalVar/', params={
+ 'varKey': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
+print(r.json())
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+
+GET /JSON/script/action/clearGlobalVar/
-result = RestClient.get 'http://zap/JSON/ascan/view/optionPromptToClearFinishedScans/',
- params: {
- }, headers: headers
+Clears the global variable with the given key.
-p JSON.parse(result)
+Parameters
-
-GET /JSON/ascan/view/optionPromptToClearFinishedScans/
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+varKey
+query
+string
+true
+none
+
+
Example responses
@@ -26197,11 +42876,12 @@ curl -X GET http://zap/JSON/ascan/view/optionPromptToCle
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -26214,27 +42894,26 @@ curl -X GET http://zap/JSON/ascan/view/optionPromptToCle
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanViewOptionRescanInAttackMode
-
+scriptActionClearGlobalVars
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/optionRescanInAttackMode/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/script/action/clearGlobalVars/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/optionRescanInAttackMode/");
+
URL obj = new URL("http://zap/JSON/script/action/clearGlobalVars/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -26250,32 +42929,17 @@ curl -X GET http://zap/JSON/ascan/view/optionRescanInAtt
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/ascan/view/optionRescanInAttackMode/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/ascan/view/optionRescanInAttackMode/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/script/action/clearGlobalVars/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/view/optionRescanInAttackMode/
+GET /JSON/script/action/clearGlobalVars/
+
+Clears the global variables.
Example responses
@@ -26283,11 +42947,12 @@ curl -X GET http://zap/JSON/ascan/view/optionRescanInAtt
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -26300,27 +42965,26 @@ curl -X GET http://zap/JSON/ascan/view/optionRescanInAtt
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanViewOptionScanHeadersAllRequests
-
+scriptActionClearScriptCustomVar
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/optionScanHeadersAllRequests/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/script/action/clearScriptCustomVar/?scriptName=string&varKey=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/optionScanHeadersAllRequests/");
+
URL obj = new URL("http://zap/JSON/script/action/clearScriptCustomVar/?scriptName=string&varKey=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -26336,34 +43000,46 @@ curl -X GET http://zap/JSON/ascan/view/optionScanHeaders
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/view/optionScanHeadersAllRequests/', params={
-
+r = requests.get('http://zap/JSON/script/action/clearScriptCustomVar/', params={
+ 'scriptName': 'string', 'varKey': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
+print(r.json())
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/view/optionScanHeadersAllRequests/',
- params: {
- }, headers: headers
+
+GET /JSON/script/action/clearScriptCustomVar/
-p JSON.parse(result)
+Clears a script custom variable.
-
-GET /JSON/ascan/view/optionScanHeadersAllRequests/
+Parameters
-Tells whether or not the HTTP Headers of all requests should be scanned. Not just requests that send parameters, through the query or request body.
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+scriptName
+query
+string
+true
+The name of the script.
+
+
+varKey
+query
+string
+true
+The key of the variable.
+
+
Example responses
@@ -26371,11 +43047,12 @@ curl -X GET http://zap/JSON/ascan/view/optionScanHeaders
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -26388,27 +43065,26 @@ curl -X GET http://zap/JSON/ascan/view/optionScanHeaders
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanViewOptionShowAdvancedDialog
-
+scriptActionClearScriptVar
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/view/optionShowAdvancedDialog/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/script/action/clearScriptVar/?scriptName=string&varKey=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/view/optionShowAdvancedDialog/");
+
URL obj = new URL("http://zap/JSON/script/action/clearScriptVar/?scriptName=string&varKey=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -26424,32 +43100,46 @@ curl -X GET http://zap/JSON/ascan/view/optionShowAdvance
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/view/optionShowAdvancedDialog/', params={
-
+r = requests.get('http://zap/JSON/script/action/clearScriptVar/', params={
+ 'scriptName': 'string', 'varKey': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
+print(r.json())
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+
+GET /JSON/script/action/clearScriptVar/
-result = RestClient.get 'http://zap/JSON/ascan/view/optionShowAdvancedDialog/',
- params: {
- }, headers: headers
+Clears the variable with the given key of the given script. Returns an API error (DOES_NOT_EXIST) if no script with the given name exists.
-p JSON.parse(result)
+Parameters
-
-GET /JSON/ascan/view/optionShowAdvancedDialog/
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+scriptName
+query
+string
+true
+none
+
+
+varKey
+query
+string
+true
+none
+
+
Example responses
@@ -26457,11 +43147,12 @@ curl -X GET http://zap/JSON/ascan/view/optionShowAdvance
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -26474,27 +43165,26 @@ curl -X GET http://zap/JSON/ascan/view/optionShowAdvance
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionScan
-
+scriptActionClearScriptVars
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/scan/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/script/action/clearScriptVars/?scriptName=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/scan/");
+
URL obj = new URL("http://zap/JSON/script/action/clearScriptVars/?scriptName=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -26510,36 +43200,21 @@ curl -X GET http://zap/JSON/ascan/action/scan/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/scan/', params={
-
+r = requests.get('http://zap/JSON/script/action/clearScriptVars/', params={
+ 'scriptName': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/scan/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/scan/
+GET /JSON/script/action/clearScriptVars/
-Runs the active scanner against the given URL and/or Context. Optionally, the 'recurse' parameter can be used to scan URLs under the given URL, the parameter 'inScopeOnly' can be used to constrain the scan to URLs that are in scope (ignored if a Context is specified), the parameter 'scanPolicyName' allows to specify the scan policy (if none is given it uses the default scan policy), the parameters 'method' and 'postData' allow to select a given request in conjunction with the given URL.
+Clears the variables of the given script. Returns an API error (DOES_NOT_EXIST) if no script with the given name exists.
-Parameters
+Parameters
@@ -26551,52 +43226,10 @@ curl -X GET http://zap/JSON/ascan/action/scan/
-url
-query
-string
-false
-none
-
-
-recurse
-query
-boolean
-false
-none
-
-
-inScopeOnly
-query
-boolean
-false
-none
-
-
-scanPolicyName
-query
-string
-false
-none
-
-
-method
-query
-string
-false
-none
-
-
-postData
+scriptName
query
string
-false
-none
-
-
-contextId
-query
-integer
-false
+true
none
@@ -26607,11 +43240,12 @@ curl -X GET http://zap/JSON/ascan/action/scan/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -26624,27 +43258,26 @@ curl -X GET http://zap/JSON/ascan/action/scan/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionScanAsUser
-
+scriptActionDisable
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/scanAsUser/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/script/action/disable/?scriptName=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/scanAsUser/");
+
URL obj = new URL("http://zap/JSON/script/action/disable/?scriptName=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -26660,36 +43293,21 @@ curl -X GET http://zap/JSON/ascan/action/scanAsUser/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/scanAsUser/', params={
-
+r = requests.get('http://zap/JSON/script/action/disable/', params={
+ 'scriptName': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/scanAsUser/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/scanAsUser/
+GET /JSON/script/action/disable/
-Active Scans from the perspective of a User, obtained using the given Context ID and User ID. See 'scan' action for more details.
+Disables the script with the given name
-Parameters
+Parameters
@@ -26701,52 +43319,10 @@ curl -X GET http://zap/JSON/ascan/action/scanAsUser/
-url
-query
-string
-false
-none
-
-
-contextId
-query
-integer
-false
-none
-
-
-userId
-query
-integer
-false
-none
-
-
-recurse
-query
-boolean
-false
-none
-
-
-scanPolicyName
-query
-string
-false
-none
-
-
-method
-query
-string
-false
-none
-
-
-postData
+scriptName
query
string
-false
+true
none
@@ -26757,11 +43333,12 @@ curl -X GET http://zap/JSON/ascan/action/scanAsUser/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -26774,27 +43351,26 @@ curl -X GET http://zap/JSON/ascan/action/scanAsUser/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionPause
-
+scriptActionEnable
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/pause/?scanId=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/script/action/enable/?scriptName=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/pause/?scanId=0");
+
URL obj = new URL("http://zap/JSON/script/action/enable/?scriptName=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -26810,35 +43386,21 @@ curl -X GET http://zap/JSON/ascan/action/pause/?scanId
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/pause/', params={
- 'scanId': '0'
+r = requests.get('http://zap/JSON/script/action/enable/', params={
+ 'scriptName': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/pause/',
- params: {
- 'scanId' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/pause/
+GET /JSON/script/action/enable/
-Parameters
+Enables the script with the given name
+
+Parameters
@@ -26850,9 +43412,9 @@ curl -X GET http://zap/JSON/ascan/action/pause/?scanId
-scanId
+scriptName
query
-integer
+string
true
none
@@ -26864,11 +43426,12 @@ curl -X GET http://zap/JSON/ascan/action/pause/?scanIddefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -26881,27 +43444,26 @@ curl -X GET http://zap/JSON/ascan/action/pause/?scanId
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionResume
-
+scriptActionLoad
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/resume/?scanId=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/script/action/load/?scriptName=string&scriptType=string&scriptEngine=string&fileName=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/resume/?scanId=0");
+
URL obj = new URL("http://zap/JSON/script/action/load/?scriptName=string&scriptType=string&scriptEngine=string&fileName=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -26917,35 +43479,21 @@ curl -X GET http://zap/JSON/ascan/action/resume/?scanId<
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/resume/', params={
- 'scanId': '0'
+r = requests.get('http://zap/JSON/script/action/load/', params={
+ 'scriptName': 'string', 'scriptType': 'string', 'scriptEngine': 'string', 'fileName': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/resume/',
- params: {
- 'scanId' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/resume/
+GET /JSON/script/action/load/
-Parameters
+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 script is not in UTF-8, for example, in ISO-8859-1).
+
+Parameters
@@ -26957,12 +43505,47 @@ curl -X GET http://zap/JSON/ascan/action/resume/?scanId<
-scanId
+scriptName
query
-integer
+string
+true
+none
+
+
+scriptType
+query
+string
+true
+none
+
+
+scriptEngine
+query
+string
+true
+none
+
+
+fileName
+query
+string
true
none
+
+scriptDescription
+query
+string
+false
+none
+
+
+charset
+query
+string
+false
+none
+
@@ -26971,11 +43554,12 @@ curl -X GET http://zap/JSON/ascan/action/resume/?scanId<
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -26988,27 +43572,26 @@ curl -X GET http://zap/JSON/ascan/action/resume/?scanId<
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionStop
-
+scriptActionRemove
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/stop/?scanId=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/script/action/remove/?scriptName=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/stop/?scanId=0");
+
URL obj = new URL("http://zap/JSON/script/action/remove/?scriptName=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -27024,35 +43607,21 @@ curl -X GET http://zap/JSON/ascan/action/stop/?scanId
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/stop/', params={
- 'scanId': '0'
+r = requests.get('http://zap/JSON/script/action/remove/', params={
+ 'scriptName': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/stop/',
- params: {
- 'scanId' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/stop/
+GET /JSON/script/action/remove/
-Parameters
+Removes the script with the given name
+
+Parameters
@@ -27064,9 +43633,9 @@ curl -X GET http://zap/JSON/ascan/action/stop/?scanId
-scanId
+scriptName
query
-integer
+string
true
none
@@ -27078,11 +43647,12 @@ curl -X GET http://zap/JSON/ascan/action/stop/?scanIddefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -27095,27 +43665,26 @@ curl -X GET http://zap/JSON/ascan/action/stop/?scanId
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionRemoveScan
-
+scriptActionRunStandAloneScript
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/removeScan/?scanId=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/script/action/runStandAloneScript/?scriptName=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/removeScan/?scanId=0");
+
URL obj = new URL("http://zap/JSON/script/action/runStandAloneScript/?scriptName=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -27131,35 +43700,21 @@ curl -X GET http://zap/JSON/ascan/action/removeScan/?sca
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/removeScan/', params={
- 'scanId': '0'
+r = requests.get('http://zap/JSON/script/action/runStandAloneScript/', params={
+ 'scriptName': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/removeScan/',
- params: {
- 'scanId' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/removeScan/
+GET /JSON/script/action/runStandAloneScript/
-Parameters
+Runs the stand alone script with the given name
+
+Parameters
@@ -27171,9 +43726,9 @@ curl -X GET http://zap/JSON/ascan/action/removeScan/?sca
-scanId
+scriptName
query
-integer
+string
true
none
@@ -27185,11 +43740,12 @@ curl -X GET http://zap/JSON/ascan/action/removeScan/?sca
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -27202,27 +43758,26 @@ curl -X GET http://zap/JSON/ascan/action/removeScan/?sca
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionPauseAllScans
-
+scriptActionSetGlobalVar
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/pauseAllScans/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/script/action/setGlobalVar/?varKey=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/pauseAllScans/");
+
URL obj = new URL("http://zap/JSON/script/action/setGlobalVar/?varKey=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -27238,32 +43793,46 @@ curl -X GET http://zap/JSON/ascan/action/pauseAllScans/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/pauseAllScans/', params={
-
+r = requests.get('http://zap/JSON/script/action/setGlobalVar/', params={
+ 'varKey': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
+print(r.json())
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+
+GET /JSON/script/action/setGlobalVar/
-result = RestClient.get 'http://zap/JSON/ascan/action/pauseAllScans/',
- params: {
- }, headers: headers
+Sets the value of the global variable with the given key.
-p JSON.parse(result)
+Parameters
-
-GET /JSON/ascan/action/pauseAllScans/
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+varKey
+query
+string
+true
+none
+
+
+varValue
+query
+string
+false
+none
+
+
Example responses
@@ -27271,11 +43840,12 @@ curl -X GET http://zap/JSON/ascan/action/pauseAllScans/
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -27288,27 +43858,26 @@ curl -X GET http://zap/JSON/ascan/action/pauseAllScans/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionResumeAllScans
-
+scriptActionSetScriptVar
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/resumeAllScans/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/script/action/setScriptVar/?scriptName=string&varKey=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/resumeAllScans/");
+
URL obj = new URL("http://zap/JSON/script/action/setScriptVar/?scriptName=string&varKey=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -27324,32 +43893,53 @@ curl -X GET http://zap/JSON/ascan/action/resumeAllScans/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/resumeAllScans/', params={
-
+r = requests.get('http://zap/JSON/script/action/setScriptVar/', params={
+ 'scriptName': 'string', 'varKey': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
+print(r.json())
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+
+GET /JSON/script/action/setScriptVar/
-result = RestClient.get 'http://zap/JSON/ascan/action/resumeAllScans/',
- params: {
- }, headers: headers
+Sets the value of the variable with the given key of the given script. Returns an API error (DOES_NOT_EXIST) if no script with the given name exists.
-p JSON.parse(result)
+Parameters
-
-GET /JSON/ascan/action/resumeAllScans/
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+scriptName
+query
+string
+true
+none
+
+
+varKey
+query
+string
+true
+none
+
+
+varValue
+query
+string
+false
+none
+
+
Example responses
@@ -27357,11 +43947,12 @@ curl -X GET http://zap/JSON/ascan/action/resumeAllScans/
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -27374,27 +43965,26 @@ curl -X GET http://zap/JSON/ascan/action/resumeAllScans/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionStopAllScans
-
+scriptViewGlobalCustomVar
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/stopAllScans/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/script/view/globalCustomVar/?varKey=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/stopAllScans/");
+
URL obj = new URL("http://zap/JSON/script/view/globalCustomVar/?varKey=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -27410,32 +44000,39 @@ curl -X GET http://zap/JSON/ascan/action/stopAllScans/ <
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/stopAllScans/', params={
-
+r = requests.get('http://zap/JSON/script/view/globalCustomVar/', params={
+ 'varKey': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
+print(r.json())
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+
+GET /JSON/script/view/globalCustomVar/
-result = RestClient.get 'http://zap/JSON/ascan/action/stopAllScans/',
- params: {
- }, headers: headers
+Gets the value (string representation) of a global custom variable. Returns an API error (DOES_NOT_EXIST) if no value was previously set.
-p JSON.parse(result)
+Parameters
-
-GET /JSON/ascan/action/stopAllScans/
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+varKey
+query
+string
+true
+The key of the variable.
+
+
Example responses
@@ -27443,11 +44040,12 @@ curl -X GET http://zap/JSON/ascan/action/stopAllScans/ <
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -27460,27 +44058,26 @@ curl -X GET http://zap/JSON/ascan/action/stopAllScans/ <
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionRemoveAllScans
-
+scriptViewGlobalCustomVars
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/removeAllScans/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/script/view/globalCustomVars/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/removeAllScans/");
+
URL obj = new URL("http://zap/JSON/script/view/globalCustomVars/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -27496,32 +44093,17 @@ curl -X GET http://zap/JSON/ascan/action/removeAllScans/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/ascan/action/removeAllScans/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/ascan/action/removeAllScans/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/script/view/globalCustomVars/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/removeAllScans/
+GET /JSON/script/view/globalCustomVars/
+
+Gets all the global custom variables (key/value pairs, the value is the string representation).
Example responses
@@ -27529,11 +44111,12 @@ curl -X GET http://zap/JSON/ascan/action/removeAllScans/
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -27546,27 +44129,26 @@ curl -X GET http://zap/JSON/ascan/action/removeAllScans/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionClearExcludedFromScan
-
+scriptViewGlobalVar
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/clearExcludedFromScan/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/script/view/globalVar/?varKey=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/clearExcludedFromScan/");
+
URL obj = new URL("http://zap/JSON/script/view/globalVar/?varKey=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -27582,34 +44164,39 @@ curl -X GET http://zap/JSON/ascan/action/clearExcludedFr
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/clearExcludedFromScan/', params={
-
+r = requests.get('http://zap/JSON/script/view/globalVar/', params={
+ 'varKey': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+print(r.json())
-result = RestClient.get 'http://zap/JSON/ascan/action/clearExcludedFromScan/',
- params: {
- }, headers: headers
+
+GET /JSON/script/view/globalVar/
-p JSON.parse(result)
+Gets the value of the global variable with the given key. Returns an API error (DOES_NOT_EXIST) if no value was previously set.
-
-GET /JSON/ascan/action/clearExcludedFromScan/
+Parameters
-Clears the regexes of URLs excluded from the active scans.
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+varKey
+query
+string
+true
+none
+
+
Example responses
@@ -27617,11 +44204,12 @@ curl -X GET http://zap/JSON/ascan/action/clearExcludedFr
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -27634,27 +44222,26 @@ curl -X GET http://zap/JSON/ascan/action/clearExcludedFr
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionExcludeFromScan
-
+scriptViewGlobalVars
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/excludeFromScan/?regex=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/script/view/globalVars/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/excludeFromScan/?regex=string");
+
URL obj = new URL("http://zap/JSON/script/view/globalVars/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -27670,55 +44257,17 @@ curl -X GET http://zap/JSON/ascan/action/excludeFromScan
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/ascan/action/excludeFromScan/', params={
- 'regex': 'string'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/ascan/action/excludeFromScan/',
- params: {
- 'regex' => 'string'
-}, headers: headers
+r = requests.get('http://zap/JSON/script/view/globalVars/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/excludeFromScan/
-
-Adds a regex of URLs that should be excluded from the active scans.
-
-Parameters
+GET /JSON/script/view/globalVars/
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-regex
-query
-string
-true
-none
-
-
+Gets all the global variables (key/value pairs).
Example responses
@@ -27726,11 +44275,12 @@ curl -X GET http://zap/JSON/ascan/action/excludeFromScan
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -27743,27 +44293,26 @@ curl -X GET http://zap/JSON/ascan/action/excludeFromScan
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionEnableAllScanners
-
+scriptViewListEngines
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/enableAllScanners/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/script/view/listEngines/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/enableAllScanners/");
+
URL obj = new URL("http://zap/JSON/script/view/listEngines/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -27779,54 +44328,17 @@ curl -X GET http://zap/JSON/ascan/action/enableAllScanne
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/ascan/action/enableAllScanners/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/ascan/action/enableAllScanners/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/script/view/listEngines/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/enableAllScanners/
-
-Enables all scanners of the scan policy with the given name, or the default if none given.
-
-Parameters
+GET /JSON/script/view/listEngines/
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-scanPolicyName
-query
-string
-false
-none
-
-
+Lists the script engines available
Example responses
@@ -27834,11 +44346,12 @@ curl -X GET http://zap/JSON/ascan/action/enableAllScanne
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -27851,27 +44364,26 @@ curl -X GET http://zap/JSON/ascan/action/enableAllScanne
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionDisableAllScanners
-
+scriptViewListScripts
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/disableAllScanners/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/script/view/listScripts/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/disableAllScanners/");
+
URL obj = new URL("http://zap/JSON/script/view/listScripts/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -27887,54 +44399,17 @@ curl -X GET http://zap/JSON/ascan/action/disableAllScann
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/ascan/action/disableAllScanners/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/ascan/action/disableAllScanners/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/script/view/listScripts/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/disableAllScanners/
-
-Disables all scanners of the scan policy with the given name, or the default if none given.
-
-Parameters
+GET /JSON/script/view/listScripts/
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-scanPolicyName
-query
-string
-false
-none
-
-
+Lists the scripts available, with its engine, name, description, type and error state.
Example responses
@@ -27942,11 +44417,12 @@ curl -X GET http://zap/JSON/ascan/action/disableAllScann
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -27959,27 +44435,26 @@ curl -X GET http://zap/JSON/ascan/action/disableAllScann
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionEnableScanners
-
+scriptViewListTypes
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/enableScanners/?ids=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/script/view/listTypes/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/enableScanners/?ids=string");
+
URL obj = new URL("http://zap/JSON/script/view/listTypes/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -27995,62 +44470,17 @@ curl -X GET http://zap/JSON/ascan/action/enableScanners/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/ascan/action/enableScanners/', params={
- 'ids': 'string'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/ascan/action/enableScanners/',
- params: {
- 'ids' => 'string'
-}, headers: headers
+r = requests.get('http://zap/JSON/script/view/listTypes/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/enableScanners/
-
-Enables the scanners with the given IDs (comma separated list of IDs) of the scan policy with the given name, or the default if none given.
-
-Parameters
+GET /JSON/script/view/listTypes/
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-ids
-query
-string
-true
-none
-
-
-scanPolicyName
-query
-string
-false
-none
-
-
+Lists the script types available.
Example responses
@@ -28058,11 +44488,12 @@ curl -X GET http://zap/JSON/ascan/action/enableScanners/
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -28075,27 +44506,26 @@ curl -X GET http://zap/JSON/ascan/action/enableScanners/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionDisableScanners
-
+scriptViewScriptCustomVar
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/disableScanners/?ids=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/script/view/scriptCustomVar/?scriptName=string&varKey=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/disableScanners/?ids=string");
+
URL obj = new URL("http://zap/JSON/script/view/scriptCustomVar/?scriptName=string&varKey=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -28111,37 +44541,21 @@ curl -X GET http://zap/JSON/ascan/action/disableScanners
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/disableScanners/', params={
- 'ids': 'string'
+r = requests.get('http://zap/JSON/script/view/scriptCustomVar/', params={
+ 'scriptName': 'string', 'varKey': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/disableScanners/',
- params: {
- 'ids' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/disableScanners/
+GET /JSON/script/view/scriptCustomVar/
-Disables the scanners with the given IDs (comma separated list of IDs) of the scan policy with the given name, or the default if none given.
+Gets the value (string representation) of a custom variable. Returns an API error (DOES_NOT_EXIST) if no script with the given name exists or if no value was previously set.
-Parameters
+Parameters
@@ -28153,18 +44567,18 @@ curl -X GET http://zap/JSON/ascan/action/disableScanners
-ids
+scriptName
query
string
true
-none
+The name of the script.
-scanPolicyName
+varKey
query
string
-false
-none
+true
+The key of the variable.
@@ -28174,11 +44588,12 @@ curl -X GET http://zap/JSON/ascan/action/disableScanners
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -28191,27 +44606,26 @@ curl -X GET http://zap/JSON/ascan/action/disableScanners
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionSetEnabledPolicies
-
+scriptViewScriptCustomVars
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/setEnabledPolicies/?ids=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/script/view/scriptCustomVars/?scriptName=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/setEnabledPolicies/?ids=string");
+
URL obj = new URL("http://zap/JSON/script/view/scriptCustomVars/?scriptName=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -28227,35 +44641,21 @@ curl -X GET http://zap/JSON/ascan/action/setEnabledPolic
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/setEnabledPolicies/', params={
- 'ids': 'string'
+r = requests.get('http://zap/JSON/script/view/scriptCustomVars/', params={
+ 'scriptName': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/setEnabledPolicies/',
- params: {
- 'ids' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/setEnabledPolicies/
+GET /JSON/script/view/scriptCustomVars/
-Parameters
+Gets all the custom variables (key/value pairs, the value is the string representation) of a script. Returns an API error (DOES_NOT_EXIST) if no script with the given name exists.
+
+Parameters
@@ -28267,18 +44667,11 @@ curl -X GET http://zap/JSON/ascan/action/setEnabledPolic
-ids
+scriptName
query
string
true
-none
-
-
-scanPolicyName
-query
-string
-false
-none
+The name of the script.
@@ -28288,11 +44681,12 @@ curl -X GET http://zap/JSON/ascan/action/setEnabledPolic
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -28305,27 +44699,26 @@ curl -X GET http://zap/JSON/ascan/action/setEnabledPolic
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionSetPolicyAttackStrength
-
+scriptViewScriptVar
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/setPolicyAttackStrength/?id=0&attackStrength=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/script/view/scriptVar/?scriptName=string&varKey=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/setPolicyAttackStrength/?id=0&attackStrength=string");
+
URL obj = new URL("http://zap/JSON/script/view/scriptVar/?scriptName=string&varKey=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -28341,36 +44734,21 @@ curl -X GET http://zap/JSON/ascan/action/setPolicyAttack
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/setPolicyAttackStrength/', params={
- 'id': '0', 'attackStrength': 'string'
+r = requests.get('http://zap/JSON/script/view/scriptVar/', params={
+ 'scriptName': 'string', 'varKey': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/setPolicyAttackStrength/',
- params: {
- 'id' => 'integer',
-'attackStrength' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/setPolicyAttackStrength/
+GET /JSON/script/view/scriptVar/
-Parameters
+Gets the value of the variable with the given key for the given script. Returns an API error (DOES_NOT_EXIST) if no script with the given name exists or if no value was previously set.
+
+Parameters
@@ -28382,24 +44760,17 @@ curl -X GET http://zap/JSON/ascan/action/setPolicyAttack
-id
-query
-integer
-true
-none
-
-
-attackStrength
+scriptName
query
string
true
none
-scanPolicyName
+varKey
query
string
-false
+true
none
@@ -28410,11 +44781,12 @@ curl -X GET http://zap/JSON/ascan/action/setPolicyAttack
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -28427,27 +44799,26 @@ curl -X GET http://zap/JSON/ascan/action/setPolicyAttack
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionSetPolicyAlertThreshold
-
+scriptViewScriptVars
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/setPolicyAlertThreshold/?id=0&alertThreshold=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/script/view/scriptVars/?scriptName=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/setPolicyAlertThreshold/?id=0&alertThreshold=string");
+
URL obj = new URL("http://zap/JSON/script/view/scriptVars/?scriptName=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -28463,36 +44834,21 @@ curl -X GET http://zap/JSON/ascan/action/setPolicyAlertT
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/setPolicyAlertThreshold/', params={
- 'id': '0', 'alertThreshold': 'string'
+r = requests.get('http://zap/JSON/script/view/scriptVars/', params={
+ 'scriptName': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/setPolicyAlertThreshold/',
- params: {
- 'id' => 'integer',
-'alertThreshold' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/setPolicyAlertThreshold/
+GET /JSON/script/view/scriptVars/
-Parameters
+Gets all the variables (key/value pairs) of the given script. Returns an API error (DOES_NOT_EXIST) if no script with the given name exists.
+
+Parameters
@@ -28504,26 +44860,12 @@ curl -X GET http://zap/JSON/ascan/action/setPolicyAlertT
-id
-query
-integer
-true
-none
-
-
-alertThreshold
+scriptName
query
string
true
none
-
-scanPolicyName
-query
-string
-false
-none
-
@@ -28532,11 +44874,12 @@ curl -X GET http://zap/JSON/ascan/action/setPolicyAlertT
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -28549,27 +44892,28 @@ curl -X GET http://zap/JSON/ascan/action/setPolicyAlertT
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionSetScannerAttackStrength
-
+
+search
+searchOtherHarByHeaderRegex
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/setScannerAttackStrength/?id=0&attackStrength=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/OTHER/search/other/harByHeaderRegex/?regex=string \
+ -H 'Accept: */*'
-
URL obj = new URL("http://zap/JSON/ascan/action/setScannerAttackStrength/?id=0&attackStrength=string");
+
URL obj = new URL("http://zap/OTHER/search/other/harByHeaderRegex/?regex=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -28585,36 +44929,21 @@ curl -X GET http://zap/JSON/ascan/action/setScannerAttac
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': '*/*'
}
-r = requests.get('http://zap/JSON/ascan/action/setScannerAttackStrength/', params={
- 'id': '0', 'attackStrength': 'string'
+r = requests.get('http://zap/OTHER/search/other/harByHeaderRegex/', params={
+ 'regex': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/setScannerAttackStrength/',
- params: {
- 'id' => 'integer',
-'attackStrength' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.content)
-GET /JSON/ascan/action/setScannerAttackStrength/
+GET /OTHER/search/other/harByHeaderRegex/
-Parameters
+Returns the HTTP messages, in HAR format, that match the given regular expression in the header(s) optionally filtered by URL and paginated with 'start' position and 'count' of messages.
+
+Parameters
@@ -28626,21 +44955,28 @@ curl -X GET http://zap/JSON/ascan/action/setScannerAttac
-id
+regex
query
-integer
+string
true
none
-attackStrength
+baseurl
query
string
-true
+false
none
-scanPolicyName
+start
+query
+string
+false
+none
+
+
+count
query
string
false
@@ -28650,15 +44986,9 @@ curl -X GET http://zap/JSON/ascan/action/setScannerAttac
Example responses
-
-default Response
-{
- "message": "string",
- "code": 100
-}
-
-Responses
+
+Responses
@@ -28671,27 +45001,28 @@ curl -X GET http://zap/JSON/ascan/action/setScannerAttac
default
Default
-unexpected error
-Error
+Error of OTHER endpoints.
+None
+Response Schema
+
-ascanActionSetScannerAlertThreshold
-
+searchOtherHarByRequestRegex
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/setScannerAlertThreshold/?id=0&alertThreshold=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/OTHER/search/other/harByRequestRegex/?regex=string \
+ -H 'Accept: */*'
-
URL obj = new URL("http://zap/JSON/ascan/action/setScannerAlertThreshold/?id=0&alertThreshold=string");
+
URL obj = new URL("http://zap/OTHER/search/other/harByRequestRegex/?regex=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -28707,36 +45038,21 @@ curl -X GET http://zap/JSON/ascan/action/setScannerAlert
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': '*/*'
}
-r = requests.get('http://zap/JSON/ascan/action/setScannerAlertThreshold/', params={
- 'id': '0', 'alertThreshold': 'string'
+r = requests.get('http://zap/OTHER/search/other/harByRequestRegex/', params={
+ 'regex': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/setScannerAlertThreshold/',
- params: {
- 'id' => 'integer',
-'alertThreshold' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.content)
-GET /JSON/ascan/action/setScannerAlertThreshold/
+GET /OTHER/search/other/harByRequestRegex/
-Parameters
+Returns the HTTP messages, in HAR format, that match the given regular expression in the request optionally filtered by URL and paginated with 'start' position and 'count' of messages.
+
+Parameters
@@ -28748,21 +45064,28 @@ curl -X GET http://zap/JSON/ascan/action/setScannerAlert
-id
+regex
query
-integer
+string
true
none
-alertThreshold
+baseurl
query
string
-true
+false
none
-scanPolicyName
+start
+query
+string
+false
+none
+
+
+count
query
string
false
@@ -28772,15 +45095,9 @@ curl -X GET http://zap/JSON/ascan/action/setScannerAlert
Example responses
-
-default Response
-{
- "message": "string",
- "code": 100
-}
-
-Responses
+
+Responses
@@ -28793,27 +45110,28 @@ curl -X GET http://zap/JSON/ascan/action/setScannerAlert
default
Default
-unexpected error
-Error
+Error of OTHER endpoints.
+None
+Response Schema
+
-ascanActionAddScanPolicy
-
+searchOtherHarByResponseRegex
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/addScanPolicy/?scanPolicyName=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/OTHER/search/other/harByResponseRegex/?regex=string \
+ -H 'Accept: */*'
-
URL obj = new URL("http://zap/JSON/ascan/action/addScanPolicy/?scanPolicyName=string");
+
URL obj = new URL("http://zap/OTHER/search/other/harByResponseRegex/?regex=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -28829,35 +45147,21 @@ curl -X GET http://zap/JSON/ascan/action/addScanPolicy/?
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': '*/*'
}
-r = requests.get('http://zap/JSON/ascan/action/addScanPolicy/', params={
- 'scanPolicyName': 'string'
+r = requests.get('http://zap/OTHER/search/other/harByResponseRegex/', params={
+ 'regex': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/addScanPolicy/',
- params: {
- 'scanPolicyName' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.content)
-GET /JSON/ascan/action/addScanPolicy/
+GET /OTHER/search/other/harByResponseRegex/
-Parameters
+Returns the HTTP messages, in HAR format, that match the given regular expression in the response optionally filtered by URL and paginated with 'start' position and 'count' of messages.
+
+Parameters
@@ -28869,21 +45173,28 @@ curl -X GET http://zap/JSON/ascan/action/addScanPolicy/?
-scanPolicyName
+regex
query
string
true
none
-alertThreshold
+baseurl
query
string
false
none
-attackStrength
+start
+query
+string
+false
+none
+
+
+count
query
string
false
@@ -28893,15 +45204,9 @@ curl -X GET http://zap/JSON/ascan/action/addScanPolicy/?
Example responses
-
-default Response
-{
- "message": "string",
- "code": 100
-}
-
-Responses
+
+Responses
@@ -28914,27 +45219,28 @@ curl -X GET http://zap/JSON/ascan/action/addScanPolicy/?
default
Default
-unexpected error
-Error
+Error of OTHER endpoints.
+None
+Response Schema
+
-ascanActionRemoveScanPolicy
-
+searchOtherHarByUrlRegex
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/removeScanPolicy/?scanPolicyName=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/OTHER/search/other/harByUrlRegex/?regex=string \
+ -H 'Accept: */*'
-
URL obj = new URL("http://zap/JSON/ascan/action/removeScanPolicy/?scanPolicyName=string");
+
URL obj = new URL("http://zap/OTHER/search/other/harByUrlRegex/?regex=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -28950,35 +45256,21 @@ curl -X GET http://zap/JSON/ascan/action/removeScanPolic
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': '*/*'
}
-r = requests.get('http://zap/JSON/ascan/action/removeScanPolicy/', params={
- 'scanPolicyName': 'string'
+r = requests.get('http://zap/OTHER/search/other/harByUrlRegex/', params={
+ 'regex': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/removeScanPolicy/',
- params: {
- 'scanPolicyName' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.content)
-GET /JSON/ascan/action/removeScanPolicy/
+GET /OTHER/search/other/harByUrlRegex/
-Parameters
+Returns the HTTP messages, in HAR format, that match the given regular expression in the URL optionally filtered by URL and paginated with 'start' position and 'count' of messages.
+
+Parameters
@@ -28990,25 +45282,40 @@ curl -X GET http://zap/JSON/ascan/action/removeScanPolic
-scanPolicyName
+regex
query
string
true
none
+
+baseurl
+query
+string
+false
+none
+
+
+start
+query
+string
+false
+none
+
+
+count
+query
+string
+false
+none
+
Example responses
-
-default Response
-{
- "message": "string",
- "code": 100
-}
-
-Responses
+
+Responses
@@ -29021,27 +45328,28 @@ curl -X GET http://zap/JSON/ascan/action/removeScanPolic
default
Default
-unexpected error
-Error
+Error of OTHER endpoints.
+None
+Response Schema
+
-ascanActionUpdateScanPolicy
-
+searchViewMessagesByHeaderRegex
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/updateScanPolicy/?scanPolicyName=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/search/view/messagesByHeaderRegex/?regex=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/updateScanPolicy/?scanPolicyName=string");
+
URL obj = new URL("http://zap/JSON/search/view/messagesByHeaderRegex/?regex=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -29057,35 +45365,21 @@ curl -X GET http://zap/JSON/ascan/action/updateScanPolic
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/updateScanPolicy/', params={
- 'scanPolicyName': 'string'
+r = requests.get('http://zap/JSON/search/view/messagesByHeaderRegex/', params={
+ 'regex': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/updateScanPolicy/',
- params: {
- 'scanPolicyName' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/updateScanPolicy/
+GET /JSON/search/view/messagesByHeaderRegex/
-Parameters
+Returns the HTTP messages that match the given regular expression in the header(s) optionally filtered by URL and paginated with 'start' position and 'count' of messages.
+
+Parameters
@@ -29097,21 +45391,28 @@ curl -X GET http://zap/JSON/ascan/action/updateScanPolic
-scanPolicyName
+regex
query
string
true
none
-alertThreshold
+baseurl
+query
+string
+false
+The highest URL in the Sites tree under which messages should be included.
+
+
+start
query
string
false
none
-attackStrength
+count
query
string
false
@@ -29125,11 +45426,12 @@ curl -X GET http://zap/JSON/ascan/action/updateScanPolic
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -29142,27 +45444,26 @@ curl -X GET http://zap/JSON/ascan/action/updateScanPolic
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionImportScanPolicy
-
+searchViewMessagesByRequestRegex
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/importScanPolicy/?path=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/search/view/messagesByRequestRegex/?regex=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/importScanPolicy/?path=string");
+
URL obj = new URL("http://zap/JSON/search/view/messagesByRequestRegex/?regex=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -29178,37 +45479,21 @@ curl -X GET http://zap/JSON/ascan/action/importScanPolic
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/importScanPolicy/', params={
- 'path': 'string'
+r = requests.get('http://zap/JSON/search/view/messagesByRequestRegex/', params={
+ 'regex': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/importScanPolicy/',
- params: {
- 'path' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/importScanPolicy/
+GET /JSON/search/view/messagesByRequestRegex/
-Imports a Scan Policy using the given file system path.
+Returns the HTTP messages that match the given regular expression in the request optionally filtered by URL and paginated with 'start' position and 'count' of messages.
-Parameters
+Parameters
@@ -29220,12 +45505,33 @@ curl -X GET http://zap/JSON/ascan/action/importScanPolic
-path
+regex
query
string
true
none
+
+baseurl
+query
+string
+false
+The highest URL in the Sites tree under which messages should be included.
+
+
+start
+query
+string
+false
+none
+
+
+count
+query
+string
+false
+none
+
@@ -29234,11 +45540,12 @@ curl -X GET http://zap/JSON/ascan/action/importScanPolic
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -29251,27 +45558,26 @@ curl -X GET http://zap/JSON/ascan/action/importScanPolic
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionAddExcludedParam
-
+searchViewMessagesByResponseRegex
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/addExcludedParam/?name=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/search/view/messagesByResponseRegex/?regex=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/addExcludedParam/?name=string");
+
URL obj = new URL("http://zap/JSON/search/view/messagesByResponseRegex/?regex=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -29287,37 +45593,21 @@ curl -X GET http://zap/JSON/ascan/action/addExcludedPara
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/addExcludedParam/', params={
- 'name': 'string'
+r = requests.get('http://zap/JSON/search/view/messagesByResponseRegex/', params={
+ 'regex': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/addExcludedParam/',
- params: {
- 'name' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/addExcludedParam/
+GET /JSON/search/view/messagesByResponseRegex/
-Adds a new parameter excluded from the scan, using the specified name. Optionally sets if the new entry applies to a specific URL (default, all URLs) and sets the ID of the type of the parameter (default, ID of any type). The type IDs can be obtained with the view excludedParamTypes.
+Returns the HTTP messages that match the given regular expression in the response optionally filtered by URL and paginated with 'start' position and 'count' of messages.
-Parameters
+Parameters
@@ -29329,21 +45619,28 @@ curl -X GET http://zap/JSON/ascan/action/addExcludedPara
-name
+regex
query
string
true
none
-type
+baseurl
+query
+string
+false
+The highest URL in the Sites tree under which messages should be included.
+
+
+start
query
string
false
none
-url
+count
query
string
false
@@ -29357,11 +45654,12 @@ curl -X GET http://zap/JSON/ascan/action/addExcludedPara
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -29374,27 +45672,26 @@ curl -X GET http://zap/JSON/ascan/action/addExcludedPara
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionModifyExcludedParam
-
+searchViewMessagesByUrlRegex
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/modifyExcludedParam/?idx=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/search/view/messagesByUrlRegex/?regex=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/modifyExcludedParam/?idx=0");
+
URL obj = new URL("http://zap/JSON/search/view/messagesByUrlRegex/?regex=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -29410,37 +45707,21 @@ curl -X GET http://zap/JSON/ascan/action/modifyExcludedP
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/modifyExcludedParam/', params={
- 'idx': '0'
+r = requests.get('http://zap/JSON/search/view/messagesByUrlRegex/', params={
+ 'regex': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/modifyExcludedParam/',
- params: {
- 'idx' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/modifyExcludedParam/
+GET /JSON/search/view/messagesByUrlRegex/
-Modifies a parameter excluded from the scan. Allows to modify the name, the URL and the type of parameter. The parameter is selected with its index, which can be obtained with the view excludedParams.
+Returns the HTTP messages that match the given regular expression in the URL optionally filtered by URL and paginated with 'start' position and 'count' of messages.
-Parameters
+Parameters
@@ -29452,28 +45733,28 @@ curl -X GET http://zap/JSON/ascan/action/modifyExcludedP
-idx
+regex
query
-integer
+string
true
none
-name
+baseurl
query
string
false
-none
+The highest URL in the Sites tree under which messages should be included.
-type
+start
query
string
false
none
-url
+count
query
string
false
@@ -29487,11 +45768,12 @@ curl -X GET http://zap/JSON/ascan/action/modifyExcludedP
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -29504,27 +45786,26 @@ curl -X GET http://zap/JSON/ascan/action/modifyExcludedP
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionRemoveExcludedParam
-
+searchViewUrlsByHeaderRegex
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/removeExcludedParam/?idx=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/search/view/urlsByHeaderRegex/?regex=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/removeExcludedParam/?idx=0");
+
URL obj = new URL("http://zap/JSON/search/view/urlsByHeaderRegex/?regex=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -29540,37 +45821,21 @@ curl -X GET http://zap/JSON/ascan/action/removeExcludedP
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/removeExcludedParam/', params={
- 'idx': '0'
+r = requests.get('http://zap/JSON/search/view/urlsByHeaderRegex/', params={
+ 'regex': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/removeExcludedParam/',
- params: {
- 'idx' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/removeExcludedParam/
+GET /JSON/search/view/urlsByHeaderRegex/
-Removes a parameter excluded from the scan, with the given index. The index can be obtained with the view excludedParams.
+Returns the URLs of the HTTP messages that match the given regular expression in the header(s) optionally filtered by URL and paginated with 'start' position and 'count' of messages.
-Parameters
+Parameters
@@ -29582,12 +45847,33 @@ curl -X GET http://zap/JSON/ascan/action/removeExcludedP
-idx
+regex
query
-integer
+string
true
none
+
+baseurl
+query
+string
+false
+The highest URL in the Sites tree under which URLs should be included.
+
+
+start
+query
+string
+false
+none
+
+
+count
+query
+string
+false
+none
+
@@ -29596,11 +45882,12 @@ curl -X GET http://zap/JSON/ascan/action/removeExcludedP
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -29613,27 +45900,26 @@ curl -X GET http://zap/JSON/ascan/action/removeExcludedP
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionSkipScanner
-
+searchViewUrlsByRequestRegex
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/skipScanner/?scanId=0&scannerId=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/search/view/urlsByRequestRegex/?regex=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/skipScanner/?scanId=0&scannerId=0");
+
URL obj = new URL("http://zap/JSON/search/view/urlsByRequestRegex/?regex=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -29649,38 +45935,21 @@ curl -X GET http://zap/JSON/ascan/action/skipScanner/?sc
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/skipScanner/', params={
- 'scanId': '0', 'scannerId': '0'
+r = requests.get('http://zap/JSON/search/view/urlsByRequestRegex/', params={
+ 'regex': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/skipScanner/',
- params: {
- 'scanId' => 'integer',
-'scannerId' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/skipScanner/
+GET /JSON/search/view/urlsByRequestRegex/
-Skips the scanner using the given IDs of the scan and the scanner.
+Returns the URLs of the HTTP messages that match the given regular expression in the request optionally filtered by URL and paginated with 'start' position and 'count' of messages.
-Parameters
+Parameters
@@ -29692,17 +45961,31 @@ curl -X GET http://zap/JSON/ascan/action/skipScanner/?sc
-scanId
+regex
query
-integer
+string
true
none
-scannerId
+baseurl
query
-integer
-true
+string
+false
+The highest URL in the Sites tree under which URLs should be included.
+
+
+start
+query
+string
+false
+none
+
+
+count
+query
+string
+false
none
@@ -29713,11 +45996,12 @@ curl -X GET http://zap/JSON/ascan/action/skipScanner/?sc
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -29730,27 +46014,26 @@ curl -X GET http://zap/JSON/ascan/action/skipScanner/?sc
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionSetOptionAttackPolicy
-
+searchViewUrlsByResponseRegex
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/setOptionAttackPolicy/?String=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/search/view/urlsByResponseRegex/?regex=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/setOptionAttackPolicy/?String=string");
+
URL obj = new URL("http://zap/JSON/search/view/urlsByResponseRegex/?regex=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -29766,35 +46049,21 @@ curl -X GET http://zap/JSON/ascan/action/setOptionAttack
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/setOptionAttackPolicy/', params={
- 'String': 'string'
+r = requests.get('http://zap/JSON/search/view/urlsByResponseRegex/', params={
+ 'regex': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/setOptionAttackPolicy/',
- params: {
- 'String' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/setOptionAttackPolicy/
+GET /JSON/search/view/urlsByResponseRegex/
-Parameters
+Returns the URLs of the HTTP messages that match the given regular expression in the response optionally filtered by URL and paginated with 'start' position and 'count' of messages.
+
+Parameters
@@ -29806,12 +46075,33 @@ curl -X GET http://zap/JSON/ascan/action/setOptionAttack
-String
+regex
query
string
true
none
+
+baseurl
+query
+string
+false
+The highest URL in the Sites tree under which URLs should be included.
+
+
+start
+query
+string
+false
+none
+
+
+count
+query
+string
+false
+none
+
@@ -29820,11 +46110,12 @@ curl -X GET http://zap/JSON/ascan/action/setOptionAttack
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -29837,27 +46128,26 @@ curl -X GET http://zap/JSON/ascan/action/setOptionAttack
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionSetOptionDefaultPolicy
-
+searchViewUrlsByUrlRegex
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/setOptionDefaultPolicy/?String=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/search/view/urlsByUrlRegex/?regex=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/setOptionDefaultPolicy/?String=string");
+
URL obj = new URL("http://zap/JSON/search/view/urlsByUrlRegex/?regex=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -29873,35 +46163,21 @@ curl -X GET http://zap/JSON/ascan/action/setOptionDefaul
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/setOptionDefaultPolicy/', params={
- 'String': 'string'
+r = requests.get('http://zap/JSON/search/view/urlsByUrlRegex/', params={
+ 'regex': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/setOptionDefaultPolicy/',
- params: {
- 'String' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/setOptionDefaultPolicy/
+GET /JSON/search/view/urlsByUrlRegex/
-Parameters
+Returns the URLs of the HTTP messages that match the given regular expression in the URL optionally filtered by URL and paginated with 'start' position and 'count' of messages.
+
+Parameters
@@ -29913,12 +46189,33 @@ curl -X GET http://zap/JSON/ascan/action/setOptionDefaul
-String
+regex
query
string
true
none
+
+baseurl
+query
+string
+false
+The highest URL in the Sites tree under which URLs should be included.
+
+
+start
+query
+string
+false
+none
+
+
+count
+query
+string
+false
+none
+
@@ -29927,11 +46224,12 @@ curl -X GET http://zap/JSON/ascan/action/setOptionDefaul
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -29944,27 +46242,28 @@ curl -X GET http://zap/JSON/ascan/action/setOptionDefaul
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionSetOptionAddQueryParam
-
+
+selenium
+seleniumActionAddBrowserArgument
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/setOptionAddQueryParam/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/selenium/action/addBrowserArgument/?browser=string&argument=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/setOptionAddQueryParam/?Boolean=string");
+
URL obj = new URL("http://zap/JSON/selenium/action/addBrowserArgument/?browser=string&argument=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -29980,37 +46279,21 @@ curl -X GET http://zap/JSON/ascan/action/setOptionAddQue
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/setOptionAddQueryParam/', params={
- 'Boolean': 'string'
+r = requests.get('http://zap/JSON/selenium/action/addBrowserArgument/', params={
+ 'browser': 'string', 'argument': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/setOptionAddQueryParam/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/setOptionAddQueryParam/
+GET /JSON/selenium/action/addBrowserArgument/
-Sets whether or not the active scanner should add a query param to GET requests which do not have parameters to start with.
+Adds a browser argument.
-Parameters
+Parameters
@@ -30022,11 +46305,25 @@ curl -X GET http://zap/JSON/ascan/action/setOptionAddQue
-Boolean
+browser
query
string
true
-none
+The browser, chrome or firefox.
+
+
+argument
+query
+string
+true
+The argument.
+
+
+enabled
+query
+string
+false
+The enabled state, true or false.
@@ -30036,11 +46333,12 @@ curl -X GET http://zap/JSON/ascan/action/setOptionAddQue
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -30053,27 +46351,26 @@ curl -X GET http://zap/JSON/ascan/action/setOptionAddQue
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionSetOptionAllowAttackOnStart
-
+seleniumActionRemoveBrowserArgument
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/setOptionAllowAttackOnStart/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/selenium/action/removeBrowserArgument/?browser=string&argument=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/setOptionAllowAttackOnStart/?Boolean=string");
+
URL obj = new URL("http://zap/JSON/selenium/action/removeBrowserArgument/?browser=string&argument=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -30089,35 +46386,21 @@ curl -X GET http://zap/JSON/ascan/action/setOptionAllowA
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/setOptionAllowAttackOnStart/', params={
- 'Boolean': 'string'
+r = requests.get('http://zap/JSON/selenium/action/removeBrowserArgument/', params={
+ 'browser': 'string', 'argument': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/setOptionAllowAttackOnStart/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/setOptionAllowAttackOnStart/
+GET /JSON/selenium/action/removeBrowserArgument/
-Parameters
+Removes a browser argument.
+
+Parameters
@@ -30129,11 +46412,18 @@ curl -X GET http://zap/JSON/ascan/action/setOptionAllowA
-Boolean
+browser
query
string
true
-none
+The browser, chrome or firefox.
+
+
+argument
+query
+string
+true
+The argument.
@@ -30143,11 +46433,12 @@ curl -X GET http://zap/JSON/ascan/action/setOptionAllowA
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -30160,27 +46451,26 @@ curl -X GET http://zap/JSON/ascan/action/setOptionAllowA
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionSetOptionDelayInMs
-
+seleniumActionSetBrowserArgumentEnabled
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/setOptionDelayInMs/?Integer=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/selenium/action/setBrowserArgumentEnabled/?browser=string&argument=string&enabled=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/setOptionDelayInMs/?Integer=0");
+
URL obj = new URL("http://zap/JSON/selenium/action/setBrowserArgumentEnabled/?browser=string&argument=string&enabled=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -30196,35 +46486,21 @@ curl -X GET http://zap/JSON/ascan/action/setOptionDelayI
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/setOptionDelayInMs/', params={
- 'Integer': '0'
+r = requests.get('http://zap/JSON/selenium/action/setBrowserArgumentEnabled/', params={
+ 'browser': 'string', 'argument': 'string', 'enabled': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/setOptionDelayInMs/',
- params: {
- 'Integer' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/setOptionDelayInMs/
+GET /JSON/selenium/action/setBrowserArgumentEnabled/
-Parameters
+Sets whether or not a browser argument is enabled.
+
+Parameters
@@ -30236,11 +46512,25 @@ curl -X GET http://zap/JSON/ascan/action/setOptionDelayI
-Integer
+browser
query
-integer
+string
true
-none
+The browser, chrome or firefox.
+
+
+argument
+query
+string
+true
+The argument.
+
+
+enabled
+query
+string
+true
+The enabled state, true or false.
@@ -30250,11 +46540,12 @@ curl -X GET http://zap/JSON/ascan/action/setOptionDelayI
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -30267,27 +46558,26 @@ curl -X GET http://zap/JSON/ascan/action/setOptionDelayI
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionSetOptionHandleAntiCSRFTokens
-
+seleniumActionSetOptionChromeBinaryPath
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/setOptionHandleAntiCSRFTokens/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/selenium/action/setOptionChromeBinaryPath/?String=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/setOptionHandleAntiCSRFTokens/?Boolean=string");
+
URL obj = new URL("http://zap/JSON/selenium/action/setOptionChromeBinaryPath/?String=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -30303,35 +46593,21 @@ curl -X GET http://zap/JSON/ascan/action/setOptionHandle
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/setOptionHandleAntiCSRFTokens/', params={
- 'Boolean': 'string'
+r = requests.get('http://zap/JSON/selenium/action/setOptionChromeBinaryPath/', params={
+ 'String': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/setOptionHandleAntiCSRFTokens/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/setOptionHandleAntiCSRFTokens/
+GET /JSON/selenium/action/setOptionChromeBinaryPath/
-Parameters
+Sets the current path to Chrome binary
+
+Parameters
@@ -30343,7 +46619,7 @@ curl -X GET http://zap/JSON/ascan/action/setOptionHandle
-Boolean
+String
query
string
true
@@ -30357,11 +46633,12 @@ curl -X GET http://zap/JSON/ascan/action/setOptionHandle
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -30374,27 +46651,26 @@ curl -X GET http://zap/JSON/ascan/action/setOptionHandle
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionSetOptionHostPerScan
-
+seleniumActionSetOptionChromeDriverPath
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/setOptionHostPerScan/?Integer=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/selenium/action/setOptionChromeDriverPath/?String=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/setOptionHostPerScan/?Integer=0");
+
URL obj = new URL("http://zap/JSON/selenium/action/setOptionChromeDriverPath/?String=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -30410,35 +46686,21 @@ curl -X GET http://zap/JSON/ascan/action/setOptionHostPe
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/setOptionHostPerScan/', params={
- 'Integer': '0'
+r = requests.get('http://zap/JSON/selenium/action/setOptionChromeDriverPath/', params={
+ 'String': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/setOptionHostPerScan/',
- params: {
- 'Integer' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/setOptionHostPerScan/
+GET /JSON/selenium/action/setOptionChromeDriverPath/
-Parameters
+Sets the current path to ChromeDriver
+
+Parameters
@@ -30450,9 +46712,9 @@ curl -X GET http://zap/JSON/ascan/action/setOptionHostPe
-Integer
+String
query
-integer
+string
true
none
@@ -30464,11 +46726,12 @@ curl -X GET http://zap/JSON/ascan/action/setOptionHostPe
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -30481,27 +46744,26 @@ curl -X GET http://zap/JSON/ascan/action/setOptionHostPe
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionSetOptionInjectPluginIdInHeader
-
+seleniumActionSetOptionFirefoxBinaryPath
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/setOptionInjectPluginIdInHeader/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/selenium/action/setOptionFirefoxBinaryPath/?String=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/setOptionInjectPluginIdInHeader/?Boolean=string");
+
URL obj = new URL("http://zap/JSON/selenium/action/setOptionFirefoxBinaryPath/?String=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -30517,37 +46779,21 @@ curl -X GET http://zap/JSON/ascan/action/setOptionInject
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/setOptionInjectPluginIdInHeader/', params={
- 'Boolean': 'string'
+r = requests.get('http://zap/JSON/selenium/action/setOptionFirefoxBinaryPath/', params={
+ 'String': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/setOptionInjectPluginIdInHeader/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/setOptionInjectPluginIdInHeader/
+GET /JSON/selenium/action/setOptionFirefoxBinaryPath/
-Sets whether or not the active scanner should inject the HTTP request header X-ZAP-Scan-ID, with the ID of the scanner that's sending the requests.
+Sets the current path to Firefox binary
-Parameters
+Parameters
@@ -30559,7 +46805,7 @@ curl -X GET http://zap/JSON/ascan/action/setOptionInject
-Boolean
+String
query
string
true
@@ -30573,11 +46819,12 @@ curl -X GET http://zap/JSON/ascan/action/setOptionInject
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -30590,27 +46837,26 @@ curl -X GET http://zap/JSON/ascan/action/setOptionInject
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionSetOptionMaxChartTimeInMins
-
+seleniumActionSetOptionFirefoxDefaultProfile
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/setOptionMaxChartTimeInMins/?Integer=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/selenium/action/setOptionFirefoxDefaultProfile/?String=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/setOptionMaxChartTimeInMins/?Integer=0");
+
URL obj = new URL("http://zap/JSON/selenium/action/setOptionFirefoxDefaultProfile/?String=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -30626,35 +46872,19 @@ curl -X GET http://zap/JSON/ascan/action/setOptionMaxCha
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/setOptionMaxChartTimeInMins/', params={
- 'Integer': '0'
+r = requests.get('http://zap/JSON/selenium/action/setOptionFirefoxDefaultProfile/', params={
+ 'String': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/setOptionMaxChartTimeInMins/',
- params: {
- 'Integer' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/setOptionMaxChartTimeInMins/
+GET /JSON/selenium/action/setOptionFirefoxDefaultProfile/
-Parameters
+Parameters
@@ -30666,9 +46896,9 @@ curl -X GET http://zap/JSON/ascan/action/setOptionMaxCha
-Integer
+String
query
-integer
+string
true
none
@@ -30680,11 +46910,12 @@ curl -X GET http://zap/JSON/ascan/action/setOptionMaxCha
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -30697,27 +46928,26 @@ curl -X GET http://zap/JSON/ascan/action/setOptionMaxCha
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionSetOptionMaxResultsToList
-
+seleniumActionSetOptionFirefoxDriverPath
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/setOptionMaxResultsToList/?Integer=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/selenium/action/setOptionFirefoxDriverPath/?String=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/setOptionMaxResultsToList/?Integer=0");
+
URL obj = new URL("http://zap/JSON/selenium/action/setOptionFirefoxDriverPath/?String=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -30733,35 +46963,21 @@ curl -X GET http://zap/JSON/ascan/action/setOptionMaxRes
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/setOptionMaxResultsToList/', params={
- 'Integer': '0'
+r = requests.get('http://zap/JSON/selenium/action/setOptionFirefoxDriverPath/', params={
+ 'String': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/setOptionMaxResultsToList/',
- params: {
- 'Integer' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/setOptionMaxResultsToList/
+GET /JSON/selenium/action/setOptionFirefoxDriverPath/
-Parameters
+Sets the current path to Firefox driver (geckodriver)
+
+Parameters
@@ -30773,9 +46989,9 @@ curl -X GET http://zap/JSON/ascan/action/setOptionMaxRes
-Integer
+String
query
-integer
+string
true
none
@@ -30787,11 +47003,12 @@ curl -X GET http://zap/JSON/ascan/action/setOptionMaxRes
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -30804,27 +47021,26 @@ curl -X GET http://zap/JSON/ascan/action/setOptionMaxRes
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionSetOptionMaxRuleDurationInMins
-
+seleniumActionSetOptionIeDriverPath
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/setOptionMaxRuleDurationInMins/?Integer=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/selenium/action/setOptionIeDriverPath/?String=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/setOptionMaxRuleDurationInMins/?Integer=0");
+
URL obj = new URL("http://zap/JSON/selenium/action/setOptionIeDriverPath/?String=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -30840,35 +47056,21 @@ curl -X GET http://zap/JSON/ascan/action/setOptionMaxRul
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/setOptionMaxRuleDurationInMins/', params={
- 'Integer': '0'
+r = requests.get('http://zap/JSON/selenium/action/setOptionIeDriverPath/', params={
+ 'String': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/setOptionMaxRuleDurationInMins/',
- params: {
- 'Integer' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/setOptionMaxRuleDurationInMins/
+GET /JSON/selenium/action/setOptionIeDriverPath/
-Parameters
+Option no longer in effective use.
+
+Parameters
@@ -30880,9 +47082,9 @@ curl -X GET http://zap/JSON/ascan/action/setOptionMaxRul
-Integer
+String
query
-integer
+string
true
none
@@ -30894,11 +47096,12 @@ curl -X GET http://zap/JSON/ascan/action/setOptionMaxRul
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -30911,27 +47114,26 @@ curl -X GET http://zap/JSON/ascan/action/setOptionMaxRul
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionSetOptionMaxScanDurationInMins
-
+seleniumActionSetOptionLastDirectory
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/setOptionMaxScanDurationInMins/?Integer=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/selenium/action/setOptionLastDirectory/?String=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/setOptionMaxScanDurationInMins/?Integer=0");
+
URL obj = new URL("http://zap/JSON/selenium/action/setOptionLastDirectory/?String=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -30947,35 +47149,19 @@ curl -X GET http://zap/JSON/ascan/action/setOptionMaxSca
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/setOptionMaxScanDurationInMins/', params={
- 'Integer': '0'
+r = requests.get('http://zap/JSON/selenium/action/setOptionLastDirectory/', params={
+ 'String': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/setOptionMaxScanDurationInMins/',
- params: {
- 'Integer' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/setOptionMaxScanDurationInMins/
+GET /JSON/selenium/action/setOptionLastDirectory/
-Parameters
+Parameters
@@ -30987,9 +47173,9 @@ curl -X GET http://zap/JSON/ascan/action/setOptionMaxSca
-Integer
+String
query
-integer
+string
true
none
@@ -31001,11 +47187,12 @@ curl -X GET http://zap/JSON/ascan/action/setOptionMaxSca
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -31018,27 +47205,26 @@ curl -X GET http://zap/JSON/ascan/action/setOptionMaxSca
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionSetOptionMaxScansInUI
-
+seleniumActionSetOptionPhantomJsBinaryPath
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/setOptionMaxScansInUI/?Integer=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/selenium/action/setOptionPhantomJsBinaryPath/?String=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/setOptionMaxScansInUI/?Integer=0");
+
URL obj = new URL("http://zap/JSON/selenium/action/setOptionPhantomJsBinaryPath/?String=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -31054,35 +47240,21 @@ curl -X GET http://zap/JSON/ascan/action/setOptionMaxSca
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/setOptionMaxScansInUI/', params={
- 'Integer': '0'
+r = requests.get('http://zap/JSON/selenium/action/setOptionPhantomJsBinaryPath/', params={
+ 'String': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/setOptionMaxScansInUI/',
- params: {
- 'Integer' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/setOptionMaxScansInUI/
+GET /JSON/selenium/action/setOptionPhantomJsBinaryPath/
-Parameters
+Option no longer in effective use.
+
+Parameters
@@ -31094,9 +47266,9 @@ curl -X GET http://zap/JSON/ascan/action/setOptionMaxSca
-Integer
+String
query
-integer
+string
true
none
@@ -31108,11 +47280,12 @@ curl -X GET http://zap/JSON/ascan/action/setOptionMaxSca
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -31125,27 +47298,26 @@ curl -X GET http://zap/JSON/ascan/action/setOptionMaxSca
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionSetOptionPromptInAttackMode
-
+seleniumViewGetBrowserArguments
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/setOptionPromptInAttackMode/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/selenium/view/getBrowserArguments/?browser=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/setOptionPromptInAttackMode/?Boolean=string");
+
URL obj = new URL("http://zap/JSON/selenium/view/getBrowserArguments/?browser=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -31161,35 +47333,21 @@ curl -X GET http://zap/JSON/ascan/action/setOptionPrompt
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/setOptionPromptInAttackMode/', params={
- 'Boolean': 'string'
+r = requests.get('http://zap/JSON/selenium/view/getBrowserArguments/', params={
+ 'browser': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/setOptionPromptInAttackMode/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/setOptionPromptInAttackMode/
+GET /JSON/selenium/view/getBrowserArguments/
-Parameters
+Gets the browser arguments.
+
+Parameters
@@ -31201,11 +47359,11 @@ curl -X GET http://zap/JSON/ascan/action/setOptionPrompt
-Boolean
+browser
query
string
true
-none
+The browser, chrome or firefox.
@@ -31215,11 +47373,12 @@ curl -X GET http://zap/JSON/ascan/action/setOptionPrompt
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -31232,27 +47391,26 @@ curl -X GET http://zap/JSON/ascan/action/setOptionPrompt
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionSetOptionPromptToClearFinishedScans
-
+seleniumViewOptionBrowserExtensions
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/setOptionPromptToClearFinishedScans/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/selenium/view/optionBrowserExtensions/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/setOptionPromptToClearFinishedScans/?Boolean=string");
+
URL obj = new URL("http://zap/JSON/selenium/view/optionBrowserExtensions/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -31268,53 +47426,15 @@ curl -X GET http://zap/JSON/ascan/action/setOptionPrompt
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/setOptionPromptToClearFinishedScans/', params={
- 'Boolean': 'string'
-}, headers = headers)
+r = requests.get('http://zap/JSON/selenium/view/optionBrowserExtensions/', headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/setOptionPromptToClearFinishedScans/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/setOptionPromptToClearFinishedScans/
-
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-Boolean
-query
-string
-true
-none
-
-
+GET /JSON/selenium/view/optionBrowserExtensions/
Example responses
@@ -31322,11 +47442,12 @@ curl -X GET http://zap/JSON/ascan/action/setOptionPrompt
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -31339,27 +47460,26 @@ curl -X GET http://zap/JSON/ascan/action/setOptionPrompt
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionSetOptionRescanInAttackMode
-
+seleniumViewOptionChromeBinaryPath
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/setOptionRescanInAttackMode/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/selenium/view/optionChromeBinaryPath/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/setOptionRescanInAttackMode/?Boolean=string");
+
URL obj = new URL("http://zap/JSON/selenium/view/optionChromeBinaryPath/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -31375,53 +47495,17 @@ curl -X GET http://zap/JSON/ascan/action/setOptionRescan
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/setOptionRescanInAttackMode/', params={
- 'Boolean': 'string'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+r = requests.get('http://zap/JSON/selenium/view/optionChromeBinaryPath/', headers = headers)
-result = RestClient.get 'http://zap/JSON/ascan/action/setOptionRescanInAttackMode/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/setOptionRescanInAttackMode/
+GET /JSON/selenium/view/optionChromeBinaryPath/
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-Boolean
-query
-string
-true
-none
-
-
+Returns the current path to Chrome binary
Example responses
@@ -31429,11 +47513,12 @@ curl -X GET http://zap/JSON/ascan/action/setOptionRescan
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -31446,27 +47531,26 @@ curl -X GET http://zap/JSON/ascan/action/setOptionRescan
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionSetOptionScanHeadersAllRequests
-
+seleniumViewOptionChromeDriverPath
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/setOptionScanHeadersAllRequests/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/selenium/view/optionChromeDriverPath/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/setOptionScanHeadersAllRequests/?Boolean=string");
+
URL obj = new URL("http://zap/JSON/selenium/view/optionChromeDriverPath/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -31482,55 +47566,17 @@ curl -X GET http://zap/JSON/ascan/action/setOptionScanHe
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/setOptionScanHeadersAllRequests/', params={
- 'Boolean': 'string'
-}, headers = headers)
-
-print r.json()
+r = requests.get('http://zap/JSON/selenium/view/optionChromeDriverPath/', headers = headers)
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/setOptionScanHeadersAllRequests/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/setOptionScanHeadersAllRequests/
+GET /JSON/selenium/view/optionChromeDriverPath/
-Sets whether or not the HTTP Headers of all requests should be scanned. Not just requests that send parameters, through the query or request body.
-
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-Boolean
-query
-string
-true
-none
-
-
+Returns the current path to ChromeDriver
Example responses
@@ -31538,11 +47584,12 @@ curl -X GET http://zap/JSON/ascan/action/setOptionScanHe
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -31555,27 +47602,26 @@ curl -X GET http://zap/JSON/ascan/action/setOptionScanHe
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionSetOptionShowAdvancedDialog
-
+seleniumViewOptionFirefoxBinaryPath
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/setOptionShowAdvancedDialog/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/selenium/view/optionFirefoxBinaryPath/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/setOptionShowAdvancedDialog/?Boolean=string");
+
URL obj = new URL("http://zap/JSON/selenium/view/optionFirefoxBinaryPath/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -31591,53 +47637,17 @@ curl -X GET http://zap/JSON/ascan/action/setOptionShowAd
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/setOptionShowAdvancedDialog/', params={
- 'Boolean': 'string'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ascan/action/setOptionShowAdvancedDialog/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
+r = requests.get('http://zap/JSON/selenium/view/optionFirefoxBinaryPath/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/setOptionShowAdvancedDialog/
-
-Parameters
+GET /JSON/selenium/view/optionFirefoxBinaryPath/
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-Boolean
-query
-string
-true
-none
-
-
+Returns the current path to Firefox binary
Example responses
@@ -31645,11 +47655,12 @@ curl -X GET http://zap/JSON/ascan/action/setOptionShowAd
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -31662,27 +47673,26 @@ curl -X GET http://zap/JSON/ascan/action/setOptionShowAd
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionSetOptionTargetParamsEnabledRPC
-
+seleniumViewOptionFirefoxDefaultProfile
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/setOptionTargetParamsEnabledRPC/?Integer=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/selenium/view/optionFirefoxDefaultProfile/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/setOptionTargetParamsEnabledRPC/?Integer=0");
+
URL obj = new URL("http://zap/JSON/selenium/view/optionFirefoxDefaultProfile/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -31698,53 +47708,15 @@ curl -X GET http://zap/JSON/ascan/action/setOptionTarget
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/ascan/action/setOptionTargetParamsEnabledRPC/', params={
- 'Integer': '0'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/ascan/action/setOptionTargetParamsEnabledRPC/',
- params: {
- 'Integer' => 'integer'
-}, headers: headers
+r = requests.get('http://zap/JSON/selenium/view/optionFirefoxDefaultProfile/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/setOptionTargetParamsEnabledRPC/
-
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-Integer
-query
-integer
-true
-none
-
-
+GET /JSON/selenium/view/optionFirefoxDefaultProfile/
Example responses
@@ -31752,11 +47724,12 @@ curl -X GET http://zap/JSON/ascan/action/setOptionTarget
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -31769,27 +47742,26 @@ curl -X GET http://zap/JSON/ascan/action/setOptionTarget
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionSetOptionTargetParamsInjectable
-
+seleniumViewOptionFirefoxDriverPath
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/setOptionTargetParamsInjectable/?Integer=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/selenium/view/optionFirefoxDriverPath/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/setOptionTargetParamsInjectable/?Integer=0");
+
URL obj = new URL("http://zap/JSON/selenium/view/optionFirefoxDriverPath/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -31805,53 +47777,17 @@ curl -X GET http://zap/JSON/ascan/action/setOptionTarget
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/ascan/action/setOptionTargetParamsInjectable/', params={
- 'Integer': '0'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/ascan/action/setOptionTargetParamsInjectable/',
- params: {
- 'Integer' => 'integer'
-}, headers: headers
+r = requests.get('http://zap/JSON/selenium/view/optionFirefoxDriverPath/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ascan/action/setOptionTargetParamsInjectable/
-
-Parameters
+GET /JSON/selenium/view/optionFirefoxDriverPath/
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-Integer
-query
-integer
-true
-none
-
-
+Returns the current path to Firefox driver (geckodriver)
Example responses
@@ -31859,11 +47795,12 @@ curl -X GET http://zap/JSON/ascan/action/setOptionTarget
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -31876,27 +47813,26 @@ curl -X GET http://zap/JSON/ascan/action/setOptionTarget
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ascanActionSetOptionThreadPerHost
-
+seleniumViewOptionIeDriverPath
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ascan/action/setOptionThreadPerHost/?Integer=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/selenium/view/optionIeDriverPath/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ascan/action/setOptionThreadPerHost/?Integer=0");
+
URL obj = new URL("http://zap/JSON/selenium/view/optionIeDriverPath/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -31912,65 +47848,99 @@ curl -X GET http://zap/JSON/ascan/action/setOptionThread
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ascan/action/setOptionThreadPerHost/', params={
- 'Integer': '0'
-}, headers = headers)
-
-print r.json()
+r = requests.get('http://zap/JSON/selenium/view/optionIeDriverPath/', headers = headers)
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+print(r.json())
-result = RestClient.get 'http://zap/JSON/ascan/action/setOptionThreadPerHost/',
- params: {
- 'Integer' => 'integer'
-}, headers: headers
+
+GET /JSON/selenium/view/optionIeDriverPath/
-p JSON.parse(result)
+Option no longer in effective use.
-
-GET /JSON/ascan/action/setOptionThreadPerHost/
+
+Example responses
-Parameters
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
-Name
-In
-Type
-Required
+Status
+Meaning
Description
+Schema
-Integer
-query
-integer
-true
-none
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+seleniumViewOptionLastDirectory
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/selenium/view/optionLastDirectory/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/selenium/view/optionLastDirectory/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/selenium/view/optionLastDirectory/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/selenium/view/optionLastDirectory/
+
Example responses
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -31983,29 +47953,26 @@ curl -X GET http://zap/JSON/ascan/action/setOptionThread
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-
-context
-contextViewContextList
-
+seleniumViewOptionPhantomJsBinaryPath
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/context/view/contextList/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/selenium/view/optionPhantomJsBinaryPath/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/context/view/contextList/");
+
URL obj = new URL("http://zap/JSON/selenium/view/optionPhantomJsBinaryPath/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -32021,34 +47988,17 @@ curl -X GET http://zap/JSON/context/view/contextList/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/context/view/contextList/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/context/view/contextList/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/selenium/view/optionPhantomJsBinaryPath/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/context/view/contextList/
+GET /JSON/selenium/view/optionPhantomJsBinaryPath/
-List context names of current session
+Option no longer in effective use.
Example responses
@@ -32056,11 +48006,12 @@ curl -X GET http://zap/JSON/context/view/contextList/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -32073,27 +48024,28 @@ curl -X GET http://zap/JSON/context/view/contextList/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-contextViewExcludeRegexs
-
+
+sessionManagement
+sessionManagementActionSetSessionManagementMethod
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/context/view/excludeRegexs/?contextName=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/sessionManagement/action/setSessionManagementMethod/?contextId=string&methodName=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/context/view/excludeRegexs/?contextName=string");
+
URL obj = new URL("http://zap/JSON/sessionManagement/action/setSessionManagementMethod/?contextId=string&methodName=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -32109,37 +48061,21 @@ curl -X GET http://zap/JSON/context/view/excludeRegexs/?
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/context/view/excludeRegexs/', params={
- 'contextName': 'string'
+r = requests.get('http://zap/JSON/sessionManagement/action/setSessionManagementMethod/', params={
+ 'contextId': 'string', 'methodName': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/context/view/excludeRegexs/',
- params: {
- 'contextName' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/context/view/excludeRegexs/
+GET /JSON/sessionManagement/action/setSessionManagementMethod/
-List excluded regexs for context
+Sets the session management method for the context with the given ID.
-Parameters
+Parameters
@@ -32151,12 +48087,26 @@ curl -X GET http://zap/JSON/context/view/excludeRegexs/?
-contextName
+contextId
query
string
true
none
+
+methodName
+query
+string
+true
+none
+
+
+methodConfigParams
+query
+string
+false
+none
+
@@ -32165,11 +48115,12 @@ curl -X GET http://zap/JSON/context/view/excludeRegexs/?
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -32182,27 +48133,26 @@ curl -X GET http://zap/JSON/context/view/excludeRegexs/?
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-contextViewIncludeRegexs
-
+sessionManagementViewGetSessionManagementMethod
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/context/view/includeRegexs/?contextName=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/sessionManagement/view/getSessionManagementMethod/?contextId=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/context/view/includeRegexs/?contextName=string");
+
URL obj = new URL("http://zap/JSON/sessionManagement/view/getSessionManagementMethod/?contextId=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -32218,37 +48168,21 @@ curl -X GET http://zap/JSON/context/view/includeRegexs/?
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/context/view/includeRegexs/', params={
- 'contextName': 'string'
+r = requests.get('http://zap/JSON/sessionManagement/view/getSessionManagementMethod/', params={
+ 'contextId': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/context/view/includeRegexs/',
- params: {
- 'contextName' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/context/view/includeRegexs/
+GET /JSON/sessionManagement/view/getSessionManagementMethod/
-List included regexs for context
+Gets the name of the session management method for the context with the given ID.
-Parameters
+Parameters
@@ -32260,7 +48194,7 @@ curl -X GET http://zap/JSON/context/view/includeRegexs/?
-contextName
+contextId
query
string
true
@@ -32274,11 +48208,12 @@ curl -X GET http://zap/JSON/context/view/includeRegexs/?
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -32291,27 +48226,26 @@ curl -X GET http://zap/JSON/context/view/includeRegexs/?
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-contextViewContext
-
+sessionManagementViewGetSessionManagementMethodConfigParams
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/context/view/context/?contextName=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/sessionManagement/view/getSessionManagementMethodConfigParams/?methodName=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/context/view/context/?contextName=string");
+
URL obj = new URL("http://zap/JSON/sessionManagement/view/getSessionManagementMethodConfigParams/?methodName=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -32327,37 +48261,21 @@ curl -X GET http://zap/JSON/context/view/context/?contex
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/context/view/context/', params={
- 'contextName': 'string'
+r = requests.get('http://zap/JSON/sessionManagement/view/getSessionManagementMethodConfigParams/', params={
+ 'methodName': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/context/view/context/',
- params: {
- 'contextName' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/context/view/context/
+GET /JSON/sessionManagement/view/getSessionManagementMethodConfigParams/
-List the information about the named context
+Gets the configuration parameters for the session management method with the given name.
-Parameters
+Parameters
@@ -32369,7 +48287,7 @@ curl -X GET http://zap/JSON/context/view/context/?contex
-contextName
+methodName
query
string
true
@@ -32383,11 +48301,12 @@ curl -X GET http://zap/JSON/context/view/context/?contex
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -32400,27 +48319,26 @@ curl -X GET http://zap/JSON/context/view/context/?contex
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-contextViewTechnologyList
-
+sessionManagementViewGetSupportedSessionManagementMethods
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/context/view/technologyList/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/sessionManagement/view/getSupportedSessionManagementMethods/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/context/view/technologyList/");
+
URL obj = new URL("http://zap/JSON/sessionManagement/view/getSupportedSessionManagementMethods/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -32436,34 +48354,17 @@ curl -X GET http://zap/JSON/context/view/technologyList/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/context/view/technologyList/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/context/view/technologyList/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/sessionManagement/view/getSupportedSessionManagementMethods/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/context/view/technologyList/
+GET /JSON/sessionManagement/view/getSupportedSessionManagementMethods/
-Lists the names of all built in technologies
+Gets the name of the session management methods.
Example responses
@@ -32471,11 +48372,12 @@ curl -X GET http://zap/JSON/context/view/technologyList/
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -32488,27 +48390,28 @@ curl -X GET http://zap/JSON/context/view/technologyList/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-contextViewIncludedTechnologyList
-
+
+soap
+soapActionImportFile
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/context/view/includedTechnologyList/?contextName=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/soap/action/importFile/?file=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/context/view/includedTechnologyList/?contextName=string");
+
URL obj = new URL("http://zap/JSON/soap/action/importFile/?file=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -32524,37 +48427,21 @@ curl -X GET http://zap/JSON/context/view/includedTechnol
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/context/view/includedTechnologyList/', params={
- 'contextName': 'string'
+r = requests.get('http://zap/JSON/soap/action/importFile/', params={
+ 'file': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/context/view/includedTechnologyList/',
- params: {
- 'contextName' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/context/view/includedTechnologyList/
+GET /JSON/soap/action/importFile/
-Lists the names of all technologies included in a context
+Import a WSDL definition from local file.
-Parameters
+Parameters
@@ -32566,7 +48453,7 @@ curl -X GET http://zap/JSON/context/view/includedTechnol
-contextName
+file
query
string
true
@@ -32580,11 +48467,12 @@ curl -X GET http://zap/JSON/context/view/includedTechnol
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -32597,27 +48485,26 @@ curl -X GET http://zap/JSON/context/view/includedTechnol
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-contextViewExcludedTechnologyList
-
+soapActionImportUrl
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/context/view/excludedTechnologyList/?contextName=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/soap/action/importUrl/?url=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/context/view/excludedTechnologyList/?contextName=string");
+
URL obj = new URL("http://zap/JSON/soap/action/importUrl/?url=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -32633,37 +48520,21 @@ curl -X GET http://zap/JSON/context/view/excludedTechnol
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/context/view/excludedTechnologyList/', params={
- 'contextName': 'string'
+r = requests.get('http://zap/JSON/soap/action/importUrl/', params={
+ 'url': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/context/view/excludedTechnologyList/',
- params: {
- 'contextName' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/context/view/excludedTechnologyList/
+GET /JSON/soap/action/importUrl/
-Lists the names of all technologies excluded from a context
+Import a WSDL definition from a URL.
-Parameters
+Parameters
@@ -32675,7 +48546,7 @@ curl -X GET http://zap/JSON/context/view/excludedTechnol
-contextName
+url
query
string
true
@@ -32689,11 +48560,12 @@ curl -X GET http://zap/JSON/context/view/excludedTechnol
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -32706,27 +48578,28 @@ curl -X GET http://zap/JSON/context/view/excludedTechnol
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-contextViewUrls
-
+
+spider
+spiderActionAddDomainAlwaysInScope
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/context/view/urls/?contextName=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/addDomainAlwaysInScope/?value=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/context/view/urls/?contextName=string");
+
URL obj = new URL("http://zap/JSON/spider/action/addDomainAlwaysInScope/?value=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -32742,37 +48615,21 @@ curl -X GET http://zap/JSON/context/view/urls/?contextNa
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/context/view/urls/', params={
- 'contextName': 'string'
+r = requests.get('http://zap/JSON/spider/action/addDomainAlwaysInScope/', params={
+ 'value': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/context/view/urls/',
- params: {
- 'contextName' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/context/view/urls/
+GET /JSON/spider/action/addDomainAlwaysInScope/
-Lists the URLs accessed through/by ZAP, that belong to the context with the given name.
+Adds a new domain that's always in scope, 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).
-Parameters
+Parameters
@@ -32784,12 +48641,26 @@ curl -X GET http://zap/JSON/context/view/urls/?contextNa
-contextName
+value
query
string
true
none
+
+isRegex
+query
+string
+false
+none
+
+
+isEnabled
+query
+string
+false
+none
+
@@ -32798,11 +48669,12 @@ curl -X GET http://zap/JSON/context/view/urls/?contextNa
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -32815,27 +48687,26 @@ curl -X GET http://zap/JSON/context/view/urls/?contextNa
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-contextActionExcludeFromContext
-
+spiderActionClearExcludedFromScan
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/context/action/excludeFromContext/?contextName=string®ex=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/clearExcludedFromScan/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/context/action/excludeFromContext/?contextName=string®ex=string");
+
URL obj = new URL("http://zap/JSON/spider/action/clearExcludedFromScan/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -32851,75 +48722,172 @@ curl -X GET http://zap/JSON/context/action/excludeFromCo
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/context/action/excludeFromContext/', params={
- 'contextName': 'string', 'regex': 'string'
-}, headers = headers)
+r = requests.get('http://zap/JSON/spider/action/clearExcludedFromScan/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/spider/action/clearExcludedFromScan/
+
+Clears the regexes of URLs excluded from the spider scans.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
-print r.json()
+
+spiderActionDisableAllDomainsAlwaysInScope
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/spider/action/disableAllDomainsAlwaysInScope/ \
+ -H 'Accept: application/json'
-
require 'rest-client'
-require 'json'
+
URL obj = new URL("http://zap/JSON/spider/action/disableAllDomainsAlwaysInScope/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
import requests
headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/context/action/excludeFromContext/',
- params: {
- 'contextName' => 'string',
-'regex' => 'string'
-}, headers: headers
+r = requests.get('http://zap/JSON/spider/action/disableAllDomainsAlwaysInScope/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/context/action/excludeFromContext/
+GET /JSON/spider/action/disableAllDomainsAlwaysInScope/
-Add exclude regex to context
+Disables all domains that are always in scope.
-Parameters
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
-Name
-In
-Type
-Required
+Status
+Meaning
Description
+Schema
-contextName
-query
-string
-true
-none
-
-
-regex
-query
-string
-true
-none
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+spiderActionEnableAllDomainsAlwaysInScope
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/spider/action/enableAllDomainsAlwaysInScope/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/spider/action/enableAllDomainsAlwaysInScope/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/spider/action/enableAllDomainsAlwaysInScope/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/spider/action/enableAllDomainsAlwaysInScope/
+
+Enables all domains that are always in scope.
+
Example responses
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -32932,27 +48900,26 @@ curl -X GET http://zap/JSON/context/action/excludeFromCo
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-contextActionIncludeInContext
-
+spiderActionExcludeFromScan
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/context/action/includeInContext/?contextName=string®ex=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/excludeFromScan/?regex=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/context/action/includeInContext/?contextName=string®ex=string");
+
URL obj = new URL("http://zap/JSON/spider/action/excludeFromScan/?regex=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -32968,38 +48935,21 @@ curl -X GET http://zap/JSON/context/action/includeInCont
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/context/action/includeInContext/', params={
- 'contextName': 'string', 'regex': 'string'
+r = requests.get('http://zap/JSON/spider/action/excludeFromScan/', params={
+ 'regex': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/context/action/includeInContext/',
- params: {
- 'contextName' => 'string',
-'regex' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/context/action/includeInContext/
+GET /JSON/spider/action/excludeFromScan/
-Add include regex to context
+Adds a regex of URLs that should be excluded from the spider scans.
-Parameters
+Parameters
@@ -33011,13 +48961,6 @@ curl -X GET http://zap/JSON/context/action/includeInCont
-contextName
-query
-string
-true
-none
-
-
regex
query
string
@@ -33032,11 +48975,12 @@ curl -X GET http://zap/JSON/context/action/includeInCont
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -33049,27 +48993,26 @@ curl -X GET http://zap/JSON/context/action/includeInCont
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-contextActionSetContextRegexs
-
+spiderActionModifyDomainAlwaysInScope
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/context/action/setContextRegexs/?contextName=string&incRegexs=string&excRegexs=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/modifyDomainAlwaysInScope/?idx=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/context/action/setContextRegexs/?contextName=string&incRegexs=string&excRegexs=string");
+
URL obj = new URL("http://zap/JSON/spider/action/modifyDomainAlwaysInScope/?idx=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -33085,39 +49028,21 @@ curl -X GET http://zap/JSON/context/action/setContextReg
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/context/action/setContextRegexs/', params={
- 'contextName': 'string', 'incRegexs': 'string', 'excRegexs': 'string'
+r = requests.get('http://zap/JSON/spider/action/modifyDomainAlwaysInScope/', params={
+ 'idx': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/context/action/setContextRegexs/',
- params: {
- 'contextName' => 'string',
-'incRegexs' => 'string',
-'excRegexs' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/context/action/setContextRegexs/
+GET /JSON/spider/action/modifyDomainAlwaysInScope/
-Set the regexs to include and exclude for a context, both supplied as JSON string arrays
+Modifies a domain that's always in scope. 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 domainsAlwaysInScope.
-Parameters
+Parameters
@@ -33129,24 +49054,31 @@ curl -X GET http://zap/JSON/context/action/setContextReg
-contextName
+idx
query
string
true
none
-incRegexs
+value
query
string
-true
+false
none
-excRegexs
+isRegex
query
string
-true
+false
+none
+
+
+isEnabled
+query
+string
+false
none
@@ -33157,11 +49089,12 @@ curl -X GET http://zap/JSON/context/action/setContextReg
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -33174,27 +49107,26 @@ curl -X GET http://zap/JSON/context/action/setContextReg
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-contextActionNewContext
-
+spiderActionPause
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/context/action/newContext/?contextName=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/pause/?scanId=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/context/action/newContext/?contextName=string");
+
URL obj = new URL("http://zap/JSON/spider/action/pause/?scanId=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -33210,37 +49142,19 @@ curl -X GET http://zap/JSON/context/action/newContext/?c
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/context/action/newContext/', params={
- 'contextName': 'string'
+r = requests.get('http://zap/JSON/spider/action/pause/', params={
+ 'scanId': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/context/action/newContext/',
- params: {
- 'contextName' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/context/action/newContext/
-
-Creates a new context with the given name in the current session
+GET /JSON/spider/action/pause/
-Parameters
+Parameters
@@ -33252,7 +49166,7 @@ curl -X GET http://zap/JSON/context/action/newContext/?c
-contextName
+scanId
query
string
true
@@ -33266,11 +49180,12 @@ curl -X GET http://zap/JSON/context/action/newContext/?c
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -33283,27 +49198,26 @@ curl -X GET http://zap/JSON/context/action/newContext/?c
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-contextActionRemoveContext
-
+spiderActionPauseAllScans
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/context/action/removeContext/?contextName=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/pauseAllScans/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/context/action/removeContext/?contextName=string");
+
URL obj = new URL("http://zap/JSON/spider/action/pauseAllScans/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -33319,55 +49233,15 @@ curl -X GET http://zap/JSON/context/action/removeContext
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/context/action/removeContext/', params={
- 'contextName': 'string'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/context/action/removeContext/',
- params: {
- 'contextName' => 'string'
-}, headers: headers
+r = requests.get('http://zap/JSON/spider/action/pauseAllScans/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/context/action/removeContext/
-
-Removes a context in the current session
-
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-contextName
-query
-string
-true
-none
-
-
+GET /JSON/spider/action/pauseAllScans/
Example responses
@@ -33375,11 +49249,12 @@ curl -X GET http://zap/JSON/context/action/removeContext
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -33392,27 +49267,26 @@ curl -X GET http://zap/JSON/context/action/removeContext
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-contextActionExportContext
-
+spiderActionRemoveAllScans
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/context/action/exportContext/?contextName=string&contextFile=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/removeAllScans/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/context/action/exportContext/?contextName=string&contextFile=string");
+
URL obj = new URL("http://zap/JSON/spider/action/removeAllScans/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -33428,63 +49302,15 @@ curl -X GET http://zap/JSON/context/action/exportContext
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/context/action/exportContext/', params={
- 'contextName': 'string', 'contextFile': 'string'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/context/action/exportContext/',
- params: {
- 'contextName' => 'string',
-'contextFile' => 'string'
-}, headers: headers
+r = requests.get('http://zap/JSON/spider/action/removeAllScans/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/context/action/exportContext/
-
-Exports the context with the given name to a file. If a relative file path is specified it will be resolved against the "contexts" directory in ZAP "home" dir.
-
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-contextName
-query
-string
-true
-none
-
-
-contextFile
-query
-string
-true
-none
-
-
+GET /JSON/spider/action/removeAllScans/
Example responses
@@ -33492,11 +49318,12 @@ curl -X GET http://zap/JSON/context/action/exportContext
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -33509,27 +49336,26 @@ curl -X GET http://zap/JSON/context/action/exportContext
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-contextActionImportContext
-
+spiderActionRemoveDomainAlwaysInScope
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/context/action/importContext/?contextFile=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/removeDomainAlwaysInScope/?idx=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/context/action/importContext/?contextFile=string");
+
URL obj = new URL("http://zap/JSON/spider/action/removeDomainAlwaysInScope/?idx=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -33545,37 +49371,21 @@ curl -X GET http://zap/JSON/context/action/importContext
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/context/action/importContext/', params={
- 'contextFile': 'string'
+r = requests.get('http://zap/JSON/spider/action/removeDomainAlwaysInScope/', params={
+ 'idx': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/context/action/importContext/',
- params: {
- 'contextFile' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/context/action/importContext/
+GET /JSON/spider/action/removeDomainAlwaysInScope/
-Imports a context from a file. If a relative file path is specified it will be resolved against the "contexts" directory in ZAP "home" dir.
+Removes a domain that's always in scope, with the given index. The index can be obtained with the view domainsAlwaysInScope.
-Parameters
+Parameters
@@ -33587,7 +49397,7 @@ curl -X GET http://zap/JSON/context/action/importContext
-contextFile
+idx
query
string
true
@@ -33601,11 +49411,12 @@ curl -X GET http://zap/JSON/context/action/importContext
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -33618,27 +49429,26 @@ curl -X GET http://zap/JSON/context/action/importContext
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-contextActionIncludeContextTechnologies
-
+spiderActionRemoveScan
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/context/action/includeContextTechnologies/?contextName=string&technologyNames=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/removeScan/?scanId=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/context/action/includeContextTechnologies/?contextName=string&technologyNames=string");
+
URL obj = new URL("http://zap/JSON/spider/action/removeScan/?scanId=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -33654,38 +49464,19 @@ curl -X GET http://zap/JSON/context/action/includeContex
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/context/action/includeContextTechnologies/', params={
- 'contextName': 'string', 'technologyNames': 'string'
+r = requests.get('http://zap/JSON/spider/action/removeScan/', params={
+ 'scanId': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/context/action/includeContextTechnologies/',
- params: {
- 'contextName' => 'string',
-'technologyNames' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/context/action/includeContextTechnologies/
-
-Includes technologies with the given names, separated by a comma, to a context
+GET /JSON/spider/action/removeScan/
-Parameters
+Parameters
@@ -33697,14 +49488,7 @@ curl -X GET http://zap/JSON/context/action/includeContex
-contextName
-query
-string
-true
-none
-
-
-technologyNames
+scanId
query
string
true
@@ -33718,11 +49502,12 @@ curl -X GET http://zap/JSON/context/action/includeContex
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -33735,27 +49520,26 @@ curl -X GET http://zap/JSON/context/action/includeContex
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-contextActionIncludeAllContextTechnologies
-
+spiderActionResume
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/context/action/includeAllContextTechnologies/?contextName=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/resume/?scanId=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/context/action/includeAllContextTechnologies/?contextName=string");
+
URL obj = new URL("http://zap/JSON/spider/action/resume/?scanId=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -33771,37 +49555,19 @@ curl -X GET http://zap/JSON/context/action/includeAllCon
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/context/action/includeAllContextTechnologies/', params={
- 'contextName': 'string'
+r = requests.get('http://zap/JSON/spider/action/resume/', params={
+ 'scanId': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/context/action/includeAllContextTechnologies/',
- params: {
- 'contextName' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/context/action/includeAllContextTechnologies/
-
-Includes all built in technologies in to a context
+GET /JSON/spider/action/resume/
-Parameters
+Parameters
@@ -33813,7 +49579,7 @@ curl -X GET http://zap/JSON/context/action/includeAllCon
-contextName
+scanId
query
string
true
@@ -33827,11 +49593,12 @@ curl -X GET http://zap/JSON/context/action/includeAllCon
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -33844,27 +49611,26 @@ curl -X GET http://zap/JSON/context/action/includeAllCon
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-contextActionExcludeContextTechnologies
-
+spiderActionResumeAllScans
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/context/action/excludeContextTechnologies/?contextName=string&technologyNames=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/resumeAllScans/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/context/action/excludeContextTechnologies/?contextName=string&technologyNames=string");
+
URL obj = new URL("http://zap/JSON/spider/action/resumeAllScans/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -33880,63 +49646,15 @@ curl -X GET http://zap/JSON/context/action/excludeContex
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/context/action/excludeContextTechnologies/', params={
- 'contextName': 'string', 'technologyNames': 'string'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/context/action/excludeContextTechnologies/',
- params: {
- 'contextName' => 'string',
-'technologyNames' => 'string'
-}, headers: headers
+r = requests.get('http://zap/JSON/spider/action/resumeAllScans/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/context/action/excludeContextTechnologies/
-
-Excludes technologies with the given names, separated by a comma, from a context
-
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-contextName
-query
-string
-true
-none
-
-
-technologyNames
-query
-string
-true
-none
-
-
+GET /JSON/spider/action/resumeAllScans/
Example responses
@@ -33944,11 +49662,12 @@ curl -X GET http://zap/JSON/context/action/excludeContex
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -33961,27 +49680,26 @@ curl -X GET http://zap/JSON/context/action/excludeContex
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-contextActionExcludeAllContextTechnologies
-
+spiderActionScan
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/context/action/excludeAllContextTechnologies/?contextName=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/scan/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/context/action/excludeAllContextTechnologies/?contextName=string");
+
URL obj = new URL("http://zap/JSON/spider/action/scan/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -33997,37 +49715,19 @@ curl -X GET http://zap/JSON/context/action/excludeAllCon
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/context/action/excludeAllContextTechnologies/', params={
- 'contextName': 'string'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/context/action/excludeAllContextTechnologies/',
- params: {
- 'contextName' => 'string'
-}, headers: headers
+r = requests.get('http://zap/JSON/spider/action/scan/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/context/action/excludeAllContextTechnologies/
+GET /JSON/spider/action/scan/
-Excludes all built in technologies from a context
+Runs the spider against the given URL (or context). Optionally, the 'maxChildren' parameter can be set to limit the number of children scanned, the 'recurse' parameter can be used to prevent the spider from seeding recursively, the parameter 'contextName' can be used to constrain the scan to a Context and the parameter 'subtreeOnly' allows to restrict the spider under a site's subtree (using the specified 'url').
-Parameters
+Parameters
@@ -34039,10 +49739,38 @@ curl -X GET http://zap/JSON/context/action/excludeAllCon
+url
+query
+string
+false
+none
+
+
+maxChildren
+query
+string
+false
+none
+
+
+recurse
+query
+string
+false
+none
+
+
contextName
query
string
-true
+false
+none
+
+
+subtreeOnly
+query
+string
+false
none
@@ -34053,11 +49781,12 @@ curl -X GET http://zap/JSON/context/action/excludeAllCon
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -34070,27 +49799,26 @@ curl -X GET http://zap/JSON/context/action/excludeAllCon
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-contextActionSetContextInScope
-
+spiderActionScanAsUser
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/context/action/setContextInScope/?contextName=string&booleanInScope=true \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/scanAsUser/?contextId=string&userId=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/context/action/setContextInScope/?contextName=string&booleanInScope=true");
+
URL obj = new URL("http://zap/JSON/spider/action/scanAsUser/?contextId=string&userId=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -34106,38 +49834,21 @@ curl -X GET http://zap/JSON/context/action/setContextInS
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/context/action/setContextInScope/', params={
- 'contextName': 'string', 'booleanInScope': 'true'
+r = requests.get('http://zap/JSON/spider/action/scanAsUser/', params={
+ 'contextId': 'string', 'userId': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/context/action/setContextInScope/',
- params: {
- 'contextName' => 'string',
-'booleanInScope' => 'boolean'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/context/action/setContextInScope/
+GET /JSON/spider/action/scanAsUser/
-Sets a context to in scope (contexts are in scope by default)
+Runs the spider from the perspective of a User, obtained using the given Context ID and User ID. See 'scan' action for more details.
-Parameters
+Parameters
@@ -34149,122 +49860,61 @@ curl -X GET http://zap/JSON/context/action/setContextInS
-contextName
+contextId
query
string
true
none
-booleanInScope
+userId
query
-boolean
+string
true
none
-
-
-
-Example responses
-
-default Response
-
-{
- "message": "string",
- "code": 100
-}
-
-Responses
-
-
-Status
-Meaning
-Description
-Schema
+url
+query
+string
+false
+none
-
-default
-Default
-unexpected error
-Error
+maxChildren
+query
+string
+false
+none
+
+
+recurse
+query
+string
+false
+none
+
+
+subtreeOnly
+query
+string
+false
+none
-
-
-httpSessions
-httpSessionsViewSites
-
-
-
-Code samples
-
-# You can also use wget
-curl -X GET http://zap/JSON/httpSessions/view/sites/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
-
-
URL obj = new URL("http://zap/JSON/httpSessions/view/sites/");
-HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("GET");
-int responseCode = con.getResponseCode();
-BufferedReader in = new BufferedReader(
- new InputStreamReader(con.getInputStream()));
-String inputLine;
-StringBuffer response = new StringBuffer();
-while ((inputLine = in.readLine()) != null) {
- response.append(inputLine);
-}
-in.close();
-System.out.println(response.toString());
-
-
import requests
-headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/httpSessions/view/sites/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/httpSessions/view/sites/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
-
-
-GET /JSON/httpSessions/view/sites/
-
-Gets all of the sites that have sessions.
-
Example responses
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -34277,27 +49927,26 @@ curl -X GET http://zap/JSON/httpSessions/view/sites/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-httpSessionsViewSessions
-
+spiderActionSetOptionAcceptCookies
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/httpSessions/view/sessions/?site=string&session=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/setOptionAcceptCookies/?Boolean=true \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/httpSessions/view/sessions/?site=string&session=string");
+
URL obj = new URL("http://zap/JSON/spider/action/setOptionAcceptCookies/?Boolean=true");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -34313,38 +49962,21 @@ curl -X GET http://zap/JSON/httpSessions/view/sessions/?
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/httpSessions/view/sessions/', params={
- 'site': 'string', 'session': 'string'
+r = requests.get('http://zap/JSON/spider/action/setOptionAcceptCookies/', params={
+ 'Boolean': 'true'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/httpSessions/view/sessions/',
- params: {
- 'site' => 'string',
-'session' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/httpSessions/view/sessions/
+GET /JSON/spider/action/setOptionAcceptCookies/
-Gets the sessions for the given site. Optionally returning just the session with the given name.
+Sets whether or not a spider process should accept cookies while spidering.
-Parameters
+Parameters
@@ -34356,16 +49988,9 @@ curl -X GET http://zap/JSON/httpSessions/view/sessions/?
-site
-query
-string
-true
-none
-
-
-session
+Boolean
query
-string
+boolean
true
none
@@ -34377,11 +50002,12 @@ curl -X GET http://zap/JSON/httpSessions/view/sessions/?
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -34394,27 +50020,26 @@ curl -X GET http://zap/JSON/httpSessions/view/sessions/?
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-httpSessionsViewActiveSession
-
+spiderActionSetOptionHandleODataParametersVisited
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/httpSessions/view/activeSession/?site=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/setOptionHandleODataParametersVisited/?Boolean=true \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/httpSessions/view/activeSession/?site=string");
+
URL obj = new URL("http://zap/JSON/spider/action/setOptionHandleODataParametersVisited/?Boolean=true");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -34430,37 +50055,19 @@ curl -X GET http://zap/JSON/httpSessions/view/activeSess
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/httpSessions/view/activeSession/', params={
- 'site': 'string'
+r = requests.get('http://zap/JSON/spider/action/setOptionHandleODataParametersVisited/', params={
+ 'Boolean': 'true'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/httpSessions/view/activeSession/',
- params: {
- 'site' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/httpSessions/view/activeSession/
-
-Gets the name of the active session for the given site.
+GET /JSON/spider/action/setOptionHandleODataParametersVisited/
-Parameters
+Parameters
@@ -34472,9 +50079,9 @@ curl -X GET http://zap/JSON/httpSessions/view/activeSess
-site
+Boolean
query
-string
+boolean
true
none
@@ -34486,11 +50093,12 @@ curl -X GET http://zap/JSON/httpSessions/view/activeSess
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -34503,27 +50111,26 @@ curl -X GET http://zap/JSON/httpSessions/view/activeSess
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-httpSessionsViewSessionTokens
-
+spiderActionSetOptionHandleParameters
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/httpSessions/view/sessionTokens/?site=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/setOptionHandleParameters/?String=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/httpSessions/view/sessionTokens/?site=string");
+
URL obj = new URL("http://zap/JSON/spider/action/setOptionHandleParameters/?String=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -34539,37 +50146,19 @@ curl -X GET http://zap/JSON/httpSessions/view/sessionTok
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/httpSessions/view/sessionTokens/', params={
- 'site': 'string'
+r = requests.get('http://zap/JSON/spider/action/setOptionHandleParameters/', params={
+ 'String': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/httpSessions/view/sessionTokens/',
- params: {
- 'site' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/httpSessions/view/sessionTokens/
-
-Gets the names of the session tokens for the given site.
+GET /JSON/spider/action/setOptionHandleParameters/
-Parameters
+Parameters
@@ -34581,7 +50170,7 @@ curl -X GET http://zap/JSON/httpSessions/view/sessionTok
-site
+String
query
string
true
@@ -34595,11 +50184,12 @@ curl -X GET http://zap/JSON/httpSessions/view/sessionTok
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -34612,27 +50202,26 @@ curl -X GET http://zap/JSON/httpSessions/view/sessionTok
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-httpSessionsViewDefaultSessionTokens
-
+spiderActionSetOptionMaxChildren
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/httpSessions/view/defaultSessionTokens/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/setOptionMaxChildren/?Integer=0 \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/httpSessions/view/defaultSessionTokens/");
+
URL obj = new URL("http://zap/JSON/spider/action/setOptionMaxChildren/?Integer=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -34648,34 +50237,39 @@ curl -X GET http://zap/JSON/httpSessions/view/defaultSes
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/httpSessions/view/defaultSessionTokens/', params={
-
+r = requests.get('http://zap/JSON/spider/action/setOptionMaxChildren/', params={
+ 'Integer': '0'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+print(r.json())
-result = RestClient.get 'http://zap/JSON/httpSessions/view/defaultSessionTokens/',
- params: {
- }, headers: headers
+
+GET /JSON/spider/action/setOptionMaxChildren/
-p JSON.parse(result)
+Sets the maximum number of child nodes (per node) that can be crawled, 0 means no limit.
-
-GET /JSON/httpSessions/view/defaultSessionTokens/
+Parameters
-Gets the default session tokens.
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Integer
+query
+integer
+true
+none
+
+
Example responses
@@ -34683,11 +50277,12 @@ curl -X GET http://zap/JSON/httpSessions/view/defaultSes
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -34700,27 +50295,26 @@ curl -X GET http://zap/JSON/httpSessions/view/defaultSes
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-httpSessionsActionCreateEmptySession
-
+spiderActionSetOptionMaxDepth
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/httpSessions/action/createEmptySession/?site=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/setOptionMaxDepth/?Integer=0 \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/httpSessions/action/createEmptySession/?site=string");
+
URL obj = new URL("http://zap/JSON/spider/action/setOptionMaxDepth/?Integer=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -34736,37 +50330,21 @@ curl -X GET http://zap/JSON/httpSessions/action/createEm
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/httpSessions/action/createEmptySession/', params={
- 'site': 'string'
+r = requests.get('http://zap/JSON/spider/action/setOptionMaxDepth/', params={
+ 'Integer': '0'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/httpSessions/action/createEmptySession/',
- params: {
- 'site' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/httpSessions/action/createEmptySession/
+GET /JSON/spider/action/setOptionMaxDepth/
-Creates an empty session for the given site. Optionally with the given name.
+Sets the maximum depth the spider can crawl, 0 for unlimited depth.
-Parameters
+Parameters
@@ -34778,19 +50356,12 @@ curl -X GET http://zap/JSON/httpSessions/action/createEm
-site
+Integer
query
-string
+integer
true
none
-
-session
-query
-string
-false
-none
-
@@ -34799,11 +50370,12 @@ curl -X GET http://zap/JSON/httpSessions/action/createEm
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -34816,27 +50388,26 @@ curl -X GET http://zap/JSON/httpSessions/action/createEm
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-httpSessionsActionRemoveSession
-
+spiderActionSetOptionMaxDuration
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/httpSessions/action/removeSession/?site=string&session=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/setOptionMaxDuration/?Integer=0 \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/httpSessions/action/removeSession/?site=string&session=string");
+
URL obj = new URL("http://zap/JSON/spider/action/setOptionMaxDuration/?Integer=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -34852,38 +50423,19 @@ curl -X GET http://zap/JSON/httpSessions/action/removeSe
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/httpSessions/action/removeSession/', params={
- 'site': 'string', 'session': 'string'
+r = requests.get('http://zap/JSON/spider/action/setOptionMaxDuration/', params={
+ 'Integer': '0'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/httpSessions/action/removeSession/',
- params: {
- 'site' => 'string',
-'session' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/httpSessions/action/removeSession/
-
-Removes the session from the given site.
+GET /JSON/spider/action/setOptionMaxDuration/
-Parameters
+Parameters
@@ -34895,16 +50447,9 @@ curl -X GET http://zap/JSON/httpSessions/action/removeSe
-site
-query
-string
-true
-none
-
-
-session
+Integer
query
-string
+integer
true
none
@@ -34916,11 +50461,12 @@ curl -X GET http://zap/JSON/httpSessions/action/removeSe
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -34933,27 +50479,26 @@ curl -X GET http://zap/JSON/httpSessions/action/removeSe
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-httpSessionsActionSetActiveSession
-
+spiderActionSetOptionMaxParseSizeBytes
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/httpSessions/action/setActiveSession/?site=string&session=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/setOptionMaxParseSizeBytes/?Integer=0 \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/httpSessions/action/setActiveSession/?site=string&session=string");
+
URL obj = new URL("http://zap/JSON/spider/action/setOptionMaxParseSizeBytes/?Integer=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -34969,38 +50514,21 @@ curl -X GET http://zap/JSON/httpSessions/action/setActiv
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/httpSessions/action/setActiveSession/', params={
- 'site': 'string', 'session': 'string'
+r = requests.get('http://zap/JSON/spider/action/setOptionMaxParseSizeBytes/', params={
+ 'Integer': '0'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/httpSessions/action/setActiveSession/',
- params: {
- 'site' => 'string',
-'session' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/httpSessions/action/setActiveSession/
+GET /JSON/spider/action/setOptionMaxParseSizeBytes/
-Sets the given session as active for the given site.
+Sets the maximum size, in bytes, that a response might have to be parsed. This allows the spider to skip big responses/files.
-Parameters
+Parameters
@@ -35012,16 +50540,9 @@ curl -X GET http://zap/JSON/httpSessions/action/setActiv
-site
-query
-string
-true
-none
-
-
-session
+Integer
query
-string
+integer
true
none
@@ -35033,11 +50554,12 @@ curl -X GET http://zap/JSON/httpSessions/action/setActiv
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -35050,27 +50572,26 @@ curl -X GET http://zap/JSON/httpSessions/action/setActiv
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-httpSessionsActionUnsetActiveSession
-
+spiderActionSetOptionMaxScansInUI
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/httpSessions/action/unsetActiveSession/?site=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/setOptionMaxScansInUI/?Integer=0 \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/httpSessions/action/unsetActiveSession/?site=string");
+
URL obj = new URL("http://zap/JSON/spider/action/setOptionMaxScansInUI/?Integer=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -35086,37 +50607,19 @@ curl -X GET http://zap/JSON/httpSessions/action/unsetAct
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/httpSessions/action/unsetActiveSession/', params={
- 'site': 'string'
+r = requests.get('http://zap/JSON/spider/action/setOptionMaxScansInUI/', params={
+ 'Integer': '0'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/httpSessions/action/unsetActiveSession/',
- params: {
- 'site' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/httpSessions/action/unsetActiveSession/
-
-Unsets the active session of the given site.
+GET /JSON/spider/action/setOptionMaxScansInUI/
-Parameters
+Parameters
@@ -35128,9 +50631,9 @@ curl -X GET http://zap/JSON/httpSessions/action/unsetAct
-site
+Integer
query
-string
+integer
true
none
@@ -35142,11 +50645,12 @@ curl -X GET http://zap/JSON/httpSessions/action/unsetAct
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -35159,27 +50663,26 @@ curl -X GET http://zap/JSON/httpSessions/action/unsetAct
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-httpSessionsActionAddSessionToken
-
+spiderActionSetOptionParseComments
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/httpSessions/action/addSessionToken/?site=string&sessionToken=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/setOptionParseComments/?Boolean=true \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/httpSessions/action/addSessionToken/?site=string&sessionToken=string");
+
URL obj = new URL("http://zap/JSON/spider/action/setOptionParseComments/?Boolean=true");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -35195,38 +50698,19 @@ curl -X GET http://zap/JSON/httpSessions/action/addSessi
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/httpSessions/action/addSessionToken/', params={
- 'site': 'string', 'sessionToken': 'string'
+r = requests.get('http://zap/JSON/spider/action/setOptionParseComments/', params={
+ 'Boolean': 'true'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/httpSessions/action/addSessionToken/',
- params: {
- 'site' => 'string',
-'sessionToken' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/httpSessions/action/addSessionToken/
-
-Adds the session token to the given site.
+GET /JSON/spider/action/setOptionParseComments/
-Parameters
+Parameters
@@ -35238,16 +50722,9 @@ curl -X GET http://zap/JSON/httpSessions/action/addSessi
-site
-query
-string
-true
-none
-
-
-sessionToken
+Boolean
query
-string
+boolean
true
none
@@ -35259,11 +50736,12 @@ curl -X GET http://zap/JSON/httpSessions/action/addSessi
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -35276,27 +50754,26 @@ curl -X GET http://zap/JSON/httpSessions/action/addSessi
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-httpSessionsActionRemoveSessionToken
-
+spiderActionSetOptionParseDsStore
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/httpSessions/action/removeSessionToken/?site=string&sessionToken=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/setOptionParseDsStore/?Boolean=true \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/httpSessions/action/removeSessionToken/?site=string&sessionToken=string");
+
URL obj = new URL("http://zap/JSON/spider/action/setOptionParseDsStore/?Boolean=true");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -35312,38 +50789,19 @@ curl -X GET http://zap/JSON/httpSessions/action/removeSe
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/httpSessions/action/removeSessionToken/', params={
- 'site': 'string', 'sessionToken': 'string'
+r = requests.get('http://zap/JSON/spider/action/setOptionParseDsStore/', params={
+ 'Boolean': 'true'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/httpSessions/action/removeSessionToken/',
- params: {
- 'site' => 'string',
-'sessionToken' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/httpSessions/action/removeSessionToken/
+GET /JSON/spider/action/setOptionParseDsStore/
-Removes the session token from the given site.
-
-Parameters
+Parameters
@@ -35355,16 +50813,9 @@ curl -X GET http://zap/JSON/httpSessions/action/removeSe
-site
-query
-string
-true
-none
-
-
-sessionToken
+Boolean
query
-string
+boolean
true
none
@@ -35376,11 +50827,12 @@ curl -X GET http://zap/JSON/httpSessions/action/removeSe
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -35393,27 +50845,26 @@ curl -X GET http://zap/JSON/httpSessions/action/removeSe
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-httpSessionsActionSetSessionTokenValue
-
+spiderActionSetOptionParseGit
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/httpSessions/action/setSessionTokenValue/?site=string&session=string&sessionToken=string&tokenValue=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/setOptionParseGit/?Boolean=true \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/httpSessions/action/setSessionTokenValue/?site=string&session=string&sessionToken=string&tokenValue=string");
+
URL obj = new URL("http://zap/JSON/spider/action/setOptionParseGit/?Boolean=true");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -35429,40 +50880,19 @@ curl -X GET http://zap/JSON/httpSessions/action/setSessi
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/httpSessions/action/setSessionTokenValue/', params={
- 'site': 'string', 'session': 'string', 'sessionToken': 'string', 'tokenValue': 'string'
+r = requests.get('http://zap/JSON/spider/action/setOptionParseGit/', params={
+ 'Boolean': 'true'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/httpSessions/action/setSessionTokenValue/',
- params: {
- 'site' => 'string',
-'session' => 'string',
-'sessionToken' => 'string',
-'tokenValue' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/httpSessions/action/setSessionTokenValue/
-
-Sets the value of the session token of the given session for the given site.
+GET /JSON/spider/action/setOptionParseGit/
-Parameters
+Parameters
@@ -35474,30 +50904,9 @@ curl -X GET http://zap/JSON/httpSessions/action/setSessi
-site
-query
-string
-true
-none
-
-
-session
-query
-string
-true
-none
-
-
-sessionToken
-query
-string
-true
-none
-
-
-tokenValue
+Boolean
query
-string
+boolean
true
none
@@ -35509,11 +50918,12 @@ curl -X GET http://zap/JSON/httpSessions/action/setSessi
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -35526,27 +50936,26 @@ curl -X GET http://zap/JSON/httpSessions/action/setSessi
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-httpSessionsActionRenameSession
-
+spiderActionSetOptionParseRobotsTxt
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/httpSessions/action/renameSession/?site=string&oldSessionName=string&newSessionName=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/setOptionParseRobotsTxt/?Boolean=true \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/httpSessions/action/renameSession/?site=string&oldSessionName=string&newSessionName=string");
+
URL obj = new URL("http://zap/JSON/spider/action/setOptionParseRobotsTxt/?Boolean=true");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -35562,39 +50971,19 @@ curl -X GET http://zap/JSON/httpSessions/action/renameSe
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/httpSessions/action/renameSession/', params={
- 'site': 'string', 'oldSessionName': 'string', 'newSessionName': 'string'
+r = requests.get('http://zap/JSON/spider/action/setOptionParseRobotsTxt/', params={
+ 'Boolean': 'true'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/httpSessions/action/renameSession/',
- params: {
- 'site' => 'string',
-'oldSessionName' => 'string',
-'newSessionName' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/httpSessions/action/renameSession/
-
-Renames the session of the given site.
+GET /JSON/spider/action/setOptionParseRobotsTxt/
-Parameters
+Parameters
@@ -35606,23 +50995,9 @@ curl -X GET http://zap/JSON/httpSessions/action/renameSe
-site
-query
-string
-true
-none
-
-
-oldSessionName
-query
-string
-true
-none
-
-
-newSessionName
+Boolean
query
-string
+boolean
true
none
@@ -35634,11 +51009,12 @@ curl -X GET http://zap/JSON/httpSessions/action/renameSe
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -35651,27 +51027,26 @@ curl -X GET http://zap/JSON/httpSessions/action/renameSe
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-httpSessionsActionAddDefaultSessionToken
-
+spiderActionSetOptionParseSVNEntries
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/httpSessions/action/addDefaultSessionToken/?sessionToken=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/setOptionParseSVNEntries/?Boolean=true \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/httpSessions/action/addDefaultSessionToken/?sessionToken=string");
+
URL obj = new URL("http://zap/JSON/spider/action/setOptionParseSVNEntries/?Boolean=true");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -35687,37 +51062,19 @@ curl -X GET http://zap/JSON/httpSessions/action/addDefau
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/httpSessions/action/addDefaultSessionToken/', params={
- 'sessionToken': 'string'
+r = requests.get('http://zap/JSON/spider/action/setOptionParseSVNEntries/', params={
+ 'Boolean': 'true'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/httpSessions/action/addDefaultSessionToken/',
- params: {
- 'sessionToken' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/httpSessions/action/addDefaultSessionToken/
-
-Adds a default session token with the given name and enabled state.
+GET /JSON/spider/action/setOptionParseSVNEntries/
-Parameters
+Parameters
@@ -35729,19 +51086,12 @@ curl -X GET http://zap/JSON/httpSessions/action/addDefau
-sessionToken
+Boolean
query
-string
+boolean
true
none
-
-tokenEnabled
-query
-string
-false
-none
-
@@ -35750,11 +51100,12 @@ curl -X GET http://zap/JSON/httpSessions/action/addDefau
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -35767,27 +51118,26 @@ curl -X GET http://zap/JSON/httpSessions/action/addDefau
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-httpSessionsActionSetDefaultSessionTokenEnabled
-
+spiderActionSetOptionParseSitemapXml
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/httpSessions/action/setDefaultSessionTokenEnabled/?sessionToken=string&tokenEnabled=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/setOptionParseSitemapXml/?Boolean=true \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/httpSessions/action/setDefaultSessionTokenEnabled/?sessionToken=string&tokenEnabled=string");
+
URL obj = new URL("http://zap/JSON/spider/action/setOptionParseSitemapXml/?Boolean=true");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -35803,38 +51153,19 @@ curl -X GET http://zap/JSON/httpSessions/action/setDefau
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/httpSessions/action/setDefaultSessionTokenEnabled/', params={
- 'sessionToken': 'string', 'tokenEnabled': 'string'
+r = requests.get('http://zap/JSON/spider/action/setOptionParseSitemapXml/', params={
+ 'Boolean': 'true'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/httpSessions/action/setDefaultSessionTokenEnabled/',
- params: {
- 'sessionToken' => 'string',
-'tokenEnabled' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/httpSessions/action/setDefaultSessionTokenEnabled/
-
-Sets whether or not the default session token with the given name is enabled.
+GET /JSON/spider/action/setOptionParseSitemapXml/
-Parameters
+Parameters
@@ -35846,16 +51177,9 @@ curl -X GET http://zap/JSON/httpSessions/action/setDefau
-sessionToken
-query
-string
-true
-none
-
-
-tokenEnabled
+Boolean
query
-string
+boolean
true
none
@@ -35867,11 +51191,12 @@ curl -X GET http://zap/JSON/httpSessions/action/setDefau
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -35884,27 +51209,26 @@ curl -X GET http://zap/JSON/httpSessions/action/setDefau
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-httpSessionsActionRemoveDefaultSessionToken
-
+spiderActionSetOptionPostForm
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/httpSessions/action/removeDefaultSessionToken/?sessionToken=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/setOptionPostForm/?Boolean=true \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/httpSessions/action/removeDefaultSessionToken/?sessionToken=string");
+
URL obj = new URL("http://zap/JSON/spider/action/setOptionPostForm/?Boolean=true");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -35920,37 +51244,19 @@ curl -X GET http://zap/JSON/httpSessions/action/removeDe
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/httpSessions/action/removeDefaultSessionToken/', params={
- 'sessionToken': 'string'
+r = requests.get('http://zap/JSON/spider/action/setOptionPostForm/', params={
+ 'Boolean': 'true'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/httpSessions/action/removeDefaultSessionToken/',
- params: {
- 'sessionToken' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/httpSessions/action/removeDefaultSessionToken/
-
-Removes the default session token with the given name.
+GET /JSON/spider/action/setOptionPostForm/
-Parameters
+Parameters
@@ -35962,9 +51268,9 @@ curl -X GET http://zap/JSON/httpSessions/action/removeDe
-sessionToken
+Boolean
query
-string
+boolean
true
none
@@ -35976,11 +51282,12 @@ curl -X GET http://zap/JSON/httpSessions/action/removeDe
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -35993,29 +51300,26 @@ curl -X GET http://zap/JSON/httpSessions/action/removeDe
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-
-break
-breakViewIsBreakAll
-
+spiderActionSetOptionProcessForm
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/break/view/isBreakAll/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/setOptionProcessForm/?Boolean=true \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/break/view/isBreakAll/");
+
URL obj = new URL("http://zap/JSON/spider/action/setOptionProcessForm/?Boolean=true");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -36031,34 +51335,37 @@ curl -X GET http://zap/JSON/break/view/isBreakAll/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/break/view/isBreakAll/', params={
-
+r = requests.get('http://zap/JSON/spider/action/setOptionProcessForm/', params={
+ 'Boolean': 'true'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/break/view/isBreakAll/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/break/view/isBreakAll/
+GET /JSON/spider/action/setOptionProcessForm/
-Returns True if ZAP will break on both requests and responses
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Boolean
+query
+boolean
+true
+none
+
+
Example responses
@@ -36066,11 +51373,12 @@ curl -X GET http://zap/JSON/break/view/isBreakAll/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -36083,27 +51391,26 @@ curl -X GET http://zap/JSON/break/view/isBreakAll/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-breakViewIsBreakRequest
-
+spiderActionSetOptionRequestWaitTime
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/break/view/isBreakRequest/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/setOptionRequestWaitTime/?Integer=0 \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/break/view/isBreakRequest/");
+
URL obj = new URL("http://zap/JSON/spider/action/setOptionRequestWaitTime/?Integer=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -36119,34 +51426,37 @@ curl -X GET http://zap/JSON/break/view/isBreakRequest/ <
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/break/view/isBreakRequest/', params={
-
+r = requests.get('http://zap/JSON/spider/action/setOptionRequestWaitTime/', params={
+ 'Integer': '0'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/break/view/isBreakRequest/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/break/view/isBreakRequest/
+GET /JSON/spider/action/setOptionRequestWaitTime/
-Returns True if ZAP will break on requests
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Integer
+query
+integer
+true
+none
+
+
Example responses
@@ -36154,11 +51464,12 @@ curl -X GET http://zap/JSON/break/view/isBreakRequest/ <
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -36171,27 +51482,26 @@ curl -X GET http://zap/JSON/break/view/isBreakRequest/ <
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-breakViewIsBreakResponse
-
+spiderActionSetOptionSendRefererHeader
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/break/view/isBreakResponse/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/setOptionSendRefererHeader/?Boolean=true \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/break/view/isBreakResponse/");
+
URL obj = new URL("http://zap/JSON/spider/action/setOptionSendRefererHeader/?Boolean=true");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -36207,34 +51517,39 @@ curl -X GET http://zap/JSON/break/view/isBreakResponse/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/break/view/isBreakResponse/', params={
-
+r = requests.get('http://zap/JSON/spider/action/setOptionSendRefererHeader/', params={
+ 'Boolean': 'true'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+print(r.json())
-result = RestClient.get 'http://zap/JSON/break/view/isBreakResponse/',
- params: {
- }, headers: headers
+
+GET /JSON/spider/action/setOptionSendRefererHeader/
-p JSON.parse(result)
+Sets whether or not the 'Referer' header should be sent while spidering.
-
-GET /JSON/break/view/isBreakResponse/
+Parameters
-Returns True if ZAP will break on responses
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Boolean
+query
+boolean
+true
+none
+
+
Example responses
@@ -36242,11 +51557,12 @@ curl -X GET http://zap/JSON/break/view/isBreakResponse/
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -36259,27 +51575,26 @@ curl -X GET http://zap/JSON/break/view/isBreakResponse/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-breakViewHttpMessage
-
+spiderActionSetOptionShowAdvancedDialog
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/break/view/httpMessage/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/setOptionShowAdvancedDialog/?Boolean=true \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/break/view/httpMessage/");
+
URL obj = new URL("http://zap/JSON/spider/action/setOptionShowAdvancedDialog/?Boolean=true");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -36295,34 +51610,37 @@ curl -X GET http://zap/JSON/break/view/httpMessage/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/break/view/httpMessage/', params={
-
+r = requests.get('http://zap/JSON/spider/action/setOptionShowAdvancedDialog/', params={
+ 'Boolean': 'true'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/break/view/httpMessage/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/break/view/httpMessage/
+GET /JSON/spider/action/setOptionShowAdvancedDialog/
-Returns the HTTP message currently intercepted (if any)
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Boolean
+query
+boolean
+true
+none
+
+
Example responses
@@ -36330,11 +51648,12 @@ curl -X GET http://zap/JSON/break/view/httpMessage/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -36347,27 +51666,26 @@ curl -X GET http://zap/JSON/break/view/httpMessage/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-breakActionBreak
-
+spiderActionSetOptionSkipURLString
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/break/action/break/?type=string&state=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/setOptionSkipURLString/?String=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/break/action/break/?type=string&state=string");
+
URL obj = new URL("http://zap/JSON/spider/action/setOptionSkipURLString/?String=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -36383,38 +51701,19 @@ curl -X GET http://zap/JSON/break/action/break/?type
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/break/action/break/', params={
- 'type': 'string', 'state': 'string'
+r = requests.get('http://zap/JSON/spider/action/setOptionSkipURLString/', params={
+ 'String': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/break/action/break/',
- params: {
- 'type' => 'string',
-'state' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/break/action/break/
-
-Controls the global break functionality. The type may be one of: http-all, http-request or http-response. The state may be true (for turning break on for the specified type) or false (for turning break off). Scope is not currently used.
+GET /JSON/spider/action/setOptionSkipURLString/
-Parameters
+Parameters
@@ -36426,26 +51725,12 @@ curl -X GET http://zap/JSON/break/action/break/?type
-type
-query
-string
-true
-none
-
-
-state
+String
query
string
true
none
-
-scope
-query
-string
-false
-none
-
@@ -36454,11 +51739,12 @@ curl -X GET http://zap/JSON/break/action/break/?typedefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -36471,27 +51757,26 @@ curl -X GET http://zap/JSON/break/action/break/?type
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-breakActionSetHttpMessage
-
+spiderActionSetOptionThreadCount
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/break/action/setHttpMessage/?httpHeader=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/setOptionThreadCount/?Integer=0 \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/break/action/setHttpMessage/?httpHeader=string");
+
URL obj = new URL("http://zap/JSON/spider/action/setOptionThreadCount/?Integer=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -36507,37 +51792,19 @@ curl -X GET http://zap/JSON/break/action/setHttpMessage/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/break/action/setHttpMessage/', params={
- 'httpHeader': 'string'
+r = requests.get('http://zap/JSON/spider/action/setOptionThreadCount/', params={
+ 'Integer': '0'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/break/action/setHttpMessage/',
- params: {
- 'httpHeader' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/break/action/setHttpMessage/
-
-Overwrites the currently intercepted message with the data provided
+GET /JSON/spider/action/setOptionThreadCount/
-Parameters
+Parameters
@@ -36549,19 +51816,12 @@ curl -X GET http://zap/JSON/break/action/setHttpMessage/
-httpHeader
+Integer
query
-string
+integer
true
none
-
-httpBody
-query
-string
-false
-none
-
@@ -36570,11 +51830,12 @@ curl -X GET http://zap/JSON/break/action/setHttpMessage/
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -36587,27 +51848,26 @@ curl -X GET http://zap/JSON/break/action/setHttpMessage/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-breakActionContinue
-
+spiderActionSetOptionUserAgent
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/break/action/continue/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/setOptionUserAgent/?String=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/break/action/continue/");
+
URL obj = new URL("http://zap/JSON/spider/action/setOptionUserAgent/?String=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -36623,34 +51883,37 @@ curl -X GET http://zap/JSON/break/action/continue/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/break/action/continue/', params={
-
+r = requests.get('http://zap/JSON/spider/action/setOptionUserAgent/', params={
+ 'String': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/break/action/continue/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/break/action/continue/
+GET /JSON/spider/action/setOptionUserAgent/
-Submits the currently intercepted message and unsets the global request/response break points
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+String
+query
+string
+true
+none
+
+
Example responses
@@ -36658,11 +51921,12 @@ curl -X GET http://zap/JSON/break/action/continue/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -36675,27 +51939,26 @@ curl -X GET http://zap/JSON/break/action/continue/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-breakActionStep
-
+spiderActionStop
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/break/action/step/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/stop/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/break/action/step/");
+
URL obj = new URL("http://zap/JSON/spider/action/stop/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -36711,34 +51974,35 @@ curl -X GET http://zap/JSON/break/action/step/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/break/action/step/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/break/action/step/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/spider/action/stop/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/break/action/step/
+GET /JSON/spider/action/stop/
-Submits the currently intercepted message, the next request or response will automatically be intercepted
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+scanId
+query
+string
+false
+none
+
+
Example responses
@@ -36746,11 +52010,12 @@ curl -X GET http://zap/JSON/break/action/step/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -36763,27 +52028,26 @@ curl -X GET http://zap/JSON/break/action/step/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-breakActionDrop
-
+spiderActionStopAllScans
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/break/action/drop/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/action/stopAllScans/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/break/action/drop/");
+
URL obj = new URL("http://zap/JSON/spider/action/stopAllScans/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -36799,34 +52063,15 @@ curl -X GET http://zap/JSON/break/action/drop/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/break/action/drop/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/break/action/drop/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/spider/action/stopAllScans/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/break/action/drop/
-
-Drops the currently intercepted message
+GET /JSON/spider/action/stopAllScans/
Example responses
@@ -36834,11 +52079,12 @@ curl -X GET http://zap/JSON/break/action/drop/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -36851,27 +52097,26 @@ curl -X GET http://zap/JSON/break/action/drop/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-breakActionAddHttpBreakpoint
-
+spiderViewAddedNodes
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/break/action/addHttpBreakpoint/?string=string&location=string&match=string&inverse=true&ignorecase=true \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/view/addedNodes/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/break/action/addHttpBreakpoint/?string=string&location=string&match=string&inverse=true&ignorecase=true");
+
URL obj = new URL("http://zap/JSON/spider/view/addedNodes/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -36887,84 +52132,34 @@ curl -X GET http://zap/JSON/break/action/addHttpBreakpoi
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/break/action/addHttpBreakpoint/', params={
- 'string': 'string', 'location': 'string', 'match': 'string', 'inverse': 'true', 'ignorecase': 'true'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/break/action/addHttpBreakpoint/',
- params: {
- 'string' => 'string',
-'location' => 'string',
-'match' => 'string',
-'inverse' => 'boolean',
-'ignorecase' => 'boolean'
-}, headers: headers
+r = requests.get('http://zap/JSON/spider/view/addedNodes/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/break/action/addHttpBreakpoint/
-
-Adds a custom HTTP breakpoint. The string is the string to match. Location may be one of: url, request_header, request_body, response_header or response_body. Match may be: contains or regex. Inverse (match) may be true or false. Lastly, ignorecase (when matching the string) may be true or false.
+GET /JSON/spider/view/addedNodes/
-Parameters
+Returns a list of the names of the nodes added to the Sites tree by the specified scan.
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-string
-query
-string
-true
-none
-
-
-location
-query
-string
-true
-none
-
-
-match
-query
-string
-true
-none
-
-
-inverse
-query
-boolean
-true
-none
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
-ignorecase
+scanId
query
-boolean
-true
+string
+false
none
@@ -36975,11 +52170,12 @@ curl -X GET http://zap/JSON/break/action/addHttpBreakpoi
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -36992,27 +52188,26 @@ curl -X GET http://zap/JSON/break/action/addHttpBreakpoi
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-breakActionRemoveHttpBreakpoint
-
+spiderViewAllUrls
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/break/action/removeHttpBreakpoint/?string=string&location=string&match=string&inverse=true&ignorecase=true \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/view/allUrls/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/break/action/removeHttpBreakpoint/?string=string&location=string&match=string&inverse=true&ignorecase=true");
+
URL obj = new URL("http://zap/JSON/spider/view/allUrls/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -37028,87 +52223,17 @@ curl -X GET http://zap/JSON/break/action/removeHttpBreak
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/break/action/removeHttpBreakpoint/', params={
- 'string': 'string', 'location': 'string', 'match': 'string', 'inverse': 'true', 'ignorecase': 'true'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/break/action/removeHttpBreakpoint/',
- params: {
- 'string' => 'string',
-'location' => 'string',
-'match' => 'string',
-'inverse' => 'boolean',
-'ignorecase' => 'boolean'
-}, headers: headers
+r = requests.get('http://zap/JSON/spider/view/allUrls/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/break/action/removeHttpBreakpoint/
-
-Removes the specified break point
-
-Parameters
+GET /JSON/spider/view/allUrls/
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-string
-query
-string
-true
-none
-
-
-location
-query
-string
-true
-none
-
-
-match
-query
-string
-true
-none
-
-
-inverse
-query
-boolean
-true
-none
-
-
-ignorecase
-query
-boolean
-true
-none
-
-
+Returns a list of unique URLs from the history table based on HTTP messages added by the Spider.
Example responses
@@ -37116,11 +52241,12 @@ curl -X GET http://zap/JSON/break/action/removeHttpBreak
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -37133,29 +52259,26 @@ curl -X GET http://zap/JSON/break/action/removeHttpBreak
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-
-authentication
-authenticationViewGetSupportedAuthenticationMethods
-
+spiderViewDomainsAlwaysInScope
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/authentication/view/getSupportedAuthenticationMethods/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/view/domainsAlwaysInScope/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/authentication/view/getSupportedAuthenticationMethods/");
+
URL obj = new URL("http://zap/JSON/spider/view/domainsAlwaysInScope/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -37171,34 +52294,17 @@ curl -X GET http://zap/JSON/authentication/view/getSuppo
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/authentication/view/getSupportedAuthenticationMethods/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/authentication/view/getSupportedAuthenticationMethods/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/spider/view/domainsAlwaysInScope/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/authentication/view/getSupportedAuthenticationMethods/
+GET /JSON/spider/view/domainsAlwaysInScope/
-Gets the name of the authentication methods.
+Gets all the domains that are always in scope. For each domain the following are shown: the index, the value (domain), if enabled, and if specified as a regex.
Example responses
@@ -37206,11 +52312,12 @@ curl -X GET http://zap/JSON/authentication/view/getSuppo
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -37223,27 +52330,26 @@ curl -X GET http://zap/JSON/authentication/view/getSuppo
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-authenticationViewGetAuthenticationMethodConfigParams
-
+spiderViewExcludedFromScan
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/authentication/view/getAuthenticationMethodConfigParams/?authMethodName=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/view/excludedFromScan/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/authentication/view/getAuthenticationMethodConfigParams/?authMethodName=string");
+
URL obj = new URL("http://zap/JSON/spider/view/excludedFromScan/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -37259,55 +52365,17 @@ curl -X GET http://zap/JSON/authentication/view/getAuthe
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/authentication/view/getAuthenticationMethodConfigParams/', params={
- 'authMethodName': 'string'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/authentication/view/getAuthenticationMethodConfigParams/',
- params: {
- 'authMethodName' => 'string'
-}, headers: headers
+r = requests.get('http://zap/JSON/spider/view/excludedFromScan/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/authentication/view/getAuthenticationMethodConfigParams/
-
-Gets the configuration parameters for the authentication method with the given name.
-
-Parameters
+GET /JSON/spider/view/excludedFromScan/
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-authMethodName
-query
-string
-true
-none
-
-
+Gets the regexes of URLs excluded from the spider scans.
Example responses
@@ -37315,11 +52383,12 @@ curl -X GET http://zap/JSON/authentication/view/getAuthe
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -37332,27 +52401,26 @@ curl -X GET http://zap/JSON/authentication/view/getAuthe
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-authenticationViewGetAuthenticationMethod
-
+spiderViewFullResults
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/authentication/view/getAuthenticationMethod/?contextId=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/view/fullResults/?scanId=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/authentication/view/getAuthenticationMethod/?contextId=0");
+
URL obj = new URL("http://zap/JSON/spider/view/fullResults/?scanId=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -37368,37 +52436,19 @@ curl -X GET http://zap/JSON/authentication/view/getAuthe
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/authentication/view/getAuthenticationMethod/', params={
- 'contextId': '0'
+r = requests.get('http://zap/JSON/spider/view/fullResults/', params={
+ 'scanId': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/authentication/view/getAuthenticationMethod/',
- params: {
- 'contextId' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/authentication/view/getAuthenticationMethod/
-
-Gets the name of the authentication method for the context with the given ID.
+GET /JSON/spider/view/fullResults/
-Parameters
+Parameters
@@ -37410,9 +52460,9 @@ curl -X GET http://zap/JSON/authentication/view/getAuthe
-contextId
+scanId
query
-integer
+string
true
none
@@ -37424,11 +52474,12 @@ curl -X GET http://zap/JSON/authentication/view/getAuthe
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -37441,27 +52492,26 @@ curl -X GET http://zap/JSON/authentication/view/getAuthe
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-authenticationViewGetLoggedInIndicator
-
+spiderViewOptionAcceptCookies
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/authentication/view/getLoggedInIndicator/?contextId=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/view/optionAcceptCookies/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/authentication/view/getLoggedInIndicator/?contextId=0");
+
URL obj = new URL("http://zap/JSON/spider/view/optionAcceptCookies/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -37477,55 +52527,17 @@ curl -X GET http://zap/JSON/authentication/view/getLogge
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/authentication/view/getLoggedInIndicator/', params={
- 'contextId': '0'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/authentication/view/getLoggedInIndicator/',
- params: {
- 'contextId' => 'integer'
-}, headers: headers
+r = requests.get('http://zap/JSON/spider/view/optionAcceptCookies/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/authentication/view/getLoggedInIndicator/
-
-Gets the logged in indicator for the context with the given ID.
-
-Parameters
+GET /JSON/spider/view/optionAcceptCookies/
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-contextId
-query
-integer
-true
-none
-
-
+Gets whether or not a spider process should accept cookies while spidering.
Example responses
@@ -37533,11 +52545,12 @@ curl -X GET http://zap/JSON/authentication/view/getLogge
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -37550,27 +52563,26 @@ curl -X GET http://zap/JSON/authentication/view/getLogge
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-authenticationViewGetLoggedOutIndicator
-
+spiderViewOptionDomainsAlwaysInScope
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/authentication/view/getLoggedOutIndicator/?contextId=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/view/optionDomainsAlwaysInScope/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/authentication/view/getLoggedOutIndicator/?contextId=0");
+
URL obj = new URL("http://zap/JSON/spider/view/optionDomainsAlwaysInScope/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -37586,55 +52598,17 @@ curl -X GET http://zap/JSON/authentication/view/getLogge
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/authentication/view/getLoggedOutIndicator/', params={
- 'contextId': '0'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/authentication/view/getLoggedOutIndicator/',
- params: {
- 'contextId' => 'integer'
-}, headers: headers
+r = requests.get('http://zap/JSON/spider/view/optionDomainsAlwaysInScope/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/authentication/view/getLoggedOutIndicator/
-
-Gets the logged out indicator for the context with the given ID.
-
-Parameters
+GET /JSON/spider/view/optionDomainsAlwaysInScope/
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-contextId
-query
-integer
-true
-none
-
-
+Use view domainsAlwaysInScope instead.
Example responses
@@ -37642,11 +52616,12 @@ curl -X GET http://zap/JSON/authentication/view/getLogge
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -37659,27 +52634,26 @@ curl -X GET http://zap/JSON/authentication/view/getLogge
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-authenticationActionSetAuthenticationMethod
-
+spiderViewOptionDomainsAlwaysInScopeEnabled
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/authentication/action/setAuthenticationMethod/?contextId=0&authMethodName=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/view/optionDomainsAlwaysInScopeEnabled/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/authentication/action/setAuthenticationMethod/?contextId=0&authMethodName=string");
+
URL obj = new URL("http://zap/JSON/spider/view/optionDomainsAlwaysInScopeEnabled/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -37695,70 +52669,17 @@ curl -X GET http://zap/JSON/authentication/action/setAut
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/authentication/action/setAuthenticationMethod/', params={
- 'contextId': '0', 'authMethodName': 'string'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/authentication/action/setAuthenticationMethod/',
- params: {
- 'contextId' => 'integer',
-'authMethodName' => 'string'
-}, headers: headers
+r = requests.get('http://zap/JSON/spider/view/optionDomainsAlwaysInScopeEnabled/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/authentication/action/setAuthenticationMethod/
-
-Sets the authentication method for the context with the given ID.
-
-Parameters
+GET /JSON/spider/view/optionDomainsAlwaysInScopeEnabled/
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-contextId
-query
-integer
-true
-none
-
-
-authMethodName
-query
-string
-true
-none
-
-
-authMethodConfigParams
-query
-string
-false
-none
-
-
+Use view domainsAlwaysInScope instead.
Example responses
@@ -37766,11 +52687,12 @@ curl -X GET http://zap/JSON/authentication/action/setAut
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -37783,27 +52705,26 @@ curl -X GET http://zap/JSON/authentication/action/setAut
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-authenticationActionSetLoggedInIndicator
-
+spiderViewOptionHandleODataParametersVisited
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/authentication/action/setLoggedInIndicator/?contextId=0&loggedInIndicatorRegex=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/view/optionHandleODataParametersVisited/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/authentication/action/setLoggedInIndicator/?contextId=0&loggedInIndicatorRegex=string");
+
URL obj = new URL("http://zap/JSON/spider/view/optionHandleODataParametersVisited/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -37819,63 +52740,15 @@ curl -X GET http://zap/JSON/authentication/action/setLog
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/authentication/action/setLoggedInIndicator/', params={
- 'contextId': '0', 'loggedInIndicatorRegex': 'string'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/authentication/action/setLoggedInIndicator/',
- params: {
- 'contextId' => 'integer',
-'loggedInIndicatorRegex' => 'string'
-}, headers: headers
+r = requests.get('http://zap/JSON/spider/view/optionHandleODataParametersVisited/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/authentication/action/setLoggedInIndicator/
-
-Sets the logged in indicator for the context with the given ID.
-
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-contextId
-query
-integer
-true
-none
-
-
-loggedInIndicatorRegex
-query
-string
-true
-none
-
-
+GET /JSON/spider/view/optionHandleODataParametersVisited/
Example responses
@@ -37883,11 +52756,12 @@ curl -X GET http://zap/JSON/authentication/action/setLog
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -37900,27 +52774,26 @@ curl -X GET http://zap/JSON/authentication/action/setLog
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-authenticationActionSetLoggedOutIndicator
-
+spiderViewOptionHandleParameters
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/authentication/action/setLoggedOutIndicator/?contextId=0&loggedOutIndicatorRegex=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/view/optionHandleParameters/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/authentication/action/setLoggedOutIndicator/?contextId=0&loggedOutIndicatorRegex=string");
+
URL obj = new URL("http://zap/JSON/spider/view/optionHandleParameters/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -37936,63 +52809,15 @@ curl -X GET http://zap/JSON/authentication/action/setLog
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/authentication/action/setLoggedOutIndicator/', params={
- 'contextId': '0', 'loggedOutIndicatorRegex': 'string'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/authentication/action/setLoggedOutIndicator/',
- params: {
- 'contextId' => 'integer',
-'loggedOutIndicatorRegex' => 'string'
-}, headers: headers
+r = requests.get('http://zap/JSON/spider/view/optionHandleParameters/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/authentication/action/setLoggedOutIndicator/
-
-Sets the logged out indicator for the context with the given ID.
-
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-contextId
-query
-integer
-true
-none
-
-
-loggedOutIndicatorRegex
-query
-string
-true
-none
-
-
+GET /JSON/spider/view/optionHandleParameters/
Example responses
@@ -38000,11 +52825,12 @@ curl -X GET http://zap/JSON/authentication/action/setLog
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -38017,29 +52843,26 @@ curl -X GET http://zap/JSON/authentication/action/setLog
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-
-authorization
-authorizationViewGetAuthorizationDetectionMethod
-
+spiderViewOptionMaxChildren
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/authorization/view/getAuthorizationDetectionMethod/?contextId=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/view/optionMaxChildren/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/authorization/view/getAuthorizationDetectionMethod/?contextId=0");
+
URL obj = new URL("http://zap/JSON/spider/view/optionMaxChildren/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -38055,55 +52878,17 @@ curl -X GET http://zap/JSON/authorization/view/getAuthor
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/authorization/view/getAuthorizationDetectionMethod/', params={
- 'contextId': '0'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/authorization/view/getAuthorizationDetectionMethod/',
- params: {
- 'contextId' => 'integer'
-}, headers: headers
+r = requests.get('http://zap/JSON/spider/view/optionMaxChildren/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/authorization/view/getAuthorizationDetectionMethod/
-
-Obtains all the configuration of the authorization detection method that is currently set for a context.
-
-Parameters
+GET /JSON/spider/view/optionMaxChildren/
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-contextId
-query
-integer
-true
-none
-
-
+Gets the maximum number of child nodes (per node) that can be crawled, 0 means no limit.
Example responses
@@ -38111,11 +52896,12 @@ curl -X GET http://zap/JSON/authorization/view/getAuthor
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -38128,27 +52914,26 @@ curl -X GET http://zap/JSON/authorization/view/getAuthor
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-authorizationActionSetBasicAuthorizationDetectionMethod
-
+spiderViewOptionMaxDepth
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/authorization/action/setBasicAuthorizationDetectionMethod/?contextId=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/view/optionMaxDepth/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/authorization/action/setBasicAuthorizationDetectionMethod/?contextId=0");
+
URL obj = new URL("http://zap/JSON/spider/view/optionMaxDepth/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -38164,83 +52949,17 @@ curl -X GET http://zap/JSON/authorization/action/setBasi
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/authorization/action/setBasicAuthorizationDetectionMethod/', params={
- 'contextId': '0'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/authorization/action/setBasicAuthorizationDetectionMethod/',
- params: {
- 'contextId' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
-
-
-GET /JSON/authorization/action/setBasicAuthorizationDetectionMethod/
-
-Sets the authorization detection method for a context as one that identifies un-authorized messages based on: the message's status code or a regex pattern in the response's header or body. Also, whether all conditions must match or just some can be specified via the logicalOperator parameter, which accepts two values: "AND" (default), "OR".
-
-Parameters
+r = requests.get('http://zap/JSON/spider/view/optionMaxDepth/', headers = headers)
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-contextId
-query
-integer
-true
-none
-
-
-headerRegex
-query
-string
-false
-none
-
-
-bodyRegex
-query
-string
-false
-none
-
-
-statusCode
-query
-string
-false
-none
-
-
-logicalOperator
-query
-string
-false
-none
-
-
+print(r.json())
+
+
+GET /JSON/spider/view/optionMaxDepth/
+
+Gets the maximum depth the spider can crawl, 0 if unlimited.
Example responses
@@ -38248,11 +52967,12 @@ curl -X GET http://zap/JSON/authorization/action/setBasi
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -38265,29 +52985,26 @@ curl -X GET http://zap/JSON/authorization/action/setBasi
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-
-localProxies
-localProxiesViewAdditionalProxies
-
+spiderViewOptionMaxDuration
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/localProxies/view/additionalProxies/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/view/optionMaxDuration/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/localProxies/view/additionalProxies/");
+
URL obj = new URL("http://zap/JSON/spider/view/optionMaxDuration/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -38303,34 +53020,15 @@ curl -X GET http://zap/JSON/localProxies/view/additional
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/localProxies/view/additionalProxies/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/localProxies/view/additionalProxies/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/spider/view/optionMaxDuration/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/localProxies/view/additionalProxies/
-
-Gets all of the additional proxies that have been configured.
+GET /JSON/spider/view/optionMaxDuration/
Example responses
@@ -38338,11 +53036,12 @@ curl -X GET http://zap/JSON/localProxies/view/additional
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -38355,27 +53054,26 @@ curl -X GET http://zap/JSON/localProxies/view/additional
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-localProxiesActionAddAdditionalProxy
-
+spiderViewOptionMaxParseSizeBytes
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/localProxies/action/addAdditionalProxy/?address=string&port=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/view/optionMaxParseSizeBytes/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/localProxies/action/addAdditionalProxy/?address=string&port=0");
+
URL obj = new URL("http://zap/JSON/spider/view/optionMaxParseSizeBytes/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -38391,84 +53089,17 @@ curl -X GET http://zap/JSON/localProxies/action/addAddit
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/localProxies/action/addAdditionalProxy/', params={
- 'address': 'string', 'port': '0'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/localProxies/action/addAdditionalProxy/',
- params: {
- 'address' => 'string',
-'port' => 'integer'
-}, headers: headers
+r = requests.get('http://zap/JSON/spider/view/optionMaxParseSizeBytes/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/localProxies/action/addAdditionalProxy/
-
-Adds an new proxy using the details supplied.
-
-Parameters
+GET /JSON/spider/view/optionMaxParseSizeBytes/
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-address
-query
-string
-true
-none
-
-
-port
-query
-integer
-true
-none
-
-
-behindNat
-query
-boolean
-false
-none
-
-
-alwaysDecodeZip
-query
-boolean
-false
-none
-
-
-removeUnsupportedEncodings
-query
-boolean
-false
-none
-
-
+Gets the maximum size, in bytes, that a response might have to be parsed.
Example responses
@@ -38476,11 +53107,12 @@ curl -X GET http://zap/JSON/localProxies/action/addAddit
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -38493,27 +53125,26 @@ curl -X GET http://zap/JSON/localProxies/action/addAddit
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-localProxiesActionRemoveAdditionalProxy
-
+spiderViewOptionMaxScansInUI
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/localProxies/action/removeAdditionalProxy/?address=string&port=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/view/optionMaxScansInUI/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/localProxies/action/removeAdditionalProxy/?address=string&port=0");
+
URL obj = new URL("http://zap/JSON/spider/view/optionMaxScansInUI/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -38529,63 +53160,15 @@ curl -X GET http://zap/JSON/localProxies/action/removeAd
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/localProxies/action/removeAdditionalProxy/', params={
- 'address': 'string', 'port': '0'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/localProxies/action/removeAdditionalProxy/',
- params: {
- 'address' => 'string',
-'port' => 'integer'
-}, headers: headers
+r = requests.get('http://zap/JSON/spider/view/optionMaxScansInUI/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/localProxies/action/removeAdditionalProxy/
-
-Removes the additional proxy with the specified address and port.
-
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-address
-query
-string
-true
-none
-
-
-port
-query
-integer
-true
-none
-
-
+GET /JSON/spider/view/optionMaxScansInUI/
Example responses
@@ -38593,11 +53176,12 @@ curl -X GET http://zap/JSON/localProxies/action/removeAd
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -38610,29 +53194,26 @@ curl -X GET http://zap/JSON/localProxies/action/removeAd
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-
-ruleConfig
-ruleConfigViewRuleConfigValue
-
+spiderViewOptionParseComments
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ruleConfig/view/ruleConfigValue/?key=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/view/optionParseComments/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ruleConfig/view/ruleConfigValue/?key=string");
+
URL obj = new URL("http://zap/JSON/spider/view/optionParseComments/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -38648,55 +53229,15 @@ curl -X GET http://zap/JSON/ruleConfig/view/ruleConfigVa
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/ruleConfig/view/ruleConfigValue/', params={
- 'key': 'string'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/ruleConfig/view/ruleConfigValue/',
- params: {
- 'key' => 'string'
-}, headers: headers
+r = requests.get('http://zap/JSON/spider/view/optionParseComments/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ruleConfig/view/ruleConfigValue/
-
-Show the specified rule configuration
-
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-key
-query
-string
-true
-none
-
-
+GET /JSON/spider/view/optionParseComments/
Example responses
@@ -38704,11 +53245,12 @@ curl -X GET http://zap/JSON/ruleConfig/view/ruleConfigVa
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -38721,27 +53263,26 @@ curl -X GET http://zap/JSON/ruleConfig/view/ruleConfigVa
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ruleConfigViewAllRuleConfigs
-
+spiderViewOptionParseDsStore
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ruleConfig/view/allRuleConfigs/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/view/optionParseDsStore/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ruleConfig/view/allRuleConfigs/");
+
URL obj = new URL("http://zap/JSON/spider/view/optionParseDsStore/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -38757,34 +53298,15 @@ curl -X GET http://zap/JSON/ruleConfig/view/allRuleConfi
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/ruleConfig/view/allRuleConfigs/', params={
+r = requests.get('http://zap/JSON/spider/view/optionParseDsStore/', headers = headers)
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/ruleConfig/view/allRuleConfigs/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ruleConfig/view/allRuleConfigs/
-
-Show all of the rule configurations
+GET /JSON/spider/view/optionParseDsStore/
Example responses
@@ -38792,11 +53314,12 @@ curl -X GET http://zap/JSON/ruleConfig/view/allRuleConfi
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -38809,27 +53332,26 @@ curl -X GET http://zap/JSON/ruleConfig/view/allRuleConfi
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ruleConfigActionResetRuleConfigValue
-
+spiderViewOptionParseGit
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ruleConfig/action/resetRuleConfigValue/?key=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/view/optionParseGit/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ruleConfig/action/resetRuleConfigValue/?key=string");
+
URL obj = new URL("http://zap/JSON/spider/view/optionParseGit/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -38845,55 +53367,15 @@ curl -X GET http://zap/JSON/ruleConfig/action/resetRuleC
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/ruleConfig/action/resetRuleConfigValue/', params={
- 'key': 'string'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/ruleConfig/action/resetRuleConfigValue/',
- params: {
- 'key' => 'string'
-}, headers: headers
+r = requests.get('http://zap/JSON/spider/view/optionParseGit/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ruleConfig/action/resetRuleConfigValue/
-
-Reset the specified rule configuration, which must already exist
-
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-key
-query
-string
-true
-none
-
-
+GET /JSON/spider/view/optionParseGit/
Example responses
@@ -38901,11 +53383,12 @@ curl -X GET http://zap/JSON/ruleConfig/action/resetRuleC
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -38918,27 +53401,26 @@ curl -X GET http://zap/JSON/ruleConfig/action/resetRuleC
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ruleConfigActionResetAllRuleConfigValues
-
+spiderViewOptionParseRobotsTxt
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ruleConfig/action/resetAllRuleConfigValues/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/view/optionParseRobotsTxt/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ruleConfig/action/resetAllRuleConfigValues/");
+
URL obj = new URL("http://zap/JSON/spider/view/optionParseRobotsTxt/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -38954,34 +53436,15 @@ curl -X GET http://zap/JSON/ruleConfig/action/resetAllRu
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/ruleConfig/action/resetAllRuleConfigValues/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/ruleConfig/action/resetAllRuleConfigValues/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/spider/view/optionParseRobotsTxt/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ruleConfig/action/resetAllRuleConfigValues/
-
-Reset all of the rule configurations
+GET /JSON/spider/view/optionParseRobotsTxt/
Example responses
@@ -38989,11 +53452,12 @@ curl -X GET http://zap/JSON/ruleConfig/action/resetAllRu
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -39006,27 +53470,26 @@ curl -X GET http://zap/JSON/ruleConfig/action/resetAllRu
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-ruleConfigActionSetRuleConfigValue
-
+spiderViewOptionParseSVNEntries
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/ruleConfig/action/setRuleConfigValue/?key=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/view/optionParseSVNEntries/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/ruleConfig/action/setRuleConfigValue/?key=string");
+
URL obj = new URL("http://zap/JSON/spider/view/optionParseSVNEntries/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -39042,62 +53505,15 @@ curl -X GET http://zap/JSON/ruleConfig/action/setRuleCon
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/ruleConfig/action/setRuleConfigValue/', params={
- 'key': 'string'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/ruleConfig/action/setRuleConfigValue/',
- params: {
- 'key' => 'string'
-}, headers: headers
+r = requests.get('http://zap/JSON/spider/view/optionParseSVNEntries/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/ruleConfig/action/setRuleConfigValue/
-
-Set the specified rule configuration, which must already exist
-
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-key
-query
-string
-true
-none
-
-
-value
-query
-string
-false
-none
-
-
+GET /JSON/spider/view/optionParseSVNEntries/
Example responses
@@ -39105,11 +53521,12 @@ curl -X GET http://zap/JSON/ruleConfig/action/setRuleCon
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -39122,29 +53539,26 @@ curl -X GET http://zap/JSON/ruleConfig/action/setRuleCon
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-
-sessionManagement
-sessionManagementViewGetSupportedSessionManagementMethods
-
+spiderViewOptionParseSitemapXml
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/sessionManagement/view/getSupportedSessionManagementMethods/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/view/optionParseSitemapXml/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/sessionManagement/view/getSupportedSessionManagementMethods/");
+
URL obj = new URL("http://zap/JSON/spider/view/optionParseSitemapXml/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -39160,34 +53574,15 @@ curl -X GET http://zap/JSON/sessionManagement/view/getSu
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/sessionManagement/view/getSupportedSessionManagementMethods/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/sessionManagement/view/getSupportedSessionManagementMethods/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/spider/view/optionParseSitemapXml/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/sessionManagement/view/getSupportedSessionManagementMethods/
-
-Gets the name of the session management methods.
+GET /JSON/spider/view/optionParseSitemapXml/
Example responses
@@ -39195,11 +53590,12 @@ curl -X GET http://zap/JSON/sessionManagement/view/getSu
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -39212,27 +53608,26 @@ curl -X GET http://zap/JSON/sessionManagement/view/getSu
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-sessionManagementViewGetSessionManagementMethodConfigParams
-
+spiderViewOptionPostForm
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/sessionManagement/view/getSessionManagementMethodConfigParams/?methodName=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/view/optionPostForm/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/sessionManagement/view/getSessionManagementMethodConfigParams/?methodName=string");
+
URL obj = new URL("http://zap/JSON/spider/view/optionPostForm/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -39248,55 +53643,15 @@ curl -X GET http://zap/JSON/sessionManagement/view/getSe
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/sessionManagement/view/getSessionManagementMethodConfigParams/', params={
- 'methodName': 'string'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/sessionManagement/view/getSessionManagementMethodConfigParams/',
- params: {
- 'methodName' => 'string'
-}, headers: headers
+r = requests.get('http://zap/JSON/spider/view/optionPostForm/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/sessionManagement/view/getSessionManagementMethodConfigParams/
-
-Gets the configuration parameters for the session management method with the given name.
-
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-methodName
-query
-string
-true
-none
-
-
+GET /JSON/spider/view/optionPostForm/
Example responses
@@ -39304,11 +53659,12 @@ curl -X GET http://zap/JSON/sessionManagement/view/getSe
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -39321,27 +53677,26 @@ curl -X GET http://zap/JSON/sessionManagement/view/getSe
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-sessionManagementViewGetSessionManagementMethod
-
+spiderViewOptionProcessForm
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/sessionManagement/view/getSessionManagementMethod/?contextId=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/view/optionProcessForm/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/sessionManagement/view/getSessionManagementMethod/?contextId=0");
+
URL obj = new URL("http://zap/JSON/spider/view/optionProcessForm/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -39357,55 +53712,15 @@ curl -X GET http://zap/JSON/sessionManagement/view/getSe
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/sessionManagement/view/getSessionManagementMethod/', params={
- 'contextId': '0'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/sessionManagement/view/getSessionManagementMethod/',
- params: {
- 'contextId' => 'integer'
-}, headers: headers
+r = requests.get('http://zap/JSON/spider/view/optionProcessForm/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/sessionManagement/view/getSessionManagementMethod/
-
-Gets the name of the session management method for the context with the given ID.
-
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-contextId
-query
-integer
-true
-none
-
-
+GET /JSON/spider/view/optionProcessForm/
Example responses
@@ -39413,11 +53728,12 @@ curl -X GET http://zap/JSON/sessionManagement/view/getSe
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -39430,27 +53746,26 @@ curl -X GET http://zap/JSON/sessionManagement/view/getSe
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-sessionManagementActionSetSessionManagementMethod
-
+spiderViewOptionRequestWaitTime
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/sessionManagement/action/setSessionManagementMethod/?contextId=0&methodName=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/view/optionRequestWaitTime/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/sessionManagement/action/setSessionManagementMethod/?contextId=0&methodName=string");
+
URL obj = new URL("http://zap/JSON/spider/view/optionRequestWaitTime/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -39466,82 +53781,99 @@ curl -X GET http://zap/JSON/sessionManagement/action/set
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/sessionManagement/action/setSessionManagementMethod/', params={
- 'contextId': '0', 'methodName': 'string'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/sessionManagement/action/setSessionManagementMethod/',
- params: {
- 'contextId' => 'integer',
-'methodName' => 'string'
-}, headers: headers
+r = requests.get('http://zap/JSON/spider/view/optionRequestWaitTime/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/sessionManagement/action/setSessionManagementMethod/
+GET /JSON/spider/view/optionRequestWaitTime/
-Sets the session management method for the context with the given ID.
+
+Example responses
-Parameters
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
-Name
-In
-Type
-Required
+Status
+Meaning
Description
+Schema
-contextId
-query
-integer
-true
-none
-
-
-methodName
-query
-string
-true
-none
-
-
-methodConfigParams
-query
-string
-false
-none
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+spiderViewOptionSendRefererHeader
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/spider/view/optionSendRefererHeader/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/spider/view/optionSendRefererHeader/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/spider/view/optionSendRefererHeader/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/spider/view/optionSendRefererHeader/
+
+Gets whether or not the 'Referer' header should be sent while spidering.
+
Example responses
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -39554,29 +53886,26 @@ curl -X GET http://zap/JSON/sessionManagement/action/set
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-
-users
-usersViewUsersList
-
+spiderViewOptionShowAdvancedDialog
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/users/view/usersList/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/view/optionShowAdvancedDialog/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/users/view/usersList/");
+
URL obj = new URL("http://zap/JSON/spider/view/optionShowAdvancedDialog/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -39592,54 +53921,15 @@ curl -X GET http://zap/JSON/users/view/usersList/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/users/view/usersList/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/users/view/usersList/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/spider/view/optionShowAdvancedDialog/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/users/view/usersList/
-
-Gets a list of users that belong to the context with the given ID, or all users if none provided.
-
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-contextId
-query
-integer
-false
-none
-
-
+GET /JSON/spider/view/optionShowAdvancedDialog/
Example responses
@@ -39647,11 +53937,12 @@ curl -X GET http://zap/JSON/users/view/usersList/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -39664,27 +53955,26 @@ curl -X GET http://zap/JSON/users/view/usersList/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-usersViewGetUserById
-
+spiderViewOptionSkipURLString
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/users/view/getUserById/?contextId=0&userId=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/view/optionSkipURLString/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/users/view/getUserById/?contextId=0&userId=0");
+
URL obj = new URL("http://zap/JSON/spider/view/optionSkipURLString/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -39700,63 +53990,15 @@ curl -X GET http://zap/JSON/users/view/getUserById/?cont
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/users/view/getUserById/', params={
- 'contextId': '0', 'userId': '0'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/users/view/getUserById/',
- params: {
- 'contextId' => 'integer',
-'userId' => 'integer'
-}, headers: headers
+r = requests.get('http://zap/JSON/spider/view/optionSkipURLString/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/users/view/getUserById/
-
-Gets the data of the user with the given ID that belongs to the context with the given ID.
-
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-contextId
-query
-integer
-true
-none
-
-
-userId
-query
-integer
-true
-none
-
-
+GET /JSON/spider/view/optionSkipURLString/
Example responses
@@ -39764,11 +54006,12 @@ curl -X GET http://zap/JSON/users/view/getUserById/?cont
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -39781,27 +54024,26 @@ curl -X GET http://zap/JSON/users/view/getUserById/?cont
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-usersViewGetAuthenticationCredentialsConfigParams
-
+spiderViewOptionThreadCount
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/users/view/getAuthenticationCredentialsConfigParams/?contextId=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/view/optionThreadCount/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/users/view/getAuthenticationCredentialsConfigParams/?contextId=0");
+
URL obj = new URL("http://zap/JSON/spider/view/optionThreadCount/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -39817,55 +54059,15 @@ curl -X GET http://zap/JSON/users/view/getAuthentication
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/users/view/getAuthenticationCredentialsConfigParams/', params={
- 'contextId': '0'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/users/view/getAuthenticationCredentialsConfigParams/',
- params: {
- 'contextId' => 'integer'
-}, headers: headers
+r = requests.get('http://zap/JSON/spider/view/optionThreadCount/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/users/view/getAuthenticationCredentialsConfigParams/
-
-Gets the configuration parameters for the credentials of the context with the given ID.
-
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-contextId
-query
-integer
-true
-none
-
-
+GET /JSON/spider/view/optionThreadCount/
Example responses
@@ -39873,11 +54075,12 @@ curl -X GET http://zap/JSON/users/view/getAuthentication
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -39890,27 +54093,26 @@ curl -X GET http://zap/JSON/users/view/getAuthentication
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-usersViewGetAuthenticationCredentials
-
+spiderViewOptionUserAgent
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/users/view/getAuthenticationCredentials/?contextId=0&userId=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/view/optionUserAgent/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/users/view/getAuthenticationCredentials/?contextId=0&userId=0");
+
URL obj = new URL("http://zap/JSON/spider/view/optionUserAgent/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -39926,63 +54128,15 @@ curl -X GET http://zap/JSON/users/view/getAuthentication
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/users/view/getAuthenticationCredentials/', params={
- 'contextId': '0', 'userId': '0'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/users/view/getAuthenticationCredentials/',
- params: {
- 'contextId' => 'integer',
-'userId' => 'integer'
-}, headers: headers
+r = requests.get('http://zap/JSON/spider/view/optionUserAgent/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/users/view/getAuthenticationCredentials/
-
-Gets the authentication credentials of the user with given ID that belongs to the context with the given ID.
-
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-contextId
-query
-integer
-true
-none
-
-
-userId
-query
-integer
-true
-none
-
-
+GET /JSON/spider/view/optionUserAgent/
Example responses
@@ -39990,11 +54144,12 @@ curl -X GET http://zap/JSON/users/view/getAuthentication
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -40007,27 +54162,26 @@ curl -X GET http://zap/JSON/users/view/getAuthentication
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-usersActionNewUser
-
+spiderViewResults
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/users/action/newUser/?contextId=0&name=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/view/results/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/users/action/newUser/?contextId=0&name=string");
+
URL obj = new URL("http://zap/JSON/spider/view/results/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -40043,38 +54197,17 @@ curl -X GET http://zap/JSON/users/action/newUser/?contex
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/users/action/newUser/', params={
- 'contextId': '0', 'name': 'string'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/users/action/newUser/',
- params: {
- 'contextId' => 'integer',
-'name' => 'string'
-}, headers: headers
+r = requests.get('http://zap/JSON/spider/view/results/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/users/action/newUser/
-
-Creates a new user with the given name for the context with the given ID.
+GET /JSON/spider/view/results/
-Parameters
+Parameters
@@ -40086,17 +54219,10 @@ curl -X GET http://zap/JSON/users/action/newUser/?contex
-contextId
-query
-integer
-true
-none
-
-
-name
+scanId
query
string
-true
+false
none
@@ -40107,11 +54233,12 @@ curl -X GET http://zap/JSON/users/action/newUser/?contex
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -40124,27 +54251,26 @@ curl -X GET http://zap/JSON/users/action/newUser/?contex
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-usersActionRemoveUser
-
+spiderViewScans
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/users/action/removeUser/?contextId=0&userId=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/view/scans/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/users/action/removeUser/?contextId=0&userId=0");
+
URL obj = new URL("http://zap/JSON/spider/view/scans/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -40160,63 +54286,15 @@ curl -X GET http://zap/JSON/users/action/removeUser/?con
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/users/action/removeUser/', params={
- 'contextId': '0', 'userId': '0'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/users/action/removeUser/',
- params: {
- 'contextId' => 'integer',
-'userId' => 'integer'
-}, headers: headers
+r = requests.get('http://zap/JSON/spider/view/scans/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/users/action/removeUser/
-
-Removes the user with the given ID that belongs to the context with the given ID.
-
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-contextId
-query
-integer
-true
-none
-
-
-userId
-query
-integer
-true
-none
-
-
+GET /JSON/spider/view/scans/
Example responses
@@ -40224,11 +54302,12 @@ curl -X GET http://zap/JSON/users/action/removeUser/?con
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -40241,27 +54320,26 @@ curl -X GET http://zap/JSON/users/action/removeUser/?con
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-usersActionSetUserEnabled
-
+spiderViewStatus
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/users/action/setUserEnabled/?contextId=0&userId=0&enabled=true \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/spider/view/status/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/users/action/setUserEnabled/?contextId=0&userId=0&enabled=true");
+
URL obj = new URL("http://zap/JSON/spider/view/status/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -40277,39 +54355,17 @@ curl -X GET http://zap/JSON/users/action/setUserEnabled/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/users/action/setUserEnabled/', params={
- 'contextId': '0', 'userId': '0', 'enabled': 'true'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/users/action/setUserEnabled/',
- params: {
- 'contextId' => 'integer',
-'userId' => 'integer',
-'enabled' => 'boolean'
-}, headers: headers
+r = requests.get('http://zap/JSON/spider/view/status/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/users/action/setUserEnabled/
-
-Sets whether or not the user, with the given ID that belongs to the context with the given ID, should be enabled.
+GET /JSON/spider/view/status/
-Parameters
+Parameters
@@ -40321,24 +54377,10 @@ curl -X GET http://zap/JSON/users/action/setUserEnabled/
-contextId
-query
-integer
-true
-none
-
-
-userId
-query
-integer
-true
-none
-
-
-enabled
+scanId
query
-boolean
-true
+string
+false
none
@@ -40349,11 +54391,12 @@ curl -X GET http://zap/JSON/users/action/setUserEnabled/
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -40366,27 +54409,28 @@ curl -X GET http://zap/JSON/users/action/setUserEnabled/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-usersActionSetUserName
-
+
+stats
+statsActionClearStats
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/users/action/setUserName/?contextId=0&userId=0&name=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/stats/action/clearStats/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/users/action/setUserName/?contextId=0&userId=0&name=string");
+
URL obj = new URL("http://zap/JSON/stats/action/clearStats/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -40402,39 +54446,19 @@ curl -X GET http://zap/JSON/users/action/setUserName/?co
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/users/action/setUserName/', params={
- 'contextId': '0', 'userId': '0', 'name': 'string'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/users/action/setUserName/',
- params: {
- 'contextId' => 'integer',
-'userId' => 'integer',
-'name' => 'string'
-}, headers: headers
+r = requests.get('http://zap/JSON/stats/action/clearStats/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/users/action/setUserName/
+GET /JSON/stats/action/clearStats/
-Renames the user with the given ID that belongs to the context with the given ID.
+Clears all of the statistics
-Parameters
+Parameters
@@ -40446,24 +54470,10 @@ curl -X GET http://zap/JSON/users/action/setUserName/?co
-contextId
-query
-integer
-true
-none
-
-
-userId
-query
-integer
-true
-none
-
-
-name
+keyPrefix
query
string
-true
+false
none
@@ -40474,11 +54484,12 @@ curl -X GET http://zap/JSON/users/action/setUserName/?co
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -40491,27 +54502,26 @@ curl -X GET http://zap/JSON/users/action/setUserName/?co
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-usersActionSetAuthenticationCredentials
-
+statsActionSetOptionInMemoryEnabled
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/users/action/setAuthenticationCredentials/?contextId=0&userId=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/stats/action/setOptionInMemoryEnabled/?Boolean=true \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/users/action/setAuthenticationCredentials/?contextId=0&userId=0");
+
URL obj = new URL("http://zap/JSON/stats/action/setOptionInMemoryEnabled/?Boolean=true");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -40527,38 +54537,21 @@ curl -X GET http://zap/JSON/users/action/setAuthenticati
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/users/action/setAuthenticationCredentials/', params={
- 'contextId': '0', 'userId': '0'
+r = requests.get('http://zap/JSON/stats/action/setOptionInMemoryEnabled/', params={
+ 'Boolean': 'true'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/users/action/setAuthenticationCredentials/',
- params: {
- 'contextId' => 'integer',
-'userId' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/users/action/setAuthenticationCredentials/
+GET /JSON/stats/action/setOptionInMemoryEnabled/
-Sets the authentication credentials for the user with the given ID that belongs to the context with the given ID.
+Sets whether in memory statistics are enabled
-Parameters
+Parameters
@@ -40570,26 +54563,12 @@ curl -X GET http://zap/JSON/users/action/setAuthenticati
-contextId
-query
-integer
-true
-none
-
-
-userId
+Boolean
query
-integer
+boolean
true
none
-
-authCredentialsConfigParams
-query
-string
-false
-none
-
@@ -40598,11 +54577,12 @@ curl -X GET http://zap/JSON/users/action/setAuthenticati
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -40615,29 +54595,26 @@ curl -X GET http://zap/JSON/users/action/setAuthenticati
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-
-forcedUser
-forcedUserViewIsForcedUserModeEnabled
-
+statsActionSetOptionStatsdHost
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/forcedUser/view/isForcedUserModeEnabled/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/stats/action/setOptionStatsdHost/?String=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/forcedUser/view/isForcedUserModeEnabled/");
+
URL obj = new URL("http://zap/JSON/stats/action/setOptionStatsdHost/?String=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -40653,34 +54630,39 @@ curl -X GET http://zap/JSON/forcedUser/view/isForcedUser
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/forcedUser/view/isForcedUserModeEnabled/', params={
-
+r = requests.get('http://zap/JSON/stats/action/setOptionStatsdHost/', params={
+ 'String': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+print(r.json())
-result = RestClient.get 'http://zap/JSON/forcedUser/view/isForcedUserModeEnabled/',
- params: {
- }, headers: headers
+
+GET /JSON/stats/action/setOptionStatsdHost/
-p JSON.parse(result)
+Sets the Statsd service hostname, supply an empty string to stop using a Statsd service
-
-GET /JSON/forcedUser/view/isForcedUserModeEnabled/
+Parameters
-Returns 'true' if 'forced user' mode is enabled, 'false' otherwise
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+String
+query
+string
+true
+none
+
+
Example responses
@@ -40688,11 +54670,12 @@ curl -X GET http://zap/JSON/forcedUser/view/isForcedUser
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -40705,27 +54688,26 @@ curl -X GET http://zap/JSON/forcedUser/view/isForcedUser
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-forcedUserViewGetForcedUser
-
+statsActionSetOptionStatsdPort
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/forcedUser/view/getForcedUser/?contextId=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/stats/action/setOptionStatsdPort/?Integer=0 \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/forcedUser/view/getForcedUser/?contextId=0");
+
URL obj = new URL("http://zap/JSON/stats/action/setOptionStatsdPort/?Integer=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -40741,37 +54723,21 @@ curl -X GET http://zap/JSON/forcedUser/view/getForcedUse
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/forcedUser/view/getForcedUser/', params={
- 'contextId': '0'
+r = requests.get('http://zap/JSON/stats/action/setOptionStatsdPort/', params={
+ 'Integer': '0'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/forcedUser/view/getForcedUser/',
- params: {
- 'contextId' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/forcedUser/view/getForcedUser/
+GET /JSON/stats/action/setOptionStatsdPort/
-Gets the user (ID) set as 'forced user' for the given context (ID)
+Sets the Statsd service port
-Parameters
+Parameters
@@ -40783,7 +54749,7 @@ curl -X GET http://zap/JSON/forcedUser/view/getForcedUse
-contextId
+Integer
query
integer
true
@@ -40797,11 +54763,12 @@ curl -X GET http://zap/JSON/forcedUser/view/getForcedUse
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -40814,27 +54781,26 @@ curl -X GET http://zap/JSON/forcedUser/view/getForcedUse
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-forcedUserActionSetForcedUser
-
+statsActionSetOptionStatsdPrefix
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/forcedUser/action/setForcedUser/?contextId=0&userId=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/stats/action/setOptionStatsdPrefix/?String=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/forcedUser/action/setForcedUser/?contextId=0&userId=0");
+
URL obj = new URL("http://zap/JSON/stats/action/setOptionStatsdPrefix/?String=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -40850,38 +54816,21 @@ curl -X GET http://zap/JSON/forcedUser/action/setForcedU
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/forcedUser/action/setForcedUser/', params={
- 'contextId': '0', 'userId': '0'
+r = requests.get('http://zap/JSON/stats/action/setOptionStatsdPrefix/', params={
+ 'String': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/forcedUser/action/setForcedUser/',
- params: {
- 'contextId' => 'integer',
-'userId' => 'integer'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/forcedUser/action/setForcedUser/
+GET /JSON/stats/action/setOptionStatsdPrefix/
-Sets the user (ID) that should be used in 'forced user' mode for the given context (ID)
+Sets the prefix to be applied to all stats sent to the configured Statsd service
-Parameters
+Parameters
@@ -40893,16 +54842,9 @@ curl -X GET http://zap/JSON/forcedUser/action/setForcedU
-contextId
-query
-integer
-true
-none
-
-
-userId
+String
query
-integer
+string
true
none
@@ -40914,11 +54856,12 @@ curl -X GET http://zap/JSON/forcedUser/action/setForcedU
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -40931,27 +54874,26 @@ curl -X GET http://zap/JSON/forcedUser/action/setForcedU
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-forcedUserActionSetForcedUserModeEnabled
-
+statsViewAllSitesStats
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/forcedUser/action/setForcedUserModeEnabled/?boolean=true \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/stats/view/allSitesStats/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/forcedUser/action/setForcedUserModeEnabled/?boolean=true");
+
URL obj = new URL("http://zap/JSON/stats/view/allSitesStats/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -40967,37 +54909,19 @@ curl -X GET http://zap/JSON/forcedUser/action/setForcedU
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/forcedUser/action/setForcedUserModeEnabled/', params={
- 'boolean': 'true'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/forcedUser/action/setForcedUserModeEnabled/',
- params: {
- 'boolean' => 'boolean'
-}, headers: headers
+r = requests.get('http://zap/JSON/stats/view/allSitesStats/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/forcedUser/action/setForcedUserModeEnabled/
+GET /JSON/stats/view/allSitesStats/
-Sets if 'forced user' mode should be enabled or not
+Gets all of the site based statistics, optionally filtered by a key prefix
-Parameters
+Parameters
@@ -41009,10 +54933,10 @@ curl -X GET http://zap/JSON/forcedUser/action/setForcedU
-boolean
+keyPrefix
query
-boolean
-true
+string
+false
none
@@ -41023,11 +54947,12 @@ curl -X GET http://zap/JSON/forcedUser/action/setForcedU
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -41040,29 +54965,26 @@ curl -X GET http://zap/JSON/forcedUser/action/setForcedU
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-
-script
-scriptViewListEngines
-
+statsViewOptionInMemoryEnabled
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/script/view/listEngines/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/stats/view/optionInMemoryEnabled/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/script/view/listEngines/");
+
URL obj = new URL("http://zap/JSON/stats/view/optionInMemoryEnabled/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -41078,34 +55000,17 @@ curl -X GET http://zap/JSON/script/view/listEngines/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/script/view/listEngines/', params={
+r = requests.get('http://zap/JSON/stats/view/optionInMemoryEnabled/', headers = headers)
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/script/view/listEngines/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/script/view/listEngines/
+GET /JSON/stats/view/optionInMemoryEnabled/
-Lists the script engines available
+Returns 'true' if in memory statistics are enabled, otherwise returns 'false'
Example responses
@@ -41113,11 +55018,12 @@ curl -X GET http://zap/JSON/script/view/listEngines/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -41130,27 +55036,26 @@ curl -X GET http://zap/JSON/script/view/listEngines/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-scriptViewListTypes
-
+statsViewOptionStatsdEnabled
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/script/view/listTypes/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/stats/view/optionStatsdEnabled/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/script/view/listTypes/");
+
URL obj = new URL("http://zap/JSON/stats/view/optionStatsdEnabled/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -41166,34 +55071,17 @@ curl -X GET http://zap/JSON/script/view/listTypes/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/script/view/listTypes/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/script/view/listTypes/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/stats/view/optionStatsdEnabled/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/script/view/listTypes/
+GET /JSON/stats/view/optionStatsdEnabled/
-Lists the script types available.
+Returns 'true' if a Statsd server has been correctly configured, otherwise returns 'false'
Example responses
@@ -41201,11 +55089,12 @@ curl -X GET http://zap/JSON/script/view/listTypes/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -41218,27 +55107,26 @@ curl -X GET http://zap/JSON/script/view/listTypes/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-scriptViewListScripts
-
+statsViewOptionStatsdHost
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/script/view/listScripts/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/stats/view/optionStatsdHost/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/script/view/listScripts/");
+
URL obj = new URL("http://zap/JSON/stats/view/optionStatsdHost/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -41254,34 +55142,17 @@ curl -X GET http://zap/JSON/script/view/listScripts/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/script/view/listScripts/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/script/view/listScripts/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/stats/view/optionStatsdHost/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/script/view/listScripts/
+GET /JSON/stats/view/optionStatsdHost/
-Lists the scripts available, with its engine, name, description, type and error state.
+Gets the Statsd service hostname
Example responses
@@ -41289,11 +55160,12 @@ curl -X GET http://zap/JSON/script/view/listScripts/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -41306,27 +55178,26 @@ curl -X GET http://zap/JSON/script/view/listScripts/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-scriptViewGlobalVar
-
+statsViewOptionStatsdPort
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/script/view/globalVar/?varKey=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/stats/view/optionStatsdPort/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/script/view/globalVar/?varKey=string");
+
URL obj = new URL("http://zap/JSON/stats/view/optionStatsdPort/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -41342,55 +55213,17 @@ curl -X GET http://zap/JSON/script/view/globalVar/?varKe
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/script/view/globalVar/', params={
- 'varKey': 'string'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/script/view/globalVar/',
- params: {
- 'varKey' => 'string'
-}, headers: headers
+r = requests.get('http://zap/JSON/stats/view/optionStatsdPort/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/script/view/globalVar/
-
-Gets the value of the global variable with the given key. Returns an API error (DOES_NOT_EXIST) if no value was previously set.
-
-Parameters
+GET /JSON/stats/view/optionStatsdPort/
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-varKey
-query
-string
-true
-none
-
-
+Gets the Statsd service port
Example responses
@@ -41398,11 +55231,12 @@ curl -X GET http://zap/JSON/script/view/globalVar/?varKe
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -41415,27 +55249,26 @@ curl -X GET http://zap/JSON/script/view/globalVar/?varKe
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-scriptViewGlobalVars
-
+statsViewOptionStatsdPrefix
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/script/view/globalVars/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/stats/view/optionStatsdPrefix/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/script/view/globalVars/");
+
URL obj = new URL("http://zap/JSON/stats/view/optionStatsdPrefix/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -41451,34 +55284,17 @@ curl -X GET http://zap/JSON/script/view/globalVars/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/script/view/globalVars/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/script/view/globalVars/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/stats/view/optionStatsdPrefix/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/script/view/globalVars/
+GET /JSON/stats/view/optionStatsdPrefix/
-Gets all the global variables (key/value pairs).
+Gets the prefix to be applied to all stats sent to the configured Statsd service
Example responses
@@ -41486,11 +55302,12 @@ curl -X GET http://zap/JSON/script/view/globalVars/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -41503,27 +55320,26 @@ curl -X GET http://zap/JSON/script/view/globalVars/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-scriptViewScriptVar
-
+statsViewSiteStats
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/script/view/scriptVar/?scriptName=string&varKey=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/stats/view/siteStats/?site=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/script/view/scriptVar/?scriptName=string&varKey=string");
+
URL obj = new URL("http://zap/JSON/stats/view/siteStats/?site=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -41539,38 +55355,21 @@ curl -X GET http://zap/JSON/script/view/scriptVar/?scrip
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/script/view/scriptVar/', params={
- 'scriptName': 'string', 'varKey': 'string'
+r = requests.get('http://zap/JSON/stats/view/siteStats/', params={
+ 'site': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/script/view/scriptVar/',
- params: {
- 'scriptName' => 'string',
-'varKey' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/script/view/scriptVar/
+GET /JSON/stats/view/siteStats/
-Gets the value of the variable with the given key for the given script. Returns an API error (DOES_NOT_EXIST) if no script with the given name exists or if no value was previously set.
+Gets all of the global statistics, optionally filtered by a key prefix
-Parameters
+Parameters
@@ -41582,17 +55381,17 @@ curl -X GET http://zap/JSON/script/view/scriptVar/?scrip
-scriptName
+site
query
string
true
none
-varKey
+keyPrefix
query
string
-true
+false
none
@@ -41603,11 +55402,12 @@ curl -X GET http://zap/JSON/script/view/scriptVar/?scrip
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -41620,27 +55420,26 @@ curl -X GET http://zap/JSON/script/view/scriptVar/?scrip
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-scriptViewScriptVars
-
+statsViewStats
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/script/view/scriptVars/?scriptName=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/stats/view/stats/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/script/view/scriptVars/?scriptName=string");
+
URL obj = new URL("http://zap/JSON/stats/view/stats/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -41656,37 +55455,19 @@ curl -X GET http://zap/JSON/script/view/scriptVars/?scri
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/script/view/scriptVars/', params={
- 'scriptName': 'string'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/script/view/scriptVars/',
- params: {
- 'scriptName' => 'string'
-}, headers: headers
+r = requests.get('http://zap/JSON/stats/view/stats/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/script/view/scriptVars/
+GET /JSON/stats/view/stats/
-Gets all the variables (key/value pairs) of the given script. Returns an API error (DOES_NOT_EXIST) if no script with the given name exists.
+Statistics
-Parameters
+Parameters
@@ -41698,10 +55479,10 @@ curl -X GET http://zap/JSON/script/view/scriptVars/?scri
-scriptName
+keyPrefix
query
string
-true
+false
none
@@ -41712,11 +55493,12 @@ curl -X GET http://zap/JSON/script/view/scriptVars/?scri
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -41729,27 +55511,28 @@ curl -X GET http://zap/JSON/script/view/scriptVars/?scri
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-scriptActionEnable
-
+
+users
+usersActionAuthenticateAsUser
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/script/action/enable/?scriptName=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/users/action/authenticateAsUser/?contextId=string&userId=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/script/action/enable/?scriptName=string");
+
URL obj = new URL("http://zap/JSON/users/action/authenticateAsUser/?contextId=string&userId=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -41765,37 +55548,21 @@ curl -X GET http://zap/JSON/script/action/enable/?script
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/script/action/enable/', params={
- 'scriptName': 'string'
+r = requests.get('http://zap/JSON/users/action/authenticateAsUser/', params={
+ 'contextId': 'string', 'userId': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/script/action/enable/',
- params: {
- 'scriptName' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/script/action/enable/
+GET /JSON/users/action/authenticateAsUser/
-Enables the script with the given name
+Tries to authenticate as the identified user, returning the authentication request and whether it appears to have succeeded.
-Parameters
+Parameters
@@ -41807,11 +55574,18 @@ curl -X GET http://zap/JSON/script/action/enable/?script
-scriptName
+contextId
query
string
true
-none
+The Context ID
+
+
+userId
+query
+string
+true
+The User ID
@@ -41821,11 +55595,12 @@ curl -X GET http://zap/JSON/script/action/enable/?script
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -41838,27 +55613,26 @@ curl -X GET http://zap/JSON/script/action/enable/?script
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-scriptActionDisable
-
+usersActionNewUser
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/script/action/disable/?scriptName=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/users/action/newUser/?contextId=string&name=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/script/action/disable/?scriptName=string");
+
URL obj = new URL("http://zap/JSON/users/action/newUser/?contextId=string&name=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -41874,37 +55648,21 @@ curl -X GET http://zap/JSON/script/action/disable/?scrip
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/script/action/disable/', params={
- 'scriptName': 'string'
+r = requests.get('http://zap/JSON/users/action/newUser/', params={
+ 'contextId': 'string', 'name': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/script/action/disable/',
- params: {
- 'scriptName' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/script/action/disable/
+GET /JSON/users/action/newUser/
-Disables the script with the given name
+Creates a new user with the given name for the context with the given ID.
-Parameters
+Parameters
@@ -41916,7 +55674,14 @@ curl -X GET http://zap/JSON/script/action/disable/?scrip
-scriptName
+contextId
+query
+string
+true
+The Context ID
+
+
+name
query
string
true
@@ -41930,11 +55695,12 @@ curl -X GET http://zap/JSON/script/action/disable/?scrip
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -41947,27 +55713,26 @@ curl -X GET http://zap/JSON/script/action/disable/?scrip
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-scriptActionLoad
-
+usersActionPollAsUser
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/script/action/load/?scriptName=string&scriptType=string&scriptEngine=string&fileName=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/users/action/pollAsUser/?contextId=string&userId=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/script/action/load/?scriptName=string&scriptType=string&scriptEngine=string&fileName=string");
+
URL obj = new URL("http://zap/JSON/users/action/pollAsUser/?contextId=string&userId=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -41983,40 +55748,21 @@ curl -X GET http://zap/JSON/script/action/load/?scriptNa
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/script/action/load/', params={
- 'scriptName': 'string', 'scriptType': 'string', 'scriptEngine': 'string', 'fileName': 'string'
+r = requests.get('http://zap/JSON/users/action/pollAsUser/', params={
+ 'contextId': 'string', 'userId': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/script/action/load/',
- params: {
- 'scriptName' => 'string',
-'scriptType' => 'string',
-'scriptEngine' => 'string',
-'fileName' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/script/action/load/
+GET /JSON/users/action/pollAsUser/
-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 script is not in UTF-8, for example, in ISO-8859-1).
+Tries to poll as the identified user, returning the authentication request and whether it appears to have succeeded. This will only work if the polling verification strategy has been configured.
-Parameters
+Parameters
@@ -42028,46 +55774,18 @@ curl -X GET http://zap/JSON/script/action/load/?scriptNa
-scriptName
-query
-string
-true
-none
-
-
-scriptType
-query
-string
-true
-none
-
-
-scriptEngine
+contextId
query
string
true
-none
+The Context ID
-fileName
+userId
query
string
true
-none
-
-
-scriptDescription
-query
-string
-false
-none
-
-
-charset
-query
-string
-false
-none
+The User ID
@@ -42077,11 +55795,12 @@ curl -X GET http://zap/JSON/script/action/load/?scriptNa
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -42094,27 +55813,26 @@ curl -X GET http://zap/JSON/script/action/load/?scriptNa
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-scriptActionRemove
-
+usersActionRemoveUser
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/script/action/remove/?scriptName=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/users/action/removeUser/?contextId=string&userId=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/script/action/remove/?scriptName=string");
+
URL obj = new URL("http://zap/JSON/users/action/removeUser/?contextId=string&userId=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -42130,37 +55848,21 @@ curl -X GET http://zap/JSON/script/action/remove/?script
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/script/action/remove/', params={
- 'scriptName': 'string'
+r = requests.get('http://zap/JSON/users/action/removeUser/', params={
+ 'contextId': 'string', 'userId': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/script/action/remove/',
- params: {
- 'scriptName' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/script/action/remove/
+GET /JSON/users/action/removeUser/
-Removes the script with the given name
+Removes the user with the given ID that belongs to the context with the given ID.
-Parameters
+Parameters
@@ -42172,11 +55874,18 @@ curl -X GET http://zap/JSON/script/action/remove/?script
-scriptName
+contextId
query
string
true
-none
+The Context ID
+
+
+userId
+query
+string
+true
+The User ID
@@ -42186,11 +55895,12 @@ curl -X GET http://zap/JSON/script/action/remove/?script
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -42203,27 +55913,26 @@ curl -X GET http://zap/JSON/script/action/remove/?script
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-scriptActionRunStandAloneScript
-
+usersActionSetAuthenticationCredentials
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/script/action/runStandAloneScript/?scriptName=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/users/action/setAuthenticationCredentials/?contextId=string&userId=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/script/action/runStandAloneScript/?scriptName=string");
+
URL obj = new URL("http://zap/JSON/users/action/setAuthenticationCredentials/?contextId=string&userId=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -42239,37 +55948,21 @@ curl -X GET http://zap/JSON/script/action/runStandAloneS
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/script/action/runStandAloneScript/', params={
- 'scriptName': 'string'
+r = requests.get('http://zap/JSON/users/action/setAuthenticationCredentials/', params={
+ 'contextId': 'string', 'userId': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/script/action/runStandAloneScript/',
- params: {
- 'scriptName' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/script/action/runStandAloneScript/
+GET /JSON/users/action/setAuthenticationCredentials/
-Runs the stand alone script with the given name
+Sets the authentication credentials for the user with the given ID that belongs to the context with the given ID.
-Parameters
+Parameters
@@ -42281,10 +55974,24 @@ curl -X GET http://zap/JSON/script/action/runStandAloneS
-scriptName
+contextId
+query
+string
+true
+The Context ID
+
+
+userId
query
string
true
+The User ID
+
+
+authCredentialsConfigParams
+query
+string
+false
none
@@ -42295,11 +56002,12 @@ curl -X GET http://zap/JSON/script/action/runStandAloneS
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -42312,27 +56020,26 @@ curl -X GET http://zap/JSON/script/action/runStandAloneS
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-scriptActionClearGlobalVar
-
+usersActionSetAuthenticationState
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/script/action/clearGlobalVar/?varKey=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/users/action/setAuthenticationState/?contextId=string&userId=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/script/action/clearGlobalVar/?varKey=string");
+
URL obj = new URL("http://zap/JSON/users/action/setAuthenticationState/?contextId=string&userId=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -42348,37 +56055,21 @@ curl -X GET http://zap/JSON/script/action/clearGlobalVar
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/script/action/clearGlobalVar/', params={
- 'varKey': 'string'
+r = requests.get('http://zap/JSON/users/action/setAuthenticationState/', params={
+ 'contextId': 'string', 'userId': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/script/action/clearGlobalVar/',
- params: {
- 'varKey' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/script/action/clearGlobalVar/
+GET /JSON/users/action/setAuthenticationState/
-Clears the global variable with the given key.
+Sets fields in the authentication state for the user identified by the Context and User Ids.
-Parameters
+Parameters
@@ -42390,11 +56081,39 @@ curl -X GET http://zap/JSON/script/action/clearGlobalVar
-varKey
+contextId
query
string
true
-none
+The Context ID
+
+
+userId
+query
+string
+true
+The User ID
+
+
+lastPollResult
+query
+string
+false
+Last Poll Result - optional, should be 'true' or 'false'.
+
+
+lastPollTimeInMs
+query
+string
+false
+Last Poll Time in Milliseconds - optional, should be a long or 'NOW' for the current time in ms.
+
+
+requestsSinceLastPoll
+query
+string
+false
+Requests Since Last Poll - optional, should be an integer.
@@ -42404,11 +56123,12 @@ curl -X GET http://zap/JSON/script/action/clearGlobalVar
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -42421,27 +56141,26 @@ curl -X GET http://zap/JSON/script/action/clearGlobalVar
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-scriptActionClearGlobalVars
-
+usersActionSetCookie
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/script/action/clearGlobalVars/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/users/action/setCookie/?contextId=string&userId=string&domain=string&name=string&value=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/script/action/clearGlobalVars/");
+
URL obj = new URL("http://zap/JSON/users/action/setCookie/?contextId=string&userId=string&domain=string&name=string&value=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -42457,34 +56176,81 @@ curl -X GET http://zap/JSON/script/action/clearGlobalVar
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/script/action/clearGlobalVars/', params={
-
+r = requests.get('http://zap/JSON/users/action/setCookie/', params={
+ 'contextId': 'string', 'userId': 'string', 'domain': 'string', 'name': 'string', 'value': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+print(r.json())
-result = RestClient.get 'http://zap/JSON/script/action/clearGlobalVars/',
- params: {
- }, headers: headers
+
+GET /JSON/users/action/setCookie/
-p JSON.parse(result)
+Sets the specified cookie for the user identified by the Context and User Ids.
-
-GET /JSON/script/action/clearGlobalVars/
+Parameters
-Clears the global variables.
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+contextId
+query
+string
+true
+The Context ID
+
+
+userId
+query
+string
+true
+The User ID
+
+
+domain
+query
+string
+true
+The Cookie Domain
+
+
+name
+query
+string
+true
+The Cookie Name
+
+
+value
+query
+string
+true
+The Cookie Value
+
+
+path
+query
+string
+false
+The Cookie Path - optional default no path
+
+
+secure
+query
+string
+false
+If the Cookie is secure - optional default false
+
+
Example responses
@@ -42492,11 +56258,12 @@ curl -X GET http://zap/JSON/script/action/clearGlobalVar
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -42509,27 +56276,26 @@ curl -X GET http://zap/JSON/script/action/clearGlobalVar
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-scriptActionClearScriptVar
-
+usersActionSetUserEnabled
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/script/action/clearScriptVar/?scriptName=string&varKey=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/users/action/setUserEnabled/?contextId=string&userId=string&enabled=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/script/action/clearScriptVar/?scriptName=string&varKey=string");
+
URL obj = new URL("http://zap/JSON/users/action/setUserEnabled/?contextId=string&userId=string&enabled=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -42545,38 +56311,21 @@ curl -X GET http://zap/JSON/script/action/clearScriptVar
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/script/action/clearScriptVar/', params={
- 'scriptName': 'string', 'varKey': 'string'
+r = requests.get('http://zap/JSON/users/action/setUserEnabled/', params={
+ 'contextId': 'string', 'userId': 'string', 'enabled': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/script/action/clearScriptVar/',
- params: {
- 'scriptName' => 'string',
-'varKey' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/script/action/clearScriptVar/
+GET /JSON/users/action/setUserEnabled/
-Clears the variable with the given key of the given script. Returns an API error (DOES_NOT_EXIST) if no script with the given name exists.
+Sets whether or not the user, with the given ID that belongs to the context with the given ID, should be enabled.
-Parameters
+Parameters
@@ -42588,14 +56337,21 @@ curl -X GET http://zap/JSON/script/action/clearScriptVar
-scriptName
+contextId
query
string
true
-none
+The Context ID
-varKey
+userId
+query
+string
+true
+The User ID
+
+
+enabled
query
string
true
@@ -42609,11 +56365,12 @@ curl -X GET http://zap/JSON/script/action/clearScriptVar
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -42626,27 +56383,26 @@ curl -X GET http://zap/JSON/script/action/clearScriptVar
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-scriptActionClearScriptVars
-
+usersActionSetUserName
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/script/action/clearScriptVars/?scriptName=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/users/action/setUserName/?contextId=string&userId=string&name=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/script/action/clearScriptVars/?scriptName=string");
+
URL obj = new URL("http://zap/JSON/users/action/setUserName/?contextId=string&userId=string&name=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -42662,37 +56418,21 @@ curl -X GET http://zap/JSON/script/action/clearScriptVar
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/script/action/clearScriptVars/', params={
- 'scriptName': 'string'
+r = requests.get('http://zap/JSON/users/action/setUserName/', params={
+ 'contextId': 'string', 'userId': 'string', 'name': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/script/action/clearScriptVars/',
- params: {
- 'scriptName' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/script/action/clearScriptVars/
+GET /JSON/users/action/setUserName/
-Clears the variables of the given script. Returns an API error (DOES_NOT_EXIST) if no script with the given name exists.
+Renames the user with the given ID that belongs to the context with the given ID.
-Parameters
+Parameters
@@ -42704,7 +56444,21 @@ curl -X GET http://zap/JSON/script/action/clearScriptVar
-scriptName
+contextId
+query
+string
+true
+The Context ID
+
+
+userId
+query
+string
+true
+The User ID
+
+
+name
query
string
true
@@ -42718,11 +56472,12 @@ curl -X GET http://zap/JSON/script/action/clearScriptVar
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -42735,27 +56490,26 @@ curl -X GET http://zap/JSON/script/action/clearScriptVar
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-scriptActionSetScriptVar
-
+usersViewGetAuthenticationCredentials
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/script/action/setScriptVar/?scriptName=string&varKey=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/users/view/getAuthenticationCredentials/?contextId=string&userId=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/script/action/setScriptVar/?scriptName=string&varKey=string");
+
URL obj = new URL("http://zap/JSON/users/view/getAuthenticationCredentials/?contextId=string&userId=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -42771,38 +56525,21 @@ curl -X GET http://zap/JSON/script/action/setScriptVar/?
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/script/action/setScriptVar/', params={
- 'scriptName': 'string', 'varKey': 'string'
+r = requests.get('http://zap/JSON/users/view/getAuthenticationCredentials/', params={
+ 'contextId': 'string', 'userId': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/script/action/setScriptVar/',
- params: {
- 'scriptName' => 'string',
-'varKey' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/script/action/setScriptVar/
+GET /JSON/users/view/getAuthenticationCredentials/
-Sets the value of the variable with the given key of the given script. Returns an API error (DOES_NOT_EXIST) if no script with the given name exists.
+Gets the authentication credentials of the user with given ID that belongs to the context with the given ID.
-Parameters
+Parameters
@@ -42814,25 +56551,18 @@ curl -X GET http://zap/JSON/script/action/setScriptVar/?
-scriptName
+contextId
query
string
true
-none
+The Context ID
-varKey
+userId
query
string
true
-none
-
-
-varValue
-query
-string
-false
-none
+the User ID
@@ -42842,11 +56572,12 @@ curl -X GET http://zap/JSON/script/action/setScriptVar/?
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -42859,27 +56590,26 @@ curl -X GET http://zap/JSON/script/action/setScriptVar/?
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-scriptActionSetGlobalVar
-
+usersViewGetAuthenticationCredentialsConfigParams
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/script/action/setGlobalVar/?varKey=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/users/view/getAuthenticationCredentialsConfigParams/?contextId=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/script/action/setGlobalVar/?varKey=string");
+
URL obj = new URL("http://zap/JSON/users/view/getAuthenticationCredentialsConfigParams/?contextId=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -42895,37 +56625,21 @@ curl -X GET http://zap/JSON/script/action/setGlobalVar/?
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/script/action/setGlobalVar/', params={
- 'varKey': 'string'
+r = requests.get('http://zap/JSON/users/view/getAuthenticationCredentialsConfigParams/', params={
+ 'contextId': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/script/action/setGlobalVar/',
- params: {
- 'varKey' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/script/action/setGlobalVar/
+GET /JSON/users/view/getAuthenticationCredentialsConfigParams/
-Sets the value of the global variable with the given key.
+Gets the configuration parameters for the credentials of the context with the given ID.
-Parameters
+Parameters
@@ -42937,18 +56651,11 @@ curl -X GET http://zap/JSON/script/action/setGlobalVar/?
-varKey
+contextId
query
string
true
-none
-
-
-varValue
-query
-string
-false
-none
+The Context ID
@@ -42958,11 +56665,12 @@ curl -X GET http://zap/JSON/script/action/setGlobalVar/?
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -42975,29 +56683,26 @@ curl -X GET http://zap/JSON/script/action/setGlobalVar/?
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-
-stats
-statsViewStats
-
+usersViewGetAuthenticationSession
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/stats/view/stats/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/users/view/getAuthenticationSession/?contextId=string&userId=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/stats/view/stats/");
+
URL obj = new URL("http://zap/JSON/users/view/getAuthenticationSession/?contextId=string&userId=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -43013,36 +56718,21 @@ curl -X GET http://zap/JSON/stats/view/stats/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/stats/view/stats/', params={
-
+r = requests.get('http://zap/JSON/users/view/getAuthenticationSession/', params={
+ 'contextId': 'string', 'userId': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/stats/view/stats/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/stats/view/stats/
+GET /JSON/users/view/getAuthenticationSession/
-Statistics
+Gets the authentication session information for the user identified by the Context and User Ids, e.g. cookies and realm credentials.
-Parameters
+Parameters
@@ -43054,11 +56744,18 @@ curl -X GET http://zap/JSON/stats/view/stats/
-keyPrefix
+contextId
query
string
-false
-none
+true
+The Context ID
+
+
+userId
+query
+string
+true
+The User ID
@@ -43068,11 +56765,12 @@ curl -X GET http://zap/JSON/stats/view/stats/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -43085,27 +56783,26 @@ curl -X GET http://zap/JSON/stats/view/stats/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-statsViewAllSitesStats
-
+usersViewGetAuthenticationState
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/stats/view/allSitesStats/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/users/view/getAuthenticationState/?contextId=string&userId=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/stats/view/allSitesStats/");
+
URL obj = new URL("http://zap/JSON/users/view/getAuthenticationState/?contextId=string&userId=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -43121,36 +56818,21 @@ curl -X GET http://zap/JSON/stats/view/allSitesStats/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/stats/view/allSitesStats/', params={
-
+r = requests.get('http://zap/JSON/users/view/getAuthenticationState/', params={
+ 'contextId': 'string', 'userId': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/stats/view/allSitesStats/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/stats/view/allSitesStats/
+GET /JSON/users/view/getAuthenticationState/
-Gets all of the site based statistics, optionally filtered by a key prefix
+Gets the authentication state information for the user identified by the Context and User Ids.
-Parameters
+Parameters
@@ -43162,11 +56844,18 @@ curl -X GET http://zap/JSON/stats/view/allSitesStats/
-keyPrefix
+contextId
query
string
-false
-none
+true
+The Context ID
+
+
+userId
+query
+string
+true
+The User ID
@@ -43176,11 +56865,12 @@ curl -X GET http://zap/JSON/stats/view/allSitesStats/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -43193,27 +56883,26 @@ curl -X GET http://zap/JSON/stats/view/allSitesStats/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-statsViewSiteStats
-
+usersViewGetUserById
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/stats/view/siteStats/?site=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/users/view/getUserById/?contextId=string&userId=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/stats/view/siteStats/?site=string");
+
URL obj = new URL("http://zap/JSON/users/view/getUserById/?contextId=string&userId=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -43229,37 +56918,21 @@ curl -X GET http://zap/JSON/stats/view/siteStats/?site
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/stats/view/siteStats/', params={
- 'site': 'string'
+r = requests.get('http://zap/JSON/users/view/getUserById/', params={
+ 'contextId': 'string', 'userId': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/stats/view/siteStats/',
- params: {
- 'site' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/stats/view/siteStats/
+GET /JSON/users/view/getUserById/
-Gets all of the global statistics, optionally filtered by a key prefix
+Gets the data of the user with the given ID that belongs to the context with the given ID.
-Parameters
+Parameters
@@ -43271,18 +56944,18 @@ curl -X GET http://zap/JSON/stats/view/siteStats/?site
-site
+contextId
query
string
true
-none
+The Context ID
-keyPrefix
+userId
query
string
-false
-none
+true
+The User ID
@@ -43292,11 +56965,12 @@ curl -X GET http://zap/JSON/stats/view/siteStats/?sitedefault Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -43309,27 +56983,26 @@ curl -X GET http://zap/JSON/stats/view/siteStats/?site
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-statsViewOptionStatsdHost
-
+usersViewUsersList
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/stats/view/optionStatsdHost/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/users/view/usersList/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/stats/view/optionStatsdHost/");
+
URL obj = new URL("http://zap/JSON/users/view/usersList/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -43345,34 +57018,37 @@ curl -X GET http://zap/JSON/stats/view/optionStatsdHost/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/stats/view/optionStatsdHost/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
+r = requests.get('http://zap/JSON/users/view/usersList/', headers = headers)
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+print(r.json())
-result = RestClient.get 'http://zap/JSON/stats/view/optionStatsdHost/',
- params: {
- }, headers: headers
+
+GET /JSON/users/view/usersList/
-p JSON.parse(result)
+Gets a list of users that belong to the context with the given ID, or all users if none provided.
-
-GET /JSON/stats/view/optionStatsdHost/
+Parameters
-Gets the Statsd service hostname
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+contextId
+query
+string
+false
+The Context ID
+
+
Example responses
@@ -43380,11 +57056,12 @@ curl -X GET http://zap/JSON/stats/view/optionStatsdHost/
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -43397,27 +57074,28 @@ curl -X GET http://zap/JSON/stats/view/optionStatsdHost/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-statsViewOptionStatsdPort
-
+
+wappalyzer
+wappalyzerViewListAll
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/stats/view/optionStatsdPort/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/wappalyzer/view/listAll/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/stats/view/optionStatsdPort/");
+
URL obj = new URL("http://zap/JSON/wappalyzer/view/listAll/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -43433,34 +57111,17 @@ curl -X GET http://zap/JSON/stats/view/optionStatsdPort/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/stats/view/optionStatsdPort/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/stats/view/optionStatsdPort/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/wappalyzer/view/listAll/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/stats/view/optionStatsdPort/
+GET /JSON/wappalyzer/view/listAll/
-Gets the Statsd service port
+Lists all sites and their associated applications (technologies).
Example responses
@@ -43468,11 +57129,12 @@ curl -X GET http://zap/JSON/stats/view/optionStatsdPort/
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -43485,27 +57147,26 @@ curl -X GET http://zap/JSON/stats/view/optionStatsdPort/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-statsViewOptionStatsdPrefix
-
+wappalyzerViewListSite
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/stats/view/optionStatsdPrefix/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/wappalyzer/view/listSite/?site=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/stats/view/optionStatsdPrefix/");
+
URL obj = new URL("http://zap/JSON/wappalyzer/view/listSite/?site=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -43521,34 +57182,39 @@ curl -X GET http://zap/JSON/stats/view/optionStatsdPrefi
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/stats/view/optionStatsdPrefix/', params={
-
+r = requests.get('http://zap/JSON/wappalyzer/view/listSite/', params={
+ 'site': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
+print(r.json())
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/stats/view/optionStatsdPrefix/',
- params: {
- }, headers: headers
+
+GET /JSON/wappalyzer/view/listSite/
-p JSON.parse(result)
+Lists all the applications (technologies) associated with a specific site.
-
-GET /JSON/stats/view/optionStatsdPrefix/
+Parameters
-Gets the prefix to be applied to all stats sent to the configured Statsd service
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+site
+query
+string
+true
+none
+
+
Example responses
@@ -43556,11 +57222,12 @@ curl -X GET http://zap/JSON/stats/view/optionStatsdPrefi
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -43573,27 +57240,26 @@ curl -X GET http://zap/JSON/stats/view/optionStatsdPrefi
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-statsViewOptionInMemoryEnabled
-
+wappalyzerViewListSites
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/stats/view/optionInMemoryEnabled/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/wappalyzer/view/listSites/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/stats/view/optionInMemoryEnabled/");
+
URL obj = new URL("http://zap/JSON/wappalyzer/view/listSites/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -43609,34 +57275,17 @@ curl -X GET http://zap/JSON/stats/view/optionInMemoryEna
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/stats/view/optionInMemoryEnabled/', params={
-
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/stats/view/optionInMemoryEnabled/',
- params: {
- }, headers: headers
+r = requests.get('http://zap/JSON/wappalyzer/view/listSites/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/stats/view/optionInMemoryEnabled/
+GET /JSON/wappalyzer/view/listSites/
-Returns 'true' if in memory statistics are enabled, otherwise returns 'false'
+Lists all the sites recognized by the wappalyzer addon.
Example responses
@@ -43644,11 +57293,12 @@ curl -X GET http://zap/JSON/stats/view/optionInMemoryEna
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -43661,27 +57311,28 @@ curl -X GET http://zap/JSON/stats/view/optionInMemoryEna
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-statsViewOptionStatsdEnabled
-
+
+websocket
+websocketActionSendTextMessage
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/stats/view/optionStatsdEnabled/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/websocket/action/sendTextMessage/?channelId=string&outgoing=string&message=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/stats/view/optionStatsdEnabled/");
+
URL obj = new URL("http://zap/JSON/websocket/action/sendTextMessage/?channelId=string&outgoing=string&message=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -43697,34 +57348,53 @@ curl -X GET http://zap/JSON/stats/view/optionStatsdEnabl
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/stats/view/optionStatsdEnabled/', params={
-
+r = requests.get('http://zap/JSON/websocket/action/sendTextMessage/', params={
+ 'channelId': 'string', 'outgoing': 'string', 'message': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
+print(r.json())
-result = RestClient.get 'http://zap/JSON/stats/view/optionStatsdEnabled/',
- params: {
- }, headers: headers
+
+GET /JSON/websocket/action/sendTextMessage/
-p JSON.parse(result)
+Sends the specified message on the channel specified by channelId, if outgoing is 'True' then the message will be sent to the server and if it is 'False' then it will be sent to the client
-
-GET /JSON/stats/view/optionStatsdEnabled/
+Parameters
-Returns 'true' if a Statsd server has been correctly configured, otherwise returns 'false'
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+channelId
+query
+string
+true
+none
+
+
+outgoing
+query
+string
+true
+none
+
+
+message
+query
+string
+true
+none
+
+
Example responses
@@ -43732,11 +57402,12 @@ curl -X GET http://zap/JSON/stats/view/optionStatsdEnabl
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -43749,27 +57420,26 @@ curl -X GET http://zap/JSON/stats/view/optionStatsdEnabl
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-statsActionClearStats
-
+websocketActionSetBreakTextMessage
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/stats/action/clearStats/ \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/websocket/action/setBreakTextMessage/?message=string&outgoing=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/stats/action/clearStats/");
+
URL obj = new URL("http://zap/JSON/websocket/action/setBreakTextMessage/?message=string&outgoing=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -43785,36 +57455,21 @@ curl -X GET http://zap/JSON/stats/action/clearStats/
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/stats/action/clearStats/', params={
-
+r = requests.get('http://zap/JSON/websocket/action/setBreakTextMessage/', params={
+ 'message': 'string', 'outgoing': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/stats/action/clearStats/',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/stats/action/clearStats/
+GET /JSON/websocket/action/setBreakTextMessage/
-Clears all of the statistics
+Sets the text message for an intercepted websockets message
-Parameters
+Parameters
@@ -43826,10 +57481,17 @@ curl -X GET http://zap/JSON/stats/action/clearStats/
-keyPrefix
+message
query
string
-false
+true
+none
+
+
+outgoing
+query
+string
+true
none
@@ -43840,11 +57502,12 @@ curl -X GET http://zap/JSON/stats/action/clearStats/ default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -43857,27 +57520,26 @@ curl -X GET http://zap/JSON/stats/action/clearStats/
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-statsActionSetOptionStatsdHost
-
+websocketViewBreakTextMessage
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/stats/action/setOptionStatsdHost/?String=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/websocket/view/breakTextMessage/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/stats/action/setOptionStatsdHost/?String=string");
+
URL obj = new URL("http://zap/JSON/websocket/view/breakTextMessage/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -43893,55 +57555,17 @@ curl -X GET http://zap/JSON/stats/action/setOptionStatsd
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/stats/action/setOptionStatsdHost/', params={
- 'String': 'string'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/stats/action/setOptionStatsdHost/',
- params: {
- 'String' => 'string'
-}, headers: headers
+r = requests.get('http://zap/JSON/websocket/view/breakTextMessage/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/stats/action/setOptionStatsdHost/
-
-Sets the Statsd service hostname, supply an empty string to stop using a Statsd service
-
-Parameters
+GET /JSON/websocket/view/breakTextMessage/
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-String
-query
-string
-true
-none
-
-
+Returns a text representation of an intercepted websockets message
Example responses
@@ -43949,11 +57573,12 @@ curl -X GET http://zap/JSON/stats/action/setOptionStatsd
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -43966,27 +57591,26 @@ curl -X GET http://zap/JSON/stats/action/setOptionStatsd
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-statsActionSetOptionStatsdPrefix
-
+websocketViewChannels
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/stats/action/setOptionStatsdPrefix/?String=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/websocket/view/channels/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/stats/action/setOptionStatsdPrefix/?String=string");
+
URL obj = new URL("http://zap/JSON/websocket/view/channels/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -44002,55 +57626,17 @@ curl -X GET http://zap/JSON/stats/action/setOptionStatsd
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/stats/action/setOptionStatsdPrefix/', params={
- 'String': 'string'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/stats/action/setOptionStatsdPrefix/',
- params: {
- 'String' => 'string'
-}, headers: headers
+r = requests.get('http://zap/JSON/websocket/view/channels/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/stats/action/setOptionStatsdPrefix/
-
-Sets the prefix to be applied to all stats sent to the configured Statsd service
-
-Parameters
+GET /JSON/websocket/view/channels/
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-String
-query
-string
-true
-none
-
-
+Returns all of the registered web socket channels
Example responses
@@ -44058,11 +57644,12 @@ curl -X GET http://zap/JSON/stats/action/setOptionStatsd
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -44075,27 +57662,26 @@ curl -X GET http://zap/JSON/stats/action/setOptionStatsd
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-statsActionSetOptionInMemoryEnabled
-
+websocketViewMessage
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/stats/action/setOptionInMemoryEnabled/?Boolean=string \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/websocket/view/message/?channelId=string&messageId=string \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/stats/action/setOptionInMemoryEnabled/?Boolean=string");
+
URL obj = new URL("http://zap/JSON/websocket/view/message/?channelId=string&messageId=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -44111,37 +57697,21 @@ curl -X GET http://zap/JSON/stats/action/setOptionInMemo
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
+ 'Accept': 'application/json'
}
-r = requests.get('http://zap/JSON/stats/action/setOptionInMemoryEnabled/', params={
- 'Boolean': 'string'
+r = requests.get('http://zap/JSON/websocket/view/message/', params={
+ 'channelId': 'string', 'messageId': 'string'
}, headers = headers)
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
-}
-
-result = RestClient.get 'http://zap/JSON/stats/action/setOptionInMemoryEnabled/',
- params: {
- 'Boolean' => 'string'
-}, headers: headers
-
-p JSON.parse(result)
+print(r.json())
-GET /JSON/stats/action/setOptionInMemoryEnabled/
+GET /JSON/websocket/view/message/
-Sets whether in memory statistics are enabled
+Returns full details of the message specified by the channelId and messageId
-Parameters
+Parameters
@@ -44153,7 +57723,14 @@ curl -X GET http://zap/JSON/stats/action/setOptionInMemo
-Boolean
+channelId
+query
+string
+true
+none
+
+
+messageId
query
string
true
@@ -44167,11 +57744,12 @@ curl -X GET http://zap/JSON/stats/action/setOptionInMemo
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -44184,27 +57762,26 @@ curl -X GET http://zap/JSON/stats/action/setOptionInMemo
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
-statsActionSetOptionStatsdPort
-
+websocketViewMessages
+
Code samples
# You can also use wget
-curl -X GET http://zap/JSON/stats/action/setOptionStatsdPort/?Integer=0 \
- -H 'Accept: application/json' \
- -H 'X-ZAP-API-Key: API_KEY'
+curl -X GET http://zap/JSON/websocket/view/messages/ \
+ -H 'Accept: application/json'
-
URL obj = new URL("http://zap/JSON/stats/action/setOptionStatsdPort/?Integer=0");
+
URL obj = new URL("http://zap/JSON/websocket/view/messages/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -44220,37 +57797,19 @@ curl -X GET http://zap/JSON/stats/action/setOptionStatsd
import requests
headers = {
- 'Accept': 'application/json',
- 'X-ZAP-API-Key': 'API_KEY'
-}
-
-r = requests.get('http://zap/JSON/stats/action/setOptionStatsdPort/', params={
- 'Integer': '0'
-}, headers = headers)
-
-print r.json()
-
-
require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'X-ZAP-API-Key' => 'API_KEY'
+ 'Accept': 'application/json'
}
-result = RestClient.get 'http://zap/JSON/stats/action/setOptionStatsdPort/',
- params: {
- 'Integer' => 'integer'
-}, headers: headers
+r = requests.get('http://zap/JSON/websocket/view/messages/', headers = headers)
-p JSON.parse(result)
+print(r.json())
-GET /JSON/stats/action/setOptionStatsdPort/
+GET /JSON/websocket/view/messages/
-Sets the Statsd service port
+Returns a list of all of the messages that meet the given criteria (all optional), where channelId is a channel identifier, start is the offset to start returning messages from (starting from 0), count is the number of messages to return (default no limit) and payloadPreviewLength is the maximum number bytes to return for the payload contents
-Parameters
+Parameters
@@ -44262,10 +57821,31 @@ curl -X GET http://zap/JSON/stats/action/setOptionStatsd
-Integer
+channelId
query
-integer
-true
+string
+false
+none
+
+
+start
+query
+string
+false
+none
+
+
+count
+query
+string
+false
+none
+
+
+payloadPreviewLength
+query
+string
+false
none
@@ -44276,11 +57856,12 @@ curl -X GET http://zap/JSON/stats/action/setOptionStatsd
default Response
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
-Responses
+Responses
@@ -44293,22 +57874,26 @@ curl -X GET http://zap/JSON/stats/action/setOptionStatsd
default
Default
-unexpected error
-Error
+Error of JSON endpoints.
+ErrorJson
Schemas
-Error
+ErrorJson
-
+
{
+ "code": "string",
"message": "string",
- "code": 100
+ "detail": "string"
}
Properties
@@ -44322,17 +57907,26 @@ apiKeyHeader, apiKeyQuery
-message
+code
string
true
none
none
-code
-integer
+message
+string
true
none
none
+
+detail
+string
+false
+none
+none
+
+
+undefined
diff --git a/docs/api/index.html b/docs/api/index.html
index 20f6dd2864..181c3f08f6 100644
--- a/docs/api/index.html
+++ b/docs/api/index.html
@@ -344,43 +344,25 @@
API Catalogue
- Authentication
-
-
- alert
+ accessControl
-
- alertViewAlert
-
- -
- alertViewAlerts
-
- -
- alertViewAlertsSummary
-
- -
- alertViewNumberOfAlerts
-
- -
- alertViewAlertsByRisk
+ accessControlActionScan
-
- alertViewAlertCountsByRisk
+ accessControlActionWriteHTMLreport
-
- alertActionDeleteAllAlerts
+ accessControlViewGetScanProgress
-
- alertActionDeleteAlert
+ accessControlViewGetScanStatus
acsrf
- -
- acsrfViewOptionTokensNames
-
-
acsrfActionAddOptionToken
@@ -388,1364 +370,2183 @@
acsrfActionRemoveOptionToken
- acsrfOtherGenForm
-
-
-
-
- pscan
-
- -
- pscanViewScanOnlyInScope
-
- -
- pscanViewRecordsToScan
-
- -
- pscanViewScanners
-
- -
- pscanViewCurrentRule
-
- -
- pscanViewMaxAlertsPerRule
-
- -
- pscanActionSetEnabled
+ acsrfActionSetOptionPartialMatchingEnabled
-
- pscanActionSetScanOnlyInScope
+ acsrfOtherGenForm
-
- pscanActionEnableAllScanners
+ acsrfViewOptionPartialMatchingEnabled
-
- pscanActionDisableAllScanners
+ acsrfViewOptionTokensNames
+
+
+
+ ajaxSpider
+
-
-
- search
-
-
- searchViewUrlsByUrlRegex
+ ajaxSpiderActionRemoveExcludedElement
-
- searchViewUrlsByRequestRegex
+ ajaxSpiderActionScan
-
- searchViewUrlsByResponseRegex
+ ajaxSpiderActionScanAsUser
-
- searchViewUrlsByHeaderRegex
+ ajaxSpiderActionSetEnabledAllowedResource
-
- searchViewMessagesByUrlRegex
+ ajaxSpiderActionSetOptionBrowserId
-
- searchViewMessagesByRequestRegex
+ ajaxSpiderActionSetOptionClickDefaultElems
-
- searchViewMessagesByResponseRegex
+ ajaxSpiderActionSetOptionClickElemsOnce
-
- searchViewMessagesByHeaderRegex
+ ajaxSpiderActionSetOptionEventWait
-
- searchOtherHarByUrlRegex
+ ajaxSpiderActionSetOptionMaxCrawlDepth
-
- searchOtherHarByRequestRegex
+ ajaxSpiderActionSetOptionMaxCrawlStates
-
- searchOtherHarByResponseRegex
+ ajaxSpiderActionSetOptionMaxDuration
-
- searchOtherHarByHeaderRegex
+ ajaxSpiderActionSetOptionNumberOfBrowsers
-
-
-
- autoupdate
-
-
- autoupdateViewLatestVersionNumber
+ ajaxSpiderActionSetOptionRandomInputs
-
- autoupdateViewIsLatestVersion
+ ajaxSpiderActionSetOptionReloadWait
-
- autoupdateViewInstalledAddons
+ ajaxSpiderActionStop
-
- autoupdateViewLocalAddons
+ ajaxSpiderViewAllowedResources
-
- autoupdateViewNewAddons
+ ajaxSpiderViewExcludedElements
-
- autoupdateViewUpdatedAddons
+ ajaxSpiderViewFullResults
-
- autoupdateViewMarketplaceAddons
+ ajaxSpiderViewNumberOfResults
-
- autoupdateViewOptionAddonDirectories
+ ajaxSpiderViewOptionBrowserId
-
- autoupdateViewOptionDayLastChecked
+ ajaxSpiderViewOptionClickDefaultElems
-
- autoupdateViewOptionDayLastInstallWarned
+ ajaxSpiderViewOptionClickElemsOnce
-
- autoupdateViewOptionDayLastUpdateWarned
+ ajaxSpiderViewOptionEventWait
-
- autoupdateViewOptionDownloadDirectory
+ ajaxSpiderViewOptionMaxCrawlDepth
-
- autoupdateViewOptionCheckAddonUpdates
+ ajaxSpiderViewOptionMaxCrawlStates
-
- autoupdateViewOptionCheckOnStart
+ ajaxSpiderViewOptionMaxDuration
-
- autoupdateViewOptionDownloadNewRelease
+ ajaxSpiderViewOptionNumberOfBrowsers
-
- autoupdateViewOptionInstallAddonUpdates
+ ajaxSpiderViewOptionRandomInputs
-
- autoupdateViewOptionInstallScannerRules
+ ajaxSpiderViewOptionReloadWait
-
- autoupdateViewOptionReportAlphaAddons
+ ajaxSpiderViewResults
-
- autoupdateViewOptionReportBetaAddons
+ ajaxSpiderViewStatus
+
+
+
+ alert
+
-
- autoupdateViewOptionReportReleaseAddons
+ alertActionAddAlert
-
- autoupdateActionDownloadLatestRelease
+ alertActionDeleteAlert
-
- autoupdateActionInstallAddon
+ alertActionDeleteAlerts
-
- autoupdateActionInstallLocalAddon
+ alertActionDeleteAllAlerts
-
- autoupdateActionUninstallAddon
+ alertActionUpdateAlert
-
- autoupdateActionSetOptionCheckAddonUpdates
+ alertActionUpdateAlertsConfidence
-
- autoupdateActionSetOptionCheckOnStart
+ alertActionUpdateAlertsRisk
-
- autoupdateActionSetOptionDownloadNewRelease
+ alertViewAlert
-
- autoupdateActionSetOptionInstallAddonUpdates
+ alertViewAlertCountsByRisk
-
- autoupdateActionSetOptionInstallScannerRules
+ alertViewAlerts
-
- autoupdateActionSetOptionReportAlphaAddons
+ alertViewAlertsByRisk
-
- autoupdateActionSetOptionReportBetaAddons
+ alertViewAlertsSummary
-
- autoupdateActionSetOptionReportReleaseAddons
+ alertViewNumberOfAlerts
- spider
+ alertFilter
-
- spiderViewStatus
-
- -
- spiderViewResults
-
- -
- spiderViewFullResults
+ alertFilterActionAddAlertFilter
-
- spiderViewScans
+ alertFilterActionAddGlobalAlertFilter
-
- spiderViewExcludedFromScan
+ alertFilterActionApplyAll
-
- spiderViewAllUrls
+ alertFilterActionApplyContext
-
- spiderViewAddedNodes
+ alertFilterActionApplyGlobal
-
- spiderViewDomainsAlwaysInScope
+ alertFilterActionRemoveAlertFilter
-
- spiderViewOptionDomainsAlwaysInScope
+ alertFilterActionRemoveGlobalAlertFilter
-
- spiderViewOptionDomainsAlwaysInScopeEnabled
+ alertFilterActionTestAll
-
- spiderViewOptionHandleParameters
+ alertFilterActionTestContext
-
- spiderViewOptionMaxChildren
+ alertFilterActionTestGlobal
-
- spiderViewOptionMaxDepth
+ alertFilterViewAlertFilterList
-
- spiderViewOptionMaxDuration
+ alertFilterViewGlobalAlertFilterList
+
+
+
+ ascan
+
-
- spiderViewOptionMaxParseSizeBytes
+ ascanActionAddExcludedParam
-
- spiderViewOptionMaxScansInUI
+ ascanActionAddScanPolicy
-
- spiderViewOptionRequestWaitTime
+ ascanActionClearExcludedFromScan
-
- spiderViewOptionScope
+ ascanActionDisableAllScanners
-
- spiderViewOptionScopeText
+ ascanActionDisableScanners
-
- spiderViewOptionSkipURLString
+ ascanActionEnableAllScanners
-
- spiderViewOptionThreadCount
+ ascanActionEnableScanners
-
- spiderViewOptionUserAgent
+ ascanActionExcludeFromScan
-
- spiderViewOptionAcceptCookies
+ ascanActionImportScanPolicy
-
- spiderViewOptionHandleODataParametersVisited
+ ascanActionModifyExcludedParam
-
- spiderViewOptionParseComments
+ ascanActionPause
-
- spiderViewOptionParseGit
+ ascanActionPauseAllScans
-
- spiderViewOptionParseRobotsTxt
+ ascanActionRemoveAllScans
-
- spiderViewOptionParseSVNEntries
+ ascanActionRemoveExcludedParam
-
- spiderViewOptionParseSitemapXml
+ ascanActionRemoveScan
-
- spiderViewOptionPostForm
+ ascanActionRemoveScanPolicy
-
- spiderViewOptionProcessForm
+ ascanActionResume
-
- spiderViewOptionSendRefererHeader
+ ascanActionResumeAllScans
-
- spiderViewOptionShowAdvancedDialog
+ ascanActionScan
-
- spiderActionScan
+ ascanActionScanAsUser
-
- spiderActionScanAsUser
+ ascanActionSetEnabledPolicies
-
- spiderActionPause
+ ascanActionSetOptionAddQueryParam
-
- spiderActionResume
+ ascanActionSetOptionAllowAttackOnStart
-
- spiderActionStop
+ ascanActionSetOptionAttackPolicy
-
- spiderActionRemoveScan
+ ascanActionSetOptionDefaultPolicy
-
- spiderActionPauseAllScans
+ ascanActionSetOptionDelayInMs
-
- spiderActionResumeAllScans
+ ascanActionSetOptionHandleAntiCSRFTokens
-
- spiderActionStopAllScans
+ ascanActionSetOptionHostPerScan
-
- spiderActionRemoveAllScans
+ ascanActionSetOptionInjectPluginIdInHeader
-
- spiderActionClearExcludedFromScan
+ ascanActionSetOptionMaxAlertsPerRule
-
- spiderActionExcludeFromScan
+ ascanActionSetOptionMaxChartTimeInMins
-
- spiderActionAddDomainAlwaysInScope
+ ascanActionSetOptionMaxResultsToList
-
- spiderActionModifyDomainAlwaysInScope
+ ascanActionSetOptionMaxRuleDurationInMins
-
- spiderActionRemoveDomainAlwaysInScope
+ ascanActionSetOptionMaxScanDurationInMins
-
- spiderActionEnableAllDomainsAlwaysInScope
+ ascanActionSetOptionMaxScansInUI
-
- spiderActionDisableAllDomainsAlwaysInScope
+ ascanActionSetOptionPromptInAttackMode
-
- spiderActionSetOptionHandleParameters
+ ascanActionSetOptionPromptToClearFinishedScans
-
- spiderActionSetOptionScopeString
+ ascanActionSetOptionRescanInAttackMode
-
- spiderActionSetOptionSkipURLString
+ ascanActionSetOptionScanHeadersAllRequests
-
- spiderActionSetOptionUserAgent
+ ascanActionSetOptionScanNullJsonValues
-
- spiderActionSetOptionAcceptCookies
+ ascanActionSetOptionShowAdvancedDialog
-
- spiderActionSetOptionHandleODataParametersVisited
+ ascanActionSetOptionTargetParamsEnabledRPC
-
- spiderActionSetOptionMaxChildren
+ ascanActionSetOptionTargetParamsInjectable
-
- spiderActionSetOptionMaxDepth
+ ascanActionSetOptionThreadPerHost
-
- spiderActionSetOptionMaxDuration
+ ascanActionSetPolicyAlertThreshold
-
- spiderActionSetOptionMaxParseSizeBytes
+ ascanActionSetPolicyAttackStrength
-
- spiderActionSetOptionMaxScansInUI
+ ascanActionSetScannerAlertThreshold
-
- spiderActionSetOptionParseComments
+ ascanActionSetScannerAttackStrength
-
- spiderActionSetOptionParseGit
+ ascanActionSkipScanner
-
- spiderActionSetOptionParseRobotsTxt
+ ascanActionStop
-
- spiderActionSetOptionParseSVNEntries
+ ascanActionStopAllScans
-
- spiderActionSetOptionParseSitemapXml
+ ascanActionUpdateScanPolicy
-
- spiderActionSetOptionPostForm
+ ascanViewAlertsIds
-
- spiderActionSetOptionProcessForm
+ ascanViewAttackModeQueue
-
- spiderActionSetOptionRequestWaitTime
+ ascanViewExcludedFromScan
-
- spiderActionSetOptionSendRefererHeader
+ ascanViewExcludedParamTypes
-
- spiderActionSetOptionShowAdvancedDialog
+ ascanViewExcludedParams
-
- spiderActionSetOptionThreadCount
+ ascanViewMessagesIds
-
-
-
- core
-
-
- coreViewHosts
+ ascanViewOptionAddQueryParam
-
- coreViewSites
+ ascanViewOptionAllowAttackOnStart
-
- coreViewUrls
+ ascanViewOptionAttackPolicy
-
- coreViewChildNodes
+ ascanViewOptionDefaultPolicy
-
- coreViewMessage
+ ascanViewOptionDelayInMs
-
- coreViewMessages
+ ascanViewOptionExcludedParamList
-
- coreViewMessagesById
+ ascanViewOptionHandleAntiCSRFTokens
-
- coreViewNumberOfMessages
+ ascanViewOptionHostPerScan
-
- coreViewMode
+ ascanViewOptionInjectPluginIdInHeader
-
- coreViewVersion
+ ascanViewOptionMaxAlertsPerRule
-
- coreViewExcludedFromProxy
+ ascanViewOptionMaxChartTimeInMins
-
- coreViewHomeDirectory
+ ascanViewOptionMaxResultsToList
-
- coreViewSessionLocation
+ ascanViewOptionMaxRuleDurationInMins
-
- coreViewProxyChainExcludedDomains
+ ascanViewOptionMaxScanDurationInMins
-
- coreViewOptionProxyChainSkipName
+ ascanViewOptionMaxScansInUI
-
- coreViewOptionProxyExcludedDomains
+ ascanViewOptionPromptInAttackMode
-
- coreViewOptionProxyExcludedDomainsEnabled
+ ascanViewOptionPromptToClearFinishedScans
-
- coreViewZapHomePath
+ ascanViewOptionRescanInAttackMode
-
- coreViewOptionMaximumAlertInstances
+ ascanViewOptionScanHeadersAllRequests
-
- coreViewOptionMergeRelatedAlerts
+ ascanViewOptionScanNullJsonValues
-
- coreViewOptionAlertOverridesFilePath
+ ascanViewOptionShowAdvancedDialog
-
- coreViewAlert
+ ascanViewOptionTargetParamsEnabledRPC
-
- coreViewAlerts
+ ascanViewOptionTargetParamsInjectable
-
- coreViewAlertsSummary
+ ascanViewOptionThreadPerHost
-
- coreViewNumberOfAlerts
+ ascanViewPolicies
-
- coreViewOptionDefaultUserAgent
+ ascanViewScanPolicyNames
-
- coreViewOptionDnsTtlSuccessfulQueries
+ ascanViewScanProgress
-
- coreViewOptionHttpState
+ ascanViewScanners
-
- coreViewOptionProxyChainName
+ ascanViewScans
-
- coreViewOptionProxyChainPassword
+ ascanViewStatus
+
+
+
+ authentication
+
-
- coreViewOptionProxyChainPort
+ authenticationActionSetAuthenticationMethod
-
- coreViewOptionProxyChainRealm
+ authenticationActionSetLoggedInIndicator
-
- coreViewOptionProxyChainUserName
+ authenticationActionSetLoggedOutIndicator
-
- coreViewOptionTimeoutInSecs
+ authenticationViewGetAuthenticationMethod
-
- coreViewOptionHttpStateEnabled
+ authenticationViewGetAuthenticationMethodConfigParams
-
- coreViewOptionProxyChainPrompt
+ authenticationViewGetLoggedInIndicator
-
- coreViewOptionSingleCookieRequestHeader
+ authenticationViewGetLoggedOutIndicator
-
- coreViewOptionUseProxyChain
+ authenticationViewGetSupportedAuthenticationMethods
+
+
+
+ authorization
+
+
+
+ automation
+
+
+
+ autoupdate
+
-
- coreActionSaveSession
+ autoupdateActionDownloadLatestRelease
-
- coreActionSnapshotSession
+ autoupdateActionInstallAddon
-
- coreActionClearExcludedFromProxy
+ autoupdateActionInstallLocalAddon
-
- coreActionExcludeFromProxy
+ autoupdateActionSetOptionCheckAddonUpdates
-
- coreActionSetHomeDirectory
+ autoupdateActionSetOptionCheckOnStart
-
- coreActionSetMode
+ autoupdateActionSetOptionDownloadNewRelease
-
- coreActionGenerateRootCA
+ autoupdateActionSetOptionInstallAddonUpdates
-
- coreActionSendRequest
+ autoupdateActionSetOptionInstallScannerRules
-
- coreActionRunGarbageCollection
+ autoupdateActionSetOptionReportAlphaAddons
-
- coreActionDeleteSiteNode
+ autoupdateActionSetOptionReportBetaAddons
-
- coreActionAddProxyChainExcludedDomain
+ autoupdateActionSetOptionReportReleaseAddons
-
- coreActionModifyProxyChainExcludedDomain
+ autoupdateActionUninstallAddon
-
- coreActionRemoveProxyChainExcludedDomain
+ autoupdateViewInstalledAddons
-
- coreActionEnableAllProxyChainExcludedDomains
+ autoupdateViewIsLatestVersion
-
- coreActionDisableAllProxyChainExcludedDomains
+ autoupdateViewLatestVersionNumber
-
- coreActionSetOptionMaximumAlertInstances
+ autoupdateViewLocalAddons
-
- coreActionSetOptionMergeRelatedAlerts
+ autoupdateViewMarketplaceAddons
-
- coreActionSetOptionAlertOverridesFilePath
+ autoupdateViewNewAddons
-
- coreActionEnablePKCS12ClientCertificate
+ autoupdateViewOptionAddonDirectories
-
- coreActionDisableClientCertificate
+ autoupdateViewOptionCheckAddonUpdates
-
- coreActionDeleteAllAlerts
+ autoupdateViewOptionCheckOnStart
-
- coreActionDeleteAlert
+ autoupdateViewOptionDayLastChecked
-
- coreActionSetOptionDefaultUserAgent
+ autoupdateViewOptionDayLastInstallWarned
-
- coreActionSetOptionProxyChainName
+ autoupdateViewOptionDayLastUpdateWarned
-
- coreActionSetOptionProxyChainPassword
+ autoupdateViewOptionDownloadDirectory
-
- coreActionSetOptionProxyChainRealm
+ autoupdateViewOptionDownloadNewRelease
-
- coreActionSetOptionProxyChainSkipName
+ autoupdateViewOptionInstallAddonUpdates
-
- coreActionSetOptionProxyChainUserName
+ autoupdateViewOptionInstallScannerRules
-
- coreActionSetOptionDnsTtlSuccessfulQueries
+ autoupdateViewOptionReportAlphaAddons
-
- coreActionSetOptionHttpStateEnabled
+ autoupdateViewOptionReportBetaAddons
-
- coreActionSetOptionProxyChainPort
+ autoupdateViewOptionReportReleaseAddons
-
- coreActionSetOptionProxyChainPrompt
+ autoupdateViewUpdatedAddons
+
+
+
+ break
+
-
- coreActionSetOptionSingleCookieRequestHeader
+ breakActionAddHttpBreakpoint
-
- coreActionSetOptionTimeoutInSecs
+ breakActionBreak
-
- coreActionSetOptionUseProxyChain
+ breakActionContinue
-
- coreActionSetOptionUseProxyChainAuth
+ breakActionDrop
-
- coreOtherProxy.pac
+ breakActionRemoveHttpBreakpoint
-
- coreOtherRootcert
+ breakActionSetHttpMessage
-
- coreOtherSetproxy
+ breakActionStep
-
- coreOtherXmlreport
+ breakViewHttpMessage
-
- coreOtherHtmlreport
+ breakViewIsBreakAll
-
- coreOtherJsonreport
+ breakViewIsBreakRequest
-
- coreOtherMdreport
+ breakViewIsBreakResponse
+
+
+
+ client
+
- params
+ codedx
- ascan
+ context
-
- ascanViewStatus
+ contextActionExcludeAllContextTechnologies
-
- ascanViewScanProgress
+ contextActionExcludeContextTechnologies
-
- ascanViewMessagesIds
+ contextActionExcludeFromContext
-
- ascanViewAlertsIds
+ contextActionExportContext
-
- ascanViewScans
+ contextActionImportContext
-
- ascanViewScanPolicyNames
+ contextActionIncludeAllContextTechnologies
-
- ascanViewExcludedFromScan
+ contextActionIncludeContextTechnologies
-
- ascanViewScanners
+ contextActionIncludeInContext
-
- ascanViewPolicies
+ contextActionNewContext
-
- ascanViewAttackModeQueue
+ contextActionRemoveContext
-
- ascanViewExcludedParams
+ contextActionSetContextCheckingStrategy
-
- ascanViewOptionExcludedParamList
+ contextActionSetContextInScope
-
- ascanViewExcludedParamTypes
+ contextActionSetContextRegexs
-
- ascanViewOptionAttackPolicy
+ contextViewContext
-
- ascanViewOptionDefaultPolicy
+ contextViewContextList
-
- ascanViewOptionDelayInMs
+ contextViewExcludeRegexs
-
- ascanViewOptionHandleAntiCSRFTokens
+ contextViewExcludedTechnologyList
-
- ascanViewOptionHostPerScan
+ contextViewIncludeRegexs
-
- ascanViewOptionMaxChartTimeInMins
+ contextViewIncludedTechnologyList
-
- ascanViewOptionMaxResultsToList
+ contextViewTechnologyList
-
- ascanViewOptionMaxRuleDurationInMins
+ contextViewUrls
+
+
+
+ core
+
-
- ascanViewOptionMaxScanDurationInMins
+ coreActionAccessUrl
-
- ascanViewOptionMaxScansInUI
+ coreActionAddProxyChainExcludedDomain
-
- ascanViewOptionTargetParamsEnabledRPC
+ coreActionClearExcludedFromProxy
-
- ascanViewOptionTargetParamsInjectable
+ coreActionDeleteAlert
-
- ascanViewOptionThreadPerHost
+ coreActionDeleteAllAlerts
-
- ascanViewOptionAddQueryParam
+ coreActionDeleteSiteNode
-
- ascanViewOptionAllowAttackOnStart
+ coreActionDisableAllProxyChainExcludedDomains
-
- ascanViewOptionInjectPluginIdInHeader
+ coreActionDisableClientCertificate
-
- ascanViewOptionPromptInAttackMode
+ coreActionEnableAllProxyChainExcludedDomains
-
- ascanViewOptionPromptToClearFinishedScans
+ coreActionEnablePKCS12ClientCertificate
-
- ascanViewOptionRescanInAttackMode
+ coreActionExcludeFromProxy
-
- ascanViewOptionScanHeadersAllRequests
+ coreActionGenerateRootCA
-
- ascanViewOptionShowAdvancedDialog
+ coreActionLoadSession
-
- ascanActionScan
+ coreActionModifyProxyChainExcludedDomain
-
- ascanActionScanAsUser
+ coreActionNewSession
-
- ascanActionPause
+ coreActionRemoveProxyChainExcludedDomain
-
- ascanActionResume
+ coreActionRunGarbageCollection
-
- ascanActionStop
+ coreActionSaveSession
-
- ascanActionRemoveScan
+ coreActionSendRequest
-
- ascanActionPauseAllScans
+ coreActionSetHomeDirectory
-
- ascanActionResumeAllScans
+ coreActionSetMode
-
- ascanActionStopAllScans
+ coreActionSetOptionAlertOverridesFilePath
-
- ascanActionRemoveAllScans
+ coreActionSetOptionDefaultUserAgent
-
- ascanActionClearExcludedFromScan
+ coreActionSetOptionDnsTtlSuccessfulQueries
-
- ascanActionExcludeFromScan
+ coreActionSetOptionHttpStateEnabled
-
- ascanActionEnableAllScanners
+ coreActionSetOptionMaximumAlertInstances
-
- ascanActionDisableAllScanners
+ coreActionSetOptionMergeRelatedAlerts
-
- ascanActionEnableScanners
+ coreActionSetOptionProxyChainName
-
- ascanActionDisableScanners
+ coreActionSetOptionProxyChainPassword
-
- ascanActionSetEnabledPolicies
+ coreActionSetOptionProxyChainPort
-
- ascanActionSetPolicyAttackStrength
+ coreActionSetOptionProxyChainPrompt
-
- ascanActionSetPolicyAlertThreshold
+ coreActionSetOptionProxyChainRealm
-
- ascanActionSetScannerAttackStrength
+ coreActionSetOptionProxyChainSkipName
-
- ascanActionSetScannerAlertThreshold
+ coreActionSetOptionProxyChainUserName
-
- ascanActionAddScanPolicy
+ coreActionSetOptionSingleCookieRequestHeader
-
- ascanActionRemoveScanPolicy
+ coreActionSetOptionTimeoutInSecs
-
- ascanActionUpdateScanPolicy
+ coreActionSetOptionUseProxyChain
-
- ascanActionImportScanPolicy
+ coreActionSetOptionUseProxyChainAuth
-
- ascanActionAddExcludedParam
+ coreActionSetOptionUseSocksProxy
-
- ascanActionModifyExcludedParam
+ coreActionShutdown
-
- ascanActionRemoveExcludedParam
+ coreActionSnapshotSession
-
- ascanActionSkipScanner
+ coreOtherFileDownload
-
- ascanActionSetOptionAttackPolicy
+ coreOtherFileUpload
-
- ascanActionSetOptionDefaultPolicy
+ coreOtherHtmlreport
-
- ascanActionSetOptionAddQueryParam
+ coreOtherJsonreport
-
- ascanActionSetOptionAllowAttackOnStart
+ coreOtherMdreport
-
- ascanActionSetOptionDelayInMs
+ coreOtherMessageHar
-
- ascanActionSetOptionHandleAntiCSRFTokens
+ coreOtherMessagesHar
-
- ascanActionSetOptionHostPerScan
+ coreOtherMessagesHarById
-
- ascanActionSetOptionInjectPluginIdInHeader
+ coreOtherProxy.pac
-
- ascanActionSetOptionMaxChartTimeInMins
+ coreOtherRootcert
-
- ascanActionSetOptionMaxResultsToList
+ coreOtherSendHarRequest
-
- ascanActionSetOptionMaxRuleDurationInMins
+ coreOtherSetproxy
-
- ascanActionSetOptionMaxScanDurationInMins
+ coreOtherXmlreport
-
- ascanActionSetOptionMaxScansInUI
+ coreViewAlert
-
- ascanActionSetOptionPromptInAttackMode
+ coreViewAlerts
-
- ascanActionSetOptionPromptToClearFinishedScans
+ coreViewAlertsSummary
-
- ascanActionSetOptionRescanInAttackMode
+ coreViewChildNodes
-
- ascanActionSetOptionScanHeadersAllRequests
+ coreViewExcludedFromProxy
-
- ascanActionSetOptionShowAdvancedDialog
+ coreViewHomeDirectory
-
- ascanActionSetOptionTargetParamsEnabledRPC
+ coreViewHosts
-
- ascanActionSetOptionTargetParamsInjectable
+ coreViewMessage
-
- ascanActionSetOptionThreadPerHost
+ coreViewMessages
-
-
-
- context
-
-
- contextViewContextList
+ coreViewMessagesById
-
- contextViewExcludeRegexs
+ coreViewMode
-
- contextViewIncludeRegexs
+ coreViewNumberOfAlerts
-
- contextViewContext
+ coreViewNumberOfMessages
-
- contextViewTechnologyList
+ coreViewOptionAlertOverridesFilePath
-
- contextViewIncludedTechnologyList
+ coreViewOptionDefaultUserAgent
-
- contextViewExcludedTechnologyList
+ coreViewOptionDnsTtlSuccessfulQueries
-
- contextViewUrls
+ coreViewOptionHttpState
-
- contextActionExcludeFromContext
+ coreViewOptionHttpStateEnabled
-
- contextActionIncludeInContext
+ coreViewOptionMaximumAlertInstances
-
- contextActionSetContextRegexs
+ coreViewOptionMergeRelatedAlerts
-
- contextActionNewContext
+ coreViewOptionProxyChainName
-
- contextActionRemoveContext
+ coreViewOptionProxyChainPassword
-
- contextActionExportContext
+ coreViewOptionProxyChainPort
-
- contextActionImportContext
+ coreViewOptionProxyChainPrompt
-
- contextActionIncludeContextTechnologies
+ coreViewOptionProxyChainRealm
-
- contextActionIncludeAllContextTechnologies
+ coreViewOptionProxyChainSkipName
-
- contextActionExcludeContextTechnologies
+ coreViewOptionProxyChainUserName
-
- contextActionExcludeAllContextTechnologies
+ coreViewOptionProxyExcludedDomains
-
- contextActionSetContextInScope
+ coreViewOptionProxyExcludedDomainsEnabled
-
-
-
- httpSessions
-
-
- httpSessionsViewSites
+ coreViewOptionSingleCookieRequestHeader
-
- httpSessionsViewSessions
+ coreViewOptionTimeoutInSecs
-
- httpSessionsViewActiveSession
+ coreViewOptionUseProxyChain
-
- httpSessionsViewSessionTokens
+ coreViewOptionUseProxyChainAuth
-
- httpSessionsViewDefaultSessionTokens
+ coreViewOptionUseSocksProxy
-
- httpSessionsActionCreateEmptySession
+ coreViewProxyChainExcludedDomains
-
- httpSessionsActionRemoveSession
+ coreViewSessionLocation
-
- httpSessionsActionSetActiveSession
+ coreViewSites
-
- httpSessionsActionUnsetActiveSession
+ coreViewUrls
-
- httpSessionsActionAddSessionToken
+ coreViewVersion
-
- httpSessionsActionRemoveSessionToken
+ coreViewZapHomePath
+
+
+
+ dev
+
+
+
+ exim
+
+ -
+ eximActionImportHar
-
- httpSessionsActionRenameSession
+ eximActionImportModsec2Logs
-
- httpSessionsActionAddDefaultSessionToken
+ eximActionImportUrls
-
- httpSessionsActionSetDefaultSessionTokenEnabled
+ eximActionImportZapLogs
-
- httpSessionsActionRemoveDefaultSessionToken
+ eximOtherExportHar
+
+ -
+ eximOtherExportHarById
+
+ -
+ eximOtherSendHarRequest
- break
+ forcedUser
+
+
+ graphql
+
-
- breakActionBreak
+ graphqlActionImportFile
-
- breakActionSetHttpMessage
+ graphqlActionImportUrl
-
- breakActionContinue
+ graphqlActionSetOptionArgsType
-
- breakActionStep
+ graphqlActionSetOptionLenientMaxQueryDepthEnabled
-
- breakActionDrop
+ graphqlActionSetOptionMaxAdditionalQueryDepth
-
- breakActionAddHttpBreakpoint
+ graphqlActionSetOptionMaxArgsDepth
-
- breakActionRemoveHttpBreakpoint
+ graphqlActionSetOptionMaxQueryDepth
+
+ -
+ graphqlActionSetOptionOptionalArgsEnabled
+
+ -
+ graphqlActionSetOptionQueryGenEnabled
+
+ -
+ graphqlActionSetOptionQuerySplitType
+
+ -
+ graphqlActionSetOptionRequestMethod
+
+ -
+ graphqlViewOptionArgsType
+
+ -
+ graphqlViewOptionLenientMaxQueryDepthEnabled
+
+ -
+ graphqlViewOptionMaxAdditionalQueryDepth
+
+ -
+ graphqlViewOptionMaxArgsDepth
+
+ -
+ graphqlViewOptionMaxQueryDepth
+
+ -
+ graphqlViewOptionOptionalArgsEnabled
+
+ -
+ graphqlViewOptionQueryGenEnabled
+
+ -
+ graphqlViewOptionQuerySplitType
+
+ -
+ graphqlViewOptionRequestMethod
- authentication
+ httpSessions
-
- authenticationViewGetSupportedAuthenticationMethods
+ httpSessionsActionAddDefaultSessionToken
-
- authenticationViewGetAuthenticationMethodConfigParams
+ httpSessionsActionAddSessionToken
-
- authenticationViewGetAuthenticationMethod
+ httpSessionsActionCreateEmptySession
-
- authenticationViewGetLoggedInIndicator
+ httpSessionsActionRemoveDefaultSessionToken
-
- authenticationViewGetLoggedOutIndicator
+ httpSessionsActionRemoveSession
-
- authenticationActionSetAuthenticationMethod
+ httpSessionsActionRemoveSessionToken
-
- authenticationActionSetLoggedInIndicator
+ httpSessionsActionRenameSession
-
- authenticationActionSetLoggedOutIndicator
+ httpSessionsActionSetActiveSession
+
+ -
+ httpSessionsActionSetDefaultSessionTokenEnabled
+
+ -
+ httpSessionsActionSetSessionTokenValue
+
+ -
+ httpSessionsActionUnsetActiveSession
+
+ -
+ httpSessionsViewActiveSession
+
+ -
+ httpSessionsViewDefaultSessionTokens
+
+ -
+ httpSessionsViewSessionTokens
+
+ -
+ httpSessionsViewSessions
+
+ -
+ httpSessionsViewSites
- authorization
+ keyboard
localProxies
- ruleConfig
+ network
-
- ruleConfigViewRuleConfigValue
+ networkActionAddAlias
-
- ruleConfigViewAllRuleConfigs
+ networkActionAddHttpProxyExclusion
-
- ruleConfigActionResetRuleConfigValue
+ networkActionAddLocalServer
-
- ruleConfigActionResetAllRuleConfigValues
+ networkActionAddPassThrough
-
- ruleConfigActionSetRuleConfigValue
+ networkActionAddPkcs12ClientCertificate
-
-
-
- sessionManagement
-
-
- sessionManagementViewGetSupportedSessionManagementMethods
+ networkActionAddRateLimitRule
-
- sessionManagementViewGetSessionManagementMethodConfigParams
+ networkActionGenerateRootCaCert
-
- sessionManagementViewGetSessionManagementMethod
+ networkActionImportRootCaCert
-
- sessionManagementActionSetSessionManagementMethod
+ networkActionRemoveAlias
-
-
-
- users
-
-
- usersViewUsersList
+ networkActionRemoveHttpProxyExclusion
-
- usersViewGetUserById
+ networkActionRemoveLocalServer
-
- usersViewGetAuthenticationCredentialsConfigParams
+ networkActionRemovePassThrough
-
- usersViewGetAuthenticationCredentials
+ networkActionRemoveRateLimitRule
-
- usersActionNewUser
+ networkActionSetAliasEnabled
-
- usersActionRemoveUser
+ networkActionSetConnectionTimeout
-
- usersActionSetUserEnabled
+ networkActionSetDefaultUserAgent
-
- usersActionSetUserName
+ networkActionSetDnsTtlSuccessfulQueries
-
- usersActionSetAuthenticationCredentials
+ networkActionSetHttpProxy
+
+ -
+ networkActionSetHttpProxyAuthEnabled
+
+ -
+ networkActionSetHttpProxyEnabled
+
+ -
+ networkActionSetHttpProxyExclusionEnabled
+
+ -
+ networkActionSetPassThroughEnabled
+
+ -
+ networkActionSetRateLimitRuleEnabled
+
+ -
+ networkActionSetRootCaCertValidity
+
+ -
+ networkActionSetServerCertValidity
+
+ -
+ networkActionSetSocksProxy
+
+ -
+ networkActionSetSocksProxyEnabled
+
+ -
+ networkActionSetUseClientCertificate
+
+ -
+ networkActionSetUseGlobalHttpState
+
+ -
+ networkOtherProxy.pac
+
+ -
+ networkOtherRootCaCert
+
+ -
+ networkOtherSetProxy
+
+ -
+ networkViewGetAliases
+
+ -
+ networkViewGetConnectionTimeout
+
+ -
+ networkViewGetDefaultUserAgent
+
+ -
+ networkViewGetDnsTtlSuccessfulQueries
+
+ -
+ networkViewGetHttpProxy
+
+ -
+ networkViewGetHttpProxyExclusions
+
+ -
+ networkViewGetLocalServers
+
+ -
+ networkViewGetPassThroughs
+
+ -
+ networkViewGetRateLimitRules
+
+ -
+ networkViewGetRootCaCertValidity
+
+ -
+ networkViewGetServerCertValidity
+
+ -
+ networkViewGetSocksProxy
+
+ -
+ networkViewIsHttpProxyAuthEnabled
+
+ -
+ networkViewIsHttpProxyEnabled
+
+ -
+ networkViewIsSocksProxyEnabled
+
+ -
+ networkViewIsUseGlobalHttpState
- forcedUser
+ openapi
+
+
+ paramDigger
+
+
+
+ pnh
+
+ -
+ pnhActionMonitor
-
- forcedUserActionSetForcedUserModeEnabled
+ pnhActionOracle
+
+ -
+ pnhActionStartMonitoring
+
+ -
+ pnhActionStopMonitoring
+
+ -
+ pnhOtherFx_pnh.xpi
+
+ -
+ pnhOtherManifest
+
+ -
+ pnhOtherPnh
+
+ -
+ pnhOtherService
- script
+ postman
+
+
+ pscan
+
-
- scriptViewListScripts
+ pscanActionClearQueue
-
- scriptViewGlobalVar
+ pscanActionDisableAllScanners
-
- scriptViewGlobalVars
+ pscanActionDisableAllTags
-
- scriptViewScriptVar
+ pscanActionDisableScanners
-
- scriptViewScriptVars
+ pscanActionEnableAllScanners
-
- scriptActionEnable
+ pscanActionEnableAllTags
-
- scriptActionDisable
+ pscanActionEnableScanners
-
- scriptActionLoad
+ pscanActionSetEnabled
-
- scriptActionRemove
+ pscanActionSetMaxAlertsPerRule
-
- scriptActionRunStandAloneScript
+ pscanActionSetScanOnlyInScope
-
- scriptActionClearGlobalVar
+ pscanActionSetScannerAlertThreshold
-
- scriptActionClearGlobalVars
+ pscanViewCurrentRule
-
- scriptActionClearScriptVar
+ pscanViewCurrentTasks
-
- scriptActionClearScriptVars
+ pscanViewMaxAlertsPerRule
-
- scriptActionSetScriptVar
+ pscanViewRecordsToScan
-
- scriptActionSetGlobalVar
+ pscanViewScanOnlyInScope
+
+ -
+ pscanViewScanners
- stats
+ quickstartlaunch
+
+
+ replacer
+
+
+
+ reports
+
+
+
+ retest
+
+
+
+ reveal
+
+
+
+ revisit
+
- Schemas
+ ruleConfig
-
+
+ ruleConfigActionResetRuleConfigValue
+
+
+ ruleConfigActionSetRuleConfigValue
+
+
+ ruleConfigViewAllRuleConfigs
+
+
+ ruleConfigViewRuleConfigValue
+
+
+
+
+ script
+
+ -
+ scriptActionClearGlobalCustomVar
+
+ -
+ scriptActionClearGlobalVar
+
+ -
+ scriptActionClearGlobalVars
+
+ -
+ scriptActionClearScriptCustomVar
+
+ -
+ scriptActionClearScriptVar
+
+ -
+ scriptActionClearScriptVars
+
+ -
+ scriptActionDisable
+
+ -
+ scriptActionEnable
+
+ -
+ scriptActionLoad
+
+ -
+ scriptActionRemove
+
+ -
+ scriptActionRunStandAloneScript
+
+ -
+ scriptActionSetGlobalVar
+
+ -
+ scriptActionSetScriptVar
+
+ -
+ scriptViewGlobalCustomVar
+
+ -
+ scriptViewGlobalCustomVars
+
+ -
+ scriptViewGlobalVar
+
+ -
+ scriptViewGlobalVars
+
+ -
+ scriptViewListEngines
+
+ -
+ scriptViewListScripts
+
+ -
+ scriptViewListTypes
+
+ -
+ scriptViewScriptCustomVar
+
+ -
+ scriptViewScriptCustomVars
+
+ -
+ scriptViewScriptVar
+
+ -
+ scriptViewScriptVars
+
+
+
+
+ search
+
+ -
+ searchOtherHarByHeaderRegex
+
+ -
+ searchOtherHarByRequestRegex
+
+ -
+ searchOtherHarByResponseRegex
+
+ -
+ searchOtherHarByUrlRegex
+
+ -
+ searchViewMessagesByHeaderRegex
+
+ -
+ searchViewMessagesByRequestRegex
+
+ -
+ searchViewMessagesByResponseRegex
+
+ -
+ searchViewMessagesByUrlRegex
+
+ -
+ searchViewUrlsByHeaderRegex
+
+ -
+ searchViewUrlsByRequestRegex
+
+ -
+ searchViewUrlsByResponseRegex
+
+ -
+ searchViewUrlsByUrlRegex
+
+
+
+
+ selenium
+
+ -
+ seleniumActionAddBrowserArgument
+
+ -
+ seleniumActionRemoveBrowserArgument
+
+ -
+ seleniumActionSetBrowserArgumentEnabled
+
+ -
+ seleniumActionSetOptionChromeBinaryPath
+
+ -
+ seleniumActionSetOptionChromeDriverPath
+
+ -
+ seleniumActionSetOptionFirefoxBinaryPath
+
+ -
+ seleniumActionSetOptionFirefoxDefaultProfile
+
+ -
+ seleniumActionSetOptionFirefoxDriverPath
+
+ -
+ seleniumActionSetOptionIeDriverPath
+
+ -
+ seleniumActionSetOptionLastDirectory
+
+ -
+ seleniumActionSetOptionPhantomJsBinaryPath
+
+ -
+ seleniumViewGetBrowserArguments
+
+ -
+ seleniumViewOptionBrowserExtensions
+
+ -
+ seleniumViewOptionChromeBinaryPath
+
+ -
+ seleniumViewOptionChromeDriverPath
+
+ -
+ seleniumViewOptionFirefoxBinaryPath
+
+ -
+ seleniumViewOptionFirefoxDefaultProfile
+
+ -
+ seleniumViewOptionFirefoxDriverPath
+
+ -
+ seleniumViewOptionIeDriverPath
+
+ -
+ seleniumViewOptionLastDirectory
+
+ -
+ seleniumViewOptionPhantomJsBinaryPath
+
+
+
+
+ sessionManagement
+
+
+
+ soap
+
+ -
+ soapActionImportFile
+
+ -
+ soapActionImportUrl
+
+
+
+
+ spider
+
+ -
+ spiderActionAddDomainAlwaysInScope
+
+ -
+ spiderActionClearExcludedFromScan
+
+ -
+ spiderActionDisableAllDomainsAlwaysInScope
+
+ -
+ spiderActionEnableAllDomainsAlwaysInScope
+
+ -
+ spiderActionExcludeFromScan
+
+ -
+ spiderActionModifyDomainAlwaysInScope
+
+ -
+ spiderActionPause
+
+ -
+ spiderActionPauseAllScans
+
+ -
+ spiderActionRemoveAllScans
+
+ -
+ spiderActionRemoveDomainAlwaysInScope
+
+ -
+ spiderActionRemoveScan
+
+ -
+ spiderActionResume
+
+ -
+ spiderActionResumeAllScans
+
+ -
+ spiderActionScan
+
+ -
+ spiderActionScanAsUser
+
+ -
+ spiderActionSetOptionAcceptCookies
+
+ -
+ spiderActionSetOptionHandleODataParametersVisited
+
+ -
+ spiderActionSetOptionHandleParameters
+
+ -
+ spiderActionSetOptionMaxChildren
+
+ -
+ spiderActionSetOptionMaxDepth
+
+ -
+ spiderActionSetOptionMaxDuration
+
+ -
+ spiderActionSetOptionMaxParseSizeBytes
+
+ -
+ spiderActionSetOptionMaxScansInUI
+
+ -
+ spiderActionSetOptionParseComments
+
+ -
+ spiderActionSetOptionParseDsStore
+
+ -
+ spiderActionSetOptionParseGit
+
+ -
+ spiderActionSetOptionParseRobotsTxt
+
+ -
+ spiderActionSetOptionParseSVNEntries
+
+ -
+ spiderActionSetOptionParseSitemapXml
+
+ -
+ spiderActionSetOptionPostForm
+
+ -
+ spiderActionSetOptionProcessForm
+
+ -
+ spiderActionSetOptionRequestWaitTime
+
+ -
+ spiderActionSetOptionSendRefererHeader
+
+ -
+ spiderActionSetOptionShowAdvancedDialog
+
+ -
+ spiderActionSetOptionSkipURLString
+
+ -
+ spiderActionSetOptionThreadCount
+
+ -
+ spiderActionSetOptionUserAgent
+
+ -
+ spiderActionStop
+
+ -
+ spiderActionStopAllScans
+
+ -
+ spiderViewAddedNodes
+
+ -
+ spiderViewAllUrls
+
+ -
+ spiderViewDomainsAlwaysInScope
+
+ -
+ spiderViewExcludedFromScan
+
+ -
+ spiderViewFullResults
+
+ -
+ spiderViewOptionAcceptCookies
+
+ -
+ spiderViewOptionDomainsAlwaysInScope
+
+ -
+ spiderViewOptionDomainsAlwaysInScopeEnabled
+
+ -
+ spiderViewOptionHandleODataParametersVisited
+
+ -
+ spiderViewOptionHandleParameters
+
+ -
+ spiderViewOptionMaxChildren
+
+ -
+ spiderViewOptionMaxDepth
+
+ -
+ spiderViewOptionMaxDuration
+
+ -
+ spiderViewOptionMaxParseSizeBytes
+
+ -
+ spiderViewOptionMaxScansInUI
+
+ -
+ spiderViewOptionParseComments
+
+ -
+ spiderViewOptionParseDsStore
+
+ -
+ spiderViewOptionParseGit
+
+ -
+ spiderViewOptionParseRobotsTxt
+
+ -
+ spiderViewOptionParseSVNEntries
+
+ -
+ spiderViewOptionParseSitemapXml
+
+ -
+ spiderViewOptionPostForm
+
+ -
+ spiderViewOptionProcessForm
+
+ -
+ spiderViewOptionRequestWaitTime
+
+ -
+ spiderViewOptionSendRefererHeader
+
+ -
+ spiderViewOptionShowAdvancedDialog
+
+ -
+ spiderViewOptionSkipURLString
+
+ -
+ spiderViewOptionThreadCount
+
+ -
+ spiderViewOptionUserAgent
+
+ -
+ spiderViewResults
+
+ -
+ spiderViewScans
+
+ -
+ spiderViewStatus
+
+
+
+
+ stats
+
+ -
+ statsActionClearStats
+
+ -
+ statsActionSetOptionInMemoryEnabled
+
+ -
+ statsActionSetOptionStatsdHost
+
+ -
+ statsActionSetOptionStatsdPort
+
+ -
+ statsActionSetOptionStatsdPrefix
+
+ -
+ statsViewAllSitesStats
+
+ -
+ statsViewOptionInMemoryEnabled
+
+ -
+ statsViewOptionStatsdEnabled
+
+ -
+ statsViewOptionStatsdHost
+
+ -
+ statsViewOptionStatsdPort
+
+ -
+ statsViewOptionStatsdPrefix
+
+ -
+ statsViewSiteStats
+
+ -
+ statsViewStats
+
+
+
+
+ users
+
+ -
+ usersActionAuthenticateAsUser
+
+ -
+ usersActionNewUser
+
+ -
+ usersActionPollAsUser
+
+ -
+ usersActionRemoveUser
+
+ -
+ usersActionSetAuthenticationCredentials
+
+ -
+ usersActionSetAuthenticationState
+
+ -
+ usersActionSetCookie
+
+ -
+ usersActionSetUserEnabled
+
+ -
+ usersActionSetUserName
+
+ -
+ usersViewGetAuthenticationCredentials
+
+ -
+ usersViewGetAuthenticationCredentialsConfigParams
+
+ -
+ usersViewGetAuthenticationSession
+
+ -
+ usersViewGetAuthenticationState
+
+ -
+ usersViewGetUserById
+
+ -
+ usersViewUsersList
+
+
+
+
+ wappalyzer
+
+ -
+ wappalyzerViewListAll
+
+ -
+ wappalyzerViewListSite
+
+ -
+ wappalyzerViewListSites
+
+
+
+
+ websocket
+
+ -
+ websocketActionSendTextMessage
+
+ -
+ websocketActionSetBreakTextMessage
+
+ -
+ websocketViewBreakTextMessage
+
+ -
+ websocketViewChannels
+
+ -
+ websocketViewMessage
+
+ -
+ websocketViewMessages
+
+
+
+
+ Schemas
+
+ -
+ ErrorJson
+
+
+
- ZAP Website
@@ -1760,1935 +2561,20830 @@ Introduction
Overview
applications. ZAP also has an extremely powerful API that allows you to do nearly everything that is possible via the desktop interface.
This allows the developers to automate pentesting and security regression testing of the application in the CI/CD pipeline.
-This document provides example guides & API definitions for ZAP APIs. You can view code examples in the dark area to
-the right; switch the programming language of the examples with the tabs on the top right.
-If anything is missing or seems incorrect, please check the FAQs or the
-GitHub issues for existing known issues.
-Also, if you are new to ZAP, then check out the getting started guide
-to learn the basic concepts behind ZAP.
+This document provides example guides & API definitions for ZAP APIs. You can view code examples in the dark area to
+the right; switch the programming language of the examples with the tabs on the top right.
+If anything is missing or seems incorrect, please check the FAQs or the
+GitHub issues for existing known issues.
+Also, if you are new to ZAP, then check out the getting started guide
+to learn the basic concepts behind ZAP.
+
+The following are some of the features provided by ZAP:
+
+
+- Intercepting Proxy
+- Active and Passive Scanners
+- Traditional and Ajax Spiders
+- Brute Force Scanner
+- Port Scanner
+- Web Sockets
+
+
+Have a look at the examples below to learn how to use each of these features via ZAP API.
+Documentation Structure
+The API documentation is divided into nine main sections.
+
+
+- Introduction section contains introductory information of ZAP and installation guide to set up ZAP for testing.
+- Exploring the App section contains examples on how to explore the web application.
+- Attacking the App section contains examples on how to scan or attack a web application.
+- Getting the Results section contains examples on how to retrieve alerts and generate Reports from ZAP.
+- Getting Authenticated section contains examples on how to authenticate the web application with ZAP.
+- Advanced Settings section contains advanced configurations on how to fine tune ZAP results.
+- Contributions section contains guidelines and instructions on how to contribute to ZAP's documentation.
+- API Catalogue section contains OpenAPI definitions and auto generated code for ZAP APIs.
+- Troubleshooting section contains solutions for trouble shooting ZAP API related issues.
+
+
+
+Basics on the API Request
+ZAP APIs provide access to most of the core features of ZAP such as the active scanner and spider. ZAP API is enabled by default
+in the daemon mode and the desktop mode. If you are using ZAP desktop, then the API can be configured by visiting the following screen:
+
+Tools -> Options -> API.
+
+
+
+
+
+
+
+Please note that not all the operations which are available in the desktop interface are available via the APIs.
+Future versions of ZAP will increase the functionality/scope available via the APIs.
+API URL Format
+The API is available via GET and POST endpoints and the response is available in JSON, XML, HTML, and OTHER (custom formats, e.g. HAR) formats.
+All the response formats return the same information, just in a different format. Based on the use case, choose the appropriate format.
+For example, to generate easily readable reports use the HTML format and use XML/JSON based response to parse the results quickly.
+
+The following example shows the API URL format of ZAP:
+
+http://zap/<format>/<component>/<operation>/<operation name>[/?<parameters>]
+
+The format can be either JSON, XML or HTML. The operation can be either view or action or other. The view operation is used to return
+information and the action is used to control ZAP. For example, views can be used to generated reports or retrieve results and
+action can be used to start or stop the Spider. The components, operation names and parameters can all be discovered by
+browsing the API Catalogue.
+Access the API
+The REST API can be accessed directly or via one of the client implementations detailed below.
+A simple web UI is also available to explore and use the APIs via the browser. This web UI can be accessed via http://zap/
+when you are proxying through ZAP, or via the host and port ZAP is listening on, e.g. http://localhost:8080/.
+
+
+
+By default only the machine ZAP is running on is able to access the APIs. You can allow other machines,
+that are able to use ZAP as a proxy, access to the API.
+Client SDKs
+API clients are available for the following languages:
+
+
+
+Language
+Download links
+Notes
+
+
+
+.NET
+NuGet
+Official API
+
+
+Java
+GitHub Maven Central
+Official API
+
+
+Node.js
+NPM
+Official API
+
+
+PHP
+GitHub Packagist
+In process of becoming an official API
+
+
+Python
+PyPI
+Official API
+
+
+Ruby
+GitHub
+
+
+Quick Setup Guide
+The quick setup guide focuses on setting up ZAP and a testing application. If you have already setup ZAP then Jump to
+specific example to experiment with specific features.
+Start ZAP
# For Linux, Option: 1, using "headless/daemon" mode
+<ZAP_HOME>./zap.sh -daemon -config api.key=change-me-9203935709
+# For Linux, Option: 2, using ZAP desktop App
+<ZAP_HOME>./zap.sh
+
+# For Windows, Run the exe file or zap.bat script to start ZAP
+
// For Linux, Option: 1, using "headless/daemon" mode
+<ZAP_HOME>./zap.sh -daemon -config api.key=change-me-9203935709
+// For Linux, Option: 2, using ZAP desktop App
+<ZAP_HOME>./zap.sh
+
+// For Windows, Run the exe file or zap.bat script to start ZAP
+
# For Linux, Option: 1, using "headless/daemon" mode
+$ <ZAP_HOME>./zap.sh -daemon -config api.key=change-me-9203935709
+# For Linux, Option: 2, using ZAP desktop App
+$ <ZAP_HOME>./zap.sh
+
+# For Windows, Run the exe file or zap.bat script to start ZAP
+
+To install ZAP, go to ZAP's home page and download the installer specific to the
+operating system. After extracting the bundle you can start ZAP by issuing the following command shown in the right column.
+
+The API key must be specified on all API actions and some other operations. The API key is used to prevent malicious
+sites from accessing ZAP API.
+Setup a Testing Application
+If you already have a website to scan or to perform security testing, then obtain the URL/IP of the application to begin the scanning.
+The example guide uses Google's Firing Range and
+OWASP Juice Shop to perform the security testing.
+The Spidering and Attacking examples use the public instance of the
+Firing Range, and OWASP Juice Shop are used to showcase the Authentication examples of ZAP.
+
+The following is a list
+of publicly available vulnerable applications that you can also used in conjunction with ZAP.
+
+
+Getting Help
+All available APIs are documented in the API Catalogue. If you are new to ZAP, then it's highly
+recommended that you experiment with the desktop UI before trying out the APIs. Because ZAP's APIs strongly resemble
+the desktop UI. Therefore by working with the UI, you will get a good understanding on how to orchestrate ZAP's APIs.
+Also, use the export config functionality from the desktop UI to export complex configurations such as contexts, scan policies, etc.
+Then use the exported configurations when creating the automation scripts.
+
+ZAP has a very friendly and active developer community. Always feel free to raise a question in the
+ZAP users forum or Stack Overflow
+for issues related to ZAP. Also, use the ZAP's GitHub repository
+to raise a bug report or to make any feature requests.
+
+Stay tuned on twitter @zaproxy.
+Exploring the App
+In order to expose content and functionality for ZAP to test the target the application should be explored before performing
+any scan or attack. The more you explore your App the more accurate the results will be. If the application is not explored
+very well then it will impact or reduce the vulnerabilities ZAP can find.
+
+The following are some of the options to explore the site by using ZAP. You can use multiple approaches in a combination to
+get more complete coverage of the application.
+
+
+Traditional Spider (Crawler): Use this approach to crawl the HTML resources (hyperlinks etc) in the web application.
Ajax Spider: Use this feature if the application heavily relies with Ajax calls.
Proxy Regression / Unit Tests This is the recommended approach for security regression testing. Use this approach
+to explore the application, if you already have a test suite or unit tests in place.
OpenAPI/SOAP Definition: Use this approach if you have a well defined OpenAPI definition. The OpenAPI plugin can be downloaded
+via the marketplace.
+Using Spider
#!/usr/bin/env python
+import time
+from zapv2 import ZAPv2
+
+# The URL of the application to be tested
+target = 'https://public-firing-range.appspot.com'
+# Change to match the API key set in ZAP, or use None if the API key is disabled
+apiKey = 'changeMe'
+
+# By default ZAP API client will connect to port 8080
+zap = ZAPv2(apikey=apiKey)
+# Use the line below if ZAP is not listening on port 8080, for example, if listening on port 8090
+# zap = ZAPv2(apikey=apiKey, proxies={'http': 'http://127.0.0.1:8090', 'https': 'http://127.0.0.1:8090'})
+
+print('Spidering target {}'.format(target))
+# The scan returns a scan id to support concurrent scanning
+scanID = zap.spider.scan(target)
+while int(zap.spider.status(scanID)) < 100:
+ # Poll the status until it completes
+ print('Spider progress %: {}'.format(zap.spider.status(scanID)))
+ time.sleep(1)
+
+print('Spider has completed!')
+# Prints the URLs the spider has crawled
+print('\n'.join(map(str, zap.spider.results(scanID))))
+# If required post process the spider results
+
+# TODO: Explore the Application more with Ajax Spider or Start scanning the application for vulnerabilities
+
public class Spider {
+
+ private static final String ZAP_ADDRESS = "localhost";
+ private static final int ZAP_PORT = 8080;
+ // Change to match the API key set in ZAP, or use NULL if the API key is disabled
+ private static final String ZAP_API_KEY = "change me";
+ // The URL of the application to be tested
+ private static final String TARGET = "https://public-firing-range.appspot.com";
+
+ public static void main(String[] args) {
+ ClientApi api = new ClientApi(ZAP_ADDRESS, ZAP_PORT, ZAP_API_KEY);
+
+ try {
+ // Start spidering the target
+ System.out.println("Spidering target : " + TARGET);
+ ApiResponse resp = api.spider.scan(TARGET, null, null, null, null);
+ String scanID;
+ int progress;
+
+ // The scan returns a scan id to support concurrent scanning
+ scanID = ((ApiResponseElement) resp).getValue();
+ // Poll the status until it completes
+ while (true) {
+ Thread.sleep(1000);
+ progress = Integer.parseInt(((ApiResponseElement) api.spider.status(scanID)).getValue());
+ System.out.println("Spider progress : " + progress + "%");
+ if (progress >= 100) {
+ break;
+ }
+ }
+ System.out.println("Spider completed");
+ // If required post process the spider results
+ List<ApiResponse> spiderResults = ((ApiResponseList) api.spider.results(scanID)).getItems();
+
+ // TODO: Explore the Application more with Ajax Spider or Start scanning the application for vulnerabilities
+
+ } catch (Exception e) {
+ System.out.println("Exception : " + e.getMessage());
+ e.printStackTrace();
+ }
+ }
+}
+
# To start the Spider scan (Response: Scan ID). Modify the API Key and URL to suite the target
+$ curl "http://localhost:8080/JSON/spider/action/scan/?apikey=<ZAP_API_KEY>&url=https://public-firing-range.appspot.com&contextName=&recurse="
+
+# To view the scan status/ percentage of work done
+$ curl "http://localhost:8080/JSON/spider/view/status/?apikey=<ZAP_API_KEY>&scanId=<SCAN_ID>"
+
+# To view the scan results
+$ curl "http://localhost:8080/JSON/spider/view/results/?apikey=<ZAP_API_KEY>&scanId=<SCAN_ID>"
+
+# To stop the scanning
+$ curl "http://localhost:8080/JSON/spider/action/stop/?apikey=<ZAP_API_KEY>&scanId=<SCAN_ID>"
+# To pause the scanning
+$ curl "http://localhost:8080/JSON/spider/action/pause/?apikey=<ZAP_API_KEY>&scanId=<SCAN_ID>"
+# To resume the scanning
+$ curl "http://localhost:8080/JSON/spider/action/resume/?apikey=<ZAP_API_KEY>&scanId=<SCAN_ID>"
+
+
+The Spider is a tool that is used to automatically discover new resources (URLs) on a particular site. It begins with a
+list of URLs to visit, called the seeds, which depends on how the Spider is started. The Spider then visits these URLs,
+it identifies all the hyperlinks in the page and adds them to the list of URLs to visit, and the process continues
+recursively as long as new resources are found. Each response type is processed differently in ZAP. All the available
+endpoints for the spider can be found in spider section.
+Start the Spider
+The Spiders explore the site and they don't actually do any scanning. The resources crawled by the Spider(s) are passively scanned
+in the background via the Passive Scanner. The scan API runs the spider against the given URL.
+Optionally, the 'maxChildren' parameter can be set to limit the number of children scanned and the 'recurse' parameter can
+be used to prevent the spider from seeding recursively. The parameter 'subtreeOnly' allows to restrict the spider under a
+site's subtree (using the specified 'URL'). The parameter 'contextName' can be used to constrain the scan to
+a Context. View the context example to understand how to create a context with ZAP API.
+
+The code sample on the right recursively scans the application with the provided URL. The scan ID is returned as a
+response when starting the Spider. Use this scan ID to perform any additional actions or to retrieve any views from the Spider API.
+View Status
+The spider scan is a async request and the time to complete the task will vary depending on the complexity of the web application.
+The scan ID returned via starting the spider should be used to obtain the results of the crawling. Execute the status
+API to get the status/percentage of work done by the Spider.
+View Spider Results
+The results of the crawling can be obtained via the results API. The following image shows the JSON sample
+response provided by the results API, listing all the resources crawled by Spider.
+
+
+Stop or Pause the Spider
+If the scanning takes more time than expected you can stop or pause the scanning via using the stop
+or pause APIs. Additional APIs are available in the API Catalogue to pause or resume or to
+stop All the scanning processes.
+
+The advanced section on Spider contains more examples on how to tweak/improve the Spider results.
+Using Ajax Spider
#!/usr/bin/env python
+import time
+from zapv2 import ZAPv2
+
+# The URL of the application to be tested
+target = 'https://public-firing-range.appspot.com'
+# Change to match the API key set in ZAP, or use None if the API key is disabled
+apiKey = 'changeme'
+
+# By default ZAP API client will connect to port 8080
+zap = ZAPv2(apikey=apiKey)
+# Use the line below if ZAP is not listening on port 8080, for example, if listening on port 8090
+# zap = ZAPv2(apikey=apiKey, proxies={'http': 'http://127.0.0.1:8090', 'https': 'http://127.0.0.1:8090'})
+
+print('Ajax Spider target {}'.format(target))
+scanID = zap.ajaxSpider.scan(target)
+
+timeout = time.time() + 60*2 # 2 minutes from now
+# Loop until the ajax spider has finished or the timeout has exceeded
+while zap.ajaxSpider.status == 'running':
+ if time.time() > timeout:
+ break
+ print('Ajax Spider status' + zap.ajaxSpider.status)
+ time.sleep(2)
+
+print('Ajax Spider completed')
+ajaxResults = zap.ajaxSpider.results(start=0, count=10)
+# If required perform additional operations with the Ajax Spider results
+
+# TODO: Start scanning the application to find vulnerabilities
+
public class AjaxSpider {
+
+ private static final int ZAP_PORT = 8080;
+ private static final String ZAP_API_KEY = null;
+ private static final String ZAP_ADDRESS = "localhost";
+ private static final String TARGET = "https://public-firing-range.appspot.com";
+
+ public static void main(String[] args) {
+ // Create the ZAP Client
+ ClientApi api = new ClientApi(ZAP_ADDRESS, ZAP_PORT, ZAP_API_KEY);
+
+ try {
+ // Start spidering the target
+ System.out.println("Ajax Spider target : " + TARGET);
+ ApiResponse resp = api.ajaxSpider.scan(TARGET, null, null, null);
+ String status;
+
+ long startTime = System.currentTimeMillis();
+ long timeout = TimeUnit.MINUTES.toMillis(2); // Two minutes in milli seconds
+ // Loop until the ajax spider has finished or the timeout has exceeded
+ while (true) {
+ Thread.sleep(2000);
+ status = (((ApiResponseElement) api.ajaxSpider.status()).getValue());
+ System.out.println("Spider status : " + status);
+ if (!("stopped".equals(status)) || (System.currentTimeMillis() - startTime) < timeout) {
+ break;
+ }
+ }
+ System.out.println("Ajax Spider completed");
+ // Perform additional operations with the Ajax Spider results
+ List<ApiResponse> ajaxSpiderResponse = ((ApiResponseList) api.ajaxSpider.results("0", "10")).getItems();
+
+ // TODO: Start scanning(passive/active scan) the application to find vulnerabilities
+
+ } catch (Exception e) {
+ System.out.println("Exception : " + e.getMessage());
+ e.printStackTrace();
+ }
+ }
+}
+
# To start the Ajax Spider
+$ curl "http://localhost:8080/JSON/ajaxSpider/action/scan/?apikey=<ZAP_API_KEY>&url=<URL>&inScope=&contextName=&subtreeOnly="
+
+# To view the status
+$ curl "http://localhost:8080/JSON/ajaxSpider/view/status/?apikey=<ZAP_API_KEY>"
+
+# To view the number of results
+$ curl "http://localhost:8080/JSON/ajaxSpider/view/numberOfResults/?apikey=<ZAP_API_KEY>"
+
+# To view the results
+$ curl "http://localhost:8080/JSON/ajaxSpider/view/fullResults/?apikey=<ZAP_API_KEY>"
+
+# To stop the Ajax Spider
+$ curl "http://localhost:8080/JSON/ajaxSpider/action/stop/?apikey=<ZAP_API_KEY>"
+
+Use the Ajax Spider if you have applications which heavily depend on Ajax or JavaScript. The Ajax Spider allows you to crawl web applications
+written in Ajax in far more depth than the traditional Spider.You should also use the traditional Spider as well for complete coverage
+of a application (e.g. to cover HTML comments).
+Start Ajax Spider
+The scan API starts the Ajax Spider based on a given URL. Similar to the Traditional Spider, Ajax Spider can be also limited to a
+context or scope. The parameter 'contextName' can be used to constrain the scan to a Context, the option 'inScope' is
+ignored if a context was also specified. The parameter 'subtreeOnly' allows to restrict the spider under a site's subtree (using the specified 'URL').
+View Status
+Unlike the traditional Spider, Ajax Spider does not provide a percentage for the work to be done. Use the status
+endpoint to identify whether the Ajax Spider is still active or finished.
+View Results
+Similar to the Traditional Spider, the Ajax Spider's results API can be used to view the resources
+which are crawled by the Ajax Spider. The following image shows a sample response given by the API.
+
+
+Stop the Ajax Spider
+Ajax spider does not have an indication on how much resources are left to be crawled. Therefore if the Ajax spider takes too much time
+than expected, then it can be stopped by using the stop API.
+
+View the advanced section on Ajax Spider to learn more about how to further fine-tune the results of the
+Ajax Spider.
+
+
+Attacking the App
+The application should be explored before starting to scan for security vulnerabilities.
+If you haven't done that look at the explore section on how to explore the web application.
+The following section provides examples on how to use the Passive and Active Scanner to find security vulnerabilities in
+the application.
+
+
+Using Passive Scan
public class PassiveScan {
+
+ private static final int ZAP_PORT = 8080;
+ private static final String ZAP_API_KEY = null;
+ private static final String ZAP_ADDRESS = "localhost";
+
+ public static void main(String[] args) {
+ ClientApi api = new ClientApi(ZAP_ADDRESS, ZAP_PORT, ZAP_API_KEY);
+ int numberOfRecords;
+
+ try {
+ // TODO : explore the app (Spider, etc) before using the Passive Scan API, Refer the explore section for details
+ // Loop until the passive scan has finished
+ while (true) {
+ Thread.sleep(2000);
+ api.pscan.recordsToScan();
+ numberOfRecords = Integer.parseInt(((ApiResponseElement) api.pscan.recordsToScan()).getValue());
+ System.out.println("Number of records left for scanning : " + numberOfRecords);
+ if (numberOfRecords == 0) {
+ break;
+ }
+ }
+ System.out.println("Passive Scan completed");
+
+ // Print Passive scan results/alerts
+ System.out.println("Alerts:");
+ System.out.println(new String(api.core.xmlreport(), StandardCharsets.UTF_8));
+
+ } catch (Exception e) {
+ System.out.println("Exception : " + e.getMessage());
+ e.printStackTrace();
+ }
+ }
+}
+
#!/usr/bin/env python
+import time
+from pprint import pprint
+from zapv2 import ZAPv2
+
+apiKey = 'changeme'
+target = 'https://public-firing-range.appspot.com'
+zap = ZAPv2(apikey=apiKey, proxies={'http': 'http://127.0.0.1:8080', 'https': 'http://127.0.0.1:8080'})
+
+# TODO : explore the app (Spider, etc) before using the Passive Scan API, Refer the explore section for details
+while int(zap.pscan.records_to_scan) > 0:
+ # Loop until the passive scan has finished
+ print('Records to passive scan : ' + zap.pscan.records_to_scan)
+ time.sleep(2)
+
+print('Passive Scan completed')
+
+# Print Passive scan results/alerts
+print('Hosts: {}'.format(', '.join(zap.core.hosts)))
+print('Alerts: ')
+pprint(zap.core.alerts())
+
# To view the number of records left to be scanned
+$ curl "http://localhost:8080/JSON/pscan/view/recordsToScan/?apikey=<ZAP_API_KEY>"
+
+# To view the alerts of passive scan
+$ curl "http://localhost:8080/JSON/core/view/alerts/?apikey=<ZAP_API_KEY>&baseurl=<TARGET_URL>&start=0&count=10"
+
+All requests that are proxied through ZAP or initialised by tools like the Spider are passively scanned. You do not have
+to manually start the passive scan process, ZAP by default passively scans all HTTP and WebSocket messages (requests and responses)
+which are sent to the application.
+
+Passive scanning does not change the requests nor the responses in any way and is therefore safe to use.
+This is good for finding problems like missing security headers or missing anti CSRF tokens but is no good for finding
+vulnerabilities like XSS which require malicious requests to be sent - that's the job of the active scanner.
+View the Status
+As the records are passively scanned it will take additional time to complete the full scan. After the crawling is completed
+use the recordsToScan API to obtain the number of records left to be scanned. After the scanning
+has completed the alerts can be obtained via the alerts endpoint(s).
+
+View the advanced section to know how to configure additional parameters of Passive Scan.
+Using Active Scan
+Active scanning attempts to find potential vulnerabilities by using known attacks against the selected targets. Active scanning
+is an attack on those targets. You should NOT use it on applications that you do not have permission to.
+Start Active Scanner
public class ActiveScan {
+
+ private static final int ZAP_PORT = 8080;
+ private static final String ZAP_API_KEY = null;
+ private static final String ZAP_ADDRESS = "localhost";
+ private static final String TARGET = "https://public-firing-range.appspot.com";
+
+ public static void main(String[] args) {
+
+ ClientApi api = new ClientApi(ZAP_ADDRESS, ZAP_PORT, ZAP_API_KEY);
+
+ try {
+ // TODO : explore the app (Spider, etc) before using the Active Scan API, Refer the explore section
+ System.out.println("Active Scanning target : " + TARGET);
+ ApiResponse resp = api.ascan.scan(TARGET, "True", "False", null, null, null);
+ String scanid;
+ int progress;
+
+ // The scan now returns a scan id to support concurrent scanning
+ scanid = ((ApiResponseElement) resp).getValue();
+ // Poll the status until it completes
+ while (true) {
+ Thread.sleep(5000);
+ progress =
+ Integer.parseInt(
+ ((ApiResponseElement) api.ascan.status(scanid)).getValue());
+ System.out.println("Active Scan progress : " + progress + "%");
+ if (progress >= 100) {
+ break;
+ }
+ }
+
+ System.out.println("Active Scan complete");
+ // Print vulnerabilities found by the scanning
+ System.out.println("Alerts:");
+ System.out.println(new String(api.core.xmlreport(), StandardCharsets.UTF_8));
+
+ } catch (Exception e) {
+ System.out.println("Exception : " + e.getMessage());
+ e.printStackTrace();
+ }
+ }
+}
+
#!/usr/bin/env python
+import time
+from pprint import pprint
+from zapv2 import ZAPv2
+
+apiKey = 'changeme'
+target = 'https://public-firing-range.appspot.com'
+zap = ZAPv2(apikey=apiKey, proxies={'http': 'http://127.0.0.1:8080', 'https': 'http://127.0.0.1:8080'})
+
+# TODO : explore the app (Spider, etc) before using the Active Scan API, Refer the explore section
+print('Active Scanning target {}'.format(target))
+scanID = zap.ascan.scan(target)
+while int(zap.ascan.status(scanID)) < 100:
+ # Loop until the scanner has finished
+ print('Scan progress %: {}'.format(zap.ascan.status(scanID)))
+ time.sleep(5)
+
+print('Active Scan completed')
+# Print vulnerabilities found by the scanning
+print('Hosts: {}'.format(', '.join(zap.core.hosts)))
+print('Alerts: ')
+pprint(zap.core.alerts(baseurl=target))
+
# To start the the active scan
+$ curl "http://localhost:8080/JSON/ascan/action/scan/?apikey=<ZAP_API_KEY>&url=<TARGET_URL>&recurse=true&inScopeOnly=&scanPolicyName=&method=&postData=&contextId="
+
+# To view the the status of active scan
+$ curl "http://localhost:8080/JSON/ascan/view/status/?apikey=<ZAP_API_KEY>&scanId=<SCAN_ID>"
+
+# To view the alerts of active scan
+$ curl "http://localhost:8080/JSON/core/view/alerts/?apikey=<ZAP_API_KEY>&baseurl=<TARGET_URL>&start=0&count=10"
+
+# To stop the active scan
+$ curl "http://localhost:8080/JSON/ascan/action/stop/?apikey=<ZAP_API_KEY>&scanId=<SCAN_ID>"
+
+The scan endpoint runs the active scanner against the given URL or Context. Optionally, the 'recurse' parameter can be used to scan URLs
+under the given URL, the parameter 'inScopeOnly' can be used to constrain the scan to URLs that are in scope (ignored if a Context is specified).
+The parameter 'scanPolicyName' allows to specify the scan policy (if none is given it uses the default scan policy).
+The parameters 'method' and 'postData' allow to select a given request in conjunction with the given URL.
+
+View advanced settings to learn, how to configure the context, scope, and
+scan policy with ZAP APIs.
+View Status
+The status API provides the percentage of scanning done by the active scanner. The scan ID returned
+via starting the Active Scan should be used to query the status of the scanner.
+View Results
+Similar to the passive scan results, the active scan results can be viewed using the same alerts endpoint(s).
+The alerts endpoint(s) will show the consolidated results of Passive and Active Scan.
+Stop Active Scanning
+Use the stop API to stop a long running active scan. Optionally you can use the stopAllScans
+endpoints or pause endpoint to stop and pause the active scanning.
+
+It should be noted that active scanning can only find certain types of vulnerabilities. Logical vulnerabilities, such as
+broken access control, will not be found by any active or automated vulnerability scanning. Manual penetration testing should
+always be performed in addition to active scanning to find all types of vulnerabilities.
+Getting the Results
#!/usr/bin/env python
+from zapv2 import ZAPv2
+
+# The URL of the application to be tested
+target = 'https://public-firing-range.appspot.com'
+# Change to match the API key set in ZAP, or use None if the API key is disabled
+apiKey = 'changeMe'
+
+# By default ZAP API client will connect to port 8080
+zap = ZAPv2(apikey=apiKey)
+# Use the line below if ZAP is not listening on port 8080, for example, if listening on port 8090
+# zap = ZAPv2(apikey=apiKey, proxies={'http': 'http://127.0.0.1:8090', 'https': 'http://127.0.0.1:8090'})
+
+# TODO: Check if the scanning has completed
+
+# Retrieve the alerts using paging in case there are lots of them
+st = 0
+pg = 5000
+alert_dict = {}
+alert_count = 0
+alerts = zap.alert.alerts(baseurl=target, start=st, count=pg)
+blacklist = [1,2]
+while len(alerts) > 0:
+ print('Reading ' + str(pg) + ' alerts from ' + str(st))
+ alert_count += len(alerts)
+ for alert in alerts:
+ plugin_id = alert.get('pluginId')
+ if plugin_id in blacklist:
+ continue
+ if alert.get('risk') == 'High':
+ # Trigger any relevant postprocessing
+ continue
+ if alert.get('risk') == 'Informational':
+ # Ignore all info alerts - some of them may have been downgraded by security annotations
+ continue
+ st += pg
+ alerts = zap.alert.alerts(start=st, count=pg)
+print('Total number of alerts: ' + str(alert_count))
+
public class Alerts {
+
+ private static final String ZAP_ADDRESS = "localhost";
+ private static final int ZAP_PORT = 8080;
+ // Change to match the API key set in ZAP, or use NULL if the API key is disabled
+ private static final String ZAP_API_KEY = "change me";
+ // The URL of the application to be tested
+ private static final String TARGET = "https://public-firing-range.appspot.com";
+
+ private static List<String> blackListPlugins = Arrays.asList("1000", "1025");
+
+
+ public static void main(String[] args) {
+ ClientApi api = new ClientApi(ZAP_ADDRESS, ZAP_PORT, ZAP_API_KEY);
+
+ try {
+ // TODO: Check if the scanning has completed
+
+ // Retrieve the alerts using paging in case there are lots of them
+ int start = 0;
+ int count = 5000;
+ int alertCount = 0;
+ ApiResponse resp = api.alert.alerts(TARGET, String.valueOf(start), String.valueOf(count), null);
+
+ while (((ApiResponseList) resp).getItems().size() != 0) {
+ System.out.println("Reading " + count + " alerts from " + start);
+ alertCount += ((ApiResponseList) resp).getItems().size();
+
+ for (ApiResponse l : (((ApiResponseList) resp).getItems())) {
+
+ Map<String, ApiResponse> element = ((ApiResponseSet) l).getValuesMap();
+ if (blackListPlugins.contains(element.get("pluginId").toString())) {
+ // TODO: Trigger any relevant postprocessing
+ } else if ("High".equals(element.get("risk").toString())) {
+ // TODO: Trigger any relevant postprocessing
+ } else if ("Informational".equals(element.get("risk").toString())) {
+ // TODO: Ignore all info alerts - some of them may have been downgraded by security annotations
+ }
+ }
+ start += count;
+ resp = api.alert.alerts(TARGET, String.valueOf(start), String.valueOf(count), null);
+ }
+ System.out.println("Total number of Alerts: " + alertCount);
+
+ } catch (Exception e) {
+ System.out.println("Exception : " + e.getMessage());
+ e.printStackTrace();
+ }
+ }
+}
+
# To view the alerts
+$ curl "http://localhost:8080/JSON/alert/view/alerts/?apikey=<ZAP_API_KEY>&baseurl=<BASE_URL>&start=0&count=5000&riskId="
+
+# To view the summary of the alerts
+$ curl "http://localhost:8080/JSON/alert/view/alertsSummary/?apikey=<ZAP_API_KEY>baseurl=<BASE_URL>"
+
+# To view alerts by risk category
+$ curl "http://localhost:8080/JSON/alert/view/alertsByRisk/?apikey=<ZAP_API_KEY>&url=<BASE_URL>&recurse="
+
+After the scanning (Active/Passive) completes, ZAP provides the security vulnerabilities in the form of alerts. The alerts
+are categorized into high-priority, medium-priority, low-priority and informational priority risks. The priority indicates the degree of risk associated with each alert.
+For example, a high priority risk means that the issues listed in that category has more threat or risk potential than a medium-priority alert.
+
+The alerts endpoint provides all the alerts which are identified by ZAP. View the sample code on the right to retrieve the
+alerts from the alerts endpoint. The results can be used to raise security alerts in the CI/CD pipeline or to trigger any custom workflows.
+
+
+
+The alerts summary gets the number of alerts grouped by each risk level and optionally filtering by URL.
+A Summary report can be also generated using the core module. Use the htmlreport
+or jsonreport or xmlreport endpoint to generate this summary report.
+The following image shows the report generated via the HTML report API. The report categories the alerts to risk level
+and provides a brief description about each alert.
+
+
+Getting Authenticated
+The target application for testing might have a portion of the functionality that is only available for a logged-in user.
+In order to get full test coverage of the application you need to test the application with a logged-in user as well. Therefore
+it's very important to understand how to perform authenticated scans with ZAP. ZAP has several means to authenticate your
+application and keep track of the authentication state. The following are some of the options available for authentication with ZAP.
+
+
+- Form-based authentication
+- Script-based authentication
+- JSON-based authentication
+- HTTP/NTLM based authentication
+
+
+The examples below show three authentication workflows. A simple form-based authentication is showcased with the use of the
+Bodgeit application. The second example shows the script-based authentication using the Damn Vulnerable Web Application(DVWA).
+The third example shows a more complicated authentication workflow using the JSON and script-based authentication using the OWASP Juice Shop.
+
+
+General Steps
+The following are the general steps when configuring the application authentication with ZAP.
+
+Step 1. Define a context
+
+Contexts are a way of relating a set of URLs together. The URLs are defined as a set of regular expressions (regex).
+You should include the target application inside the context. The unwanted URLs such as the logout page, password change functionality
+should be added to the exclude in context section.
+
+Step 2. Set the authentication mechanism
+
+Choose the appropriate login mechanism for your application. If your application supports a simple form-based login, then
+choose the form-based authentication method. For complex login workflows, you can use the script-based login to define custom
+authentication workflows.
+
+Step 3. Define your auth parameters
+
+In general, you need to provide the settings on how to communicate to the authentication service of your application. In general,
+the settings would include the login URL and payload format (username & password). The required parameters will be different
+for different authentication methods.
+
+Step 4. Set relevant logged in/out indicators
+
+ZAP additionally needs hints to identify whether the application is authenticated or not. To verify the authentication status,
+ZAP supports logged in/out regexes. These are regex patterns that you should configure to match strings in the responses which
+indicate if the user is logged in or logged out.
+
+Step 5. Add a valid user and password
+
+Add a user account (an existing user in your application) with valid credentials in ZAP. You can create multiple users
+if your application exposes different functionality based on user roles. Additionally, you should also set valid session
+management when configuring the authentication for your application. Currently, ZAP supports cookie-based session management
+and HTTP authentication based session management.
+
+Step 6. Enable forced user mode (Optional)
+
+Now enable the 
"Forced User Mode disabled - click to enable"
+button. Pressing this button will cause ZAP to resend the authentication request whenever it detects that the user is no
+longer logged in, ie by using the 'logged in' or 'logged out' indicator. But the forced user mode is ignored for scans that already have a user set.
+
+
+Form Based Authentication
#!/usr/bin/env python
+import urllib.parse
+from zapv2 import ZAPv2
+
+context_id = 1
+apikey = 'changeMe'
+context_name = 'Default Context'
+target_url = 'http://localhost:8090/bodgeit'
+
+# By default ZAP API client will connect to port 8080
+zap = ZAPv2(apikey=apikey)
+
+
+# Use the line below if ZAP is not listening on port 8080, for example, if listening on port 8090
+# zap = ZAPv2(apikey=apikey, proxies={'http': 'http://127.0.0.1:8090', 'https': 'http://127.0.0.1:8090'})
+
+def set_include_in_context():
+ exclude_url = 'http://localhost:8090/bodgeit/logout.jsp'
+ include_url = 'http://localhost:8090/bodgeit.*'
+ zap.context.include_in_context(context_name, include_url)
+ zap.context.exclude_from_context(context_name, exclude_url)
+ print('Configured include and exclude regex(s) in context')
+
+
+def set_logged_in_indicator():
+ logged_in_regex = '\Q<a href="logout.jsp">Logout</a>\E'
+ zap.authentication.set_logged_in_indicator(context_id, logged_in_regex)
+ print('Configured logged in indicator regex: ')
+
+
+def set_form_based_auth():
+ login_url = 'http://localhost:8090/bodgeit/login.jsp'
+ login_request_data = 'username={%username%}&password={%password%}'
+ form_based_config = 'loginUrl=' + urllib.parse.quote(login_url) + '&loginRequestData=' + urllib.parse.quote(login_request_data)
+ zap.authentication.set_authentication_method(context_id, 'formBasedAuthentication', form_based_config)
+ print('Configured form based authentication')
+
+
+def set_user_auth_config():
+ user = 'Test User'
+ username = 'test@example.com'
+ password = 'weakPassword'
+
+ user_id = zap.users.new_user(context_id, user)
+ user_auth_config = 'username=' + urllib.parse.quote(username) + '&password=' + urllib.parse.quote(password)
+ zap.users.set_authentication_credentials(context_id, user_id, user_auth_config)
+ zap.users.set_user_enabled(context_id, user_id, 'true')
+ zap.forcedUser.set_forced_user(context_id, user_id)
+ zap.forcedUser.set_forced_user_mode_enabled('true')
+ print('User Auth Configured')
+ return user_id
+
+
+def start_spider(user_id):
+ zap.spider.scan_as_user(context_id, user_id, target_url, recurse='true')
+ print('Started Scanning with Authentication')
+
+
+set_include_in_context()
+set_form_based_auth()
+set_logged_in_indicator()
+user_id_response = set_user_auth_config()
+start_spider(user_id_response)
+
+
public class FormAuth {
+
+ private static final String ZAP_ADDRESS = "localhost";
+ private static final int ZAP_PORT = 8080;
+ private static final String ZAP_API_KEY = null;
+ private static final String contextId = "1";
+ private static final String contextName = "Default Context";
+ private static final String target = "http://localhost:8090/bodgeit";
+
+ private static void setIncludeAndExcludeInContext(ClientApi clientApi) throws UnsupportedEncodingException, ClientApiException {
+ String includeInContext = "http://localhost:8090/bodgeit.*";
+ String excludeInContext = "http://localhost:8090/bodgeit/logout.jsp";
+
+ clientApi.context.includeInContext(contextName, includeInContext);
+ clientApi.context.excludeFromContext(contextName, excludeInContext);
+ }
+
+
+ private static void setLoggedInIndicator(ClientApi clientApi) throws UnsupportedEncodingException, ClientApiException {
+ // Prepare values to set, with the logged in indicator as a regex matching the logout link
+ String loggedInIndicator = "<a href=\"logout.jsp\">Logout</a>";
+
+ // Actually set the logged in indicator
+ clientApi.authentication.setLoggedInIndicator(contextId, java.util.regex.Pattern.quote(loggedInIndicator));
+
+ // Check out the logged in indicator that is set
+ System.out.println("Configured logged in indicator regex: "
+ + ((ApiResponseElement) clientApi.authentication.getLoggedInIndicator(contextId)).getValue());
+ }
+
+ private static void setFormBasedAuthenticationForBodgeit(ClientApi clientApi) throws ClientApiException,
+ UnsupportedEncodingException {
+ // Setup the authentication method
+
+ String loginUrl = "http://localhost:8090/bodgeit/login.jsp";
+ String loginRequestData = "username={%username%}&password={%password%}";
+
+ // Prepare the configuration in a format similar to how URL parameters are formed. This
+ // means that any value we add for the configuration values has to be URL encoded.
+ StringBuilder formBasedConfig = new StringBuilder();
+ formBasedConfig.append("loginUrl=").append(URLEncoder.encode(loginUrl, "UTF-8"));
+ formBasedConfig.append("&loginRequestData=").append(URLEncoder.encode(loginRequestData, "UTF-8"));
+
+ System.out.println("Setting form based authentication configuration as: "
+ + formBasedConfig.toString());
+ clientApi.authentication.setAuthenticationMethod(contextId, "formBasedAuthentication",
+ formBasedConfig.toString());
+
+ // Check if everything is set up ok
+ System.out
+ .println("Authentication config: " + clientApi.authentication.getAuthenticationMethod(contextId).toString(0));
+ }
+
+ private static String setUserAuthConfigForBodgeit(ClientApi clientApi) throws ClientApiException, UnsupportedEncodingException {
+ // Prepare info
+ String user = "Test User";
+ String username = "test@example.com";
+ String password = "weakPassword";
+
+ // Make sure we have at least one user
+ String userId = extractUserId(clientApi.users.newUser(contextId, user));
+
+ // Prepare the configuration in a format similar to how URL parameters are formed. This
+ // means that any value we add for the configuration values has to be URL encoded.
+ StringBuilder userAuthConfig = new StringBuilder();
+ userAuthConfig.append("username=").append(URLEncoder.encode(username, "UTF-8"));
+ userAuthConfig.append("&password=").append(URLEncoder.encode(password, "UTF-8"));
+
+ System.out.println("Setting user authentication configuration as: " + userAuthConfig.toString());
+ clientApi.users.setAuthenticationCredentials(contextId, userId, userAuthConfig.toString());
+ clientApi.users.setUserEnabled(contextId, userId, "true");
+ clientApi.forcedUser.setForcedUser(contextId, userId);
+ clientApi.forcedUser.setForcedUserModeEnabled(true);
+
+ // Check if everything is set up ok
+ System.out.println("Authentication config: " + clientApi.users.getUserById(contextId, userId).toString(0));
+ return userId;
+ }
+
+ private static String extractUserId(ApiResponse response) {
+ return ((ApiResponseElement) response).getValue();
+ }
+
+ private static void scanAsUser(ClientApi clientApi, String userId) throws ClientApiException {
+ clientApi.spider.scanAsUser(contextId, userId, target, null, "true", null);
+ }
+
+ /**
+ * The main method.
+ *
+ * @param args the arguments
+ * @throws ClientApiException
+ * @throws UnsupportedEncodingException
+ */
+ public static void main(String[] args) throws ClientApiException, UnsupportedEncodingException {
+ ClientApi clientApi = new ClientApi(ZAP_ADDRESS, ZAP_PORT, ZAP_API_KEY);
+
+ setIncludeAndExcludeInContext(clientApi);
+ setFormBasedAuthenticationForBodgeit(clientApi);
+ setLoggedInIndicator(clientApi);
+ String userId = setUserAuthConfigForBodgeit(clientApi);
+ scanAsUser(clientApi, userId);
+ }
+}
+
# To include in default context
+curl 'http://localhost:8080/JSON/context/action/includeInContext/?contextName=Default+Context®ex=http%3A%2F%2Flocalhost%3A8090%2Fbodgeit.*'
+
+# Set login details (URL Encoded)
+curl 'http://localhost:8080/JSON/authentication/action/setAuthenticationMethod/?contextId=1&authMethodName=formBasedAuthentication&authMethodConfigParams=loginUrl%3Dhttp%3A%2F%2Flocalhost%3A8090%2Fbodgeit%2Flogin.jsp%26loginRequestData%3Dusername%253D%257B%2525username%2525%257D%2526password%253D%257B%2525password%2525%257D'
+
+# To set the login indicator
+curl 'http://localhost:8080/JSON/authentication/action/setLoggedInIndicator/?contextId=1&loggedInIndicatorRegex=%5CQ%3Ca+href%3D%22logout.jsp%22%3ELogout%3C%2Fa%3E%5CE'
+
+# To create a user (The first user id is: 0)
+curl 'http://localhost:8080/JSON/users/action/newUser/?contextId=1&name=Test+User'
+
+# To add the credentials for the user
+curl 'http://localhost:8080/JSON/users/action/setAuthenticationCredentials/?contextId=1&userId=0&authCredentialsConfigParams=username%3Dtest%40example.com%26password%3DweakPassword'
+
+# To enable the user
+curl 'http://localhost:8080/JSON/users/action/setUserEnabled/?contextId=1&userId=0&enabled=true'
+
+# To set forced user
+curl 'http://localhost:8080/JSON/forcedUser/action/setForcedUser/?contextId=1&userId=0'
+
+# To enable forced user mode
+curl 'http://localhost:8080/JSON/forcedUser/action/setForcedUserModeEnabled/?boolean=true'
+
+The following example performs a simple form-based authentication using
+the Bodgeit vulnerable application. It's recommended that you configure the authentication via the desktop UI before attempting the APIs.
+Setup Target Application
+Bodgeit uses a simple form-based authentication to authenticate the users to the application. Use the following command
+to start a docker instance of the Bodgeit application: docker run --rm -p 8090:8080 -i -t psiinon/bodgeit
+Register a User
+Register a user in the application by navigating to the following URL: http://localhost:8090/bodgeit/register.jsp.
+For the purpose of this example, use the following credentials.
+
+
+- username: test@gmail.com
+- password: weakPass
+
+Login
+After registering the user, browse (proxied via ZAP) to the following URL (http://localhost:8090/bodgeit/login.jsp),
+and log in to the application. When you log in to the application, the request will be added to the History tab in ZAP.
+Search for the POST request to the following URL: http://localhost:8090/bodgeit/login.jsp.
+Right-click on the post request, and select Flag as Context -> Default Context : Form based Login Request option. This will
+open the context authentication editor. You can notice it has auto-selected the form-based authentication, auto-filled the login URL, and the post data.
+Select the correct form parameter as the username and password in the dropdown and click Ok.
+
+Now you need to inform ZAP whether the application is logged in or out. The Bodgeit application includes the logout URL
+<a href="logout.jsp">Logout</a> as the successful response. You can view this by navigating to the response tab of the login request.
+Highlight the text and right click and select the Flag as Context -> Default Context, Loggedin Indicator option. This will autofill
+the regex needed for the login indicator. The following image shows the completed set up for the authentication tab of the context menu.
+
+
+
+Now let's add the user credentials by going to the context -> users -> Add section. After adding the credentials, enable
+the "Forced User"
+mode in the desktop UI to forcefully authenticate the user prior to the testing of the application.
+
+Now let's test the authentication by performing an authenticated Spidering with ZAP. To accomplish this, go to the Spider and select the default
+context and the test user to perform the authentication. After this, you should see the Spider crawling all the protected resources.
+
+
+Steps to Reproduce via API
+If you have configured the authentication via the desktop UI, then export the context and import it using the
+importContext API. Otherwise follow the steps below to configure the authentication setting for the context.
+Include in Context
+In order to proceed with authentication, the URL of the application should be added to the context. As Bodgeit is available
+via http://localhost:8090/bodgeit use the includeInContext API to add the
+URL to a context.
+Set Authentication Method
+Use the setAuthenticationMethod to set up the authentication method and
+the configuration parameters. The setAuthenticationMethod takes contextId, authMethodName, and authMethodConfigParams as
+parameters. As Bodgeit uses the form-based authentication, use formBasedAuthentication for the authMethodName and use the contextID
+from Step 1 as the contextId parameter.
+
+The authMethodConfigParams requires the loginUrl and loginRequestData. Therefore you should set the values to authMethodConfigParams in the following format:
+
+authMethodConfigParams : loginUrl=http://localhost:8090/bodgeit/login.jsp&loginRequestData=username%3D%7B%25username%25%7D%26password%3D%7B%25password%25%7D
+
+The values for authMethodConfigParams parameters must be URL encoded, in this case loginRequestData is username={%username%}&password={%password%}.
+Set Login and Logout Indicators
+Use the setLoggedOutIndicator to set the logout indicators of the application.
+The Following is the regex command to match the successful response with the Bodgeit application.
+\Q<a href=\"logout.jsp\"></a>\E
+Create User and Enable Forced User Mode
+Now add the user credentials via the setAuthenticationCredentials API and use
+the SetForcedUserModeEnabled to enable the forced user mode in ZAP.
+Script Based Authentication
#!/usr/bin/env python
+import urllib.parse
+from zapv2 import ZAPv2
+
+context_id = 1
+apikey = 'changeMe'
+context_name = 'Default Context'
+target_url = 'http://localhost:3000'
+
+# By default ZAP API client will connect to port 8080
+zap = ZAPv2(apikey=apikey)
+
+# Use the line below if ZAP is not listening on port 8080, for example, if listening on port 8090
+# zap = ZAPv2(apikey=apikey, proxies={'http': 'http://127.0.0.1:8090', 'https': 'http://127.0.0.1:8090'})
+
+
+def set_include_in_context():
+ include_url = 'http://localhost:3000.*'
+
+ zap.context.include_in_context(context_name, include_url)
+
+ zap.context.exclude_from_context(context_name, '\\Qhttp://localhost:3000/login.php\\E')
+ zap.context.exclude_from_context(context_name, '\\Qhttp://localhost:3000/logout.php\\E')
+ zap.context.exclude_from_context(context_name, '\\Qhttp://localhost:3000/setup.php\\E')
+ zap.context.exclude_from_context(context_name, '\\Qhttp://localhost:3000/security.php\\E')
+ print('Configured include and exclude regex(s) in context')
+
+
+def set_logged_in_indicator():
+
+ logged_in_regex = "\\Q<a href=\"logout.php\">Logout</a>\\E"
+ logged_out_regex = "(?:Location: [./]*login\\.php)|(?:\\Q<form action=\"login.php\" method=\"post\">\\E)"
+
+ zap.authentication.set_logged_in_indicator(context_id, logged_in_regex)
+ zap.authentication.set_logged_out_indicator(context_id, logged_out_regex)
+ print('Configured logged in indicator regex ')
+
+
+def set_script_based_auth():
+ post_data = "username={%username%}&password={%password%}" + "&Login=Login&user_token={%user_token%}"
+ post_data_encoded = urllib.parse.quote(post_data)
+ login_request_data = "scriptName=auth-dvwa.js&Login_URL=http://localhost:3000/login.php&CSRF_Field=user_token" \
+ "&POST_Data=" + post_data_encoded
+
+ zap.authentication.set_authentication_method(context_id, 'scriptBasedAuthentication', login_request_data)
+ print('Configured script based authentication')
+
+
+def set_user_auth_config():
+ user = 'Administrator'
+ username = 'admin'
+ password = 'password'
+
+ user_id = zap.users.new_user(context_id, user)
+ user_auth_config = 'Username=' + urllib.parse.quote(username) + '&Password=' + urllib.parse.quote(password)
+ zap.users.set_authentication_credentials(context_id, user_id, user_auth_config)
+ zap.users.set_user_enabled(context_id, user_id, 'true')
+ zap.forcedUser.set_forced_user(context_id, user_id)
+ zap.forcedUser.set_forced_user_mode_enabled('true')
+ print('User Auth Configured')
+ return user_id
+
+
+def upload_script():
+ script_name = 'auth-dvwa.js'
+ script_type = 'authentication'
+ script_engine = 'Oracle Nashorn'
+ file_name = '/tmp/auth-dvwa.js'
+ charset = 'UTF-8'
+ zap.script.load(script_name, script_type, script_engine, file_name, charset=charset)
+
+
+def start_spider(user_id):
+ zap.spider.scan_as_user(context_id, user_id, target_url, recurse='true')
+ print('Started Scanning with Authentication')
+
+
+set_include_in_context()
+upload_script()
+set_script_based_auth()
+set_logged_in_indicator()
+user_id_response = set_user_auth_config()
+start_spider(user_id_response)
+
public class ScriptAuth {
+
+ private static final String ZAP_ADDRESS = "localhost";
+ private static final int ZAP_PORT = 8080;
+ private static final String ZAP_API_KEY = null;
+ private static final String contextId = "1";
+ private static final String contextName = "Default Context";
+ private static final String target = "http://localhost:3000";
+ private static void setIncludeAndExcludeInContext(ClientApi clientApi) throws UnsupportedEncodingException, ClientApiException {
+ String includeInContext = "http://localhost:3000.*";
+ clientApi.context.includeInContext(contextName, includeInContext);
+ clientApi.context.excludeFromContext(contextName, "\\Qhttp://localhost:3000/login.php\\E");
+ clientApi.context.excludeFromContext(contextName, "\\Qhttp://localhost:3000/logout.php\\E");
+ clientApi.context.excludeFromContext(contextName, "\\Qhttp://localhost:3000/setup.php\\E");
+ clientApi.context.excludeFromContext(contextName, "\\Qhttp://localhost:3000/security.php\\E");
+ }
+ private static void setLoggedInIndicator(ClientApi clientApi) throws UnsupportedEncodingException, ClientApiException {
+ // Prepare values to set, with the logged in indicator as a regex matching the logout link
+ String loggedInIndicator = "\\Q<a href=\"logout.php\">Logout</a>\\E";
+ String loggedOutIndicator = "(?:Location: [./]*login\\.php)|(?:\\Q<form action=\"login.php\" method=\"post\">\\E)";
+ // Actually set the logged in indicator
+ clientApi.authentication.setLoggedInIndicator( contextId, loggedInIndicator);
+ clientApi.authentication.setLoggedOutIndicator( contextId, loggedOutIndicator);
+ // Check out the logged in indicator that is set
+ System.out.println("Configured logged in indicator regex: "
+ + ((ApiResponseElement) clientApi.authentication.getLoggedInIndicator(contextId)).getValue());
+ }
+ private static void setScriptBasedAuthenticationForDVWA(ClientApi clientApi) throws ClientApiException,
+ UnsupportedEncodingException {
+ String postData = "username={%username%}&password={%password%}" + "&Login=Login&user_token={%user_token%}";
+ String postDataEncode = URLEncoder.encode(postData, "UTF-8");
+ String sb = ("scriptName=auth-dvwa.js&Login_URL=http://localhost:3000/login.php&CSRF_Field=user_token&")
+ .concat("POST_Data=").concat(postDataEncode);
+
+ clientApi.authentication.setAuthenticationMethod(contextId, "scriptBasedAuthentication", sb.toString());
+ System.out.println("Authentication config: " + clientApi.authentication.getAuthenticationMethod(contextId).toString(0));
+ }
+ private static String setUserAuthConfigForDVWA(ClientApi clientApi) throws ClientApiException, UnsupportedEncodingException {
+ // Prepare info
+ String user = "Admin";
+ String username = "admin";
+ String password = "password";
+
+ // Make sure we have at least one user
+ String userId = extractUserId(clientApi.users.newUser(contextId, user));
+
+ // Prepare the configuration in a format similar to how URL parameters are formed. This
+ // means that any value we add for the configuration values has to be URL encoded.
+ StringBuilder userAuthConfig = new StringBuilder();
+ userAuthConfig.append("Username=").append(URLEncoder.encode(username, "UTF-8"));
+ userAuthConfig.append("&Password=").append(URLEncoder.encode(password, "UTF-8"));
+
+ System.out.println("Setting user authentication configuration as: " + userAuthConfig.toString());
+ clientApi.users.setAuthenticationCredentials(contextId, userId, userAuthConfig.toString());
+ clientApi.users.setUserEnabled(contextId, userId, "true");
+ clientApi.forcedUser.setForcedUser(contextId, userId);
+ clientApi.forcedUser.setForcedUserModeEnabled(true);
+
+ // Check if everything is set up ok
+ System.out.println("Authentication config: " + clientApi.users.getUserById(contextId, userId).toString(0));
+ return userId;
+ }
+ private static void uploadScript(ClientApi clientApi) throws ClientApiException {
+ String script_name = "auth-dvwa.js";
+ String script_type = "authentication";
+ String script_engine = "Oracle Nashorn";
+ String file_name = "/tmp/auth-dvwa.js";
+ clientApi.script.load(script_name, script_type, script_engine, file_name, null);
+ }
+ private static String extractUserId(ApiResponse response) {
+ return ((ApiResponseElement) response).getValue();
+ }
+ private static void scanAsUser(ClientApi clientApi, String userId) throws ClientApiException {
+ clientApi.spider.scanAsUser(contextId, userId, target, null, "true", null);
+ }
+ /**
+ * The main method.
+ *
+ * @param args the arguments
+ * @throws ClientApiException
+ * @throws UnsupportedEncodingException
+ */
+ public static void main(String[] args) throws ClientApiException, UnsupportedEncodingException {
+ ClientApi clientApi = new ClientApi(ZAP_ADDRESS, ZAP_PORT, ZAP_API_KEY);
+ uploadScript(clientApi);
+ setIncludeAndExcludeInContext(clientApi);
+ setScriptBasedAuthenticationForDVWA(clientApi);
+ setLoggedInIndicator(clientApi);
+ String userId = setUserAuthConfigForDVWA(clientApi);
+ scanAsUser(clientApi, userId);
+ }
+}
+
+# To add in default context
+curl 'http://localhost:8080/JSON/context/action/includeInContext/?contextName=Default+Context®ex=http%3A%2F%2Flocalhost%3A3000.*'
+
+# To add exclude in context
+curl 'http://localhost:8080/JSON/context/action/excludeFromContext/?contextName=Default+Context®ex=%5CQhttp%3A%2F%2Flocalhost%3A3000%2Flogout.php%5CE'
+
+# To upload the script
+curl 'http://localhost:8080/JSON/script/action/load/?scriptName=auth-dvwa.js&scriptType=authentication&scriptEngine=Oracle+Nashorn&fileName=%2Ftmp%2Fauth-dvwa.js&scriptDescription=&charset='
+
+# To set up authentication information
+curl 'http://localhost:8080/JSON/authentication/action/setAuthenticationMethod/?contextId=1&authMethodName=scriptBasedAuthentication&authMethodConfigParams=scriptName%3Dauth-dvwa.js%26Login_URL%3Dhttp%3A%2F%2Flocalhost%3A3000%2Flogin.php%26CSRF_Field%3Duser_token%26POST_Data%3Dusername%253D%257B%2525username%2525%257D%2526password%253D%257B%2525password%2525%257D%2526Login%253DLogin%2526user_token%253D%257B%2525user_token%2525%257D'
+
+# To set the login indicator
+curl 'http://localhost:8080/JSON/authentication/action/setLoggedInIndicator/?contextId=1&loggedInIndicatorRegex=%5CQ%3Ca+href%3D%5C%22logout.php%5C%22%3ELogout%3C%2Fa%3E%5CE'
+
+# To set logged out indicator
+curl 'http://localhost:8080/JSON/authentication/action/setLoggedOutIndicator/?contextId=1&loggedOutIndicatorRegex=%28%3F%3ALocation%3A+%5B.%2F%5D*login%5C.php%29%7C%28%3F%3A%5CQ%3Cform+action%3D%22login.php%22+method%3D%22post%22%3E%5CE%29'
+
+# To create a user (The first user id is: 0)
+curl 'http://localhost:8080/JSON/users/action/newUser/?contextId=1&name=Test+User'
+
+# To add the credentials for the user
+curl 'http://localhost:8080/JSON/users/action/setAuthenticationCredentials/?contextId=1&userId=0&authCredentialsConfigParams=Username%3Dadmin%26Password%3Dpassword'
+
+# To enable the user
+curl 'http://localhost:8080/JSON/users/action/setUserEnabled/?contextId=1&userId=0&enabled=true'
+
+# To set forced user
+curl 'http://localhost:8080/JSON/forcedUser/action/setForcedUser/?contextId=1&userId=0'
+
+# To enable forced user mode
+curl 'http://localhost:8080/JSON/forcedUser/action/setForcedUserModeEnabled/?boolean=true'
+
+ZAP has scripting support for most of the popular languages. The following are some of the scripting languages supported by ZAP.
+
+
+- JavaScript
+- Python
+- Ruby
+- Groovy
+- Zest
+
+
+ZAP has an Add-on Marketplace where you can get add-ons for additional scripting engines. Click the red, blue, & green box stacked
+icon in ZAP to bring up the marketplace modal. After it pops up, switch to the Marketplace and install the appropriate scripting engine.
+
+The following example performs a script based authentication for the Damn Vulnerable Web Application. Similar to the
+Bodgeit example DVWA also uses POST request to authenticate the users. But apart from username and password DVWA sends an
+additional token to protect against the Cross-Site request forgery attacks. This token is obtained from the landing page.
+The following image shows the embedded token in the login page.
+
+
+
+
+
+If the token is not included with the login script as a POST parameter, the request will be rejected. In order to send this
+token, lets use the script based authentication technique. The authentication script will parse the HTML content and extract
+the token and append it in the POST request.
+Setup Target Application
+Use the following docker command to start the DVWA. In order to fully complete the setup you need to login (http://localhost:3000)
+to the application and press the configure button. Use the default credentials of the application to login and finish the setup (Username: admin, Password: password).
+
+docker run --rm -it -p 3000:80 vulnerables/web-dvwa
+Create the Script
+Go to the Scripts tab and create a new Authentication script. Provide a name to the script and select
+JavaScript/Nashorn as the engine and replace the script contents with the following script.
+
+
+Configure Context Authentication
+Now navigate to http://localhost:3000 and add the URL to the default context. Then double click
+on the default context and select the script-based authentication as the authentication method. Now load the script from the
+drop down provided and the following parameter values.
+
+
+- Login URL:
http://localhost:3000/login.php
+- CSRF Field:
user_token
+- POST Data:
username={%username%}&password={%password%}&Login=Login&user_token={%user_token%}
+- Logged in regex:
\Q<a href="logout.php">Logout</a>\E
+- Logged out regex:
(?:Location: [./]*login\.php)|(?:\Q<form action="login.php" method="post">\E)
+
+
+
+
+Now add the default admin user to the users tab and enable the user.
+
+
+- User Name:
Administrator
+- Username:
admin
+- Password:
password
+
+
+As the login operation is performed by the script lets add the login URL as out of context. Additionally you should add
+pages which will disrupt the login process to out of context. For example, by not excluding the logout URL, the Spider will
+trigger unwanted logouts (ex.: logoff/password change, etc.). Therefore, add the following regex(s) to the "Exclude from Context" tab.
+
+
+\Qhttp://localhost:3000/login.php\E\Qhttp://localhost:3000/logout.php\E\Qhttp://localhost:3000/setup.php\E\Qhttp://localhost:3000/security.php\E
+
+Now you can enable the forced user mode and start the Spider or manually select the admin user for the Spider scan.
+If you have selected the forced user mode and also manually selected a user; then the manually selected user/context will supersede the forced user mode.
+After this you should see the Spider crawling all the protected resources. The authentication results will be available through the Output panel and
+you can also select the login POST request in the History tab to verify the token has been sent to the application.
+
+
+Steps to Reproduce via API
+Use the scripts endpoint to upload the script file. Thereafter the configurations are very similar to the form based authentication
+with the Bodgeit application. Use the includeInContext API to add the URL to the default context
+and use the setAuthenticationMethod to setup the authentication method and
+the configuration parameters. Finally use the users API to create the admin user. Refer the script in the right column
+on how to use the above APIs.
+JSON Based Authentication
+#!/usr/bin/env python
+import urllib.parse
+from zapv2 import ZAPv2
+
+context_id = 1
+apiKey = 'changeMe'
+context_name = 'Default Context'
+target_url = 'http://localhost:3000'
+
+# By default ZAP API client will connect to port 8080
+zap = ZAPv2(apikey=apiKey)
+
+# Use the line below if ZAP is not listening on port 8080, for example, if listening on port 8090
+# zap = ZAPv2(apikey=apiKey, proxies={'http': 'http://127.0.0.1:8090', 'https': 'http://127.0.0.1:8090'})
+
+
+def set_include_in_context():
+ include_url = 'http://localhost:3000.*'
+ zap.context.include_in_context(context_name, include_url)
+ print('Configured include and exclude regex(s) in context')
+
+
+def set_logged_in_indicator():
+ logged_in_regex = '\Q<a href="logout.php">Logout</a>\E'
+ logged_out_regex = '(?:Location: [./]*login\.php)|(?:\Q<form action="login.php" method="post">\E)'
+
+ zap.authentication.set_logged_in_indicator(context_id, logged_in_regex)
+ zap.authentication.set_logged_out_indicator(context_id, logged_out_regex)
+ print('Configured logged in indicator regex: ')
+
+
+def set_json_based_auth():
+ login_url = "http://localhost:3000/rest/user/login"
+ login_request_data = 'email={%username%}&password={%password%}'
+
+ json_based_config = 'loginUrl=' + urllib.parse.quote(login_url) + '&loginRequestData=' + urllib.parse.quote(login_request_data)
+ zap.authentication.set_authentication_method(context_id, 'jsonBasedAuthentication', json_based_config)
+ print('Configured form based authentication')
+
+
+def set_user_auth_config():
+ user = 'Test User'
+ username = 'test@example.com'
+ password = 'testtest'
+
+ user_id = zap.users.new_user(context_id, user)
+ user_auth_config = 'username=' + urllib.parse.quote(username) + '&password=' + urllib.parse.quote(password)
+ zap.users.set_authentication_credentials(context_id, user_id, user_auth_config)
+
+
+def add_script():
+ script_name = 'jwtScript.js'
+ script_type = 'httpsender'
+ script_engine = 'Oracle Nashorn'
+ file_name = '/tmp/jwtScript.js'
+ zap.script.load(script_name, script_type, script_engine, file_name)
+
+
+set_include_in_context()
+add_script()
+set_json_based_auth()
+set_logged_in_indicator()
+set_user_auth_config()
+
public class JSONAuth {
+
+ private static final String ZAP_ADDRESS = "localhost";
+ private static final int ZAP_PORT = 8090;
+ private static final String ZAP_API_KEY = null;
+ private static final String contextId = "1";
+ private static final String target = "http://localhost:3000";
+
+ private static void setJSONBasedAuthentication(ClientApi clientApi) throws ClientApiException, UnsupportedEncodingException {
+ String loginUrl = "http://localhost:3000/rest/user/login";
+ String loginRequestData = "username={%username%}&password={%password%}";
+
+ // Prepare the configuration in a format similar to how URL parameters are formed. This
+ // means that any value we add for the configuration values has to be URL encoded.
+ StringBuilder jsonBasedConfig = new StringBuilder();
+ jsonBasedConfig.append("loginUrl=").append(URLEncoder.encode(loginUrl, "UTF-8"));
+ jsonBasedConfig.append("&loginRequestData=").append(URLEncoder.encode(loginRequestData, "UTF-8"));
+
+ System.out.println("Setting JSON based authentication configuration as: " + jsonBasedConfig.toString());
+ clientApi.authentication.setAuthenticationMethod(contextId, "jsonBasedAuthentication", jsonBasedConfig.toString());
+
+ // Check if everything is set up ok
+ System.out.println("Authentication config: " + clientApi.authentication.getAuthenticationMethod(contextId).toString(0));
+ }
+
+ private static String setUserAuthConfig(ClientApi clientApi) throws ClientApiException, UnsupportedEncodingException {
+ // Prepare info
+ String user = "Test User";
+ String username = "test@example.com";
+ String password = "testtest";
+
+ // Make sure we have at least one user
+ String userId = extractUserId(clientApi.users.newUser(contextId, user));
+
+ // Prepare the configuration in a format similar to how URL parameters are formed. This
+ // means that any value we add for the configuration values has to be URL encoded.
+ StringBuilder userAuthConfig = new StringBuilder();
+ userAuthConfig.append("username=").append(URLEncoder.encode(username, "UTF-8"));
+ userAuthConfig.append("&password=").append(URLEncoder.encode(password, "UTF-8"));
+
+ System.out.println("Setting user authentication configuration as: " + userAuthConfig.toString());
+ clientApi.users.setAuthenticationCredentials(contextId, userId, userAuthConfig.toString());
+ clientApi.users.setUserEnabled(contextId, userId, "true");
+ clientApi.forcedUser.setForcedUser(contextId, userId);
+ clientApi.forcedUser.setForcedUserModeEnabled(true);
+
+ // Check if everything is set up ok
+ System.out.println("Authentication config: " + clientApi.users.getUserById(contextId, userId).toString(0));
+ return userId;
+ }
+
+ private static void addScript(ClientApi clientApi) throws ClientApiException {
+
+ String script_name = "jwtScript.js";
+ String script_type = "httpsender";
+ String script_engine = "Oracle Nashorn";
+ String file_name = "/tmp/authscript.js";
+
+ clientApi.script.load(script_name, script_type, script_engine, file_name, null);
+ }
+
+ private static void scanAsUser(ClientApi clientApi, String userId) throws ClientApiException {
+ clientApi.spider.scanAsUser(contextId, userId, target, null, "true", null);
+ }
+
+ private static String extractUserId(ApiResponse response) {
+ return ((ApiResponseElement) response).getValue();
+ }
+
+ /**
+ * The main method.
+ *
+ * @param args the arguments
+ * @throws ClientApiException
+ * @throws UnsupportedEncodingException
+ */
+ public static void main(String[] args) throws ClientApiException, UnsupportedEncodingException {
+ ClientApi clientApi = new ClientApi(ZAP_ADDRESS, ZAP_PORT, ZAP_API_KEY);
+
+ addScript(clientApi);
+ setJSONBasedAuthentication(clientApi);
+ String userId = setUserAuthConfig(clientApi);
+ scanAsUser(clientApi, userId);
+ }
+}
+
+# To add the script
+curl 'http://localhost:8080/JSON/script/action/load/?scriptName=authscript.js&scriptType=authentication&scriptEngine=Oracle+Nashorn&fileName=%2Ftmp%2Fauthscript.js&scriptDescription=&charset=UTF-8'
+
+# To set up authentication information
+curl 'http://localhost:8080/JSON/authentication/action/setAuthenticationMethod/?contextId=1&authMethodName=scriptBasedAuthentication&authMethodConfigParams=scriptName%3Dauthscript.js%26Login+URL%3Dhttp%3A%2F%2Flocalhost%3A3000%2Flogin.php%26CSRF+Field%3Duser_token%26POST+Data%3Dusername%3D%7B%25username%25%7D%26password%3D%7B%25password%25%7D%26Login%3DLogin%26user_token%3D%7B%25user_token%25%7D'
+
+# To set the login indicator
+curl 'http://localhost:8080/JSON/authentication/action/setLoggedInIndicator/?contextId=1&loggedInIndicatorRegex=%5CQ%3Ca+href%3D%22logout.jsp%22%3ELogout%3C%2Fa%3E%5CE'
+
+# To create a user (The first user id is: 0)
+curl 'http://localhost:8080/JSON/users/action/newUser/?contextId=1&name=Test+User'
+
+# To add the credentials for the user
+curl 'http://localhost:8080/JSON/users/action/setAuthenticationCredentials/?contextId=1&userId=0&authCredentialsConfigParams=username%3Dtest%40example.com%26password%3DweakPassword'
+
+# To enable the user
+curl 'http://localhost:8080/JSON/users/action/setUserEnabled/?contextId=1&userId=0&enabled=true'
+
+# To set forced user
+curl 'http://localhost:8080/JSON/forcedUser/action/setForcedUser/?contextId=1&userId=0'
+
+# To enable forced user mode
+curl 'http://localhost:8080/JSON/forcedUser/action/setForcedUserModeEnabled/?boolean=true'
+
+The following example performs a script based authentication for the OWASP Juice Shop. Juice Shop is a modern application and
+it contrary to the previous examples the protected resources are accessed by sending an authorization header(JSON web token).
+Setup Target Application
+Use the following docker command to start the OWASP Juice Shop.
+
+docker run -d -p 3000:3000 bkimminich/juice-shop
+Register User
+Register a user in the application by navigating to the following URL: http://localhost:3000/#/register.
+For the purpose of this example, use the following information.
+
+
+- Email: test@test.com
+- Password: testtest
+- Security Question: Select Your eldest siblings middle name (enter any text)
+
+Login
+After registering the user, browse (proxied via ZAP) to the following URL (http://localhost:3000/#/login)
+and login to the application. When you login to the application the request will be added to the History tab in ZAP.
+Search for the POST request to the following URL: http://localhost:3000/rest/user/login.
+Right-click on the POST request, and select Flag as Context -> Default Context : JSON-based Auth Login Request option. This will open the context authentication editor.
+You can notice it has auto selected the JSON-based authentication, auto-filled the login URL and the post data.
+Select the correct JSON attribute as the username and password in the dropdown and click Ok. The following image shows the completed setup for the authentication tab of the context menu.
+
+
+
+Exit the context editor and go back to the login request. You will notice in the login response headers there is no set cookie. In
+the response body you will find the response data.
+
+The request that follows is GET http://localhost:3000/rest/user/whoami which you will notice has a header called Authorization
+which uses the token from the response body of the login request. In body of the response, you should see some info about your
+user: {"user":{"id":1,"email":"test@test.com"}}. If you visit that url directly, with your browser, the content of the page is
+{"user":{}} - the Authorization header is not added to request and it is not authenticated.
+
+This request is initiated as a client side AJAX request using a spec called JWT. Currently ZAP doesn't have a notion of
+the Authorization header for sessions so this is where ZAPs scripting engine will come into play! With ZAP's scripting
+engine, we can easily add to or augment it's functionality.
+Add the Script
+Now in the left sidebar next to the Sites click + to add Scripts. This will bring into focus in the sidebar. Drill into
+Scripting > Scripts > HTTP Sender. Then right click on the HTTP Sender and with that context menu click New Script. Name
+the script jwtScript.js and set the Script Engine to ECMAScript (do not check the box that says enable).
+
+
+
+Now that we have that script setup, let's test it out! Go ahead and visit the login page http://localhost:3000/#/login
+with the browser launched with ZAP and use your test account to login. After you login, back in ZAP in the Script Console
+tab you should see a message that says Capturing token for JWT.
+
+Now visit http://localhost:3000/rest/user/whoami directly in the browser and you will see you get JSON data with the
+user {"user":{"id":9,"email":"test@test.com"}}! Back in the Script Console you will see the script went ahead and added the header!
+
+Now that we have a script ensuring we have the right headers & cookies for authentication, let's go ahead and try
+spidering the application again! So let's use the same settings we used earlier from the AJAX Spider Settings.
+Once the scan starts, check out the browser running the scan - you'll notice the user is logged in! (Logout & Your Basket links visible).
+Now the AJAX Spider will pick up some new paths that it couldn't find before!
+Steps to Reproduce via API
+Use the scripts endpoint to add the script file. Thereafter the configurations are very similar to the form based authentication
+with the Bodgeit application. Use the includeInContext API to add the URL to the default context
+and use the setAuthenticationMethod to setup the authentication method and
+the configuration parameters. Finally use the users API to create the admin user. Refer the script in the right column
+on how to use the above APIs.
+Advanced Settings
+The following section shows advanced configurations of the APIs.
+Spider Settings
+The following image shows the advanced configurations tab of Spider in the desktop UI.
+
+
+
+Use the setOptionMaxDepth API to set the maximum depth the spider can crawl, where 0 refers to unlimited depth.
+The setOptionMaxChildren API sets the maximum number of child nodes (per node) that can be crawled,
+where 0 means no limit. The setOptionMaxDuration API can be used to set the maximum duration the Spider will run.
+Use the setOptionMaxParseSizeBytes API to limit the amount of data parsed by the spider.
+This allows the spider to skip big responses/files.
+
+View the Spider section in the API Catalogue for additional APIs.
+Ajax Spider Settings
+The following image shows the advanced configurations tab of Ajax Spider in the desktop UI.
+
+
+
+Similar to the Spider API, the Ajax spider also provides APIs to set the maximum depth, crawl state, and maximum duration.
+Passive Scan Settings
+The scanning rules can be enabled/disabled using the enableScanners and disableScanners APIs.
+Also use the setScanOnlyInScope API to limit the passive scanning to a scope. View
+the advanced section to learn how to configure a context or scope using ZAP APIs.
+
+Passive scanning can also be used to automatically add tags and raise alerts for potential issues. A set of rules for
+automatic tagging are provided by default. These can be changed, deleted or added to via the Options Passive Scan Tags Screen.
+Active Scan Settings
General Options
+The general options for Active Scan can be configured using the options tab in the desktop UI shown below.
+
+
+
+Use the setOptionMaxScanDurationInMins API to limit the duration of scan and
+setOptionMaxRuleDurationInMins API to limit the time of individual active scan rules.
+This can be used to prevent rules from running for an excessive amount of time.
+
+Use the setOptionHostPerScan API to set the maximum number of hosts that will be scanned at the same time.
+Furthermore, use the setOptionThreadPerHost API to set the number of threads the scanner will use per host.
+Increasing both of these values will reduce the active scanning time but this may put extra strain on the server ZAP is running on.
+
+Use the setOptionDelayInMs API to delay each request from ZAP in milliseconds. Setting this to a non zero value will increase
+the time an active scan takes, but will put less of a strain on the target host. View the Active Scan section in
+the API Catalogue for additional information regarding the APIs.
+Input Vectors
+Input vectors refers to the elements that Active Scan will target. Specifying the exact elements to target will improve the
+scanning time and accuracy of the results. For example, for the following configuration the optionTargetParamsInjectable and
+optionTargetParamsEnabledRPC will yield the results of 11 and 39.
+The numbers can be deconstructed in the following manner:
+
+
+- 1+2+8 = 11 [Query String(1), Post Data(2), HTTP Headers(8)]
+- 1+2+4+32 = 39 [Multipart (1), XML (2), JSON (4), DWR (32)]
+
+
+
+
+Thus, to change the values of Injectable targets and Input Vector Handlers calculate the exact values and
+use the setoptiontargetparamsinjectable and setoptiontargetparamsenabledrpc APIs accordingly.
+
+The Add URL query parameter option under the Injectable Tragets sets whether or not the active scanner should add a query param
+to GET requests which do not have parameters to start with. This option can be enabled using the setoptionaddqueryparam API.
+Technology
+
+
+The Technology tab allows you to specify which types of technologies to scan. Un-selecting technologies that you know are
+not present in the target application may speed up the scan, as rules which target that technology can skip those tests.
+For an example, if the target web application does not have a database then removing it will increase the performance of the Active Scan.
+
+Use the includeContextTechnologies and excludeContextTechnologies
+API endpoints to include and exclude the technology list from the context.
+Policy
+A scan policy defines exactly which rules are run as part of an active scan. It also defines how these rules run influencing
+how many requests are made and how likely potential issues are to be flagged. You can define as many scan policies as you
+like and select the most appropriate one when you start the scan via the Active Scan.
+
+
+
+The Policy tab shown in the above image allows you to override any of the settings specified in the selected scan policy.
+Contributions Welcome!
+Contributions are welcome! There are many ways you can contribute to ZAP, both as a user and as a developer.
+
+1. Creating High-level API/Automation Docs
+
+Create high level docs or example guides on how to use the APIs to perform any action/view with ZAP.
+ The source files for the ZAP API documentation is hosted on GitHub. The repository is available at Github.
+ The source files are in Markdown (md) format.
+
+2. REST API Documentation
+
+ZAP's rest API is documented using the OpenAPI specification. The specification could be improved by enhancing the description of
+ parameters/ results/ data types etc. The open API specification is available via GitHub.
+
+3. Feature Documentation
+
+Feature documentation related to ZAP is available on ZAP wiki,
+ ZAP user guide, and ZAP extensions repositories.
+How to Contribute
+The ZAP API documentation is developed according to the docs as code philosophy.
+The most direct and effective way to contribute to the docs is to submit a pull request(PR) or raise an
+issue in the GitHub repository containing the docs content that you want to change.
+
+There are 2 different workflows which you can use to make changes or PRs. Use what you are most comfortable with!
+
+1. "Edit this File on GitHub"
+
+You can edit the documentation in the browser via navigating to the relevant source file and clicking the edit this file button.
+This workflow is recommended for minor changes. For example correcting typos/spellings/grammar etc.
+For extensive changes, please use the local setup and editing option.
+
+2. Local Setup and Editing
+
+You can fork the repository on GitHub and submit the changes via pull requests.
+Please see the local setup for API docs section to setup and render the docs locally.
+
+
+Local Setup for API Docs
+ZAP uses git for its code repository.
+To submit a documentation update, use the following steps:
+
+1. Clone the ZAP Docs repository:
+ git clone https://github.com/zaproxy/zap-api-docs
+
+2. Navigate to the cloned repository:
+ cd zap-api-docs
+
+3. Use the following guide to install Ruby
+
+4. To install the dependencies: $ bundle install
+
+5. To start the server: $ bundle exec middleman server
+Documentation Style
+This style guide provides a set of editorial guidelines for anyone writing documentation for ZAP.
+General Guidelines
+
+Check for the grammar and spellings before sending the pull request. Most of the modern editors comes with a spell
+check option or plugin.
Use a friendly and conversational tone. Always use simple sentences. If the sentence is lengthy try to break it in to smaller sentences.
+Also avoid sentences with complicated words or jargon.
Write positively and avoid using negative sentences.
+
+
+- Recommended: If you are not familiar with the Spider, then read this documentation.
+- Not Recommended: Read this documentation to get familiarized with the Spider.
+
The documentation should be neutral, without judgments, opinions. For example, words like "easily" or "simple" come with
+a lot of assumptions. Things that are easier for you might be difficult for another person. Avoid this type of wordings
+when contributing to the document.
+Language and Grammar
+
+Abbreviation
+
+Spell out the abbreviation or acronym before introducing them in the sentence. If the abbreviation is well known such as
+API or ZAP or HTML, you can use it without spelling it first.
Active Voice
+
+In general use active voice when formulating the sentence instead of passive voice. A sentence written in the active voice will emphasize
+the person or thing who is performing an action (eg.The dog chased the ball). In contrast, the passive voice will highlight
+the recipient of the action (The ball was chased by the dog). Therefor use the passive voice, only when it's less important
+who or what completed the action and more important that the action was completed. For example:
+
+
+- Recommended: The Spider crawls the URLs.
+- Not recommended: The URLs are crawled by the Spider.
+
Gender References
+
+Use gender neutral pronouns (they/their/them) when referring to a hypothetical person such as "a user with a logged in session".
+For example, instead of:
+ - he or she, use they;
+ - him or her, use them;
+ - his or her, use their;
+ - his or hers, use theirs;
+ - himself or herself, use themselves;
Method Description
+
+When you're writing reference documentation for a method, phrase the main method description in terms of what it does
+("Gets," "Starts," "Creates," "Lists"), rather than what the developer would use it to do ("Get," "Start," "Create," "List").
+
+
+- Recommended: action.scan: Starts the Spider on the specified URL.
+- Not recommended: action.scan: Start the Spider on the specified URL.
+
Second Person
+
+In general, use second person in your docs rather than first person. For example:
+
+
+- Recommended: You are recommended to use the Spider.
+- Not Recommended: We recommend to use the Spider.
+
Spellings
+
+Use American spellings when
+contributing to the documentation.
+Formatting
+
+Capitalization:
+
+
+- Use the Chicago manual for capitalization rules for the documentation.
+- For titles of a section, Capitalize of the first letter of each word except for the closed-class words
+such as determiners, pronouns, conjunctions, and prepositions. Use the following link for guidance.
+
+
+- Recommended: The Spider Tutorial with APIs
+
+- For normal sentences don't capitalize random words in the middle of the sentences.
+
Number formatting
+
+
+- In general spell out the number if it starts a sentence or is less than ten or an ordinal number.
+
+
+- Recommended: Seventeen requests has been intercepted by the passive scanner.
+- Recommended: The passive scan showed nine warnings.
+- Recommended: The fifth alert was a high priority alert.
+
+- Use numerals for numbers higher than ten or fractions or unit prices.
+
+
+- Recommended: The active scanner detected 24 issues.
+- Recommended: The scanner took 23.4 seconds to complete the crawling.
+
+
+Punctuation
+
+Commas
+
+
+- Use oxford commas when writing a list of three or more items
+
+
+- Recommended: The API can return the results in XML, JSON, and HTML.
+- Not Recommended: The API can return the results in XML, JSON and HTML.
+
+
Periods
+
+
+- Do not add period to headings or titles.
+- Avoid using periods at the end of URLs. Try to modify the sentence so the URL can be in the middle of the sentence.
+
+Markdown Syntax
+The API docs are created using standard markdown files. This section contains information regarding the syntax and linting of the Markdown files.
+Refer to the Slate documentation. Also refer to this
+document to properly lint the Markdown files.
+Writing Code
+Inline Code
+
+Put `backticks` around the following symbols when used in text:
+
+
+- Data types:
json, xml, html
+- File name:
test.py, /path-to-your-data/xml/example-name
+
+
+Code Block
+
+Use three back ticks to open and close a code block. Specify the programming language after the first backtick group.
+The documentation currently supports python, java, and shell languages.
+
+
+Troubleshooting
+This section explains how to troubleshoot issues that might occur when interacting with the ZAP API.
+Enable Useful Dev Options
+While developing scripts/programs that interact with ZAP API it's recommended that the following ZAP API options
+are enabled, to have more information about possible errors:
+
+
+Report permission errors via APIReport error details via API
+
+The API response will then contain the details about why the API request was rejected or was not successful.
+
+Common Errors
Wrong API Key or Address Not Allowed
//org.zaproxy.clientapi.core.ClientApiException: java.net.SocketException: Unexpected end of file from server
+// at org.zaproxy.clientapi.core.ClientApi.callApiDom(ClientApi.java:366)
+// at org.zaproxy.clientapi.core.ClientApi.callApi(ClientApi.java:350)
+// at org.zaproxy.clientapi.gen.Spider.scan(Spider.java:242)
+
requests.exceptions.ProxyError: HTTPConnectionPool(host='127.0.0.1', port=8080): Max retries exceeded with
+url: http://zap/JSON/spider/action/scan/?apikey=changeMe&url=https%3A%2F%2Fexample.com
+(Caused by ProxyError('Cannot connect to proxy.', RemoteDisconnected('Remote end closed connection without response')))
+
+By default, ZAP will close the connection without a response if an API request is not from an allowed address or the API key is wrong.
+If you get exceptions similar to the following ensure that the API client is using the correct API key and that the address is allowed.
+No Connection to ZAP
//org.zaproxy.clientapi.core.ClientApiException: java.net.ConnectException: Connection refused: connect
+// at org.zaproxy.clientapi.core.ClientApi.callApiDom(ClientApi.java:366)
+// at org.zaproxy.clientapi.core.ClientApi.callApi(ClientApi.java:350)
+// at org.zaproxy.clientapi.gen.Spider.scan(Spider.java:242)
+// at ZAP_tests.Spider.main(Spider.java:25)
+
requests.exceptions.ProxyError: HTTPConnectionPool(host='127.0.0.1', port=8080): Max retries exceeded with
+url: http://zap/JSON/spider/action/scan/?apikey=changeMe&url=https%3A%2F%2Fexample.com
+(Caused by ProxyError('Cannot connect to proxy.', NewConnectionError('<urllib3.connection.HTTPConnection object at
+0x101be78e0>: Failed to establish a new connection: [Errno 61] Connection refused')))
+
+There are several reasons that the API client might not be able to connect to ZAP:
+
+
+- ZAP is not yet started, some clients might have methods to wait for ZAP;
+- ZAP is not listening on the address, for example, if the API client is connecting from an external machine then ZAP will have to listen on the external address (or all addresses
0.0.0.0)
+- The API client is not configured with correct address/port;
+
+Error: No Implementor
+If you come across the No Implementor Error while invoking the APIs: Check the necessary add-on or component is installed and enabled.
+(For example if you receive "no_implementor" in relation to Ajax Spider calls, perhaps the Ajax Spider add-on isn't installed.)
+API Catalogue
+
+Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
+
+
+The HTTP API for controlling and accessing ZAP.
+
+Base URLs:
+
+
+-
+
+
+- address - The address ZAP is listening on. Default: 127.0.0.1
+- port - The port ZAP is bound to. Default: 8080
+
+
+
+Email: ZAP User Group Web: ZAP User Group
+License: Apache 2.0
+
+undefined
+
+accessControl
+accessControlActionScan
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/accessControl/action/scan/?contextId=string&userId=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/accessControl/action/scan/?contextId=string&userId=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/accessControl/action/scan/', params={
+ 'contextId': 'string', 'userId': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/accessControl/action/scan/
+
+Starts an Access Control scan with the given context ID and user ID. (Optional parameters: user ID for Unauthenticated user, boolean identifying whether or not Alerts are raised, and the Risk level for the Alerts.) [This assumes the Access Control rules were previously established via ZAP gui and the necessary Context exported/imported.]
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+contextId
+query
+string
+true
+none
+
+
+userId
+query
+string
+true
+none
+
+
+scanAsUnAuthUser
+query
+string
+false
+none
+
+
+raiseAlert
+query
+string
+false
+none
+
+
+alertRiskLevel
+query
+string
+false
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+accessControlActionWriteHTMLreport
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/accessControl/action/writeHTMLreport/?contextId=string&fileName=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/accessControl/action/writeHTMLreport/?contextId=string&fileName=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/accessControl/action/writeHTMLreport/', params={
+ 'contextId': 'string', 'fileName': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/accessControl/action/writeHTMLreport/
+
+Generates an Access Control report for the given context ID and saves it based on the provided filename (path).
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+contextId
+query
+string
+true
+none
+
+
+fileName
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+accessControlViewGetScanProgress
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/accessControl/view/getScanProgress/?contextId=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/accessControl/view/getScanProgress/?contextId=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/accessControl/view/getScanProgress/', params={
+ 'contextId': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/accessControl/view/getScanProgress/
+
+Gets the Access Control scan progress (percentage integer) for the given context ID.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+contextId
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+accessControlViewGetScanStatus
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/accessControl/view/getScanStatus/?contextId=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/accessControl/view/getScanStatus/?contextId=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/accessControl/view/getScanStatus/', params={
+ 'contextId': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/accessControl/view/getScanStatus/
+
+Gets the Access Control scan status (description string) for the given context ID.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+contextId
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+
+acsrf
+acsrfActionAddOptionToken
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/acsrf/action/addOptionToken/?String=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/acsrf/action/addOptionToken/?String=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/acsrf/action/addOptionToken/', params={
+ 'String': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/acsrf/action/addOptionToken/
+
+Adds an anti-CSRF token with the given name, enabled by default
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+String
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+acsrfActionRemoveOptionToken
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/acsrf/action/removeOptionToken/?String=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/acsrf/action/removeOptionToken/?String=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/acsrf/action/removeOptionToken/', params={
+ 'String': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/acsrf/action/removeOptionToken/
+
+Removes the anti-CSRF token with the given name
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+String
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+acsrfActionSetOptionPartialMatchingEnabled
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/acsrf/action/setOptionPartialMatchingEnabled/?Boolean=true \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/acsrf/action/setOptionPartialMatchingEnabled/?Boolean=true");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/acsrf/action/setOptionPartialMatchingEnabled/', params={
+ 'Boolean': 'true'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/acsrf/action/setOptionPartialMatchingEnabled/
+
+Define if ZAP should detect CSRF tokens by searching for partial matches.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Boolean
+query
+boolean
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+acsrfOtherGenForm
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/OTHER/acsrf/other/genForm/?hrefId=string \
+ -H 'Accept: */*'
+
+
URL obj = new URL("http://zap/OTHER/acsrf/other/genForm/?hrefId=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': '*/*'
+}
+
+r = requests.get('http://zap/OTHER/acsrf/other/genForm/', params={
+ 'hrefId': 'string'
+}, headers = headers)
+
+print(r.content)
+
+
+GET /OTHER/acsrf/other/genForm/
+
+Generate a form for testing lack of anti-CSRF tokens - typically invoked via ZAP
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+hrefId
+query
+string
+true
+Define which request will be used
+
+
+actionUrl
+query
+string
+false
+Define the action URL to be used in the generated form
+
+
+
+
+Example responses
+
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of OTHER endpoints.
+None
+
+
+
+Response Schema
+
+
+acsrfViewOptionPartialMatchingEnabled
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/acsrf/view/optionPartialMatchingEnabled/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/acsrf/view/optionPartialMatchingEnabled/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/acsrf/view/optionPartialMatchingEnabled/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/acsrf/view/optionPartialMatchingEnabled/
+
+Define if ZAP should detect CSRF tokens by searching for partial matches
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+acsrfViewOptionTokensNames
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/acsrf/view/optionTokensNames/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/acsrf/view/optionTokensNames/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/acsrf/view/optionTokensNames/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/acsrf/view/optionTokensNames/
+
+Lists the names of all anti-CSRF tokens
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+
+ajaxSpider
+ajaxSpiderActionAddAllowedResource
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/action/addAllowedResource/?regex=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/action/addAllowedResource/?regex=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/action/addAllowedResource/', params={
+ 'regex': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/action/addAllowedResource/
+
+Adds an allowed resource.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+regex
+query
+string
+true
+The regular expression of the allowed resource.
+
+
+enabled
+query
+string
+false
+If the allowed resource should be enabled or not.
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderActionAddExcludedElement
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/action/addExcludedElement/?contextName=string&description=string&element=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/action/addExcludedElement/?contextName=string&description=string&element=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/action/addExcludedElement/', params={
+ 'contextName': 'string', 'description': 'string', 'element': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/action/addExcludedElement/
+
+Adds an excluded element to a context.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+contextName
+query
+string
+true
+The name of the context.
+
+
+description
+query
+string
+true
+The description of the excluded element.
+
+
+element
+query
+string
+true
+The element to exclude.
+
+
+xpath
+query
+string
+false
+The XPath of the element.
+
+
+text
+query
+string
+false
+The text of the element.
+
+
+attributeName
+query
+string
+false
+The attribute name of the element.
+
+
+attributeValue
+query
+string
+false
+The attribute value of the element.
+
+
+enabled
+query
+string
+false
+The enabled state, true or false.
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderActionModifyExcludedElement
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/action/modifyExcludedElement/?contextName=string&description=string&element=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/action/modifyExcludedElement/?contextName=string&description=string&element=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/action/modifyExcludedElement/', params={
+ 'contextName': 'string', 'description': 'string', 'element': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/action/modifyExcludedElement/
+
+Modifies an excluded element of a context.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+contextName
+query
+string
+true
+The name of the context.
+
+
+description
+query
+string
+true
+The description of the excluded element.
+
+
+element
+query
+string
+true
+The element to exclude.
+
+
+descriptionNew
+query
+string
+false
+The new description.
+
+
+xpath
+query
+string
+false
+The XPath of the element.
+
+
+text
+query
+string
+false
+The text of the element.
+
+
+attributeName
+query
+string
+false
+The attribute name of the element.
+
+
+attributeValue
+query
+string
+false
+The attribute value of the element.
+
+
+enabled
+query
+string
+false
+The enabled state, true or false.
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderActionRemoveAllowedResource
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/action/removeAllowedResource/?regex=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/action/removeAllowedResource/?regex=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/action/removeAllowedResource/', params={
+ 'regex': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/action/removeAllowedResource/
+
+Removes an allowed resource.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+regex
+query
+string
+true
+The regular expression of the allowed resource.
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderActionRemoveExcludedElement
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/action/removeExcludedElement/?contextName=string&description=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/action/removeExcludedElement/?contextName=string&description=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/action/removeExcludedElement/', params={
+ 'contextName': 'string', 'description': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/action/removeExcludedElement/
+
+Removes an excluded element from a context.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+contextName
+query
+string
+true
+The name of the context.
+
+
+description
+query
+string
+true
+The description of the excluded element.
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderActionScan
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/action/scan/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/action/scan/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/action/scan/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/action/scan/
+
+Runs the AJAX Spider against a given target.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+url
+query
+string
+false
+The starting URL (needs to include the 'scheme').
+
+
+inScope
+query
+string
+false
+A boolean (true/false) indicating whether or not the scan should be restricted to 'inScope' only resources (default value is false).
+
+
+contextName
+query
+string
+false
+The name for any defined context. If the value does not match a defined context then an error will occur.
+
+
+subtreeOnly
+query
+string
+false
+A boolean (true/false) indicating whether or not the crawl should be constrained to a specific path (default value is false).
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderActionScanAsUser
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/action/scanAsUser/?contextName=string&userName=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/action/scanAsUser/?contextName=string&userName=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/action/scanAsUser/', params={
+ 'contextName': 'string', 'userName': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/action/scanAsUser/
+
+Runs the AJAX Spider from the perspective of a User of the web application.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+contextName
+query
+string
+true
+The name for any defined context. If the value does not match a defined context then an error will occur.
+
+
+userName
+query
+string
+true
+The name of the user to be used when crawling. The "userName" should be previously defined on the context configuration.
+
+
+url
+query
+string
+false
+The starting URL (needs to include the 'scheme').
+
+
+subtreeOnly
+query
+string
+false
+A boolean (true/false) indicating whether or not the crawl should be constrained to a specific path (default value is false).
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderActionSetEnabledAllowedResource
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/action/setEnabledAllowedResource/?regex=string&enabled=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/action/setEnabledAllowedResource/?regex=string&enabled=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/action/setEnabledAllowedResource/', params={
+ 'regex': 'string', 'enabled': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/action/setEnabledAllowedResource/
+
+Sets whether or not an allowed resource is enabled.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+regex
+query
+string
+true
+The regular expression of the allowed resource.
+
+
+enabled
+query
+string
+true
+If the allowed resource should be enabled or not.
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderActionSetOptionBrowserId
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/action/setOptionBrowserId/?String=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/action/setOptionBrowserId/?String=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/action/setOptionBrowserId/', params={
+ 'String': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/action/setOptionBrowserId/
+
+Sets the configuration of the AJAX Spider to use one of the supported browsers.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+String
+query
+string
+true
+The name of the browser to be used by the AJAX Spider. (See the Selenium add-on help for a list of supported browsers.)
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderActionSetOptionClickDefaultElems
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/action/setOptionClickDefaultElems/?Boolean=true \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/action/setOptionClickDefaultElems/?Boolean=true");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/action/setOptionClickDefaultElems/', params={
+ 'Boolean': 'true'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/action/setOptionClickDefaultElems/
+
+Sets whether or not the the AJAX Spider will only click on the default HTML elements.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Boolean
+query
+boolean
+true
+A boolean (true/false) indicating if only default elements such as 'a' 'button' 'input' should be clicked (default is true).
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderActionSetOptionClickElemsOnce
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/action/setOptionClickElemsOnce/?Boolean=true \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/action/setOptionClickElemsOnce/?Boolean=true");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/action/setOptionClickElemsOnce/', params={
+ 'Boolean': 'true'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/action/setOptionClickElemsOnce/
+
+When enabled, the crawler attempts to interact with each element (e.g., by clicking) only once.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Boolean
+query
+boolean
+true
+A boolean (true/false) indicating whether or not the AJAX Spider should only click on elements once. If this is set to false, the crawler will attempt to click multiple times; which is more rigorous but may take considerably more time (default is true).
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderActionSetOptionEventWait
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/action/setOptionEventWait/?Integer=0 \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/action/setOptionEventWait/?Integer=0");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/action/setOptionEventWait/', params={
+ 'Integer': '0'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/action/setOptionEventWait/
+
+Sets the time to wait after an event (in milliseconds). For example: the wait delay after the cursor hovers over an element, in order for a menu to display, etc.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Integer
+query
+integer
+true
+The time that the AJAX Spider should wait for each event (default is 1000 milliseconds).
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderActionSetOptionMaxCrawlDepth
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/action/setOptionMaxCrawlDepth/?Integer=0 \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/action/setOptionMaxCrawlDepth/?Integer=0");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/action/setOptionMaxCrawlDepth/', params={
+ 'Integer': '0'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/action/setOptionMaxCrawlDepth/
+
+Sets the maximum depth that the crawler can reach.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Integer
+query
+integer
+true
+The maximum depth that the crawler should explore (zero means unlimited depth, default is 10).
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderActionSetOptionMaxCrawlStates
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/action/setOptionMaxCrawlStates/?Integer=0 \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/action/setOptionMaxCrawlStates/?Integer=0");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/action/setOptionMaxCrawlStates/', params={
+ 'Integer': '0'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/action/setOptionMaxCrawlStates/
+
+Sets the maximum number of states that the crawler should crawl.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Integer
+query
+integer
+true
+The maximum number of states that the AJAX Spider should explore (zero means unlimited crawl states, default is 0)
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderActionSetOptionMaxDuration
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/action/setOptionMaxDuration/?Integer=0 \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/action/setOptionMaxDuration/?Integer=0");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/action/setOptionMaxDuration/', params={
+ 'Integer': '0'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/action/setOptionMaxDuration/
+
+The maximum time that the crawler is allowed to run.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Integer
+query
+integer
+true
+The maximum amount of time that the AJAX Spider is allowed to run (zero means unlimited running time, default is 60 minutes).
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderActionSetOptionNumberOfBrowsers
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/action/setOptionNumberOfBrowsers/?Integer=0 \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/action/setOptionNumberOfBrowsers/?Integer=0");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/action/setOptionNumberOfBrowsers/', params={
+ 'Integer': '0'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/action/setOptionNumberOfBrowsers/
+
+Sets the number of windows to be used by AJAX Spider.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Integer
+query
+integer
+true
+The number of windows that the AJAX Spider can use. The more windows, the faster the process will be. However, more windows also means greater resource usage (CPU, Memory, etc), and could lead to concurrency issues depending on the app being explored (default is 1).
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderActionSetOptionRandomInputs
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/action/setOptionRandomInputs/?Boolean=true \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/action/setOptionRandomInputs/?Boolean=true");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/action/setOptionRandomInputs/', params={
+ 'Boolean': 'true'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/action/setOptionRandomInputs/
+
+When enabled, inserts random values into form fields.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Boolean
+query
+boolean
+true
+A boolean (true/false) indicating whether or not random values should be use in form fields. Otherwise, empty values are submitted (default is true).
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderActionSetOptionReloadWait
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/action/setOptionReloadWait/?Integer=0 \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/action/setOptionReloadWait/?Integer=0");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/action/setOptionReloadWait/', params={
+ 'Integer': '0'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/action/setOptionReloadWait/
+
+Sets the time to wait after the page is loaded before interacting with it.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Integer
+query
+integer
+true
+The number of milliseconds the AJAX Spider should wait after a page is loaded (default is 1000).
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderActionStop
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/action/stop/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/action/stop/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/action/stop/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/action/stop/
+
+Stops the AJAX Spider.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderViewAllowedResources
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/view/allowedResources/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/view/allowedResources/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/view/allowedResources/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/view/allowedResources/
+
+Gets the allowed resources. The allowed resources are always fetched even if out of scope, allowing to include necessary resources (e.g. scripts) from 3rd-parties.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderViewExcludedElements
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/view/excludedElements/?contextName=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/view/excludedElements/?contextName=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/view/excludedElements/', params={
+ 'contextName': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/view/excludedElements/
+
+Gets the excluded elements. The excluded elements are not clicked during crawling, for example, to prevent logging out.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+contextName
+query
+string
+true
+The name of the context.
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderViewFullResults
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/view/fullResults/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/view/fullResults/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/view/fullResults/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/view/fullResults/
+
+Gets the full crawled content detected by the AJAX Spider. Returns a set of values based on 'inScope' URLs, 'outOfScope' URLs, and 'errors' encountered during the last/current run of the AJAX Spider.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderViewNumberOfResults
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/view/numberOfResults/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/view/numberOfResults/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/view/numberOfResults/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/view/numberOfResults/
+
+Gets the number of resources found.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderViewOptionBrowserId
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/view/optionBrowserId/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/view/optionBrowserId/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/view/optionBrowserId/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/view/optionBrowserId/
+
+Gets the configured browser to use for crawling.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderViewOptionClickDefaultElems
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/view/optionClickDefaultElems/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/view/optionClickDefaultElems/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/view/optionClickDefaultElems/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/view/optionClickDefaultElems/
+
+Gets the configured value for 'Click Default Elements Only', HTML elements such as 'a', 'button', 'input', all associated with some action or links on the page.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderViewOptionClickElemsOnce
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/view/optionClickElemsOnce/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/view/optionClickElemsOnce/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/view/optionClickElemsOnce/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/view/optionClickElemsOnce/
+
+Gets the value configured for the AJAX Spider to know if it should click on the elements only once.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderViewOptionEventWait
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/view/optionEventWait/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/view/optionEventWait/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/view/optionEventWait/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/view/optionEventWait/
+
+Gets the time to wait after an event (in milliseconds). For example: the wait delay after the cursor hovers over an element, in order for a menu to display, etc.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderViewOptionMaxCrawlDepth
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/view/optionMaxCrawlDepth/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/view/optionMaxCrawlDepth/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/view/optionMaxCrawlDepth/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/view/optionMaxCrawlDepth/
+
+Gets the configured value for the max crawl depth.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderViewOptionMaxCrawlStates
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/view/optionMaxCrawlStates/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/view/optionMaxCrawlStates/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/view/optionMaxCrawlStates/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/view/optionMaxCrawlStates/
+
+Gets the configured value for the maximum crawl states allowed.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderViewOptionMaxDuration
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/view/optionMaxDuration/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/view/optionMaxDuration/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/view/optionMaxDuration/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/view/optionMaxDuration/
+
+Gets the configured max duration of the crawl, the value is in minutes.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderViewOptionNumberOfBrowsers
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/view/optionNumberOfBrowsers/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/view/optionNumberOfBrowsers/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/view/optionNumberOfBrowsers/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/view/optionNumberOfBrowsers/
+
+Gets the configured number of browsers to be used.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderViewOptionRandomInputs
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/view/optionRandomInputs/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/view/optionRandomInputs/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/view/optionRandomInputs/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/view/optionRandomInputs/
+
+Gets if the AJAX Spider will use random values in form fields when crawling, if set to true.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderViewOptionReloadWait
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/view/optionReloadWait/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/view/optionReloadWait/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/view/optionReloadWait/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/view/optionReloadWait/
+
+Gets the configured time to wait after reloading the page, this value is in milliseconds.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderViewResults
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/view/results/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/view/results/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/view/results/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/view/results/
+
+Gets the current results of the crawler.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+start
+query
+string
+false
+The position (or offset) within the results to use as a starting position for the information returned.
+
+
+count
+query
+string
+false
+The number of results to return.
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ajaxSpiderViewStatus
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ajaxSpider/view/status/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ajaxSpider/view/status/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ajaxSpider/view/status/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ajaxSpider/view/status/
+
+Gets the current status of the crawler. Actual values are Stopped and Running.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+
+alert
+alertActionAddAlert
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/alert/action/addAlert/?messageId=string&name=string&riskId=string&confidenceId=string&description=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/alert/action/addAlert/?messageId=string&name=string&riskId=string&confidenceId=string&description=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/alert/action/addAlert/', params={
+ 'messageId': 'string', 'name': 'string', 'riskId': 'string', 'confidenceId': 'string', 'description': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/alert/action/addAlert/
+
+Add an alert associated with the given message ID, with the provided details. (The ID of the created alert is returned.)
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+messageId
+query
+string
+true
+The ID of the message to which the alert should be associated.
+
+
+name
+query
+string
+true
+The name of the alert.
+
+
+riskId
+query
+string
+true
+The numeric risk representation ('0 - Informational' through '3 - High').
+
+
+confidenceId
+query
+string
+true
+The numeric confidence representation ('1 - Low' through '3 - High' [user set values '0 - False Positive', and '4 - User Confirmed' are also available]).
+
+
+description
+query
+string
+true
+The description to be set to the alert.
+
+
+param
+query
+string
+false
+The name of the parameter applicable to the alert.
+
+
+attack
+query
+string
+false
+The attack (ex: injected string) used by the scan rule.
+
+
+otherInfo
+query
+string
+false
+Other information about the alert or test.
+
+
+solution
+query
+string
+false
+The solution for the alert.
+
+
+references
+query
+string
+false
+The reference details for the alert.
+
+
+evidence
+query
+string
+false
+The evidence associated with the alert.
+
+
+cweId
+query
+string
+false
+The CWE identifier associated with the alert.
+
+
+wascId
+query
+string
+false
+The WASC identifier associated with the alert.
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+alertActionDeleteAlert
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/alert/action/deleteAlert/?id=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/alert/action/deleteAlert/?id=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/alert/action/deleteAlert/', params={
+ 'id': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/alert/action/deleteAlert/
+
+Deletes the alert with the given ID.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+id
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+alertActionDeleteAlerts
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/alert/action/deleteAlerts/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/alert/action/deleteAlerts/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/alert/action/deleteAlerts/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/alert/action/deleteAlerts/
+
+Deletes all the alerts optionally filtered by URL which fall within the Context with the provided name, risk, or base URL.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+contextName
+query
+string
+false
+The name of the Context for which the alerts should be deleted.
+
+
+baseurl
+query
+string
+false
+The highest URL in the Sites tree under which alerts should be deleted.
+
+
+riskId
+query
+string
+false
+The numeric risk representation ('0 - Informational' through '3 - High').
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+alertActionDeleteAllAlerts
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/alert/action/deleteAllAlerts/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/alert/action/deleteAllAlerts/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/alert/action/deleteAllAlerts/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/alert/action/deleteAllAlerts/
+
+Deletes all alerts of the current session.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+alertActionUpdateAlert
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/alert/action/updateAlert/?id=string&name=string&riskId=string&confidenceId=string&description=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/alert/action/updateAlert/?id=string&name=string&riskId=string&confidenceId=string&description=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/alert/action/updateAlert/', params={
+ 'id': 'string', 'name': 'string', 'riskId': 'string', 'confidenceId': 'string', 'description': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/alert/action/updateAlert/
+
+Update the alert with the given ID, with the provided details.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+id
+query
+string
+true
+The ID of the alert to update.
+
+
+name
+query
+string
+true
+The name of the alert.
+
+
+riskId
+query
+string
+true
+The numeric risk representation ('0 - Informational' through '3 - High').
+
+
+confidenceId
+query
+string
+true
+The numeric confidence representation ('1 - Low' through '3 - High' [user set values '0 - False Positive', and '4 - User Confirmed' are also available]).
+
+
+description
+query
+string
+true
+The description to be set to the alert.
+
+
+param
+query
+string
+false
+The name of the parameter applicable to the alert.
+
+
+attack
+query
+string
+false
+The attack (ex: injected string) used by the scan rule.
+
+
+otherInfo
+query
+string
+false
+Other information about the alert or test.
+
+
+solution
+query
+string
+false
+The solution for the alert.
+
+
+references
+query
+string
+false
+The reference details for the alert.
+
+
+evidence
+query
+string
+false
+The evidence associated with the alert.
+
+
+cweId
+query
+string
+false
+The CWE identifier associated with the alert.
+
+
+wascId
+query
+string
+false
+The WASC identifier associated with the alert.
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+alertActionUpdateAlertsConfidence
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/alert/action/updateAlertsConfidence/?ids=string&confidenceId=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/alert/action/updateAlertsConfidence/?ids=string&confidenceId=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/alert/action/updateAlertsConfidence/', params={
+ 'ids': 'string', 'confidenceId': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/alert/action/updateAlertsConfidence/
+
+Update the confidence of the alerts.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+ids
+query
+string
+true
+The IDs of the alerts to update (comma separated values).
+
+
+confidenceId
+query
+string
+true
+The numeric confidence representation ('1 - Low' through '3 - High' [user set values '0 - False Positive', and '4 - User Confirmed' are also available]).
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+alertActionUpdateAlertsRisk
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/alert/action/updateAlertsRisk/?ids=string&riskId=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/alert/action/updateAlertsRisk/?ids=string&riskId=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/alert/action/updateAlertsRisk/', params={
+ 'ids': 'string', 'riskId': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/alert/action/updateAlertsRisk/
+
+Update the risk of the alerts.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+ids
+query
+string
+true
+The IDs of the alerts to update (comma separated values).
+
+
+riskId
+query
+string
+true
+The numeric risk representation ('0 - Informational' through '3 - High').
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+alertViewAlert
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/alert/view/alert/?id=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/alert/view/alert/?id=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/alert/view/alert/', params={
+ 'id': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/alert/view/alert/
+
+Gets the alert with the given ID, the corresponding HTTP message can be obtained with the 'messageId' field and 'message' API method
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+id
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+alertViewAlertCountsByRisk
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/alert/view/alertCountsByRisk/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/alert/view/alertCountsByRisk/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/alert/view/alertCountsByRisk/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/alert/view/alertCountsByRisk/
+
+Gets a count of the alerts, optionally filtered as per alertsPerRisk
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+url
+query
+string
+false
+none
+
+
+recurse
+query
+string
+false
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+alertViewAlerts
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/alert/view/alerts/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/alert/view/alerts/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/alert/view/alerts/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/alert/view/alerts/
+
+Gets the alerts raised by ZAP, optionally filtering by URL or riskId, and paginating with 'start' position and 'count' of alerts
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+baseurl
+query
+string
+false
+The highest URL in the Sites tree under which alerts should be included.
+
+
+start
+query
+string
+false
+none
+
+
+count
+query
+string
+false
+none
+
+
+riskId
+query
+string
+false
+none
+
+
+contextName
+query
+string
+false
+Optionally, the Context name which the Alerts' URLs are associated with.
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+alertViewAlertsByRisk
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/alert/view/alertsByRisk/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/alert/view/alertsByRisk/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/alert/view/alertsByRisk/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/alert/view/alertsByRisk/
+
+Gets a summary of the alerts, optionally filtered by a 'url'. If 'recurse' is true then all alerts that apply to urls that start with the specified 'url' will be returned, otherwise only those on exactly the same 'url' (ignoring url parameters)
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+url
+query
+string
+false
+none
+
+
+recurse
+query
+string
+false
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+alertViewAlertsSummary
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/alert/view/alertsSummary/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/alert/view/alertsSummary/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/alert/view/alertsSummary/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/alert/view/alertsSummary/
+
+Gets number of alerts grouped by each risk level, optionally filtering by URL
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+baseurl
+query
+string
+false
+The highest URL in the Sites tree under which alerts should be included.
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+alertViewNumberOfAlerts
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/alert/view/numberOfAlerts/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/alert/view/numberOfAlerts/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/alert/view/numberOfAlerts/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/alert/view/numberOfAlerts/
+
+Gets the number of alerts, optionally filtering by URL or riskId
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+baseurl
+query
+string
+false
+The highest URL in the Sites tree under which alerts should be included.
+
+
+riskId
+query
+string
+false
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+
+alertFilter
+alertFilterActionAddAlertFilter
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/alertFilter/action/addAlertFilter/?contextId=string&ruleId=string&newLevel=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/alertFilter/action/addAlertFilter/?contextId=string&ruleId=string&newLevel=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/alertFilter/action/addAlertFilter/', params={
+ 'contextId': 'string', 'ruleId': 'string', 'newLevel': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/alertFilter/action/addAlertFilter/
+
+Adds a new alert filter for the context with the given ID.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+contextId
+query
+string
+true
+none
+
+
+ruleId
+query
+string
+true
+none
+
+
+newLevel
+query
+string
+true
+none
+
+
+url
+query
+string
+false
+none
+
+
+urlIsRegex
+query
+string
+false
+none
+
+
+parameter
+query
+string
+false
+none
+
+
+enabled
+query
+string
+false
+none
+
+
+parameterIsRegex
+query
+string
+false
+none
+
+
+attack
+query
+string
+false
+none
+
+
+attackIsRegex
+query
+string
+false
+none
+
+
+evidence
+query
+string
+false
+none
+
+
+evidenceIsRegex
+query
+string
+false
+none
+
+
+methods
+query
+string
+false
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+alertFilterActionAddGlobalAlertFilter
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/alertFilter/action/addGlobalAlertFilter/?ruleId=string&newLevel=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/alertFilter/action/addGlobalAlertFilter/?ruleId=string&newLevel=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/alertFilter/action/addGlobalAlertFilter/', params={
+ 'ruleId': 'string', 'newLevel': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/alertFilter/action/addGlobalAlertFilter/
+
+Adds a new global alert filter.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+ruleId
+query
+string
+true
+none
+
+
+newLevel
+query
+string
+true
+none
+
+
+url
+query
+string
+false
+none
+
+
+urlIsRegex
+query
+string
+false
+none
+
+
+parameter
+query
+string
+false
+none
+
+
+enabled
+query
+string
+false
+none
+
+
+parameterIsRegex
+query
+string
+false
+none
+
+
+attack
+query
+string
+false
+none
+
+
+attackIsRegex
+query
+string
+false
+none
+
+
+evidence
+query
+string
+false
+none
+
+
+evidenceIsRegex
+query
+string
+false
+none
+
+
+methods
+query
+string
+false
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+alertFilterActionApplyAll
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/alertFilter/action/applyAll/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/alertFilter/action/applyAll/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/alertFilter/action/applyAll/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/alertFilter/action/applyAll/
+
+Applies all currently enabled Global and Context alert filters.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+alertFilterActionApplyContext
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/alertFilter/action/applyContext/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/alertFilter/action/applyContext/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/alertFilter/action/applyContext/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/alertFilter/action/applyContext/
+
+Applies all currently enabled Context alert filters.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+alertFilterActionApplyGlobal
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/alertFilter/action/applyGlobal/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/alertFilter/action/applyGlobal/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/alertFilter/action/applyGlobal/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/alertFilter/action/applyGlobal/
+
+Applies all currently enabled Global alert filters.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+alertFilterActionRemoveAlertFilter
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/alertFilter/action/removeAlertFilter/?contextId=string&ruleId=string&newLevel=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/alertFilter/action/removeAlertFilter/?contextId=string&ruleId=string&newLevel=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/alertFilter/action/removeAlertFilter/', params={
+ 'contextId': 'string', 'ruleId': 'string', 'newLevel': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/alertFilter/action/removeAlertFilter/
+
+Removes an alert filter from the context with the given ID.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+contextId
+query
+string
+true
+none
+
+
+ruleId
+query
+string
+true
+none
+
+
+newLevel
+query
+string
+true
+none
+
+
+url
+query
+string
+false
+none
+
+
+urlIsRegex
+query
+string
+false
+none
+
+
+parameter
+query
+string
+false
+none
+
+
+enabled
+query
+string
+false
+none
+
+
+parameterIsRegex
+query
+string
+false
+none
+
+
+attack
+query
+string
+false
+none
+
+
+attackIsRegex
+query
+string
+false
+none
+
+
+evidence
+query
+string
+false
+none
+
+
+evidenceIsRegex
+query
+string
+false
+none
+
+
+methods
+query
+string
+false
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+alertFilterActionRemoveGlobalAlertFilter
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/alertFilter/action/removeGlobalAlertFilter/?ruleId=string&newLevel=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/alertFilter/action/removeGlobalAlertFilter/?ruleId=string&newLevel=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/alertFilter/action/removeGlobalAlertFilter/', params={
+ 'ruleId': 'string', 'newLevel': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/alertFilter/action/removeGlobalAlertFilter/
+
+Removes a global alert filter.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+ruleId
+query
+string
+true
+none
+
+
+newLevel
+query
+string
+true
+none
+
+
+url
+query
+string
+false
+none
+
+
+urlIsRegex
+query
+string
+false
+none
+
+
+parameter
+query
+string
+false
+none
+
+
+enabled
+query
+string
+false
+none
+
+
+parameterIsRegex
+query
+string
+false
+none
+
+
+attack
+query
+string
+false
+none
+
+
+attackIsRegex
+query
+string
+false
+none
+
+
+evidence
+query
+string
+false
+none
+
+
+evidenceIsRegex
+query
+string
+false
+none
+
+
+methods
+query
+string
+false
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+alertFilterActionTestAll
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/alertFilter/action/testAll/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/alertFilter/action/testAll/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/alertFilter/action/testAll/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/alertFilter/action/testAll/
+
+Tests all currently enabled Global and Context alert filters.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+alertFilterActionTestContext
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/alertFilter/action/testContext/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/alertFilter/action/testContext/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/alertFilter/action/testContext/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/alertFilter/action/testContext/
+
+Tests all currently enabled Context alert filters.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+alertFilterActionTestGlobal
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/alertFilter/action/testGlobal/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/alertFilter/action/testGlobal/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/alertFilter/action/testGlobal/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/alertFilter/action/testGlobal/
+
+Tests all currently enabled Global alert filters.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+alertFilterViewAlertFilterList
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/alertFilter/view/alertFilterList/?contextId=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/alertFilter/view/alertFilterList/?contextId=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/alertFilter/view/alertFilterList/', params={
+ 'contextId': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/alertFilter/view/alertFilterList/
+
+Lists the alert filters of the context with the given ID.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+contextId
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+alertFilterViewGlobalAlertFilterList
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/alertFilter/view/globalAlertFilterList/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/alertFilter/view/globalAlertFilterList/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/alertFilter/view/globalAlertFilterList/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/alertFilter/view/globalAlertFilterList/
+
+Lists the global alert filters.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+
+ascan
+ascanActionAddExcludedParam
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/addExcludedParam/?name=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/addExcludedParam/?name=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/addExcludedParam/', params={
+ 'name': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/addExcludedParam/
+
+Adds a new parameter excluded from the scan, using the specified name. Optionally sets if the new entry applies to a specific URL (default, all URLs) and sets the ID of the type of the parameter (default, ID of any type). The type IDs can be obtained with the view excludedParamTypes.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+name
+query
+string
+true
+none
+
+
+type
+query
+string
+false
+none
+
+
+url
+query
+string
+false
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionAddScanPolicy
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/addScanPolicy/?scanPolicyName=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/addScanPolicy/?scanPolicyName=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/addScanPolicy/', params={
+ 'scanPolicyName': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/addScanPolicy/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+scanPolicyName
+query
+string
+true
+none
+
+
+alertThreshold
+query
+string
+false
+none
+
+
+attackStrength
+query
+string
+false
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionClearExcludedFromScan
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/clearExcludedFromScan/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/clearExcludedFromScan/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/clearExcludedFromScan/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/clearExcludedFromScan/
+
+Clears the regexes of URLs excluded from the active scans.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionDisableAllScanners
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/disableAllScanners/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/disableAllScanners/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/disableAllScanners/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/disableAllScanners/
+
+Disables all scan rules of the scan policy with the given name, or the default if none given.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+scanPolicyName
+query
+string
+false
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionDisableScanners
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/disableScanners/?ids=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/disableScanners/?ids=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/disableScanners/', params={
+ 'ids': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/disableScanners/
+
+Disables the scan rules with the given IDs (comma separated list of IDs) of the scan policy with the given name, or the default if none given.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+ids
+query
+string
+true
+none
+
+
+scanPolicyName
+query
+string
+false
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionEnableAllScanners
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/enableAllScanners/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/enableAllScanners/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/enableAllScanners/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/enableAllScanners/
+
+Enables all scan rules of the scan policy with the given name, or the default if none given.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+scanPolicyName
+query
+string
+false
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionEnableScanners
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/enableScanners/?ids=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/enableScanners/?ids=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/enableScanners/', params={
+ 'ids': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/enableScanners/
+
+Enables the scan rules with the given IDs (comma separated list of IDs) of the scan policy with the given name, or the default if none given.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+ids
+query
+string
+true
+none
+
+
+scanPolicyName
+query
+string
+false
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionExcludeFromScan
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/excludeFromScan/?regex=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/excludeFromScan/?regex=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/excludeFromScan/', params={
+ 'regex': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/excludeFromScan/
+
+Adds a regex of URLs that should be excluded from the active scans.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+regex
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionImportScanPolicy
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/importScanPolicy/?path=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/importScanPolicy/?path=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/importScanPolicy/', params={
+ 'path': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/importScanPolicy/
+
+Imports a Scan Policy using the given file system path.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+path
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionModifyExcludedParam
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/modifyExcludedParam/?idx=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/modifyExcludedParam/?idx=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/modifyExcludedParam/', params={
+ 'idx': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/modifyExcludedParam/
+
+Modifies a parameter excluded from the scan. Allows to modify the name, the URL and the type of parameter. The parameter is selected with its index, which can be obtained with the view excludedParams.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+idx
+query
+string
+true
+none
+
+
+name
+query
+string
+false
+none
+
+
+type
+query
+string
+false
+none
+
+
+url
+query
+string
+false
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionPause
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/pause/?scanId=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/pause/?scanId=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/pause/', params={
+ 'scanId': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/pause/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+scanId
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionPauseAllScans
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/pauseAllScans/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/pauseAllScans/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/pauseAllScans/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/pauseAllScans/
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionRemoveAllScans
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/removeAllScans/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/removeAllScans/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/removeAllScans/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/removeAllScans/
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionRemoveExcludedParam
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/removeExcludedParam/?idx=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/removeExcludedParam/?idx=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/removeExcludedParam/', params={
+ 'idx': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/removeExcludedParam/
+
+Removes a parameter excluded from the scan, with the given index. The index can be obtained with the view excludedParams.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+idx
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionRemoveScan
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/removeScan/?scanId=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/removeScan/?scanId=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/removeScan/', params={
+ 'scanId': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/removeScan/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+scanId
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionRemoveScanPolicy
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/removeScanPolicy/?scanPolicyName=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/removeScanPolicy/?scanPolicyName=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/removeScanPolicy/', params={
+ 'scanPolicyName': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/removeScanPolicy/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+scanPolicyName
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionResume
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/resume/?scanId=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/resume/?scanId=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/resume/', params={
+ 'scanId': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/resume/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+scanId
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionResumeAllScans
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/resumeAllScans/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/resumeAllScans/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/resumeAllScans/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/resumeAllScans/
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionScan
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/scan/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/scan/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/scan/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/scan/
+
+Runs the active scanner against the given URL or Context. Optionally, the 'recurse' parameter can be used to scan URLs under the given URL, the parameter 'inScopeOnly' can be used to constrain the scan to URLs that are in scope (ignored if a Context is specified), the parameter 'scanPolicyName' allows to specify the scan policy (if none is given it uses the default scan policy), the parameters 'method' and 'postData' allow to select a given request in conjunction with the given URL.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+url
+query
+string
+false
+none
+
+
+recurse
+query
+string
+false
+none
+
+
+inScopeOnly
+query
+string
+false
+none
+
+
+scanPolicyName
+query
+string
+false
+none
+
+
+method
+query
+string
+false
+none
+
+
+postData
+query
+string
+false
+none
+
+
+contextId
+query
+string
+false
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionScanAsUser
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/scanAsUser/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/scanAsUser/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/scanAsUser/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/scanAsUser/
+
+Active Scans from the perspective of a User, obtained using the given Context ID and User ID. See 'scan' action for more details.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+url
+query
+string
+false
+none
+
+
+contextId
+query
+string
+false
+none
+
+
+userId
+query
+string
+false
+none
+
+
+recurse
+query
+string
+false
+none
+
+
+scanPolicyName
+query
+string
+false
+none
+
+
+method
+query
+string
+false
+none
+
+
+postData
+query
+string
+false
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionSetEnabledPolicies
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/setEnabledPolicies/?ids=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/setEnabledPolicies/?ids=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/setEnabledPolicies/', params={
+ 'ids': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/setEnabledPolicies/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+ids
+query
+string
+true
+none
+
+
+scanPolicyName
+query
+string
+false
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionSetOptionAddQueryParam
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/setOptionAddQueryParam/?Boolean=true \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/setOptionAddQueryParam/?Boolean=true");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/setOptionAddQueryParam/', params={
+ 'Boolean': 'true'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/setOptionAddQueryParam/
+
+Sets whether or not the active scanner should add a query param to GET requests which do not have parameters to start with.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Boolean
+query
+boolean
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionSetOptionAllowAttackOnStart
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/setOptionAllowAttackOnStart/?Boolean=true \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/setOptionAllowAttackOnStart/?Boolean=true");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/setOptionAllowAttackOnStart/', params={
+ 'Boolean': 'true'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/setOptionAllowAttackOnStart/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Boolean
+query
+boolean
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionSetOptionAttackPolicy
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/setOptionAttackPolicy/?String=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/setOptionAttackPolicy/?String=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/setOptionAttackPolicy/', params={
+ 'String': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/setOptionAttackPolicy/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+String
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionSetOptionDefaultPolicy
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/setOptionDefaultPolicy/?String=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/setOptionDefaultPolicy/?String=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/setOptionDefaultPolicy/', params={
+ 'String': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/setOptionDefaultPolicy/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+String
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionSetOptionDelayInMs
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/setOptionDelayInMs/?Integer=0 \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/setOptionDelayInMs/?Integer=0");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/setOptionDelayInMs/', params={
+ 'Integer': '0'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/setOptionDelayInMs/
+
+This option has been superseded. Use the API rate limit endpoints in the 'network' component instead.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Integer
+query
+integer
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionSetOptionHandleAntiCSRFTokens
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/setOptionHandleAntiCSRFTokens/?Boolean=true \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/setOptionHandleAntiCSRFTokens/?Boolean=true");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/setOptionHandleAntiCSRFTokens/', params={
+ 'Boolean': 'true'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/setOptionHandleAntiCSRFTokens/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Boolean
+query
+boolean
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionSetOptionHostPerScan
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/setOptionHostPerScan/?Integer=0 \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/setOptionHostPerScan/?Integer=0");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/setOptionHostPerScan/', params={
+ 'Integer': '0'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/setOptionHostPerScan/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Integer
+query
+integer
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionSetOptionInjectPluginIdInHeader
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/setOptionInjectPluginIdInHeader/?Boolean=true \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/setOptionInjectPluginIdInHeader/?Boolean=true");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/setOptionInjectPluginIdInHeader/', params={
+ 'Boolean': 'true'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/setOptionInjectPluginIdInHeader/
+
+Sets whether or not the active scanner should inject the HTTP request header X-ZAP-Scan-ID, with the ID of the scan rule that's sending the requests.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Boolean
+query
+boolean
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionSetOptionMaxAlertsPerRule
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/setOptionMaxAlertsPerRule/?Integer=0 \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/setOptionMaxAlertsPerRule/?Integer=0");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/setOptionMaxAlertsPerRule/', params={
+ 'Integer': '0'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/setOptionMaxAlertsPerRule/
+
+Sets the maximum number of alerts that a rule can raise before being skipped.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Integer
+query
+integer
+true
+The maximum alerts.
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionSetOptionMaxChartTimeInMins
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/setOptionMaxChartTimeInMins/?Integer=0 \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/setOptionMaxChartTimeInMins/?Integer=0");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/setOptionMaxChartTimeInMins/', params={
+ 'Integer': '0'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/setOptionMaxChartTimeInMins/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Integer
+query
+integer
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionSetOptionMaxResultsToList
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/setOptionMaxResultsToList/?Integer=0 \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/setOptionMaxResultsToList/?Integer=0");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/setOptionMaxResultsToList/', params={
+ 'Integer': '0'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/setOptionMaxResultsToList/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Integer
+query
+integer
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionSetOptionMaxRuleDurationInMins
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/setOptionMaxRuleDurationInMins/?Integer=0 \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/setOptionMaxRuleDurationInMins/?Integer=0");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/setOptionMaxRuleDurationInMins/', params={
+ 'Integer': '0'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/setOptionMaxRuleDurationInMins/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Integer
+query
+integer
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionSetOptionMaxScanDurationInMins
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/setOptionMaxScanDurationInMins/?Integer=0 \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/setOptionMaxScanDurationInMins/?Integer=0");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/setOptionMaxScanDurationInMins/', params={
+ 'Integer': '0'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/setOptionMaxScanDurationInMins/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Integer
+query
+integer
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionSetOptionMaxScansInUI
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/setOptionMaxScansInUI/?Integer=0 \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/setOptionMaxScansInUI/?Integer=0");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/setOptionMaxScansInUI/', params={
+ 'Integer': '0'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/setOptionMaxScansInUI/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Integer
+query
+integer
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionSetOptionPromptInAttackMode
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/setOptionPromptInAttackMode/?Boolean=true \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/setOptionPromptInAttackMode/?Boolean=true");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/setOptionPromptInAttackMode/', params={
+ 'Boolean': 'true'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/setOptionPromptInAttackMode/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Boolean
+query
+boolean
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionSetOptionPromptToClearFinishedScans
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/setOptionPromptToClearFinishedScans/?Boolean=true \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/setOptionPromptToClearFinishedScans/?Boolean=true");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/setOptionPromptToClearFinishedScans/', params={
+ 'Boolean': 'true'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/setOptionPromptToClearFinishedScans/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Boolean
+query
+boolean
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionSetOptionRescanInAttackMode
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/setOptionRescanInAttackMode/?Boolean=true \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/setOptionRescanInAttackMode/?Boolean=true");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/setOptionRescanInAttackMode/', params={
+ 'Boolean': 'true'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/setOptionRescanInAttackMode/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Boolean
+query
+boolean
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionSetOptionScanHeadersAllRequests
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/setOptionScanHeadersAllRequests/?Boolean=true \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/setOptionScanHeadersAllRequests/?Boolean=true");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/setOptionScanHeadersAllRequests/', params={
+ 'Boolean': 'true'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/setOptionScanHeadersAllRequests/
+
+Sets whether or not the HTTP Headers of all requests should be scanned. Not just requests that send parameters, through the query or request body.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Boolean
+query
+boolean
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionSetOptionScanNullJsonValues
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/setOptionScanNullJsonValues/?Boolean=true \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/setOptionScanNullJsonValues/?Boolean=true");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/setOptionScanNullJsonValues/', params={
+ 'Boolean': 'true'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/setOptionScanNullJsonValues/
+
+Sets whether or not the active scanner should scan null JSON values.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Boolean
+query
+boolean
+true
+true to scan null values, false otherwise.
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionSetOptionShowAdvancedDialog
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/setOptionShowAdvancedDialog/?Boolean=true \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/setOptionShowAdvancedDialog/?Boolean=true");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/setOptionShowAdvancedDialog/', params={
+ 'Boolean': 'true'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/setOptionShowAdvancedDialog/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Boolean
+query
+boolean
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionSetOptionTargetParamsEnabledRPC
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/setOptionTargetParamsEnabledRPC/?Integer=0 \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/setOptionTargetParamsEnabledRPC/?Integer=0");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/setOptionTargetParamsEnabledRPC/', params={
+ 'Integer': '0'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/setOptionTargetParamsEnabledRPC/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Integer
+query
+integer
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionSetOptionTargetParamsInjectable
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/setOptionTargetParamsInjectable/?Integer=0 \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/setOptionTargetParamsInjectable/?Integer=0");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/setOptionTargetParamsInjectable/', params={
+ 'Integer': '0'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/setOptionTargetParamsInjectable/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Integer
+query
+integer
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionSetOptionThreadPerHost
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/setOptionThreadPerHost/?Integer=0 \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/setOptionThreadPerHost/?Integer=0");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/setOptionThreadPerHost/', params={
+ 'Integer': '0'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/setOptionThreadPerHost/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Integer
+query
+integer
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionSetPolicyAlertThreshold
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/setPolicyAlertThreshold/?id=string&alertThreshold=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/setPolicyAlertThreshold/?id=string&alertThreshold=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/setPolicyAlertThreshold/', params={
+ 'id': 'string', 'alertThreshold': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/setPolicyAlertThreshold/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+id
+query
+string
+true
+none
+
+
+alertThreshold
+query
+string
+true
+none
+
+
+scanPolicyName
+query
+string
+false
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionSetPolicyAttackStrength
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/setPolicyAttackStrength/?id=string&attackStrength=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/setPolicyAttackStrength/?id=string&attackStrength=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/setPolicyAttackStrength/', params={
+ 'id': 'string', 'attackStrength': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/setPolicyAttackStrength/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+id
+query
+string
+true
+none
+
+
+attackStrength
+query
+string
+true
+none
+
+
+scanPolicyName
+query
+string
+false
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionSetScannerAlertThreshold
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/setScannerAlertThreshold/?id=string&alertThreshold=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/setScannerAlertThreshold/?id=string&alertThreshold=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/setScannerAlertThreshold/', params={
+ 'id': 'string', 'alertThreshold': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/setScannerAlertThreshold/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+id
+query
+string
+true
+none
+
+
+alertThreshold
+query
+string
+true
+none
+
+
+scanPolicyName
+query
+string
+false
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionSetScannerAttackStrength
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/setScannerAttackStrength/?id=string&attackStrength=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/setScannerAttackStrength/?id=string&attackStrength=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/setScannerAttackStrength/', params={
+ 'id': 'string', 'attackStrength': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/setScannerAttackStrength/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+id
+query
+string
+true
+none
+
+
+attackStrength
+query
+string
+true
+none
+
+
+scanPolicyName
+query
+string
+false
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionSkipScanner
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/skipScanner/?scanId=string&scannerId=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/skipScanner/?scanId=string&scannerId=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/skipScanner/', params={
+ 'scanId': 'string', 'scannerId': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/skipScanner/
+
+Skips the scan rule using the given IDs of the scan and the scan rule.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+scanId
+query
+string
+true
+none
+
+
+scannerId
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionStop
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/stop/?scanId=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/stop/?scanId=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/stop/', params={
+ 'scanId': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/stop/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+scanId
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionStopAllScans
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/stopAllScans/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/stopAllScans/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/stopAllScans/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/stopAllScans/
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanActionUpdateScanPolicy
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/action/updateScanPolicy/?scanPolicyName=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/action/updateScanPolicy/?scanPolicyName=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/action/updateScanPolicy/', params={
+ 'scanPolicyName': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/action/updateScanPolicy/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+scanPolicyName
+query
+string
+true
+none
+
+
+alertThreshold
+query
+string
+false
+none
+
+
+attackStrength
+query
+string
+false
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewAlertsIds
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/alertsIds/?scanId=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/alertsIds/?scanId=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/alertsIds/', params={
+ 'scanId': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/alertsIds/
+
+Gets the IDs of the alerts raised during the scan with the given ID. An alert can be obtained with 'alert' core view.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+scanId
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewAttackModeQueue
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/attackModeQueue/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/attackModeQueue/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/attackModeQueue/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/attackModeQueue/
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewExcludedFromScan
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/excludedFromScan/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/excludedFromScan/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/excludedFromScan/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/excludedFromScan/
+
+Gets the regexes of URLs excluded from the active scans.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewExcludedParamTypes
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/excludedParamTypes/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/excludedParamTypes/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/excludedParamTypes/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/excludedParamTypes/
+
+Gets all the types of excluded parameters. For each type the following are shown: the ID and the name.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewExcludedParams
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/excludedParams/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/excludedParams/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/excludedParams/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/excludedParams/
+
+Gets all the parameters that are excluded. For each parameter the following are shown: the name, the URL, and the parameter type.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewMessagesIds
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/messagesIds/?scanId=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/messagesIds/?scanId=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/messagesIds/', params={
+ 'scanId': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/messagesIds/
+
+Gets the IDs of the messages sent during the scan with the given ID. A message can be obtained with 'message' core view.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+scanId
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewOptionAddQueryParam
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/optionAddQueryParam/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/optionAddQueryParam/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/optionAddQueryParam/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/optionAddQueryParam/
+
+Tells whether or not the active scanner should add a query parameter to GET request that don't have parameters to start with.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewOptionAllowAttackOnStart
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/optionAllowAttackOnStart/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/optionAllowAttackOnStart/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/optionAllowAttackOnStart/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/optionAllowAttackOnStart/
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewOptionAttackPolicy
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/optionAttackPolicy/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/optionAttackPolicy/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/optionAttackPolicy/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/optionAttackPolicy/
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewOptionDefaultPolicy
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/optionDefaultPolicy/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/optionDefaultPolicy/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/optionDefaultPolicy/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/optionDefaultPolicy/
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewOptionDelayInMs
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/optionDelayInMs/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/optionDelayInMs/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/optionDelayInMs/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/optionDelayInMs/
+
+This option has been superseded. Use the API rate limit endpoints in the 'network' component instead.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewOptionExcludedParamList
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/optionExcludedParamList/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/optionExcludedParamList/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/optionExcludedParamList/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/optionExcludedParamList/
+
+Use view excludedParams instead.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewOptionHandleAntiCSRFTokens
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/optionHandleAntiCSRFTokens/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/optionHandleAntiCSRFTokens/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/optionHandleAntiCSRFTokens/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/optionHandleAntiCSRFTokens/
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewOptionHostPerScan
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/optionHostPerScan/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/optionHostPerScan/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/optionHostPerScan/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/optionHostPerScan/
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewOptionInjectPluginIdInHeader
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/optionInjectPluginIdInHeader/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/optionInjectPluginIdInHeader/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/optionInjectPluginIdInHeader/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/optionInjectPluginIdInHeader/
+
+Tells whether or not the active scanner should inject the HTTP request header X-ZAP-Scan-ID, with the ID of the scan rule that's sending the requests.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewOptionMaxAlertsPerRule
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/optionMaxAlertsPerRule/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/optionMaxAlertsPerRule/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/optionMaxAlertsPerRule/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/optionMaxAlertsPerRule/
+
+Gets the maximum number of alerts that a rule can raise before being skipped.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewOptionMaxChartTimeInMins
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/optionMaxChartTimeInMins/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/optionMaxChartTimeInMins/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/optionMaxChartTimeInMins/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/optionMaxChartTimeInMins/
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewOptionMaxResultsToList
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/optionMaxResultsToList/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/optionMaxResultsToList/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/optionMaxResultsToList/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/optionMaxResultsToList/
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewOptionMaxRuleDurationInMins
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/optionMaxRuleDurationInMins/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/optionMaxRuleDurationInMins/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/optionMaxRuleDurationInMins/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/optionMaxRuleDurationInMins/
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewOptionMaxScanDurationInMins
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/optionMaxScanDurationInMins/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/optionMaxScanDurationInMins/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/optionMaxScanDurationInMins/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/optionMaxScanDurationInMins/
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewOptionMaxScansInUI
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/optionMaxScansInUI/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/optionMaxScansInUI/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/optionMaxScansInUI/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/optionMaxScansInUI/
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewOptionPromptInAttackMode
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/optionPromptInAttackMode/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/optionPromptInAttackMode/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/optionPromptInAttackMode/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/optionPromptInAttackMode/
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewOptionPromptToClearFinishedScans
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/optionPromptToClearFinishedScans/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/optionPromptToClearFinishedScans/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/optionPromptToClearFinishedScans/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/optionPromptToClearFinishedScans/
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewOptionRescanInAttackMode
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/optionRescanInAttackMode/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/optionRescanInAttackMode/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/optionRescanInAttackMode/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/optionRescanInAttackMode/
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewOptionScanHeadersAllRequests
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/optionScanHeadersAllRequests/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/optionScanHeadersAllRequests/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/optionScanHeadersAllRequests/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/optionScanHeadersAllRequests/
+
+Tells whether or not the HTTP Headers of all requests should be scanned. Not just requests that send parameters, through the query or request body.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewOptionScanNullJsonValues
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/optionScanNullJsonValues/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/optionScanNullJsonValues/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/optionScanNullJsonValues/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/optionScanNullJsonValues/
+
+Tells whether or not the active scanner should scan null JSON values.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewOptionShowAdvancedDialog
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/optionShowAdvancedDialog/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/optionShowAdvancedDialog/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/optionShowAdvancedDialog/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/optionShowAdvancedDialog/
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewOptionTargetParamsEnabledRPC
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/optionTargetParamsEnabledRPC/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/optionTargetParamsEnabledRPC/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/optionTargetParamsEnabledRPC/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/optionTargetParamsEnabledRPC/
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewOptionTargetParamsInjectable
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/optionTargetParamsInjectable/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/optionTargetParamsInjectable/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/optionTargetParamsInjectable/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/optionTargetParamsInjectable/
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewOptionThreadPerHost
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/optionThreadPerHost/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/optionThreadPerHost/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/optionThreadPerHost/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/optionThreadPerHost/
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewPolicies
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/policies/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/policies/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/policies/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/policies/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+scanPolicyName
+query
+string
+false
+none
+
+
+policyId
+query
+string
+false
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewScanPolicyNames
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/scanPolicyNames/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/scanPolicyNames/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/scanPolicyNames/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/scanPolicyNames/
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewScanProgress
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/scanProgress/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/scanProgress/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/scanProgress/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/scanProgress/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+scanId
+query
+string
+false
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewScanners
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/scanners/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/scanners/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/scanners/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/scanners/
+
+Gets the scan rules, optionally, of the given scan policy or scanner policy/category ID.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+scanPolicyName
+query
+string
+false
+none
+
+
+policyId
+query
+string
+false
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewScans
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/scans/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/scans/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/scans/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/scans/
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+ascanViewStatus
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/ascan/view/status/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/ascan/view/status/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/ascan/view/status/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/ascan/view/status/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+scanId
+query
+string
+false
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+
+authentication
+authenticationActionSetAuthenticationMethod
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/authentication/action/setAuthenticationMethod/?contextId=string&authMethodName=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/authentication/action/setAuthenticationMethod/?contextId=string&authMethodName=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/authentication/action/setAuthenticationMethod/', params={
+ 'contextId': 'string', 'authMethodName': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/authentication/action/setAuthenticationMethod/
+
+Sets the authentication method for the context with the given ID.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+contextId
+query
+string
+true
+none
+
+
+authMethodName
+query
+string
+true
+none
+
+
+authMethodConfigParams
+query
+string
+false
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+authenticationActionSetLoggedInIndicator
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/authentication/action/setLoggedInIndicator/?contextId=string&loggedInIndicatorRegex=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/authentication/action/setLoggedInIndicator/?contextId=string&loggedInIndicatorRegex=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/authentication/action/setLoggedInIndicator/', params={
+ 'contextId': 'string', 'loggedInIndicatorRegex': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/authentication/action/setLoggedInIndicator/
+
+Sets the logged in indicator for the context with the given ID.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+contextId
+query
+string
+true
+none
+
+
+loggedInIndicatorRegex
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+authenticationActionSetLoggedOutIndicator
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/authentication/action/setLoggedOutIndicator/?contextId=string&loggedOutIndicatorRegex=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/authentication/action/setLoggedOutIndicator/?contextId=string&loggedOutIndicatorRegex=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/authentication/action/setLoggedOutIndicator/', params={
+ 'contextId': 'string', 'loggedOutIndicatorRegex': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/authentication/action/setLoggedOutIndicator/
+
+Sets the logged out indicator for the context with the given ID.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+contextId
+query
+string
+true
+none
+
+
+loggedOutIndicatorRegex
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+authenticationViewGetAuthenticationMethod
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/authentication/view/getAuthenticationMethod/?contextId=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/authentication/view/getAuthenticationMethod/?contextId=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/authentication/view/getAuthenticationMethod/', params={
+ 'contextId': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/authentication/view/getAuthenticationMethod/
+
+Gets the name of the authentication method for the context with the given ID.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+contextId
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+authenticationViewGetAuthenticationMethodConfigParams
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/authentication/view/getAuthenticationMethodConfigParams/?authMethodName=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/authentication/view/getAuthenticationMethodConfigParams/?authMethodName=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/authentication/view/getAuthenticationMethodConfigParams/', params={
+ 'authMethodName': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/authentication/view/getAuthenticationMethodConfigParams/
+
+Gets the configuration parameters for the authentication method with the given name.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+authMethodName
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+authenticationViewGetLoggedInIndicator
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/authentication/view/getLoggedInIndicator/?contextId=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/authentication/view/getLoggedInIndicator/?contextId=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/authentication/view/getLoggedInIndicator/', params={
+ 'contextId': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/authentication/view/getLoggedInIndicator/
+
+Gets the logged in indicator for the context with the given ID.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+contextId
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+authenticationViewGetLoggedOutIndicator
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/authentication/view/getLoggedOutIndicator/?contextId=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/authentication/view/getLoggedOutIndicator/?contextId=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/authentication/view/getLoggedOutIndicator/', params={
+ 'contextId': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/authentication/view/getLoggedOutIndicator/
+
+Gets the logged out indicator for the context with the given ID.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+contextId
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+authenticationViewGetSupportedAuthenticationMethods
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/authentication/view/getSupportedAuthenticationMethods/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/authentication/view/getSupportedAuthenticationMethods/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/authentication/view/getSupportedAuthenticationMethods/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/authentication/view/getSupportedAuthenticationMethods/
+
+Gets the name of the authentication methods.
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+
+authorization
+authorizationActionSetBasicAuthorizationDetectionMethod
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/authorization/action/setBasicAuthorizationDetectionMethod/?contextId=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/authorization/action/setBasicAuthorizationDetectionMethod/?contextId=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/authorization/action/setBasicAuthorizationDetectionMethod/', params={
+ 'contextId': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/authorization/action/setBasicAuthorizationDetectionMethod/
+
+Sets the authorization detection method for a context as one that identifies un-authorized messages based on: the message's status code or a regex pattern in the response's header or body. Also, whether all conditions must match or just some can be specified via the logicalOperator parameter, which accepts two values: "AND" (default), "OR".
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+contextId
+query
+string
+true
+none
+
+
+headerRegex
+query
+string
+false
+none
+
+
+bodyRegex
+query
+string
+false
+none
+
+
+statusCode
+query
+string
+false
+none
+
+
+logicalOperator
+query
+string
+false
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+authorizationViewGetAuthorizationDetectionMethod
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/authorization/view/getAuthorizationDetectionMethod/?contextId=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/authorization/view/getAuthorizationDetectionMethod/?contextId=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/authorization/view/getAuthorizationDetectionMethod/', params={
+ 'contextId': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/authorization/view/getAuthorizationDetectionMethod/
+
+Obtains all the configuration of the authorization detection method that is currently set for a context.
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+contextId
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+
+automation
+automationActionEndDelayJob
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/automation/action/endDelayJob/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/automation/action/endDelayJob/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/automation/action/endDelayJob/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/automation/action/endDelayJob/
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+automationActionRunPlan
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/automation/action/runPlan/?filePath=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/automation/action/runPlan/?filePath=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/automation/action/runPlan/', params={
+ 'filePath': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/automation/action/runPlan/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+filePath
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+automationViewPlanProgress
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/automation/view/planProgress/?planId=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/automation/view/planProgress/?planId=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/automation/view/planProgress/', params={
+ 'planId': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/automation/view/planProgress/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+planId
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+
+autoupdate
+autoupdateActionDownloadLatestRelease
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/autoupdate/action/downloadLatestRelease/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/autoupdate/action/downloadLatestRelease/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/autoupdate/action/downloadLatestRelease/', headers = headers)
+
+print(r.json())
+
+
+GET /JSON/autoupdate/action/downloadLatestRelease/
+
+Downloads the latest release, if any
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+autoupdateActionInstallAddon
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/autoupdate/action/installAddon/?id=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/autoupdate/action/installAddon/?id=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/autoupdate/action/installAddon/', params={
+ 'id': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/autoupdate/action/installAddon/
+
+Installs or updates the specified add-on, returning when complete (i.e. not asynchronously)
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+id
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+autoupdateActionInstallLocalAddon
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/autoupdate/action/installLocalAddon/?file=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/autoupdate/action/installLocalAddon/?file=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/autoupdate/action/installLocalAddon/', params={
+ 'file': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/autoupdate/action/installLocalAddon/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+file
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+autoupdateActionSetOptionCheckAddonUpdates
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/autoupdate/action/setOptionCheckAddonUpdates/?Boolean=true \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/autoupdate/action/setOptionCheckAddonUpdates/?Boolean=true");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/autoupdate/action/setOptionCheckAddonUpdates/', params={
+ 'Boolean': 'true'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/autoupdate/action/setOptionCheckAddonUpdates/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Boolean
+query
+boolean
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+autoupdateActionSetOptionCheckOnStart
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/autoupdate/action/setOptionCheckOnStart/?Boolean=true \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/autoupdate/action/setOptionCheckOnStart/?Boolean=true");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/autoupdate/action/setOptionCheckOnStart/', params={
+ 'Boolean': 'true'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/autoupdate/action/setOptionCheckOnStart/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Boolean
+query
+boolean
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+autoupdateActionSetOptionDownloadNewRelease
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/autoupdate/action/setOptionDownloadNewRelease/?Boolean=true \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/autoupdate/action/setOptionDownloadNewRelease/?Boolean=true");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/autoupdate/action/setOptionDownloadNewRelease/', params={
+ 'Boolean': 'true'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/autoupdate/action/setOptionDownloadNewRelease/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Boolean
+query
+boolean
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+autoupdateActionSetOptionInstallAddonUpdates
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/autoupdate/action/setOptionInstallAddonUpdates/?Boolean=true \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/autoupdate/action/setOptionInstallAddonUpdates/?Boolean=true");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/autoupdate/action/setOptionInstallAddonUpdates/', params={
+ 'Boolean': 'true'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/autoupdate/action/setOptionInstallAddonUpdates/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Boolean
+query
+boolean
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+autoupdateActionSetOptionInstallScannerRules
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/autoupdate/action/setOptionInstallScannerRules/?Boolean=true \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/autoupdate/action/setOptionInstallScannerRules/?Boolean=true");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/autoupdate/action/setOptionInstallScannerRules/', params={
+ 'Boolean': 'true'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/autoupdate/action/setOptionInstallScannerRules/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Boolean
+query
+boolean
+true
+none
+
+
+
+
+Example responses
-The following are some of the features provided by ZAP:
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
-
-- Intercepting Proxy
-- Active and Passive Scanners
-- Traditional and Ajax Spiders
-- Brute Force Scanner
-- Port Scanner
-- Web Sockets
-
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
-Have a look at the examples below to learn how to use each of these features via ZAP API.
-Documentation Structure
-The API documentation is divided into nine main sections.
+
+autoupdateActionSetOptionReportAlphaAddons
+
-
-- Introduction section contains introductory information of ZAP and installation guide to set up ZAP for testing.
-- Exploring the App section contains examples on how to explore the web application.
-- Attacking the App section contains examples on how to scan or attack a web application.
-- Getting the Results section contains examples on how to retrieve alerts and generate Reports from ZAP.
-- Getting Authenticated section contains examples on how to authenticate the web application with ZAP.
-- Advanced Settings section contains advanced configurations on how to fine tune ZAP results.
-- Contributions section contains guidelines and instructions on how to contribute to ZAP's documentation.
-- API Catalogue section contains OpenAPI definitions and auto generated code for ZAP APIs.
-- Troubleshooting section contains solutions for trouble shooting ZAP API related issues.
-
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/autoupdate/action/setOptionReportAlphaAddons/?Boolean=true \
+ -H 'Accept: application/json'
-
-Basics on the API Request
-ZAP APIs provide access to most of the core features of ZAP such as the active scanner and spider. ZAP API is enabled by default
-in the daemon mode and the desktop mode. If you are using ZAP desktop, then the API can be configured by visiting the following screen:
+
URL obj = new URL("http://zap/JSON/autoupdate/action/setOptionReportAlphaAddons/?Boolean=true");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
-Tools -> Options -> API.
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
-
+r = requests.get('http://zap/JSON/autoupdate/action/setOptionReportAlphaAddons/', params={
+ 'Boolean': 'true'
+}, headers = headers)
-
+GET /JSON/autoupdate/action/setOptionReportAlphaAddons/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Boolean
+query
+boolean
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+autoupdateActionSetOptionReportBetaAddons
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/autoupdate/action/setOptionReportBetaAddons/?Boolean=true \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/autoupdate/action/setOptionReportBetaAddons/?Boolean=true");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/autoupdate/action/setOptionReportBetaAddons/', params={
+ 'Boolean': 'true'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/autoupdate/action/setOptionReportBetaAddons/
+
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+Boolean
+query
+boolean
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+autoupdateActionSetOptionReportReleaseAddons
+
-Please note that not all the operations which are available in the desktop interface are available via the APIs.
-Future versions of ZAP will increase the functionality/scope available via the APIs.
-API URL Format
-The API is available via GET and POST endpoints and the response is available in JSON, XML, HTML, and OTHER (custom formats, e.g. HAR) formats.
-All the response formats return the same information, just in a different format. Based on the use case, choose the appropriate format.
-For example, to generate easily readable reports use the HTML format and use XML/JSON based response to parse the results quickly.
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/autoupdate/action/setOptionReportReleaseAddons/?Boolean=true \
+ -H 'Accept: application/json'
-The following example shows the API URL format of ZAP:
+
URL obj = new URL("http://zap/JSON/autoupdate/action/setOptionReportReleaseAddons/?Boolean=true");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
-http://zap/<format>/<component>/<operation>/<operation name>[/?<parameters>]
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
-The format can be either JSON, XML or HTML. The operation can be either view or action or other. The view operation is used to return
-information and the action is used to control ZAP. For example, views can be used to generated reports or retrieve results and
-action can be used to start or stop the Spider. The components, operation names and parameters can all be discovered by
-browsing the API Catalogue.
-Access the API
-The REST API can be accessed directly or via one of the client implementations detailed below.
-A simple web UI is also available to explore and use the APIs via the browser. This web UI can be accessed via http://zap/
-when you are proxying through ZAP, or via the host and port ZAP is listening on, e.g. http://localhost:8080/.
+r = requests.get('http://zap/JSON/autoupdate/action/setOptionReportReleaseAddons/', params={
+ 'Boolean': 'true'
+}, headers = headers)
-
+print(r.json())
-By default only the machine ZAP is running on is able to access the APIs. You can allow other machines,
-that are able to use ZAP as a proxy, access to the API.
-Client SDKs
-API clients are available for the following languages:
+
+GET /JSON/autoupdate/action/setOptionReportReleaseAddons/
+
+Parameters
-Language
-Download links
-Notes
+Name
+In
+Type
+Required
+Description
-.NET
-NuGet
-Official API
+Boolean
+query
+boolean
+true
+none
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
-Java
-GitHub Maven Central
-Official API
+Status
+Meaning
+Description
+Schema
+
-Node.js
-NPM
-Official API
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+autoupdateActionUninstallAddon
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/autoupdate/action/uninstallAddon/?id=string \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/autoupdate/action/uninstallAddon/?id=string");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/autoupdate/action/uninstallAddon/', params={
+ 'id': 'string'
+}, headers = headers)
+
+print(r.json())
+
+
+GET /JSON/autoupdate/action/uninstallAddon/
+
+Uninstalls the specified add-on
+
+Parameters
+
+
-PHP
-GitHub Packagist
-In process of becoming an official API
+Name
+In
+Type
+Required
+Description
+
-Python
-PyPI
-Official API
+id
+query
+string
+true
+none
+
+
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
-Ruby
-GitHub
-default
+Default
+Error of JSON endpoints.
+ErrorJson
-Quick Setup Guide
-The quick setup guide focuses on setting up ZAP and a testing application. If you have already setup ZAP then Jump to
-specific example to experiment with specific features.
-Start ZAP
# For Linux, Option: 1, using "headless/daemon" mode
-<ZAP_HOME>./zap.sh -daemon -config api.key=change-me-9203935709
-# For Linux, Option: 2, using ZAP desktop App
-<ZAP_HOME>./zap.sh
-# For Windows, Run the exe file or zap.bat script to start ZAP
-
// For Linux, Option: 1, using "headless/daemon" mode
-<ZAP_HOME>./zap.sh -daemon -config api.key=change-me-9203935709
-// For Linux, Option: 2, using ZAP desktop App
-<ZAP_HOME>./zap.sh
+
+autoupdateViewInstalledAddons
+
-// For Windows, Run the exe file or zap.bat script to start ZAP
-
# For Linux, Option: 1, using "headless/daemon" mode
-$ <ZAP_HOME>./zap.sh -daemon -config api.key=change-me-9203935709
-# For Linux, Option: 2, using ZAP desktop App
-$ <ZAP_HOME>./zap.sh
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/autoupdate/view/installedAddons/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/autoupdate/view/installedAddons/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
+
+r = requests.get('http://zap/JSON/autoupdate/view/installedAddons/', headers = headers)
+
+print(r.json())
-# For Windows, Run the exe file or zap.bat script to start ZAP
-To install ZAP, go to ZAP's home page and download the installer specific to the
-operating system. After extracting the bundle you can start ZAP by issuing the following command shown in the right column.
+GET /JSON/autoupdate/view/installedAddons/
-The API key must be specified on all API actions and some other operations. The API key is used to prevent malicious
-sites from accessing ZAP API.
-Setup a Testing Application
-If you already have a website to scan or to perform security testing, then obtain the URL/IP of the application to begin the scanning.
-The example guide uses Google's Firing Range and
-OWASP Juice Shop to perform the security testing.
-The Spidering and Attacking examples use the public instance of the
-Firing Range, and OWASP Juice Shop are used to showcase the Authentication examples of ZAP.
+Return a list of all of the installed add-ons
+
+
+Example responses
+
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
+
+
+autoupdateViewIsLatestVersion
+
+
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/autoupdate/view/isLatestVersion/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/autoupdate/view/isLatestVersion/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
-The following is a list
-of publicly available vulnerable applications that you can also used in conjunction with ZAP.
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
-
-Getting Help
-All available APIs are documented in the API Catalogue. If you are new to ZAP, then it's highly
-recommended that you experiment with the desktop UI before trying out the APIs. Because ZAP's APIs strongly resemble
-the desktop UI. Therefore by working with the UI, you will get a good understanding on how to orchestrate ZAP's APIs.
-Also, use the export config functionality from the desktop UI to export complex configurations such as contexts, scan policies, etc.
-Then use the exported configurations when creating the automation scripts.
+r = requests.get('http://zap/JSON/autoupdate/view/isLatestVersion/', headers = headers)
-ZAP has a very friendly and active developer community. Always feel free to raise a question in the
-ZAP users forum or Stack Overflow
-for issues related to ZAP. Also, use the ZAP's GitHub repository
-to raise a bug report or to make any feature requests.
+print(r.json())
-Stay tuned on twitter @zaproxy.
-Exploring the App
-In order to expose content and functionality for ZAP to test the target the application should be explored before performing
-any scan or attack. The more you explore your App the more accurate the results will be. If the application is not explored
-very well then it will impact or reduce the vulnerabilities ZAP can find.
+
+GET /JSON/autoupdate/view/isLatestVersion/
-The following are some of the options to explore the site by using ZAP. You can use multiple approaches in a combination to
-get more complete coverage of the application.
+Returns 'true' if ZAP is on the latest version
-
-Traditional Spider (Crawler): Use this approach to crawl the HTML resources (hyperlinks etc) in the web application.
Ajax Spider: Use this feature if the application heavily relies with Ajax calls.
Proxy Regression / Unit Tests This is the recommended approach for security regression testing. Use this approach
-to explore the application, if you already have a test suite or unit tests in place.
OpenAPI/SOAP Definition: Use this approach if you have a well defined OpenAPI definition. The OpenAPI plugin can be downloaded
-via the marketplace.
-Using Spider
#!/usr/bin/env python
-import time
-from zapv2 import ZAPv2
+
+Example responses
-# The URL of the application to be tested
-target = 'https://public-firing-range.appspot.com'
-# Change to match the API key set in ZAP, or use None if the API key is disabled
-apiKey = 'changeMe'
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
-# By default ZAP API client will connect to port 8080
-zap = ZAPv2(apikey=apiKey)
-# Use the line below if ZAP is not listening on port 8080, for example, if listening on port 8090
-# zap = ZAPv2(apikey=apiKey, proxies={'http': 'http://127.0.0.1:8090', 'https': 'http://127.0.0.1:8090'})
-
-print('Spidering target {}'.format(target))
-# The scan returns a scan id to support concurrent scanning
-scanID = zap.spider.scan(target)
-while int(zap.spider.status(scanID)) < 100:
- # Poll the status until it completes
- print('Spider progress %: {}'.format(zap.spider.status(scanID)))
- time.sleep(1)
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
-print('Spider has completed!')
-# Prints the URLs the spider has crawled
-print('\n'.join(map(str, zap.spider.results(scanID))))
-# If required post process the spider results
-
-# TODO: Explore the Application more with Ajax Spider or Start scanning the application for vulnerabilities
-
public class Spider {
+
+autoupdateViewLatestVersionNumber
+
- private static final String ZAP_ADDRESS = "localhost";
- private static final int ZAP_PORT = 8080;
- // Change to match the API key set in ZAP, or use NULL if the API key is disabled
- private static final String ZAP_API_KEY = "change me";
- // The URL of the application to be tested
- private static final String TARGET = "https://public-firing-range.appspot.com";
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/autoupdate/view/latestVersionNumber/ \
+ -H 'Accept: application/json'
- public static void main(String[] args) {
- ClientApi api = new ClientApi(ZAP_ADDRESS, ZAP_PORT, ZAP_API_KEY);
+
URL obj = new URL("http://zap/JSON/autoupdate/view/latestVersionNumber/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
- try {
- // Start spidering the target
- System.out.println("Spidering target : " + TARGET);
- ApiResponse resp = api.spider.scan(TARGET, null, null, null, null);
- String scanID;
- int progress;
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
- // The scan returns a scan id to support concurrent scanning
- scanID = ((ApiResponseElement) resp).getValue();
- // Poll the status until it completes
- while (true) {
- Thread.sleep(1000);
- progress = Integer.parseInt(((ApiResponseElement) api.spider.status(scanID)).getValue());
- System.out.println("Spider progress : " + progress + "%");
- if (progress >= 100) {
- break;
- }
- }
- System.out.println("Spider completed");
- // If required post process the spider results
- List<ApiResponse> spiderResults = ((ApiResponseList) api.spider.results(scanID)).getItems();
+r = requests.get('http://zap/JSON/autoupdate/view/latestVersionNumber/', headers = headers)
- // TODO: Explore the Application more with Ajax Spider or Start scanning the application for vulnerabilities
+print(r.json())
- } catch (Exception e) {
- System.out.println("Exception : " + e.getMessage());
- e.printStackTrace();
- }
- }
-}
-
# To start the Spider scan (Response: Scan ID). Modify the API Key and URL to suite the target
-$ curl "http://localhost:8080/JSON/spider/action/scan/?apikey=<ZAP_API_KEY>&url=https://public-firing-range.appspot.com&contextName=&recurse="
+
+GET /JSON/autoupdate/view/latestVersionNumber/
-# To view the scan status/ percentage of work done
-$ curl "http://localhost:8080/JSON/spider/view/status/?apikey=<ZAP_API_KEY>&scanId=<SCAN_ID>"
+Returns the latest version number
-# To view the scan results
-$ curl "http://localhost:8080/JSON/spider/view/results/?apikey=<ZAP_API_KEY>&scanId=<SCAN_ID>"
+
+Example responses
-# To stop the scanning
-$ curl "http://localhost:8080/JSON/spider/action/stop/?apikey=<ZAP_API_KEY>&scanId=<SCAN_ID>"
-# To pause the scanning
-$ curl "http://localhost:8080/JSON/spider/action/pause/?apikey=<ZAP_API_KEY>&scanId=<SCAN_ID>"
-# To resume the scanning
-$ curl "http://localhost:8080/JSON/spider/action/resume/?apikey=<ZAP_API_KEY>&scanId=<SCAN_ID>"
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
-
-The Spider is a tool that is used to automatically discover new resources (URLs) on a particular site. It begins with a
-list of URLs to visit, called the seeds, which depends on how the Spider is started. The Spider then visits these URLs,
-it identifies all the hyperlinks in the page and adds them to the list of URLs to visit, and the process continues
-recursively as long as new resources are found. Each response type is processed differently in ZAP. All the available
-endpoints for the spider can be found in spider section.
-Start the Spider
-The Spiders explore the site and they don't actually do any scanning. The resources crawled by the Spider(s) are passively scanned
-in the background via the Passive Scanner. The scan API runs the spider against the given URL.
-Optionally, the 'maxChildren' parameter can be set to limit the number of children scanned and the 'recurse' parameter can
-be used to prevent the spider from seeding recursively. The parameter 'subtreeOnly' allows to restrict the spider under a
-site's subtree (using the specified 'URL'). The parameter 'contextName' can be used to constrain the scan to
-a Context. View the context example to understand how to create a context with ZAP API.
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
-The code sample on the right recursively scans the application with the provided URL. The scan ID is returned as a
-response when starting the Spider. Use this scan ID to perform any additional actions or to retrieve any views from the Spider API.
-View Status
-The spider scan is a async request and the time to complete the task will vary depending on the complexity of the web application.
-The scan ID returned via starting the spider should be used to obtain the results of the crawling. Execute the status
-API to get the status/percentage of work done by the Spider.
-View Spider Results
-The results of the crawling can be obtained via the results API. The following image shows the JSON sample
-response provided by the results API, listing all the resources crawled by Spider.
+
+autoupdateViewLocalAddons
+
-
-Stop or Pause the Spider
-If the scanning takes more time than expected you can stop or pause the scanning via using the stop
-or pause APIs. Additional APIs are available in the API Catalogue to pause or resume or to
-stop All the scanning processes.
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/autoupdate/view/localAddons/ \
+ -H 'Accept: application/json'
-The advanced section on Spider contains more examples on how to tweak/improve the Spider results.
-Using Ajax Spider
#!/usr/bin/env python
-import time
-from zapv2 import ZAPv2
+
URL obj = new URL("http://zap/JSON/autoupdate/view/localAddons/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
-# The URL of the application to be tested
-target = 'https://public-firing-range.appspot.com'
-# Change to match the API key set in ZAP, or use None if the API key is disabled
-apiKey = 'changeme'
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
-# By default ZAP API client will connect to port 8080
-zap = ZAPv2(apikey=apiKey)
-# Use the line below if ZAP is not listening on port 8080, for example, if listening on port 8090
-# zap = ZAPv2(apikey=apiKey, proxies={'http': 'http://127.0.0.1:8090', 'https': 'http://127.0.0.1:8090'})
-
-print('Ajax Spider target {}'.format(target))
-scanID = zap.ajaxSpider.scan(target)
+r = requests.get('http://zap/JSON/autoupdate/view/localAddons/', headers = headers)
-timeout = time.time() + 60*2 # 2 minutes from now
-# Loop until the ajax spider has finished or the timeout has exceeded
-while zap.ajaxSpider.status == 'running':
- if time.time() > timeout:
- break
- print('Ajax Spider status' + zap.ajaxSpider.status)
- time.sleep(2)
+print(r.json())
-print('Ajax Spider completed')
-ajaxResults = zap.ajaxSpider.results(start=0, count=10)
-# If required perform additional operations with the Ajax Spider results
-
-# TODO: Start scanning the application to find vulnerabilities
-
public class AjaxSpider {
+
+GET /JSON/autoupdate/view/localAddons/
- private static final int ZAP_PORT = 8080;
- private static final String ZAP_API_KEY = null;
- private static final String ZAP_ADDRESS = "localhost";
- private static final String TARGET = "https://public-firing-range.appspot.com";
+Returns a list with all local add-ons, installed or not.
- public static void main(String[] args) {
- // Create the ZAP Client
- ClientApi api = new ClientApi(ZAP_ADDRESS, ZAP_PORT, ZAP_API_KEY);
+
+Example responses
- try {
- // Start spidering the target
- System.out.println("Ajax Spider target : " + TARGET);
- ApiResponse resp = api.ajaxSpider.scan(TARGET, null, null, null);
- String status;
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
- long startTime = System.currentTimeMillis();
- long timeout = TimeUnit.MINUTES.toMillis(2); // Two minutes in milli seconds
- // Loop until the ajax spider has finished or the timeout has exceeded
- while (true) {
- Thread.sleep(2000);
- status = (((ApiResponseElement) api.ajaxSpider.status()).getValue());
- System.out.println("Spider status : " + status);
- if (!("stopped".equals(status)) || (System.currentTimeMillis() - startTime) < timeout) {
- break;
- }
- }
- System.out.println("Ajax Spider completed");
- // Perform additional operations with the Ajax Spider results
- List<ApiResponse> ajaxSpiderResponse = ((ApiResponseList) api.ajaxSpider.results("0", "10")).getItems();
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
- // TODO: Start scanning(passive/active scan) the application to find vulnerabilities
+
+autoupdateViewMarketplaceAddons
+
- } catch (Exception e) {
- System.out.println("Exception : " + e.getMessage());
- e.printStackTrace();
- }
- }
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/autoupdate/view/marketplaceAddons/ \
+ -H 'Accept: application/json'
+
+
URL obj = new URL("http://zap/JSON/autoupdate/view/marketplaceAddons/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
}
-
# To start the Ajax Spider
-$ curl "http://localhost:8080/JSON/ajaxSpider/action/scan/?apikey=<ZAP_API_KEY>&url=<URL>&inScope=&contextName=&subtreeOnly="
+in.close();
+System.out.println(response.toString());
-# To view the status
-$ curl "http://localhost:8080/JSON/ajaxSpider/view/status/?apikey=<ZAP_API_KEY>"
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
-# To view the number of results
-$ curl "http://localhost:8080/JSON/ajaxSpider/view/numberOfResults/?apikey=<ZAP_API_KEY>"
+r = requests.get('http://zap/JSON/autoupdate/view/marketplaceAddons/', headers = headers)
-# To view the results
-$ curl "http://localhost:8080/JSON/ajaxSpider/view/fullResults/?apikey=<ZAP_API_KEY>"
+print(r.json())
-# To stop the Ajax Spider
-$ curl "http://localhost:8080/JSON/ajaxSpider/action/stop/?apikey=<ZAP_API_KEY>"
-Use the Ajax Spider if you have applications which heavily depend on Ajax or JavaScript. The Ajax Spider allows you to crawl web applications
-written in Ajax in far more depth than the traditional Spider.You should also use the traditional Spider as well for complete coverage
-of a application (e.g. to cover HTML comments).
-Start Ajax Spider
-The scan API starts the Ajax Spider based on a given URL. Similar to the Traditional Spider, Ajax Spider can be also limited to a
-context or scope. The parameter 'contextName' can be used to constrain the scan to a Context, the option 'inScope' is
-ignored if a context was also specified. The parameter 'subtreeOnly' allows to restrict the spider under a site's subtree (using the specified 'URL').
-View Status
-Unlike the traditional Spider, Ajax Spider does not provide a percentage for the work to be done. Use the status
-endpoint to identify whether the Ajax Spider is still active or finished.
-View Results
-Similar to the Traditional Spider, the Ajax Spider's results API can be used to view the resources
-which are crawled by the Ajax Spider. The following image shows a sample response given by the API.
+GET /JSON/autoupdate/view/marketplaceAddons/
-
-Stop the Ajax Spider
-Ajax spider does not have an indication on how much resources are left to be crawled. Therefore if the Ajax spider takes too much time
-than expected, then it can be stopped by using the stop API.
+Return a list of all of the add-ons on the ZAP Marketplace (this information is read once and then cached)
-View the advanced section on Ajax Spider to learn more about how to further fine-tune the results of the
-Ajax Spider.
+
+Example responses
-
-Attacking the App
-The application should be explored before starting to scan for security vulnerabilities.
-If you haven't done that look at the explore section on how to explore the web application.
-The following section provides examples on how to use the Passive and Active Scanner to find security vulnerabilities in
-the application.
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
-Using Passive Scan
public class PassiveScan {
-
- private static final int ZAP_PORT = 8080;
- private static final String ZAP_API_KEY = null;
- private static final String ZAP_ADDRESS = "localhost";
-
- public static void main(String[] args) {
- ClientApi api = new ClientApi(ZAP_ADDRESS, ZAP_PORT, ZAP_API_KEY);
- int numberOfRecords;
-
- try {
- // TODO : explore the app (Spider, etc) before using the Passive Scan API, Refer the explore section for details
- // Loop until the passive scan has finished
- while (true) {
- Thread.sleep(2000);
- api.pscan.recordsToScan();
- numberOfRecords = Integer.parseInt(((ApiResponseElement) api.pscan.recordsToScan()).getValue());
- System.out.println("Number of records left for scanning : " + numberOfRecords);
- if (numberOfRecords == 0) {
- break;
- }
- }
- System.out.println("Passive Scan completed");
+autoupdateViewNewAddons
+
- // Print Passive scan results/alerts
- System.out.println("Alerts:");
- System.out.println(new String(api.core.xmlreport(), StandardCharsets.UTF_8));
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/autoupdate/view/newAddons/ \
+ -H 'Accept: application/json'
- } catch (Exception e) {
- System.out.println("Exception : " + e.getMessage());
- e.printStackTrace();
- }
- }
+
URL obj = new URL("http://zap/JSON/autoupdate/view/newAddons/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
}
-
#!/usr/bin/env python
-import time
-from pprint import pprint
-from zapv2 import ZAPv2
-
-apiKey = 'changeme'
-target = 'https://public-firing-range.appspot.com'
-zap = ZAPv2(apikey=apiKey, proxies={'http': 'http://127.0.0.1:8080', 'https': 'http://127.0.0.1:8080'})
+in.close();
+System.out.println(response.toString());
-# TODO : explore the app (Spider, etc) before using the Passive Scan API, Refer the explore section for details
-while int(zap.pscan.records_to_scan) > 0:
- # Loop until the passive scan has finished
- print('Records to passive scan : ' + zap.pscan.records_to_scan)
- time.sleep(2)
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
-print('Passive Scan completed')
+r = requests.get('http://zap/JSON/autoupdate/view/newAddons/', headers = headers)
-# Print Passive scan results/alerts
-print('Hosts: {}'.format(', '.join(zap.core.hosts)))
-print('Alerts: ')
-pprint(zap.core.alerts())
-
# To view the number of records left to be scanned
-$ curl "http://localhost:8080/JSON/pscan/view/recordsToScan/?apikey=<ZAP_API_KEY>"
+print(r.json())
-# To view the alerts of passive scan
-$ curl "http://localhost:8080/JSON/core/view/alerts/?apikey=<ZAP_API_KEY>&baseurl=<TARGET_URL>&start=0&count=10"
-All requests that are proxied through ZAP or initialised by tools like the Spider are passively scanned. You do not have
-to manually start the passive scan process, ZAP by default passively scans all HTTP and WebSocket messages (requests and responses)
-which are sent to the application.
-
-Passive scanning does not change the requests nor the responses in any way and is therefore safe to use.
-This is good for finding problems like missing security headers or missing anti CSRF tokens but is no good for finding
-vulnerabilities like XSS which require malicious requests to be sent - that's the job of the active scanner.
-View the Status
-As the records are passively scanned it will take additional time to complete the full scan. After the crawling is completed
-use the recordsToScan API to obtain the number of records left to be scanned. After the scanning
-has completed the alerts can be obtained via the alerts endpoint(s).
-
-View the advanced section to know how to configure additional parameters of Passive Scan.
-Using Active Scan
-Active scanning attempts to find potential vulnerabilities by using known attacks against the selected targets. Active scanning
-is an attack on those targets. You should NOT use it on applications that you do not have permission to.
-Start Active Scanner
public class ActiveScan {
+GET /JSON/autoupdate/view/newAddons/
- private static final int ZAP_PORT = 8080;
- private static final String ZAP_API_KEY = null;
- private static final String ZAP_ADDRESS = "localhost";
- private static final String TARGET = "https://public-firing-range.appspot.com";
+Return a list of any add-ons that have been added to the Marketplace since the last check for updates
- public static void main(String[] args) {
+
+Example responses
- ClientApi api = new ClientApi(ZAP_ADDRESS, ZAP_PORT, ZAP_API_KEY);
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
- try {
- // TODO : explore the app (Spider, etc) before using the Active Scan API, Refer the explore section
- System.out.println("Active Scanning target : " + TARGET);
- ApiResponse resp = api.ascan.scan(TARGET, "True", "False", null, null, null);
- String scanid;
- int progress;
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
- // The scan now returns a scan id to support concurrent scanning
- scanid = ((ApiResponseElement) resp).getValue();
- // Poll the status until it completes
- while (true) {
- Thread.sleep(5000);
- progress =
- Integer.parseInt(
- ((ApiResponseElement) api.ascan.status(scanid)).getValue());
- System.out.println("Active Scan progress : " + progress + "%");
- if (progress >= 100) {
- break;
- }
- }
+
+autoupdateViewOptionAddonDirectories
+
- System.out.println("Active Scan complete");
- // Print vulnerabilities found by the scanning
- System.out.println("Alerts:");
- System.out.println(new String(api.core.xmlreport(), StandardCharsets.UTF_8));
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/autoupdate/view/optionAddonDirectories/ \
+ -H 'Accept: application/json'
- } catch (Exception e) {
- System.out.println("Exception : " + e.getMessage());
- e.printStackTrace();
- }
- }
+
URL obj = new URL("http://zap/JSON/autoupdate/view/optionAddonDirectories/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
}
-
#!/usr/bin/env python
-import time
-from pprint import pprint
-from zapv2 import ZAPv2
+in.close();
+System.out.println(response.toString());
-apiKey = 'changeme'
-target = 'https://public-firing-range.appspot.com'
-zap = ZAPv2(apikey=apiKey, proxies={'http': 'http://127.0.0.1:8080', 'https': 'http://127.0.0.1:8080'})
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
-# TODO : explore the app (Spider, etc) before using the Active Scan API, Refer the explore section
-print('Active Scanning target {}'.format(target))
-scanID = zap.ascan.scan(target)
-while int(zap.ascan.status(scanID)) < 100:
- # Loop until the scanner has finished
- print('Scan progress %: {}'.format(zap.ascan.status(scanID)))
- time.sleep(5)
+r = requests.get('http://zap/JSON/autoupdate/view/optionAddonDirectories/', headers = headers)
-print('Active Scan completed')
-# Print vulnerabilities found by the scanning
-print('Hosts: {}'.format(', '.join(zap.core.hosts)))
-print('Alerts: ')
-pprint(zap.core.alerts(baseurl=target))
-
# To start the the active scan
-$ curl "http://localhost:8080/JSON/ascan/action/scan/?apikey=<ZAP_API_KEY>&url=<TARGET_URL>&recurse=true&inScopeOnly=&scanPolicyName=&method=&postData=&contextId="
+print(r.json())
-# To view the the status of active scan
-$ curl "http://localhost:8080/JSON/ascan/view/status/?apikey=<ZAP_API_KEY>&scanId=<SCAN_ID>"
+
+GET /JSON/autoupdate/view/optionAddonDirectories/
-# To view the alerts of active scan
-$ curl "http://localhost:8080/JSON/core/view/alerts/?apikey=<ZAP_API_KEY>&baseurl=<TARGET_URL>&start=0&count=10"
+
+Example responses
-# To stop the active scan
-$ curl "http://localhost:8080/JSON/ascan/action/stop/?apikey=<ZAP_API_KEY>&scanId=<SCAN_ID>"
-
-The scan endpoint runs the active scanner against the given URL or Context. Optionally, the 'recurse' parameter can be used to scan URLs
-under the given URL, the parameter 'inScopeOnly' can be used to constrain the scan to URLs that are in scope (ignored if a Context is specified).
-The parameter 'scanPolicyName' allows to specify the scan policy (if none is given it uses the default scan policy).
-The parameters 'method' and 'postData' allow to select a given request in conjunction with the given URL.
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
-View advanced settings to learn, how to configure the context, scope, and
-scan policy with ZAP APIs.
-View Status
-The status API provides the percentage of scanning done by the active scanner. The scan ID returned
-via starting the Active Scan should be used to query the status of the scanner.
-View Results
-Similar to the passive scan results, the active scan results can be viewed using the same alerts endpoint(s).
-The alerts endpoint(s) will show the consolidated results of Passive and Active Scan.
-Stop Active Scanning
-Use the stop API to stop a long running active scan. Optionally you can use the stopAllScans
-endpoints or pause endpoint to stop and pause the active scanning.
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
-It should be noted that active scanning can only find certain types of vulnerabilities. Logical vulnerabilities, such as
-broken access control, will not be found by any active or automated vulnerability scanning. Manual penetration testing should
-always be performed in addition to active scanning to find all types of vulnerabilities.
-Getting the Results
#!/usr/bin/env python
-from zapv2 import ZAPv2
+
+autoupdateViewOptionCheckAddonUpdates
+
-# The URL of the application to be tested
-target = 'https://public-firing-range.appspot.com'
-# Change to match the API key set in ZAP, or use None if the API key is disabled
-apiKey = 'changeMe'
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/autoupdate/view/optionCheckAddonUpdates/ \
+ -H 'Accept: application/json'
-# By default ZAP API client will connect to port 8080
-zap = ZAPv2(apikey=apiKey)
-# Use the line below if ZAP is not listening on port 8080, for example, if listening on port 8090
-# zap = ZAPv2(apikey=apiKey, proxies={'http': 'http://127.0.0.1:8090', 'https': 'http://127.0.0.1:8090'})
-
-# TODO: Check if the scanning has completed
-
-# Retrieve the alerts using paging in case there are lots of them
-st = 0
-pg = 5000
-alert_dict = {}
-alert_count = 0
-alerts = zap.alert.alerts(baseurl=target, start=st, count=pg)
-blacklist = [1,2]
-while len(alerts) > 0:
- print('Reading ' + str(pg) + ' alerts from ' + str(st))
- alert_count += len(alerts)
- for alert in alerts:
- plugin_id = alert.get('pluginId')
- if plugin_id in blacklist:
- continue
- if alert.get('risk') == 'High':
- # Trigger any relevant postprocessing
- continue
- if alert.get('risk') == 'Informational':
- # Ignore all info alerts - some of them may have been downgraded by security annotations
- continue
- st += pg
- alerts = zap.alert.alerts(start=st, count=pg)
-print('Total number of alerts: ' + str(alert_count))
-
public class Alerts {
+
URL obj = new URL("http://zap/JSON/autoupdate/view/optionCheckAddonUpdates/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
- private static final String ZAP_ADDRESS = "localhost";
- private static final int ZAP_PORT = 8080;
- // Change to match the API key set in ZAP, or use NULL if the API key is disabled
- private static final String ZAP_API_KEY = "change me";
- // The URL of the application to be tested
- private static final String TARGET = "https://public-firing-range.appspot.com";
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
- private static List<String> blackListPlugins = Arrays.asList("1000", "1025");
+r = requests.get('http://zap/JSON/autoupdate/view/optionCheckAddonUpdates/', headers = headers)
+print(r.json())
- public static void main(String[] args) {
- ClientApi api = new ClientApi(ZAP_ADDRESS, ZAP_PORT, ZAP_API_KEY);
+
+GET /JSON/autoupdate/view/optionCheckAddonUpdates/
- try {
- // TODO: Check if the scanning has completed
+
+Example responses
- // Retrieve the alerts using paging in case there are lots of them
- int start = 0;
- int count = 5000;
- int alertCount = 0;
- ApiResponse resp = api.alert.alerts(TARGET, String.valueOf(start), String.valueOf(count), null);
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
- while (((ApiResponseList) resp).getItems().size() != 0) {
- System.out.println("Reading " + count + " alerts from " + start);
- alertCount += ((ApiResponseList) resp).getItems().size();
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
- for (ApiResponse l : (((ApiResponseList) resp).getItems())) {
+
+autoupdateViewOptionCheckOnStart
+
- Map<String, ApiResponse> element = ((ApiResponseSet) l).getValuesMap();
- if (blackListPlugins.contains(element.get("pluginId").toString())) {
- // TODO: Trigger any relevant postprocessing
- } else if ("High".equals(element.get("risk").toString())) {
- // TODO: Trigger any relevant postprocessing
- } else if ("Informational".equals(element.get("risk").toString())) {
- // TODO: Ignore all info alerts - some of them may have been downgraded by security annotations
- }
- }
- start += count;
- resp = api.alert.alerts(TARGET, String.valueOf(start), String.valueOf(count), null);
- }
- System.out.println("Total number of Alerts: " + alertCount);
+
+Code samples
+
+# You can also use wget
+curl -X GET http://zap/JSON/autoupdate/view/optionCheckOnStart/ \
+ -H 'Accept: application/json'
- } catch (Exception e) {
- System.out.println("Exception : " + e.getMessage());
- e.printStackTrace();
- }
- }
+
URL obj = new URL("http://zap/JSON/autoupdate/view/optionCheckOnStart/");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+ new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+ response.append(inputLine);
}
-
# To view the alerts
-$ curl "http://localhost:8080/JSON/alert/view/alerts/?apikey=<ZAP_API_KEY>&baseurl=<BASE_URL>&start=0&count=5000&riskId="
-
-# To view the summary of the alerts
-$ curl "http://localhost:8080/JSON/alert/view/alertsSummary/?apikey=<ZAP_API_KEY>baseurl=<BASE_URL>"
+in.close();
+System.out.println(response.toString());
-# To view alerts by risk category
-$ curl "http://localhost:8080/JSON/alert/view/alertsByRisk/?apikey=<ZAP_API_KEY>&url=<BASE_URL>&recurse="
-
-After the scanning (Active/Passive) completes, ZAP provides the security vulnerabilities in the form of alerts. The alerts
-are categorized into high-priority, medium-priority, low-priority and informational priority risks. The priority indicates the degree of risk associated with each alert.
-For example, a high priority risk means that the issues listed in that category has more threat or risk potential than a medium-priority alert.
+
import requests
+headers = {
+ 'Accept': 'application/json'
+}
-The alerts endpoint provides all the alerts which are identified by ZAP. View the sample code on the right to retrieve the
-alerts from the alerts endpoint. The results can be used to raise security alerts in the CI/CD pipeline or to trigger any custom workflows.
+r = requests.get('http://zap/JSON/autoupdate/view/optionCheckOnStart/', headers = headers)
-
+print(r.json())
-The alerts summary gets the number of alerts grouped by each risk level and optionally filtering by URL.
-A Summary report can be also generated using the core module. Use the htmlreport
-or jsonreport or xmlreport endpoint to generate this summary report.
-The following image shows the report generated via the HTML report API. The report categories the alerts to risk level
-and provides a brief description about each alert.
+
+GET /JSON/autoupdate/view/optionCheckOnStart/
-
-Getting Authenticated
-The target application for testing might have a portion of the functionality that is only available for a logged-in user.
-In order to get full test coverage of the application you need to test the application with a logged-in user as well. Therefore
-it's very important to understand how to perform authenticated scans with ZAP. ZAP has several means to authenticate your
-application and keep track of the authentication state. The following are some of the options available for authentication with ZAP.
+
+Example responses
-
-- Form-based authentication
-- Script-based authentication
-- JSON-based authentication
-- HTTP/NTLM based authentication
-
+default Response
+
+{
+ "code": "string",
+ "message": "string",
+ "detail": "string"
+}
+
+Responses
-The examples below show three authentication workflows. A simple form-based authentication is showcased with the use of the
-Bodgeit application. The second example shows the script-based authentication using the Damn Vulnerable Web Application(DVWA).
-The third example shows a more complicated authentication workflow using the JSON and script-based authentication using the OWASP Juice Shop.
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+default
+Default
+Error of JSON endpoints.
+ErrorJson
+
+
-