setInstanceState

Testing Env

https://{{host}}:8092

POST

/json-rpc/instance/state

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.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

cURL

StartStop

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

Response Example

Success

{
    "command": "instance-startInstance",
    "success": true,
    "tan": 4711
}

Modified at 2025-05-18 17:32:03

setComponentState

switchInstance