Skip to content
Documentation Prelude Collector

You are viewing documentation for 1.0.0. This version is no longer maintained.

See the latest version →

Bruno collection

Download a ready-to-run Bruno collection covering every authenticated endpoint of the Prelude Collector REST API, with a single environment file for your collector 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 collector) before shipping. You can use the same workflow against your own deployment.

Download

Download collector-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/collector/<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 collector (e.g. https://collector.example.com),
    • apiToken to a valid bearer token (see Authentication).

The Example environment is intended for customer use. The Dev environment ships pointing at our internal dev collector and is not useful outside Arolo.

Run from the CLI

Bruno ships a headless runner you can drop into CI:

npm install -g @usebruno/cli
cd collector-bruno
bru run --env Example --env-var apiToken="$PRELUDE_TOKEN" \
        --env-var baseUrl="https://collector.example.com"

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 deliberately ships without scripts so the export round-trips.

What's covered

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

Folder Endpoints
01 Auth and Health ping, validate token, metrics, license
02 Devices list, create
03 Protocols create, test path, test CLI
04 Models list/get/create + fields, mappings, test, export, import
05 Subscriptions list/get/create/update + start/stop/restart
06 Snapshots device, model, force-refresh
07 Transforms create, get, update
08 Outputs detect, get, update, inject, metrics
09 SNMP Browser search MIBs, OID detail, walk
10 YANG Browser modules, search, deviations
11 Health system, all devices, single device, history, subscription

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.

Filtering by: