API Reference

Prelude TE exposes a REST API for managing BGP peers, inspecting the live topology graph, configuring outputs, and probing service health.

This section is structured as per-resource guides plus a downloadable Bruno collection you can run against your engine.

• The per-resource pages below explain when to use each endpoint, common pitfalls, and worked examples with the expected request and response shapes.
• The Bruno collection ships every endpoint in a ready-to-run client — point it at your engine, drop in your API token, and run.

Per-resource guides

• Authentication — obtain a token and verify it works against an authenticated endpoint.
• BGP Peers — list, create, update, and delete the peers that feed BGP-LS NLRIs into the engine.
• Topology — read the consolidated graph: stats, per-domain export, individual nodes and links.
• Outputs — manage the downstream connectors that stream topology changes to consumers (NATS today).
• Health — public health snapshot and Bearer-protected Prometheus metrics endpoint.
• Bruno collection — download a ready-to-run client for the whole API.