Integration Commands¶

Commands for integrating Faraday with external services and data platforms.

ingest¶

Import vulnerabilities from one or all Faraday workspaces into an Elasticsearch index. This command enables centralized vulnerability analytics, dashboards (e.g., Kibana), and cross-workspace search.

Note: This command was previously undocumented. It has been available since it was added to the community codebase.

faraday-manage ingest [OPTIONS]

Prerequisites¶

1. ELK settings must be enabled and configured — Run faraday-manage settings -a update elk first. See [[settings-reference#elk]] for details.
2. Elasticsearch must be reachable — Test with faraday-manage ingest --test-connection

Options¶

Behavior¶

1. Reads ELK settings from the database (configured via faraday-manage settings -a update elk)
2. If ELK is not enabled, prints an error and exits
3. Connects to Elasticsearch using the configured credentials
4. Uses http_auth for Elasticsearch Python client < 8
5. Uses basic_auth for Elasticsearch Python client >= 8
6. SSL certificate verification is disabled (verify_certs=False)
7. If --test-connection: tests the connection and exits
8. Queries the specified workspace(s) for vulnerabilities, applying optional filters
9. Serializes each vulnerability using VulnerabilitySchema
10. Adds metadata: workspace name, ingest_timestamp, optional extra tags
11. Bulk-inserts documents into the Elasticsearch index (5000 per batch)

Examples¶

# Step 1: Configure ELK settings
faraday-manage settings -a update elk --data '{
  "enabled": true,
  "username": "elastic",
  "password": "changeme",
  "host": "https://elasticsearch.local",
  "port": 9200,
  "ignore_ssl": false
}'

# Step 2: Test the connection
faraday-manage ingest --test-connection

# Step 3: Ingest from a single workspace
faraday-manage ingest -w my-pentest-project

# Ingest from all workspaces
faraday-manage ingest --all-workspaces

# Ingest only recent vulnerabilities (updated since a date)
faraday-manage ingest -w my-project -d "2026-01-01"

# Ingest a range of vulnerability IDs
faraday-manage ingest -w my-project -f 1000 -t 2000

# Ingest with a custom index name and extra tags
faraday-manage ingest --all-workspaces -i faraday-prod -x "quarterly-audit"

# Ingest with workspace rename (useful for consolidation)
faraday-manage ingest -w old-project-name -r new-project-name

Output¶

Working on workspace my-project ...
Processing vulnerabilities ...
Current offset is 0 / Count 1523 ...
Current offset is 5000 / Count 1523 ...

Common Errors¶

Elasticsearch Document Schema¶

Each imported vulnerability produces an Elasticsearch document with these key fields: