Local API - AwareXone Docs

The Security Intelligence API wraps AXguard engines in a local FastAPI service for your own tooling, CI helpers, and integrations.

pip install -e '.[api]'
axguard api start
# → http://127.0.0.1:8787
# → http://127.0.0.1:8787/openapi.json

Principles

Mode	Meaning
`no-llm` (default)	Deterministic engines only
`local`	Ollama / OpenAI-compatible local endpoint
`user_key` / BYOK	Your cloud key — you provide it

No AwareXone account, hosted inference, or required cloud is part of the product.

Surface (high level)

Live contract is OpenAPI on the running server. Categories include:

Health / version / projects
Scans and findings (+ evidence, confidence)
Flows, attack paths, predictive risks
Twin, memory, investigations, reviews
Reports and security posture

POST /v1/projects/{project_id}/security-diff is experimental / partial. There is no axguard diff CLI. See Security Diff.

Binding

Default bind is localhost. Treat exposure beyond 127.0.0.1 as your operational risk — follow API security notes in the upstream repo (docs/api/).