Hive Platform Integration¶
Integrate APHIDS CLI with the Hive platform for centralized management and reporting.
Overview¶
APHIDS CLI can operate in two modes: - Online Mode: Connected to Hive platform - Offline Mode: Standalone operation
Online Mode¶
Authentication¶
API Key Authentication:
export HIVE_API_KEY="your-api-key"
aphids-cli --api-key $HIVE_API_KEY --runbook web-scan --target-url https://example.com
Get your API key from Configuration → API Keys in the Hive platform.
Executing Runbooks¶
aphids-cli --api-key $API_KEY --runbook RUNBOOK_ID --target-url https://example.com --engagement ENGAGEMENT_ID
Executing Attack Trees¶
aphids-cli --api-key $API_KEY --attack-tree TREE_ID --target-url https://example.com --engagement ENGAGEMENT_ID
Result Synchronization¶
Results are automatically synced to the platform in real-time. View them in Automation Engine → Scan Executions.
Offline Mode¶
Configuration Files¶
Create options.yaml and config.yaml files to define your scan configuration. See Configuration Files for details.
Running Offline¶
Results are saved locally and can be imported to Hive later.
CI/CD Integration¶
Store your API key in your CI/CD secrets and run APHIDS CLI as part of your pipeline:
# Example: GitHub Actions
- name: Security Scan
run: aphids-cli --api-key ${{ secrets.HIVE_API_KEY }} --runbook RUNBOOK_ID --target-url $TARGET
API Integration¶
Use the REST API for programmatic access. See API Authentication for endpoint details.
Webhook Integration¶
Configure webhooks in Configuration → Webhooks to receive notifications for scan events (started, completed, failed, vulnerabilities found).
Best Practices¶
✅ Never commit API keys to version control
✅ Test integrations in staging first
✅ Rotate API keys regularly
✅ Monitor scan execution and results
Troubleshooting¶
Authentication fails: Verify API key is valid and not expired
Results not syncing: Check network connectivity and engagement ID
Slow performance: Reduce scan scope or check rate limits
Related: Configuration | Usage | Modules