Skip to Content

API

Lynx API — Base bridge

Exposes lynx_base configuration models over the Lynx REST API.

Talk to sales See pricing

lynx_api_base · v19.0.1.0.0 · Premium

What this solves

Lynx API — Base bridge

The simplest possible Lynx API bridge — pure declarative XML, no Python, no controller code. Demonstrates the bridge pattern that all other Lynx modules follow.

Bridges free-tier lynx_base models so customers with a Lynx Premium subscription can manage platform configuration over REST. The legacy public widget endpoint at /lynx/api/website/colors is left untouched — it stays free and unauthenticated for the website asset loader.

Key Features

  • `/lynx/api/v1/lynx-configuration` — read and update the singleton Lynx platform configuration (brand colours, support contact, password policy) via the generic CRUD dispatcher.

  • Zero Python — registration is a single data/lynx_api_resources.xml file. The pattern other bridges should follow when they have no custom verbs.

  • Premium-gated — auto-installs alongside lynx_api and inherits the api.access premium feature gate; uninstalling the API framework cleanly removes the bridge.

Auto-Installation

This bridge is auto_install=True so it activates automatically as soon as both lynx_api and lynx_base are present in the database. There is no value in installing one without the other — the bridge is the productized exposure of lynx_base configuration over the API surface — so co-installation is the only useful state.

Depends on

lynx_license_enforcer lynx_base lynx_api

Try Lynx API — Base bridge on your team.

Free trial, no credit card. Talk to sales when you're ready.

Start free trial Browse all modules