Authoritative reference

The payloads in this document are representative and correct in structure. For
request and response shapes at field-level precision, the interactive API
browser served at /api-docs on every box is generated from the running code
and is the authoritative source. The machine-readable metric registry, exposing
each family's type, labels, unit, source, and introducing version, is served from
the versioned analytics surface and is the authoritative reference for anything
scraped from /metrics.

Summary

QuantumTouch presents the BlueDot BNG's operational plane through a single
authenticated REST interface, served over HTTPS on one port, under one credential
model, alongside a transparent passthrough to the raw subscriber telemetry
documented in the companion reference. One API key against one host reaches both
planes.

Where the telemetry API answers what are the subscribers doing, this interface
answers how is the node operating and what has been done to it. It composes
health from the controller, the data plane, the platform, and its own reply-path
detector into a single alarming verdict that remains meaningful even when the
controller is unreachable. It retains time series in a dual store — Prometheus
for history, an in-process ring buffer as standby and as the permanent owner of
per-subscriber series — and reports which store answered rather than hiding the
distinction. It models events as incidents with a sticky lifecycle and explicit
acknowledgement, so a condition that recovers unobserved is not lost. It merges
four independent evidence sources into one normalised audit timeline, resolves
opaque session identifiers to real operator names, and ships that record onward
to a SIEM with per-destination spooling and retry. It captures, hashes, diffs,
and restores complete node configuration with dry-run planning, per-step
reporting, and concurrency locking. And it makes credential lifecycle itself an
API, so provisioning, scoping, rotation, and revocation are scripted operations.

The property that ties it together is parity. The QuantumTouch web interface is
an ordinary client of these endpoints and holds no privileged path. Everything an
operator can see or do through the product, an integrator can see or do through
the API — which means an NMS integration, an automation pipeline, or a
custom operations portal is not working around the management plane but building
on the same foundation the management plane is built on.