HTTP API

Mosaic controllers provide an HTTP API to query and control the current project and the controller itself.

Authentication

Mosaic controllers have user accounts, each of which can belong to different security groups, which in turn control access to parts of the HTTP API. The HTTP API has a series of endpoints to allow clients to authenticate users with the controller.

API Versions

This API is available in several versions.

You can retrieve the API version in use by querying the api_version endpoint as described below.

The current API version is set as a property of the project.

Note

The ability to query the API version is available only in Designer version 2.12 and above.

GET

Returns the API version in use from the controller.

GET /api/api_version

Returns a JSON object with a single attribute, version, which is the integer version in use:

{
   "version": 8
}

Querying and Controlling

The endpoints provided in the HTTP API for querying and controlling the controller and its current project are detailed in the following sections:

• Beacon
• Channel / Park
• Cloud
• Command
• Config
• Content Targets
• Controller
• DALI
• DALI Interface
• Factory Reset
• Group
• Input
• Log
• Lua Variable
• Output
• Override
• Project
• Project File
• Protocol
• RDM Discovery
• RDM Get
• RDM Set
• Remote Device
• Replication
• Hardware Reset
• Scene
• System
• Temperature
• Text Slots
• Time
• Timeline
• Trigger
• User
• User Groups