Skip to content
Documentation Prelude Topology Engine 1.0.0

Bruno collection

Download a ready-to-run Bruno collection covering every authenticated endpoint of the Prelude TE REST API, with a single environment file for your engine URL and token.

Every endpoint documented under the API section is also packaged as a Bruno collection. Bruno is an open-source API client whose collections are plain text files in git, so the same collection runs in the desktop app, on the CLI, and inside CI.

The collection is the source of truth we run against each release — if a request 404s or 405s here, we fix the docs (or the engine) before shipping. You can use the same workflow against your own deployment.

Download

Download topology-engine-latest-bruno.zip

The zip is committed alongside the docs of each release, so the collection you download always matches the version of the documentation you are reading. Older versions, when published, will live under /docs/topology-engine/<version>/bruno.zip.

Open in Bruno (desktop)

  1. Unzip the archive.
  2. Launch Bruno.
  3. Collections → Open Collection and pick the unzipped folder.
  4. Top-right environment selector → pick example, then click the gear icon and set:
    • baseUrl to your engine (e.g. https://te.example.com),
    • token to a valid Bearer token (see Authentication).

The example environment is intended for customer use. Make a copy as local.bru to keep your secret out of git — the collection's .gitignore excludes environments/local.bru for exactly that reason.

Run from the CLI

Bruno ships a headless runner you can drop into CI:

npm install -g @usebruno/cli
cd topology-engine-bruno
bru run --env example \
        --env-var token="$PRELUDE_TE_TOKEN" \
        --env-var baseUrl="https://te.example.com"

The CRUD folders create a resource, chain its id through the read/update requests, and delete the resource at the end — running the collection leaves your engine in its original state.

Exit code is non-zero if any request fails an assertion. Pair it with --reporter-html to publish a per-release validation report.

Use in Postman

Bruno can export to Postman v2.1 collection JSON: in the desktop app, right-click the collection → Export → Postman Collection. Plain requests, headers, body, and environment variables convert cleanly; Bruno-specific scripting does not, but this collection keeps scripts to the minimum needed to chain IDs across the CRUD folders, so most consumers will only need to fix up the variable plumbing on the Postman side.

What's covered

The collection mirrors the curl examples in the API reference, grouped by resource:

Folder Endpoints
Health snapshot (public), Prometheus metrics
BGP Peers list, create, get, update, delete
Outputs list, create, get, update, delete
Topology stats, all domains, single domain, get node, get link

For the full request schema of any endpoint, follow the link from the matching page in the API reference — those pages stay authoritative for response shapes, error codes, and edge cases.

Self-signed TLS

Local Prelude TE installs typically use a self-signed certificate. The collection ships with sslVerification: false in bruno.json so this works out of the box. Toggle it back on in Collection Settings → Proxy before running against a public deployment.

Filtering by: