# 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)
Raw data
{
"_id": null,
"home_page": null,
"name": "jbxapi",
"maintainer": null,
"docs_url": null,
"requires_python": ">=2.7, !=3.0, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*",
"maintainer_email": null,
"keywords": "security,malware,sandbox,sandboxing,joe",
"author": "Joe Security LLC",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/fd/59/cf6f68e896ea9f95db23a6d6b7b88ab7218a240d889d2cd12eaf5cc4ede7/jbxapi-3.22.0.tar.gz",
"platform": null,
"description": "\n\n# API Wrapper\n\n\u26a0 There have been some breaking changes in v3.0.0, please see [CHANGES.md](CHANGES.md).\n\nThe 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.\n\nYou can use this wrapper with\n\n * [Joe Sandbox Cloud](https://www.joesecurity.org/joe-sandbox-cloud) \u2014 our Cloud hosted instance\n * [On-premise installations of Joe Sandbox](https://www.joesecurity.org/joe-security-products#on-premise) \u2014 for even more power and privacy\n\nIt is at the same time a powerful implementation of the Joe Sandbox API and also a command line tool for interacting with Joe Sandbox.\n\n# License\n\nThe code is written in Python and licensed under MIT.\n\n# Requirements\n\n* Python 2.7 or higher\n* Python 3.5 or higher\n\n# Installation\n\n## With Pip\n\n pip install jbxapi\n\n\u26a0 On-premise installations with Joe Sandbox v25 or older should use the following version:\n\n pip install jbxapi==2.10.1\n\nFor upgrading `jbxapi` to a more recent version, use\n\n pip install --upgrade jbxapi\n\n## Manually\n\n1. Install the python library [`requests`](https://requests.readthedocs.io/en/latest/).\n\n pip install requests\n\n2. Copy `jbxapi.py` to where you need it.\n\n# Documentation\n\n* [Command Line Interface](docs/cli.md)\n* [Python API](docs/api.md)\n\n# Credits\n\n* Thanks to [Pedram Amini](https://github.com/pedramamini) for a first wrapper implementation!\n\n# Links\n\n* [Joe Securiy LLC](https://www.joesecurity.org)\n* [Joe Security Blog](https://blog.joesecurity.org)\n* [Twitter @joe4security](https://twitter.com/joe4security)\n\n",
"bugtrack_url": null,
"license": null,
"summary": "API for Joe Sandbox",
"version": "3.22.0",
"project_urls": {
"Homepage": "https://github.com/joesecurity/jbxapi"
},
"split_keywords": [
"security",
"malware",
"sandbox",
"sandboxing",
"joe"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "3091666bf5d31ca1016b5607ee9eb679530f5ce3b688667f757f4e30630b1154",
"md5": "3b51467fab187e44db10b7cf1d042eeb",
"sha256": "3dc4eed81a3ce4d1d6fb1bab311932f7114056ad7d736f7ee75ca25a02582b7d"
},
"downloads": -1,
"filename": "jbxapi-3.22.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "3b51467fab187e44db10b7cf1d042eeb",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=2.7, !=3.0, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*",
"size": 18074,
"upload_time": "2024-01-30T12:50:55",
"upload_time_iso_8601": "2024-01-30T12:50:55.824289Z",
"url": "https://files.pythonhosted.org/packages/30/91/666bf5d31ca1016b5607ee9eb679530f5ce3b688667f757f4e30630b1154/jbxapi-3.22.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "fd59cf6f68e896ea9f95db23a6d6b7b88ab7218a240d889d2cd12eaf5cc4ede7",
"md5": "e21e9b47b7883ee4bb1975f104cee5af",
"sha256": "c4a21a8f837ec0273e846a032216e81c88697f46e1725ed2983c63b442cffb8a"
},
"downloads": -1,
"filename": "jbxapi-3.22.0.tar.gz",
"has_sig": false,
"md5_digest": "e21e9b47b7883ee4bb1975f104cee5af",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=2.7, !=3.0, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*",
"size": 74082,
"upload_time": "2024-01-30T12:51:11",
"upload_time_iso_8601": "2024-01-30T12:51:11.409525Z",
"url": "https://files.pythonhosted.org/packages/fd/59/cf6f68e896ea9f95db23a6d6b7b88ab7218a240d889d2cd12eaf5cc4ede7/jbxapi-3.22.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-30 12:51:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "joesecurity",
"github_project": "jbxapi",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "jbxapi"
}
JSON
