Version 1.13.0

Release Notes

Added

• Add the APIs of the following add-on:
  • Custom Payloads version 0.13.0.

Changed

• 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).

Deprecated

• The following APIs were deprecated:
  • Exportreport

Removed

• The Ant tasks are no longer provided.

Available Libraries

The following libraries are available in this release:

• zap-api-1.13.0.jar - contains Java API client implementation and its dependencies, ideally to run as standalone library;
• zap-clientapi-1.13.0.jar - contains just the Java API client implementation (similar to library available in Maven Central).

Intended for use with OWASP ZAP version 2.14.0 and above (while it's compatible with older ZAP versions new APIs/features will not work).

Version 1.12.0

Release Notes

Changed

• 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.

Available Libraries

The following libraries are available in this release:

• zap-api-1.12.0.jar - contains Java API client implementation and its dependencies, ideally to run as standalone library;
• zap-clientapi-1.12.0.jar - contains just the Java API client implementation (similar to library available in Maven Central);
• zap-clientapi-ant-1.12.0.jar - contains just the Ant tasks that wrap Java API client implementation.

Intended for use with OWASP ZAP version 2.13.0 and above (while it's compatible with older ZAP versions new APIs/features will not work).

Version 1.11.0

Release Notes

Added

• Add the APIs of the following add-ons:
  • Import/Export version 0.3.0;
  • Network version 0.3.0;
  • Spider version 0.1.0.

Changed

• 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.

Deprecated

• The following APIs were deprecated:
  • ImportLogFiles;
  • Importurls;
  • LocalProxies.

Fixed

• Add a graphql object to ClientApi.

Available Libraries

The following libraries are available in this release:

• zap-api-1.11.0.jar - contains Java API client implementation and its dependencies, ideally to run as standalone library;
• zap-clientapi-1.11.0.jar - contains just the Java API client implementation (similar to library available in Maven Central);
• zap-clientapi-ant-1.11.0.jar - contains just the Ant tasks that wrap Java API client implementation.

Intended for use with OWASP ZAP version 2.12.0 and above (while it's compatible with older ZAP versions new APIs/features will not work).

Version 1.10.0

Release Notes

Added

• 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.

Changed

• 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.

Available Libraries

The following libraries are available in this release:

• zap-api-1.10.0.jar - contains Java API client implementation and its dependencies, ideally to run as standalone library;
• zap-clientapi-1.10.0.jar - contains just the Java API client implementation (similar to library available in Maven Central);
• zap-clientapi-ant-1.10.0.jar - contains just the Ant tasks that wrap Java API client implementation.

Intended for use with OWASP ZAP version 2.11.0 and above (while it's compatible with older ZAP versions new APIs/features will not work).

Version 1.9.0

Release Notes

Added

• Add API from GraphQL add-on.

Changed

• Core APIs updated for ZAP version 2.10.0.
• Update API from AJAX Spider add-on.

Available Libraries

The following libraries are available in this release:

• zap-api-1.9.0.jar - contains Java API client implementation and its dependencies, ideally to run as standalone library;
• zap-clientapi-1.9.0.jar - contains just the Java API client implementation (similar to library available in Maven Central);
• zap-clientapi-ant-1.9.0.jar - contains just the Ant tasks that wrap Java API client implementation.

Intended for use with OWASP ZAP version 2.10.0 and above (while it's compatible with older ZAP versions new APIs/features will not work).

Version 1.8.0

Release Notes

Added

• Core APIs.
• APIs from add-ons:
• Access Control Testing;
• Export Report;
• Revisit;
• Wappalyzer - Technology Detection.

Changed

• Core APIs updated for ZAP version 2.9.0.
• Update APIs from add-ons:
• Alert Filters;
• OpenAPI Support;
• Replacer.

Available Libraries

The following libraries are available in this release:

• zap-api-1.8.0.jar - contains Java API client implementation and its dependencies, ideally to run as standalone library;
• zap-clientapi-1.8.0.jar - contains just the Java API client implementation (similar to library available in Maven Central);
• zap-clientapi-ant-1.8.0.jar - contains just the Ant tasks that wrap Java API client implementation.

Intended for use with OWASP ZAP version 2.9.0 and above (while it's compatible with older ZAP versions new APIs/features will not work).

Version 1.7.0

Release Notes

Added

• Add API for SOAP Scanner add-on, version 3.

Changed

• 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.

Fixed

• Disable XXE processing when parsing ZAP API responses.
• Ensure alerts file is always closed.

Available Libraries

The following libraries are available in this release:

• zap-api-1.7.0.jar - contains Java API client implementation and its dependencies, ideally to run as standalone library;
• zap-clientapi-1.7.0.jar - contains just the Java API client implementation (similar to library available in Maven Central);
• zap-clientapi-ant-1.7.0.jar - contains just the Ant tasks that wrap Java API client implementation.

Intended for use with OWASP ZAP version 2.8.0 and above (while it's compatible with older ZAP versions new APIs/features will not work).

Version 1.6.0

Release Notes

Changes

• Explicitly disable HTTP caching, to always obtain a fresh response from ZAP.

New APIs

• WebSockets ("websocket").

Available Libraries

The following libraries are available in this release:

• zap-api-1.6.0.jar - contains Java API client implementation and its dependencies, ideally to run as standalone library;
• zap-clientapi-1.6.0.jar - contains just the Java API client implementation (similar to library available in Maven Central);
• zap-clientapi-ant-1.6.0.jar - contains just the Ant tasks that wrap Java API client implementation.

Intended for use with OWASP ZAP version 2.7.0 and above (while it's compatible with older ZAP versions new APIs/features will not work).

Version 1.5.0

Release Notes

Updated APIs

• Core APIs updated for ZAP version 2.7.0.

Available Libraries

The following libraries are available in this release:

• zap-api-1.5.0.jar - contains Java API client implementation and its dependencies, ideally to run as standalone library;
• zap-clientapi-1.5.0.jar - contains just the Java API client implementation (similar to library available in Maven Central);
• zap-clientapi-ant-1.5.0.jar - contains just the Ant tasks that wrap Java API client implementation.

Intended for use with OWASP ZAP version 2.7.0 and above (while it's compatible with older ZAP versions new APIs/features will not work).

Version 1.4.0

Release Notes

Ant Tasks

• New 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.
      -->

Available Libraries

The following libraries are available in this release:

• zap-clientapi-ant-1.4.0.jar - contains just the Ant tasks that wrap Java API client implementation.

Intended for use with OWASP ZAP version 2.6.0 and above (while it's compatible with older ZAP versions new APIs/features will not work).