Simon Bennetts edited this page Mar 30, 2017 · 9 revisions

Python client API

The Python client can be downloaded from PyPI (download link in The ZAP API page) or it can be installed using:

pip install python-owasp-zap-v2.4

As of ZAP 2.0.0 the Python API is generated (using this class).

Note that the example has now been updated to the v2.4 API :)


In order to change/develop ZAP Python API, we need to change the actual code in python/api/src/zapv2/ directory and then run the following commands to build that code and install it system-wide:

cd python/api/
python setup.py build
sudo python setup.py install

By doing this, we won't be using virtual environment and thus cannot use pip install. By installing the API system-wide, we don't actually need to bother ourselves with pip install. Changes made to the ZAP Python API can be added/committed to repository as normal ZAP code and will eventually be added into the zapv2 egg, which others will be able to install with "pip install zapv2".

For development purposes, changing the API and installing is system-wide is a time saver and works quite nice when we've gotten used to it.

An example python script

#!/usr/bin/env python

import time
from pprint import pprint
from zapv2 import ZAPv2

target = ''
apikey = 'changeme' # Change to match the API key set in ZAP, or use None if the API key is disabled

# By default ZAP API client will connect to port 8080
zap = ZAPv2(apikey=apikey)
# Use the line below if ZAP is not listening on port 8080, for example, if listening on port 8090
# zap = ZAPv2(apikey=apikey, proxies={'http': '', 'https': ''})

# do stuff
print 'Accessing target %s' % target
# try have a unique enough session...
# Give the sites tree a chance to get updated

print 'Spidering target %s' % target
scanid = zap.spider.scan(target)
# Give the Spider a chance to start
while (int(zap.spider.status(scanid)) < 100):
    print 'Spider progress %: ' + zap.spider.status(scanid)

print 'Spider completed'
# Give the passive scanner a chance to finish

print 'Scanning target %s' % target
scanid = zap.ascan.scan(target)
while (int(zap.ascan.status(scanid)) < 100):
    print 'Scan progress %: ' + zap.ascan.status(scanid)

print 'Scan completed'

# Report the results

print 'Hosts: ' + ', '.join(zap.core.hosts)
print 'Alerts: '
pprint (zap.core.alerts())


Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.