setInstanceState - Hyperion

An instance represents an LED hardware instance/device. It runs within its own scope with its own plugin settings, LED layout and calibration.
You can start & stop instances. Before selecting an instance, you should first get information about the available instances via serverinfo.

curl --location -g --request POST 'https://localhost:8092/json-rpc/instance/state' \ --header 'Content-Type: application/json' \ --data-raw '{ "command": "instance", "subcommand": "startInstance", "instance": 1, "tan": 4711 }'

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

command

enum<string>

required

The type of command to execute.

Allowed value:

instance

subcommand

enum<string>

required

The type of sub-command to execute.

Allowed values:

startInstancestopInstance

instance

integer

required

Instance index (0-254) to which the command applies.

>= 0<= 254

tan

integer

optional

Transaction number for tracking requests and responses.

>= 0

Example:

4711

Examples

Responses

🟢200Success

application/json

Body

command

string

required

The command executed

subcommand

string

optional

The sub-command executed

success

boolean

required

Result, if the request excuted successfully

info

object

optional

Information requested

Additional properties

integer | number | string | boolean

optional

error

string

optional

Reason why a request did not execute successfully

errorData

array [object {1}]

optional

Detailed error explaination

description

string

optional

tan

integer

required

Request's transaction number