REST API v1.0

Objective

The objective of this document is to define the REST API for w3af.

The basic features

We're going to focus on delivering the most basic functionality: configure a scan, start, get status, pause, stop and read identified vulnerabilities. Any other features will be implemented in next versions.

Method to be exposed via API

w3afCore.py

• start
• stop
• pause

plugins.py

• set_plugin_options
• get_plugin_options
• get_all_enabled_plugins
• get_enabled_plugins
• set_plugins
• get_plugin_list

status.py

• get_status
• is_running
• is_paused
• get_run_time
• get_scan_time
• get_rpm

target.py

• set_options which is used to configure the scan target