This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

API

Integrator entry points for Maxx Remote — REST, operator VIEW, and signal-path URLs.

Maxx Remote exposes a few user-facing integration surfaces. This section stays thin on purpose: the live OpenAPI document on a running system is the contract for REST calls.

Entry pointTypical use
REST APIThird-party control (media controllers, show control)
View APIFullscreen operator pages at /view/
Group signal pathScoped SIG-PATH page for one group

OpenAPI UI on a running host: http://localhost:8000/api-docs/ (also linked from HOME → REST-API Doc).

1 - REST API

HTTP API for controlling Maxx Remote from third-party systems.

Goal / when to use

Drive day-to-day control (levels, mutes, selections) from a media controller or similar. Prefer this over scraping the GUI.

Where is the full reference?

Each Maxx Remote instance ships OpenAPI docs:

That document is authoritative for paths, payloads, and versions.

Scope

Compared with Maxx Control’s device REST API, this API targets the Maxx Remote project/server — operator-oriented control of the system Maxx Remote manages, not low-level single-device setup.

2 - Maxx Remote View API

Maxx Remote View API: open a saved VIEW as a standalone operator web page at http://:8000/view/ (tablet / kiosk).

The Maxx Remote View API exposes a saved VIEW as a standalone operator page — without the Maxx Remote editor chrome. Operator URLs use the /view/ path (also called the View API).

What is the Maxx Remote View API?

Use it when you want tablets or dedicated operator PCs to show only the mute / volume / meter widgets you placed in VIEW, not the full project editor.

How do I open a VIEW operator page at /view/?

  1. In VIEW, create and SAVE a page.
  2. Copy the operator Link from the editor toolbox.
  3. Open URLs of the form:

http://<server>:8000/view/<view-name>

(Exact name encoding matches what the UI copies.)

Expected result

Fullscreen operator canvas with the mute / volume / meter widgets you placed.

3 - Group signal path

Maxx Remote group signal-path API — open the SIG-PATH view scoped to one group via URL.

Goal / when to use

Embed or bookmark a SIG-PATH page for one room/group — useful on a monitoring wall.

URL pattern

Groups are addressed by their internal id (UUID), for example:

http://<server>:8000/group-signal-path/<group-uuid>

Example:

http://localhost:8000/group-signal-path/36875a19-8203-4647-9760-303ffd3c8f8f

Obtain the group id from your project/export or integrator tooling — it is not the display name.