Metadata-Version: 2.1
Name: jbxapi
Version: 3.22.0
Summary: API for Joe Sandbox
Keywords: security,malware,sandbox,sandboxing,joe
Author: Joe Security LLC
Requires-Python: >=2.7, !=3.0, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*
Description-Content-Type: text/markdown
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Security
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Requires-Dist: requests >=2.18.4,<3
Requires-Dist: pyzipper >=0.3.1; python_version >="3.5"
Project-URL: Homepage, https://github.com/joesecurity/jbxapi

![Joe Sandbox API v2](https://raw.githubusercontent.com/joesecurity/jbxapi/master/img/logo.png)

# API Wrapper

⚠ There have been some breaking changes in v3.0.0, please see [CHANGES.md](CHANGES.md).

The Joe Sandbox API Wrapper enables you to fully integrate Joe Sandbox into your malware analysis framework. Joe Sandbox is a deep malware analysis platform for analyzing malicious files.

You can use this wrapper with

 * [Joe Sandbox Cloud](https://www.joesecurity.org/joe-sandbox-cloud) — our Cloud hosted instance
 * [On-premise installations of Joe Sandbox](https://www.joesecurity.org/joe-security-products#on-premise) — for even more power and privacy

It is at the same time a powerful implementation of the Joe Sandbox API and also a command line tool for interacting with Joe Sandbox.

# License

The code is written in Python and licensed under MIT.

# Requirements

* Python 2.7 or higher
* Python 3.5 or higher

# Installation

## With Pip

    pip install jbxapi

⚠ On-premise installations with Joe Sandbox v25 or older should use the following version:

    pip install jbxapi==2.10.1

For upgrading `jbxapi` to a more recent version, use

    pip install --upgrade jbxapi

## Manually

1. Install the python library [`requests`](https://requests.readthedocs.io/en/latest/).

        pip install requests

2. Copy `jbxapi.py` to where you need it.

# Documentation

* [Command Line Interface](docs/cli.md)
* [Python API](docs/api.md)

# Credits

* Thanks to [Pedram Amini](https://github.com/pedramamini) for a first wrapper implementation!

# Links

* [Joe Securiy LLC](https://www.joesecurity.org)
* [Joe Security Blog](https://blog.joesecurity.org)
* [Twitter @joe4security](https://twitter.com/joe4security)


