All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
1.14.0 - 2024-05-13
- Update core APIs for 2.15.
1.13.0 - 2023-11-21
- Add the APIs of the following add-on:
- Custom Payloads version 0.13.0.
- Update core APIs for 2.14.
- Update the APIs of the following add-on:
- Selenium version 15.16.0.
- Stop sending the API key as query parameter, not needed since ZAP 2.6.0.
- Allow to call the ZAP API with custom HTTP method (e.g. file upload).
- The following APIs were deprecated:
Exportreport
- The Ant tasks are no longer provided.
1.12.0 - 2023-07-13
- Minimum Java version is now 11.
- Update core APIs for 2.13.
- Update the APIs of the following add-ons:
- AJAX Spider version 23.15.0;
- Alert Filters version 17;
- GraphQL Support version 0.18.0;
- Network version 0.10.0;
- Selenium version 15.13.0;
- Spider version 0.5.0.
1.11.0 - 2022-11-01
- Add the APIs of the following add-ons:
- Import/Export version 0.3.0;
- Network version 0.3.0;
- Spider version 0.1.0.
- Update core APIs for 2.12.
- Update the APIs of the following add-ons:
- Automation Framework version 0.15.0;
- Selenium version 15.8.0;
- Replacer version 11.
- The following APIs were deprecated:
ImportLogFiles
;Importurls
;LocalProxies
.
- Add a graphql object to ClientApi.
1.10.0 - 2021-10-11
- Add the APIs of the following add-ons:
- Automation Framework version 0.7.0;
- Report Generation add-on, version 0.8.0;
- Retest version 0.2.0.
- Update core APIs for 2.11.
- Update the APIs of the following add-ons:
- Ajax Spider version 23.6.0;
- Alert Filters version 13;
- GraphQL Support version 0.6.0;
- OpenAPI Support version 23;
- Replacer version 9.
1.9.0 - 2020-12-18
- Add API from GraphQL add-on.
- Core APIs updated for ZAP version 2.10.0.
- Update API from AJAX Spider add.on.
1.8.0 - 2020-01-23
- Core APIs.
- APIs from add-ons:
- Access Control Testing;
- Export Report;
- Revisit;
- Wappalyzer - Technology Detection.
- Core APIs updated for ZAP version 2.9.0.
- Update APIs from add-ons:
- Alert Filters;
- OpenAPI Support;
- Replacer.
1.7.0 - 2019-06-13
- Add API for SOAP Scanner add-on, version 3.
- Core APIs updated for ZAP version 2.8.0.
- Update Replacer API, per release of version 7.
- Update Websocket API, per release of version 19.
- Update Selenium API, per release of version 15.0.0.
- Add description to Importurls and AlertFilter API endpoints.
- Disable XXE processing when parsing ZAP API responses.
- Ensure alerts file is always closed.
1.6.0 - 2018-04-10
- WebSockets ("websocket").
- Explicitly disable HTTP caching, to always obtain a fresh response from ZAP.
1.5.0 - 2017-11-30
- Core APIs updated for ZAP version 2.7.0.
1.4.0 - 2017-07-13
- New Ant task to create ZAP reports:
<!-- Defined the task: --> <taskdef name="reportTask" classname="org.zaproxy.clientapi.ant.ReportTask" /> <!-- Call the task: --> <reportTask zapAddress="localhost" zapPort="8080" apikey="API-KEY" type="html" file="report.html" overwrite="true" /> <!-- type - the type/format of the report (e.g. HTML, XML, MD), defaults to HTML. file - where the report should be created (can be an absolute path, if relative it is resolved against the build directory). overwrite - if the file should be overwritten. -->
1.3.0 - 2017-06-23
- Import files containing URLs ("importurls").
- OpenAPI Support ("openapi").
- Replacer ("replacer").
- Update scan Ant tasks to wait for the corresponding scan to finish.
1.2.0 - 2017-03-29
- Core APIs updated for ZAP version 2.6.0.
- Update AJAX Spider API
- Allows to obtain the full results of a scan, messages in/out of scope and message with I/O errors.
1.1.1 - 2017-03-09
- Fixed a bug that prevented the new API methods (that don't require the API key) from being used with ZAP versions <= 2.5.0.
1.1.0 - 2017-03-09
- Context Alert Filters API, for more information refer to the help page: https://www.zaproxy.org/docs/desktop/addons/alert-filters/
- The
Alert
now exposes the alert ID, message ID, and scanner ID. - Added confidence "False Positive" (enum
Alert.Confidence
).
- The
ClientApi
now allows to set the API key through the constructor, which ensures that the API key is sent whenever required. - It's now possible to obtain the keys of the values of an
ApiResponseSet
(also, deprecated unused/unnecessary constructor and method). - It's now possible to specify the API key in all Ant tasks.
- Update AJAX Spider API
- Allows to scan a context, as a user and just a subtree.
- Update Selenium API
- Allows to choose which Firefox binary is used and set the path to geckodriver.
- The API methods that allowed to pass the API key were deprecated in
favour of using the new
ClientApi
constructor. Alert
andAlertTask
now usename
instead ofalert
for the name of the alert (zaproxy/zaproxy#1341), older methods were deprecated.
ApiResponseSet
now has as valuesApiResponse
(zaproxy/zaproxy#3228).
1.0.0 - 2016-06-03
- First version as "stand alone library", it was migrated from the zaproxy repository and released to Maven Central.