ZAP API UI

Component: alert

Views

alert (id* ) Gets the alert with the given ID, the corresponding HTTP message can be obtained with the 'messageId' field and 'message' API method
alertCountsByRisk (url recurse ) Gets a count of the alerts, optionally filtered as per alertsPerRisk
alerts (baseurl start count riskId contextName ) Gets the alerts raised by ZAP, optionally filtering by URL or riskId, and paginating with 'start' position and 'count' of alerts
alertsByRisk (url recurse ) 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)
alertsSummary (baseurl ) Gets number of alerts grouped by each risk level, optionally filtering by URL
numberOfAlerts (baseurl riskId ) Gets the number of alerts, optionally filtering by URL or riskId

Actions

addAlert (messageId* name* riskId* confidenceId* description* param attack otherInfo solution references evidence cweId wascId ) Add an alert associated with the given message ID, with the provided details. (The ID of the created alert is returned.)
deleteAlert (id* ) Deletes the alert with the given ID.
deleteAlerts (contextName baseurl riskId ) Deletes all the alerts optionally filtered by URL which fall within the Context with the provided name, risk, or base URL.
deleteAllAlertsDeletes all alerts of the current session.
updateAlert (id* name* riskId* confidenceId* description* param attack otherInfo solution references evidence cweId wascId ) Update the alert with the given ID, with the provided details.
updateAlertsConfidence (ids* confidenceId* ) Update the confidence of the alerts.
updateAlertsRisk (ids* riskId* ) Update the risk of the alerts.