Automation Framework

This add-on provides a framework that allows ZAP to be automated in an easy and flexible way.

It provides the following command line options:

  • -autorun <filename> Run the automation jobs specified in the file.
  • -autogenmin <filename> Generate template automation file with the key parameters.
  • -autogenmax <filename> Generate template automation file with all parameters.
  • -autogenconf <filename> Generate template automation file using the current configuration.

To use the automation framework:

  1. Generate a template automation file using one of the -autogen* command line options
  2. Edit the file to match your requirements
  3. Run the file using the -autorun commandline option e.g. ./ -cmd -autorun config.yaml

In most cases it is recommended to also use the -cmd command line option so that the ZAP desktop is not displayed and ZAP exits as soon as it has finished generating or running the jobs defined in the file. However you can choose to run Automation Framework jobs using the ZAP desktop to help you debug issues.


A GUI is under development and currently provides a limited set of functionality.


The following API endpoints are provided by this add-on:

  • Action: runPlan(filePath) - loads and asynchronously runs the plan in the specified file, returning a planId
  • View: planProgress(planId) - returns the progress details for the specified planId

If the ZAP desktop is being used then the plan will also be shown in the GUI to make it easier to diagnose any problems.


The environment section of the file defines the applications which the rest of the jobs can act on.


The following automation jobs are supported by this add-on:

This framework is plugable and so other add-ons may add support for other jobs, see the Automation Framework website pages for a more complete list.

The ‘min’ and ‘max’ templates include comments giving more information about the fields.