API Reference

The Prelude Collector exposes a REST API for managing the entire collection lifecycle: devices, protocols, models, mappings, transforms, subscriptions, outputs, and snapshots.

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

• 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 collector, drop in your API token, and run.

Per-resource guides

• Authentication - obtain a token and verify it works
• Devices - register and manage the network elements you collect from
• Protocols - attach gNMI, SNMP, NETCONF, or CLI to a device
• Models - describe what to collect; fields, mappings, test, import/export
• Subscriptions - bind a device to a model at a polling interval
• Snapshots - read the latest collected state per device and model
• Transforms - reshape values on the way out (Mbps, units, mappings)
• Outputs - configure InfluxDB, Prometheus, Kafka, NATS, webhook, file
• SNMP Browser - search the MIB catalog and walk OIDs on a device
• YANG Browser - browse module trees and check device deviations
• Health - system, device, and subscription health for dashboards
• Bruno collection - download a ready-to-run client for the whole API