Package org.zaproxy.clientapi.gen

Class Alert

  • public class Alert
extends java.lang.Object
    This file was automatically generated.

    • Constructor Summary

      Constructors 
      Constructor Description
      Alert​(ClientApi api)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ApiResponse addAlert​(java.lang.String messageid, java.lang.String name, java.lang.String riskid, java.lang.String confidenceid, java.lang.String description, java.lang.String param, java.lang.String attack, java.lang.String otherinfo, java.lang.String solution, java.lang.String references, java.lang.String evidence, java.lang.String cweid, java.lang.String wascid)
      Add an alert associated with the given message ID, with the provided details.
      ApiResponse alert​(java.lang.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​(java.lang.String url, java.lang.String recurse)
      Gets a count of the alerts, optionally filtered as per alertsPerRisk
      ApiResponse alerts​(java.lang.String baseurl, java.lang.String start, java.lang.String count, java.lang.String riskid)
      Gets the alerts raised by ZAP, optionally filtering by URL or riskId, and paginating with 'start' position and 'count' of alerts
      ApiResponse alertsByRisk​(java.lang.String url, java.lang.String recurse)
      Gets a summary of the alerts, optionally filtered by a 'url'.
      ApiResponse alertsSummary​(java.lang.String baseurl)
      Gets number of alerts grouped by each risk level, optionally filtering by URL
      ApiResponse deleteAlert​(java.lang.String id)
      Deletes the alert with the given ID.
      ApiResponse deleteAllAlerts()
      Deletes all alerts of the current session.
      ApiResponse numberOfAlerts​(java.lang.String baseurl, java.lang.String riskid)
      Gets the number of alerts, optionally filtering by URL or riskId
      ApiResponse updateAlert​(java.lang.String id, java.lang.String name, java.lang.String riskid, java.lang.String confidenceid, java.lang.String description, java.lang.String param, java.lang.String attack, java.lang.String otherinfo, java.lang.String solution, java.lang.String references, java.lang.String evidence, java.lang.String cweid, java.lang.String wascid)
      Update the alert with the given ID, with the provided details.
      ApiResponse updateAlertsConfidence​(java.lang.String ids, java.lang.String confidenceid)
      Update the confidence of the alerts.
      ApiResponse updateAlertsRisk​(java.lang.String ids, java.lang.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 Detail

    • Method Detail

      • alert

        public ApiResponse alert​(java.lang.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​(java.lang.String baseurl,
                          java.lang.String start,
                          java.lang.String count,
                          java.lang.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

      • alertsByRisk

        public ApiResponse alertsByRisk​(java.lang.String url,
                                java.lang.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

      • updateAlert

        public ApiResponse updateAlert​(java.lang.String id,
                               java.lang.String name,
                               java.lang.String riskid,
                               java.lang.String confidenceid,
                               java.lang.String description,
                               java.lang.String param,
                               java.lang.String attack,
                               java.lang.String otherinfo,
                               java.lang.String solution,
                               java.lang.String references,
                               java.lang.String evidence,
                               java.lang.String cweid,
                               java.lang.String wascid)
                        throws ClientApiException
        Update the alert with the given ID, with the provided details.
        Throws:
        ClientApiException

      • addAlert

        public ApiResponse addAlert​(java.lang.String messageid,
                            java.lang.String name,
                            java.lang.String riskid,
                            java.lang.String confidenceid,
                            java.lang.String description,
                            java.lang.String param,
                            java.lang.String attack,
                            java.lang.String otherinfo,
                            java.lang.String solution,
                            java.lang.String references,
                            java.lang.String evidence,
                            java.lang.String cweid,
                            java.lang.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