Skip to content

1. Getting started

vectra-tme edited this page Jun 1, 2018 · 3 revisions

Vectra API Tools (aka VAT) is a library, currently consisting of three modules, that can be imported into your python interpreter. To avoid conflict or risk of impacting your existing python environment, it is recommended to install in a virtual environment.

  • cli.py is a set of common parameters which can be imported into scripts which are designed to be run from the command line
  • stix_taxii.py is a module that provides a taxii client to ingest threat feeds and write to STIX file
  • vectra.py is module that provides methods that simplify interaction with the Vectra API. There are methods to support most entities including hosts, detections, and threat feeds.

Installation
To install the library using pip run:

pip install vectra_api_tools

pip install develop branch from github:

pip install git+https://github.com/vectranetworks/vectra_api_tools.git@develop

To install from source code, run the following command from the root directory:

python setup.py install

Once installed, VAT can be imported into any python code using the following:

import vat

or scripts can be run by changing the the script directory and running

python <script>

Help is available for all scripts using the -h or --help flag

Clone this wiki locally