HTTP API

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

Authentication

Pharos 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.

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": 12
}

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
• Config
• Controller
• Factory Reset
• Fixtures
• Input
• Log
• Mode Switch
• Output
• Override
• Project
• Protocol
• Ping
• Playback Group
• RDM Devices
• Hardware Reset
• Scene
• Schedule
• Space
• Status Monitor
• System
• Tag Set
• Time
• User
• User Groups