KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #codex #typescript #developer-tools #ai-agents #deepseek-harness #claude-code #ai-agent #cli #react #mcp

VxAPI

★ 229 Open GitHub ↗

A generic interface and CLI for all endpoints of the Falcon Sandbox API

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![Alt text](https://raw.githubusercontent.com/PayloadSecurity/VxAPI/master/img/icon.png)

# VxWebService Python API Connector
The Falcon Sandbox Python API Connector (e.g. for https://www.hybrid-analysis.com/).

## Requirements

- [Python](http://www.python.org) >= 3.4.0

> To install the required python modules, please run `pip install -r requirements.txt`
> Using Debian/Ubuntu OS, this can be done by calling `sudo apt-get install python3-pip`. It will then be available via `pip3`
> Using Windows, this can be done automatically when installing `python` (proper checkbox on the installer has to be checked). It should be available via `pip`

Versions
---

### V2

This version has broad support for all capabilities of VxWebService APIv2 and much more. New features include:

- support for APIv2
- improved application performance
- unified and simplified CLI schema
- bulk quick scan and sandbox submissions
- improved file handling
- test coverage

Example: `python3 vxapi.py scan_file C:\file-repo all`

![Alt text](https://raw.githubusercontent.com/PayloadSecurity/VxAPI/master/img/scan_example.png)

### V1

The legacy app utilizing the APIv1 is not supported anymore. For backward compatibility, it is still available in the `v1` branch.

Usage
---

### Define configuration file

Copy the `config_tpl.py` and name it `config.py`.

The configuration file specifies a triplet of api key/secret and server:

- api_key (should be compatible with API v2 - should contains at least 60 chars)
- server - full url of the WebService instance e.g. `https://www.hybrid-analysis.com`

Please fill them with the appropriate data. You can generate a public (restricted) API key by following these instructions:
https://www.hybrid-analysis.com/knowledge-base/issuing-self-signed-api-key

If you have the full version of Falcon Sandbox, create any kind of API key in the admin area:
https://www.hybrid-analysis.com/apikeys

### Install python requests module if you're using python < 3.5 [python-requests](http://docs.python-requests.org/en/master/).

Debian/Ubuntu OS:

sudo apt-get install python3-requests
    
or
    
    pip3 install requests
    
Windows:

pip install requests

### Install python colorama module, [python-colorama module](https://pypi.org/project/colorama/).

Debian/Ubuntu OS:
    
    pip3 install colorama
    
Windows:

pip install colorama

### Run the connector. Use 'help' or '-h' (on any API endpoint) to get to know about the various endpoint options. Use '-v' for a more verbose output.

> Depending on your API Key privileges, you will see different options.
> Few actions connected with system state and file submit, are only available while using premium API Key.
> If you are interested in obtaining one, please contact with our [support](https://www.payload-security.com/contact).

python3 vxapi.py -h
    
After choosing the `action_name`
    
    python3 vxapi.py action_name -h
    
### Use 'verbose' mode to get more wordy output

python3 vxapi.py action_name -v

![Alt text](https://raw.githubusercontent.com/PayloadSecurity/VxAPI/master/img/cli_example.png)

### Notes

> Most Linux OSes have two versions of `python` installed. 
> To ensure that the program will work correctly, please use `python3`.
> In Windows after having installed `python`, please add the parent folder to `PATH` environment variable. Now use `python` to callout the script.

### FAQ

##### My API Key authorization level was updated, but VxApi is still showing the old value.

VxApi is caching key data response. To get the fresh one, please remove `cache` directory content and try to use application once again.

##### How can I run tests attached to the project?

You should to call `pytest` from the project root directory. (installed testing library should is required)

### License

Licensed  GNU GENERAL PUBLIC LICENSE, Version 3, 29 June 2007
see https://github.com/PayloadSecurity/VxAPI/blob/master/LICENSE.md

VxAPI

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README