zaproxy - npm explorer

ZAP Node API

The NodeJS implementation to access the ZAP API. For more information
about ZAP consult the (main) ZAP project.

Install

``npm install zaproxy`

`Usage`

By default ZAP requires an API key to be sent with every request. This is done automatically providing you supply the same API key when you instantiate the ZapClientthat you use to run ZAP with. All following API requests will use this same API key. You can disable the API key when running ZAP if you are on a trusted network and understand the risks. If you choose to do so, you may omit theapiKey property of the zapOptions object supplied to ZapClient.

`$3`

`js const ZapClient = require('zaproxy');

const zapOptions = { apiKey: 'eahhr6h6kal92j21gkcnhkp80t', proxy: { host: '127.0.0.1', port: 8080, }, };

const zaproxy = new ZapClient(zapOptions);

`$3`

`js let params = { contextid: contextid, userid: userid, url: sutbaseurl, maxchildren: maxchildren, recurse: recurse, subtreeonly: subtreeonly, }; let response = await zaproxy.spider.scanAsUser(params); console.log(response);`

`$3`

When encountering an error, like attempting to retrieve a non-existent context, a rejected promise will be returned. The rejection will contain an ApiClientError object, which encapsulates the specific details of the original error. This ApiClientError object offers valuable information regarding the failed request, and the original error can be accessed through the cause property. The response details, if any, are available through the response property, containing the status and data` (body).

API

For a full API list, see https://www.zaproxy.org/docs/api/.

Getting Help

For help using the ZAP API refer to:

* API Documentation;
* ZAP User Group - for asking questions;

Issues

To report issues related to the ZAP Node API, bugs and enhancements requests, use the issue tracker of this project.

Usage

By default ZAP requires an API key to be sent with every request. This is done automatically providing you supply the same API key when you instantiate the

ZapClient

 that you use to run ZAP with. All following API requests will use this same API key.  
You can disable the API key when running ZAP if you are on a trusted network and understand the risks. If you choose to do so, you may omit the

apiKey property of the zapOptions object supplied to ZapClient.

$3

js
const ZapClient = require('zaproxy');

const zapOptions = {
  apiKey: 'eahhr6h6kal92j21gkcnhkp80t',
  proxy: {
    host: '127.0.0.1',
    port: 8080,
  },
};

const zaproxy = new ZapClient(zapOptions);

$3

js
let params = {
  contextid: contextid,
  userid: userid,
  url: sutbaseurl,
  maxchildren: maxchildren,
  recurse: recurse,
  subtreeonly: subtreeonly,
};
let response = await zaproxy.spider.scanAsUser(params);
console.log(response);

$3

When encountering an error, like attempting to retrieve a non-existent context, a rejected promise will be returned. The rejection will contain an

ApiClientError object, which encapsulates the specific details of the original error. This ApiClientError object offers valuable information regarding the failed request, and the original error can be accessed through the cause property. The response details, if any, are available through the response property, containing the status and data` (body).