Channel / Park

Note

The endpoints listed on this page require a project to be loaded on the controller.

Methods

POST

Park an output channel or channels at a specified level.

POST /api/channel

Payload is a JSON object with the following attributes:

Attribute	Value Type	Description	Value Example
universe	string	See Universe Key String Format	"dmx:1"
channels	string	Comma separated list of channel numbers.	"1-3,5"
level	integer	Level to set the channel(s) to: 0-255.	128

DELETE

Unpark an output channel or channels.

DELETE /api/channel

Payload is a JSON object with the following attributes:

Attribute	Value Type	Description	Value Example
universe	string	See Universe Key String Format	"dmx:1"
channels	string	Comma separated list of channel numbers.	"1-3,5"

Universe Key String Format

A universe key string takes the form:

• protocol:index where:

  • protocol is dmx, sacn, or art-net;

  • index is the index of the output port, 1 or 2, matching the port on the Express controller.

For example:

• "dmx:1" refers to port 1 on the Express Controller