Skip to content
ZAP API Documentation
JavaScript CSS Ruby Shell HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
source
.editorconfig
.gitignore
.travis.yml
Gemfile
Gemfile.lock
LICENSE
README.md
Rakefile
Vagrantfile
config.rb
deploy.sh
font-selection.json
openapi.yaml
run.sh

README.md

Build Status

Introduction

Welcome to ZAP API Documentation! The OWASP Zed Attack Proxy (ZAP) is one of the world's most popular free security tools which lets you automatically find security vulnerabilities in your applications. ZAP also has an extremely powerful API that allows you to do nearly everything that possible via the desktop interface. This allows the developers to automate pentesting and security regression testing of the application in the CI/CD pipeline. This repository provides example guides & API definitions for ZAP APIs.

The live documentation can be viewed in the following URL.

Contributing to the Documentation

The guidelines for contribution is available in the following page. ZAP documentation is built using Slate. The source files for the documentation are available in the source/includes directory. View the contribution guide on how to start contributing to the document.

Deploying

To deploy to https://zaproxy.org/

  1. Run bundle install if you have not done so before
  2. Run bundle exec middleman build --clean
  3. Copy the build directory to your own clone of https://github.com/zaproxy/zaproxy.github.io e.g.
    • cp -R build/* ../zaproxy.github.io/docs/api/
  4. Commit and push any changes then open a PR on https://github.com/zaproxy/zaproxy.github.io
You can’t perform that action at this time.