Skip to content

API-Only Features

Status: Current

Last reviewed: 2026-05-16

Some backend capabilities are intentionally not first-class console pages. They are documented here so reviewers and AI agents can discover the complete system surface.

Legacy Routes

API prefix: /api/routes

Legacy routes remain available for compatibility:

  • list routes.
  • create route.
  • get route.
  • update route.
  • delete route.
  • inspect route hops.

The current console workflow uses L4 Chains for L4 gateway configuration instead of the legacy route editor.

Node Config Push

API: POST /api/nodes/{id}/config

Required role: admin or operator

This endpoint refreshes the target agent with the current DB-backed runtime snapshot. Inline tcp_rules or upstreams payloads are rejected; update the stored L4/L3 resources first, then call this endpoint with an empty body for operational recovery or backend-driven refresh flows.

The normal console workflow is:

  • update node connectivity fields through backend/API paths.
  • deploy L4 chains or L3 tunnels through their deploy buttons.

Detailed generation, replay, rollback, apply report, and port conflict behavior is documented in Runtime Config Hot Reload.

Audit Revert

API: POST /api/audit/{id}/revert

Required role: admin

The endpoint exists, but current revert support is limited to legacy route resource name rollback. The console exposes audit diff inspection, not a revert button. Treat this as a compatibility/admin API until broader resource support is implemented.

Dashboard Stats

API: GET /api/dashboard/stats

The console uses this endpoint to populate dashboard KPIs. It is read-only and does not have a separate user workflow beyond the Dashboard.

NexusNet documentation