Tool integration

Faraday Integration Guide

Multi-user pentest IDE with Docker deployment and a REST API for vulnerability export

Get a Free API Key

Integrate Faraday with Vulnetix. Deploy Faraday via Docker Compose, collect findings from your pentest team, and export vulnerabilities via the REST API for upload to Vulnetix.

SaaS platformJSON

Install & scan

$ docker compose up -d
$ # Authenticate and get token
FARADAY_URL="http://localhost:5985"
TOKEN=$(curl -s -X POST "${FARADAY_URL}/_api/v3/login"   -H 'Content-Type: application/json'   -d '{"email":"admin@example.com","password":"changeme"}' | jq -r '.response.data.token')

# Export all vulnerabilities from a workspace
curl -s "${FARADAY_URL}/_api/v3/ws/my_engagement/vulns"   -H "Authorization: Token ${TOKEN}" | jq '.vulnerabilities' > faraday-vulns.json

Run Faraday in CI

Scan on every push and upload the results to Vulnetix:

- name: Export Faraday vulnerabilities
  env:
    FARADAY_URL: ${{ secrets.FARADAY_URL }}
    FARADAY_EMAIL: ${{ secrets.FARADAY_EMAIL }}
    FARADAY_PASS: ${{ secrets.FARADAY_PASS }}
    WORKSPACE: ${{ secrets.FARADAY_WORKSPACE }}
  run: |
    TOKEN=$(curl -s -X POST "$FARADAY_URL/_api/v3/login"       -H 'Content-Type: application/json'       -d "{"email":"$FARADAY_EMAIL","password":"$FARADAY_PASS"}" | jq -r '.response.data.token')
    curl -s "$FARADAY_URL/_api/v3/ws/$WORKSPACE/vulns"       -H "Authorization: Token $TOKEN" | jq '.vulnerabilities' > faraday-vulns.json

- name: Upload to Vulnetix
  run: vulnetix upload --file faraday-vulns.json

Centralise Faraday results in Vulnetix

Upload Faraday JSON output to the Vulnetix platform to deduplicate findings, prioritise them with EPSS, CISA KEV and Coalition ESS exploit intelligence, and track remediation across every scanner in a single queue.

Faraday documentation ↗  ·  Source repository ↗

Wire Faraday into your CI/CD pipeline →