Installation
You can installed pre-built binaries of VulnAPI on Linux, Windows, and MacOS.
Below are the instructions to install VulnAPI on Linux, Windows, MacOS, and Docker. You can choose the installation method that best suits your needs and environment.
Linux
Snap
You can install VulnAPI on Linux using Snap (opens in a new tab).
sudo snap install vulnapi
APT
Download the latest VulnAPI release (opens in a new tab) and install it using dpkg
.
sudo dpkg -i vulnapi.deb
RPM
Download the latest VulnAPI release (opens in a new tab) and install it using dpkg
.
sudo rpm -i vulnapi.rpm
Other
You can install VulnAPI on Linux by downloading the latest VulnAPI release (opens in a new tab) and extracting the contents of the ZIP file. After extracting the contents, run the vulnapi
binary from the command line.
Windows
Chocolatey
You can install VulnAPI on Windows using Chocolatey (opens in a new tab).
choco install vulnapi
You can also install VulnAPI on Windows by downloading the latest VulnAPI release (opens in a new tab) and extracting the contents of the ZIP file. After extracting the contents, you can run the vulnapi.exe
binary from the command line.
MacOS (Homebrew)
You can install VulnAPI on MacOS using Homebrew. To do so, run the following command:
brew tap cerberauth/vulnapi https://github.com/cerberauth/vulnapi
brew install $(brew --repository cerberauth/vulnapi)/vulnapi.rb
Docker
You can also use VulnAPI as a Docker container with VulnaAPI Docker Image (opens in a new tab). To do so, run the following command:
docker run --rm cerberauth/vulnapi scan curl [API_URL] [CURL_OPTIONS]
GitHub Action
VulnAPI can be integrated into your CI/CD pipeline using GitHub Actions. Integrating VulnAPI with GitHub Actions enables you to scan your APIs for vulnerabilities and security risks as part of your CI/CD pipeline. This allows you to automate security testing and vulnerability scanning of your APIs as part of your development workflow, ensuring that your APIs are secure and free from vulnerabilities before they are deployed to production.