Package org.zaproxy.clientapi.gen

Class Alert

java.lang.Object

org.zaproxy.clientapi.gen.Alert

public class Alert
extends Object

This file was automatically generated.

Constructor Summary

Constructors

Constructor	Description
Alert(ClientApi api)

Method Summary

Modifier and Type	Method	Description
ApiResponse	addAlert(String messageid, String name, String riskid, String confidenceid, String description, String param, String attack, String otherinfo, String solution, String references, String evidence, String cweid, String wascid)	Add an alert associated with the given message ID, with the provided details.
ApiResponse	alert(String id)	Gets the alert with the given ID, the corresponding HTTP message can be obtained with the 'messageId' field and 'message' API method
ApiResponse	alertCountsByRisk(String url, String recurse)	Gets a count of the alerts, optionally filtered as per alertsPerRisk
ApiResponse	alerts(String baseurl, String start, String count, String riskid)	Gets the alerts raised by ZAP, optionally filtering by URL or riskId, and paginating with 'start' position and 'count' of alerts
ApiResponse	alerts(String baseurl, String start, String count, String riskid, String contextname)	Gets the alerts raised by ZAP, optionally filtering by URL or riskId, and paginating with 'start' position and 'count' of alerts
ApiResponse	alertsByRisk(String url, String recurse)	Gets a summary of the alerts, optionally filtered by a 'url'.
ApiResponse	alertsSummary(String baseurl)	Gets number of alerts grouped by each risk level, optionally filtering by URL
ApiResponse	deleteAlert(String id)	Deletes the alert with the given ID.
ApiResponse	deleteAlerts(String contextname, String baseurl, String riskid)	Deletes all the alerts optionally filtered by URL which fall within the Context with the provided name, risk, or base URL.
ApiResponse	deleteAllAlerts()	Deletes all alerts of the current session.
ApiResponse	numberOfAlerts(String baseurl, String riskid)	Gets the number of alerts, optionally filtering by URL or riskId
ApiResponse	updateAlert(String id, String name, String riskid, String confidenceid, String description, String param, String attack, String otherinfo, String solution, String references, String evidence, String cweid, String wascid)	Update the alert with the given ID, with the provided details.
ApiResponse	updateAlertsConfidence(String ids, String confidenceid)	Update the confidence of the alerts.
ApiResponse	updateAlertsRisk(String ids, String riskid)	Update the risk of the alerts.

Methods inherited from class java.lang.Object

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

Constructor Details

Alert

public Alert(ClientApi api)

Method Details

alert

public ApiResponse alert(String id)
                  throws ClientApiException

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

Throws:

ClientApiException

alerts

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

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

Throws:

ClientApiException

alerts

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

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

Throws:

ClientApiException

alertsSummary

public ApiResponse alertsSummary(String baseurl)
                          throws ClientApiException

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

Throws:

ClientApiException

numberOfAlerts

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

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

Throws:

ClientApiException

alertsByRisk

public ApiResponse alertsByRisk(String url,
 String recurse)
                         throws ClientApiException

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)

Throws:

ClientApiException

alertCountsByRisk

public ApiResponse alertCountsByRisk(String url,
 String recurse)
                              throws ClientApiException

Gets a count of the alerts, optionally filtered as per alertsPerRisk

Throws:

ClientApiException

deleteAllAlerts

public ApiResponse deleteAllAlerts()
                            throws ClientApiException

Deletes all alerts of the current session.

Throws:

ClientApiException

deleteAlerts

public ApiResponse deleteAlerts(String contextname,
 String baseurl,
 String riskid)
                         throws ClientApiException

Deletes all the alerts optionally filtered by URL which fall within the Context with the provided name, risk, or base URL.

Throws:

ClientApiException

deleteAlert

public ApiResponse deleteAlert(String id)
                        throws ClientApiException

Deletes the alert with the given ID.

Throws:

ClientApiException

updateAlertsConfidence

public ApiResponse updateAlertsConfidence(String ids,
 String confidenceid)
                                   throws ClientApiException

Update the confidence of the alerts.

Throws:

ClientApiException

updateAlertsRisk

public ApiResponse updateAlertsRisk(String ids,
 String riskid)
                             throws ClientApiException

Update the risk of the alerts.

Throws:

ClientApiException

updateAlert

public ApiResponse updateAlert(String id,
 String name,
 String riskid,
 String confidenceid,
 String description,
 String param,
 String attack,
 String otherinfo,
 String solution,
 String references,
 String evidence,
 String cweid,
 String wascid)
                        throws ClientApiException

Update the alert with the given ID, with the provided details.

Throws:

ClientApiException

addAlert

public ApiResponse addAlert(String messageid,
 String name,
 String riskid,
 String confidenceid,
 String description,
 String param,
 String attack,
 String otherinfo,
 String solution,
 String references,
 String evidence,
 String cweid,
 String wascid)
                     throws ClientApiException

Add an alert associated with the given message ID, with the provided details. (The ID of the created alert is returned.)

Throws:

ClientApiException