https://github.com/danner26/bunnyapi
🌐 Node/Express.JS API for use in conjunction with the BunnyScripts repo by @danner26 and @walshg3
https://github.com/danner26/bunnyapi
bashbunny express nodejs rest-api
Last synced: 4 months ago
JSON representation
🌐 Node/Express.JS API for use in conjunction with the BunnyScripts repo by @danner26 and @walshg3
- Host: GitHub
- URL: https://github.com/danner26/bunnyapi
- Owner: danner26
- License: gpl-3.0
- Created: 2019-04-10T13:38:35.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-28T20:41:25.000Z (over 3 years ago)
- Last Synced: 2025-09-10T08:39:35.114Z (10 months ago)
- Topics: bashbunny, express, nodejs, rest-api
- Language: JavaScript
- Homepage:
- Size: 149 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# BunnyAPI [](https://codebeat.co/projects/github-com-danner26-bunnyapi-develop)
`BunnyAPI` is a Node.JS/Express.JS simple API that retrieves JSON from the [BunnyScripts](https://github.com/danner26/BunnyScripts) repo by [Daniel W. Anner](https://github.com/danner26) and [Gregory Walsh](https://github.com/walshg3). This project is originally for our CSIS33-3381 with Dr. Aakash Taneja. In working on this project, we have found a new respect and passion for these Bash Bunny scripts. We plan to keep our research going, and continue to upkeep and integrate new features for this API.
## Usage
When using this API, you are free to adapt it for your needs, but it will work best with the tested scripts over in the [BunnyScripts](https://github.com/danner26/BunnyScripts) repo. After following the [wiki setup](https://github.com/danner26/BunnyAPI/wiki/Setup-Install-Guide), you are set to use the API!
### Current API locations
| BunnyScript | API Base (Port+Path) | Individual API Path | Full API Path |
| ----------------- | -------------------- | ------------------- | -------------------------------------------------- |
| ChromeCreds | 4001 + /chrome | /submitChromeCreds | http(s)://domain.tld:4001/chrome/submitChromeCreds |
## License
`BunnyAPI` is licensed under the GNU GENERAL PUBLIC LICENSE v3.0. (https://opensource.org/licenses/GPL-3.0)
## Code of Conduct
This project and everyone participating in it is governed by the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [daniel.anner@danstechsupport.com](mailto:daniel.anner@danstechsupport.com).
## Contributing
Pull requests are the way to go here. We only have two rules for submitting a pull request: match the naming convention (camelCase) and any other styling set hereon.
## LGTM/Codacy/Code Factor
[](https://lgtm.com/projects/g/danner26/BunnyAPI/alerts/)
[](https://lgtm.com/projects/g/danner26/BunnyAPI/context:javascript)
[](https://www.codacy.com/app/danner26/BunnyAPI?utm_source=github.com&utm_medium=referral&utm_content=danner26/BunnyAPI&utm_campaign=Badge_Grade)
[](https://www.codefactor.io/repository/github/danner26/bunnyapi)
## Disclaimer
This repository is for education and research purposes only. Anything provided by this repo is to be used with your own responsibility, as we do not assume any responsibility for damages to any party. By cloning, copying, or using anything in this repository, you accept any and all responsability and liability. Please be careful and think.