Surfaces added in 1.3.0
Controller routes are served under
/v1. The published OpenAPI document
lists them spec-relative (/quantum/license/status), with the version in the
server base — so a path copied straight out of the spec intocurlreturns
404, not 401. The tables below give the full path. This is not hypothetical:
it is what shipped in the 1.3.0 console and why capacity licensing could not be
operated from it.
Three capabilities landed in 1.3.0 with an API surface an integrator will want.
Each appears twice: the controller route, and the QuantumTouch route the console
itself calls. Integrators may use either; the console's is the one guaranteed to
behave identically to what the UI does, because it is what the UI does.
Capacity licensing
| Purpose | Controller | QuantumTouch |
|---|---|---|
| Read the box's identity | GET /v1/quantum/license/fingerprint |
GET /api/bng/licensing/fingerprint |
| Install a signed licence | POST /v1/quantum/license/activate |
POST /api/bng/licensing/activate |
| Read the cap in force | GET /v1/quantum/license/status |
GET /api/bng/licensing/status |
The fingerprint identifies one specific box — a licence signed against it will not
activate on another. Activation is immediate and needs no restart.
The important property for an integrator is what happens when licensing is not
healthy. A missing, expired or tampered licence does not fail closed: the box
reverts to the free-tier cap and keeps forwarding. Licensing gates capacity, never
function, so status returning anything other than valid is not a reason to page
anyone — it is a reason to renew. Capacity activation requires a TPM 2.0 device;
the free tier requires neither a licence nor a TPM.
GET /bng/health reflects this: sessions.max carries the licensed cap when one
is active and the free-tier value otherwise. Read the cap from there rather than
assuming a constant.
Bulk local-AAA provisioning
| Purpose | Controller | QuantumTouch |
|---|---|---|
| Provision many lines | POST /v1/bng/aaa/local/subscribers/bulk |
POST /api/bng/aaa/local/subscribers/bulk-apply |
| Remove many lines | POST /v1/bng/aaa/local/subscribers/bulk_delete |
— |
| Dry-run a spreadsheet | — | POST /api/bng/aaa/local/subscribers/bulk-preview |
The single-line PUT .../subscribers/{line} still works and is unchanged. It is
the wrong tool above a handful of lines: each call serialises through the
controller, which held provisioning to roughly 2/s. The bulk endpoint restores
realistic 500–650 CPE/s.
The QuantumTouch side adds a preview step and an all-or-nothing result: an
import either lands completely or not at all, so a partial failure does not leave
the operator reconciling which rows took.
Usage records (local CDR)
| Purpose | Controller |
|---|---|
| Read a page of records | GET /v1/bng/accounting/records?limit=N |
| Acknowledge through a point | POST /v1/bng/accounting/records/ack — body {"through_seq": N} |
Durable per-subscriber usage for deployments that bill by usage without RADIUS.
Distinct from GET /bng/counters, which is a live gauge and resets; these persist.
The read returns records, next_seq and high_water. Acknowledgement is
explicit and takes the sequence you actually consumed — not the high-water
mark. A collector that acks the high-water mark after reading one page discards
everything between the page and the mark. Ack through the highest sequence you
have durably stored, then read again from next_seq.
through_seq is the required key; other spellings fail the controller's
request-body validation with a 400.
Marked a 1.3.0 preview: the record shape may still change before it is a stable
billing contract.