CyberVault Documentation

# ~/.cybervault/config.yaml

global:
  api_key: cv_prod_xxxxxxxxxxxxxxxx
  region: us-east-1
  log_level: info  # debug | info | warn | error

threat_detection:
  enabled: true
  mode: auto  # auto | manual | passive
  sensitivity: high  # low | medium | high | critical
  ai_model: cv-threatnet-v3
  rules:
    custom_rules_path: ./rules/
    default_deny: true

monitoring:
  metrics_port: 9090
  profiling_port: 6060
  alerting:
    channels:
      - type: email
        recipients: [soc@company.com]
      - type: webhook
        url: https://hooks.example.com/cybervault

response:
  auto_contain: true
  auto_block: true
  response_team: soc-team-a
  escalation_timeout: 5m

pip install cybervault
# Or with extras for async support
pip install "cybervault[async]"

from cybervault import CyberVaultClient
from cybervault.exceptions import CyberVaultError

# Initialize the client
client = CyberVaultClient(
    api_key="cv_prod_xxxxxxxxxxxxxxxx",
    region="us-east-1",
    log_level="info"
)

# Authenticate
client.auth.login()

# Fetch critical threats
threats = client.threats.list(
    severity="critical",
    status="active",
    per_page=50
)

for threat in threats:
    print(f"[THR-{threat.severity.upper()}] {threat.title}\n")
    print(f"  MITRE: {threat.mitre_attack.tactic} — {threat.mitre_attack.name}\n")
    print(f"  Confidence: {threat.confidence:.1%}\n")

# Respond to a threat
client.threats.respond(
    threat_id="thr_9f8e7d6c5b4a3",
    action="isolate",
    note="Automated response — ransomware containment"
)

# List all endpoints covered by monitoring
endpoints = client.list_endpoints(
    status="healthy",
    tags=["production", "critical-infra"]
)

# Async usage
import asyncio
from cybervault import AsyncCyberVaultClient

async def main():
    client = AsyncCyberVaultClient(api_key="cv_prod_xxxxx")
    await client.auth.login()
    threats = await client.threats.list(severity="critical")
    await client.close()

asyncio.run(main())

try:
    threats = client.threats.list(severity="critical")
except AuthenticationError as e:
    print(f"Auth failed: {e}")
except RateLimitError as e:
    print(f"Rate limited. Retry after {e.retry_after} seconds")
except CyberVaultError as e:
    print(f"API Error {e.status_code}: {e.message}")

# Response headers include rate limit info
X-RateLimit-Limit: 600
X-RateLimit-Remaining: 547
X-RateLimit-Reset: 1737033600  # Unix timestamp
Retry-After: 30  # Only on 429 responses

# Helm deployment
# Add the CyberVault Helm repository
helm repo add cybervault https://charts.cybervault.io
helm repo update

# Install with custom values
helm install cybervault cybervault/cybervault \
  -f values.yaml \
  -n cybervault \
  --create-namespace

# values.yaml
replicaCount: 3

threatEngine:
  ai_model: cv-threatnet-v3
  sensitivity: high
  max_workers: 8

ingress:
  enabled: true
  hosts:
    - cybervault.internal
  tls:
    secretName: cv-tls-cert

autoscaling:
  enabled: true
  minReplicas: 3
  maxReplicas: 20
  targetCPUUtilization: 75

resources:
  requests:
    cpu: "2000m"
    memory: "4Gi"
  limits:
    cpu: "4000m"
    memory: "8Gi"

# Enable compliance monitoring
cv compliance enable --framework soc2 --type II

# Run a compliance scan
cv compliance scan --framework iso27001

# Export audit report
cv compliance export --framework hipaa --format pdf \
  --output ./audit-reports/hipaa-2025-q1.pdf

# Enable debug logging
cv config set log_level = debug

# View real-time logs
cv logs --follow

# Export debug bundle for support
cv support debug-bundle --output ~/cybervault-debug.tar.gz