Skip to content
Documentation Prelude Topology Engine 1.0.0

bruno/README

This folder is a Bruno collection that documents the public Prelude TE REST API. Every request is annotated with usage notes, body schema, and expected status codes.

The endpoints documented here mirror the OpenAPI spec available at /api/swagger/index.html on any running Prelude TE instance.

Layout

.
├── bruno.json              # Collection manifest
├── collection.bru          # Collection-wide auth + docs
├── environments/
│   ├── example.bru         # Copy to local.bru and fill in your token
│   └── local.bru           # Your local config (not shipped)
├── Health/                 # /api/health, /api/health/metrics
├── BGP Peers/              # CRUD on /api/bgp/peers
├── Outputs/                # CRUD on /api/outputs
└── Topology/               # Read-only /api/topology endpoints

Each CRUD folder creates a resource, chains its ID via a Bruno variable, exercises read / update, and deletes the resource at the end — running the folder leaves the server in its original state.

Getting started

  1. Install Bruno: https://www.usebruno.com/downloads
  2. File → Open Collection and point it at this folder.
  3. Generate a personal API token from the Prelude TE UI: Settings → API Tokens → Create.
  4. Copy environments/example.bru to environments/local.bru and paste your token into the token variable.
  5. Select the local environment in the top-right.
  6. Open any request — its body, query parameters, and expected responses are documented under the Docs tab.

Authentication

All endpoints except GET /api/health require a Bearer token:

Authorization: Bearer <your-api-token>

Tokens are managed in the Prelude TE UI under Settings → API Tokens. A token inherits the permissions of the user that generated it.

Self-signed TLS

Local Prelude TE installs typically use a self-signed certificate. Bruno honors the per-collection SSL/TLS Certificate Verification setting (settings.sslVerification: false in bruno.json) so this works out of the box. If you run requests against a different host that fails the verification, toggle the option in Collection Settings → Proxy.

Filtering by: