Dark Web and Threat Exposure Test: API Documentation
The ImmuniWeb® Community Edition also provides a premium account status to run increased number of tests for a monthly fee. The premium status also unlocks full technical details in the reports (if applicable), allows to download the full data in PDF format and provides an API key that unlocks API's full functionality. For more information, please refer to the Monthly Limits tab.
Dark Web and Threat Exposure Test: CI/CD
Overview
Dark Web and Threat Exposure Test can be seamlessly integrated into your CI/CD pipeline to automatically test your domain’s exposure on the Dark Web. You can use a Docker image or a Python script as described below.
Installing Python Script
Create virtual environment and install dependencies. Python >= 3.7 required.
python3 -m venv env
source ./env/bin/activate
pip install -r requirements.txt
Using Python Script or Docker Container
Check your company’s data leaks on Dark Web and get your cyber threat exposure report.
You can specify option -p, --pipeline to compare a test result you get with pre-determined values in the configuration file in the iwtools/config directory. The result of the comparison can be viewed in the Exit Code of the script.
By default, iwtools uses the configuration file iwtools/config/radar.yaml. You can change the values in the default file, or use your own one. The path to the custom configuration file is specified with -cfg option.
If you're using Docker, in order to use a custom configuration file, you need to mount volume, which will contain the new file. If the name of the configuration file is different from the default config/radar.yaml one, then you need to specify the new name via the -cfg config/{new-file-name} parameter.
In the console log, you will be able to see which of your desired checks have passed or failed.
Currently only yaml and json formats are supported. List of parameters that can be configured.
One of these Exit Codes can be returned:
- 0 - all checks have passed successfully.
- 1 - an error occured.
- 2 - an error occured in the input data.
- 3 - at least one of the checks has failed.
Check other command line options here.
