Skip to main content

Robot Framework Library for the OWASP ZAP Application Vulnerability Scanner

Project description


Documentation for test library RoboZap.


  • Install RoboZap libraries into the virtualenv with pip install RoboZap


Arguments: [proxy]

ZAP Library can be imported with one argument

Arguments: - proxy: Proxy is required to initialize the ZAP Proxy at that location. Must include PortSpec - port: Port is required to be set as a global/suite variable for the rest of the suite to access location


| = Keyword Definition = | = Description = |

| Library |RoboZap | proxy| port |

Major Keywords

Start Headless Zap

Arguments: [path]

Start OWASP ZAP without a GUI


| start headless zap | path |

Start GUI Zap

Arguments: [path]

Start OWASP ZAP without a GUI


| start gui zap | path |

Zap Define Context

Arguments: [contextname, url]

Add Target to a context and use the context to perform all scanning/spidering operations


| zap define context | contextname | target |

Zap Open Url

Arguments: [url]

Invoke URLOpen with ZAP


| zap open url | target |

Zap Scan Status

Arguments: [scan_id]

Fetches the status for the spider id provided by the user


| zap scan status | scan_id |

Zap Shutdown

Arguments: []

Shutdown process for ZAP Scanner

Zap Spider Status

Arguments: [spider_id]

Fetches the status for the spider id provided by the user Examples: | zap spider status | spider_id |

Zap Start Ascan

Arguments: [context, url, policy=Default Policy]

Initiates ZAP Active Scan on the target url and context


| zap start ascan | context | url |

Zap Start Spider

Arguments: [target, url]

Start ZAP Spider with ZAP's inbuilt spider mode


| zap start spider | target | url |

Zap Write To Json File

Arguments: [scan_id]

Fetches all the results from zap.core.alerts() and writes to json file.


| zap write to json | scan_id |

Zap Generate Report (Export Report Plugin)

Arguments: [file_path, report_format, report_title, report_author]

Uses the Export Report from ZAP to generate reports in multiple formats.

  • file_path: needs to be an absolute path and include the file name with extension.
  • format: can be json|xml|xhtml|pdf|doc
  • report title: Any title you deem fit for the exported report
  • report auhor: Any name you want for the author of the report


| zap export report | file_path | format | report title | report author

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for RoboZap, version 1.3.3
Filename, size File type Python version Upload date Hashes
Filename, size RoboZap-1.3.3-py3-none-any.whl (5.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size RoboZap-1.3.3.tar.gz (5.2 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page