Hyperion

updateConfiguration

Testing Env

https://{{host}}:8092

POST

/json-rpc/config/update

WebsocketHTTP/S

Update configuration items.
Sets of configuration items can be given differentiating global ones and instance specific.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://localhost:8092/json-rpc/config/update' \
--header 'Content-Type: application/json' \
--data-raw '{
    "command": "config",
    "subcommand": "setconfig",
    "config": {
        "instances": [
            {
                "id": 1,
                "settings": {
                    "foregroundEffect": {
                        "color": [
                            0,
                            0,
                            255
                        ],
                        "duration_ms": 3000,
                        "effect": "Rainbow swirl fast",
                        "enable": true,
                        "type": "effect"
                    }
                }
            }
        ]
    },
    "tan": 4711
}'

Response Example

Success

{
    "command": "config-setconfig",
    "success": true,
    "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:

config

subcommand

enum<string>

required

The type of sub-command to execute.

Allowed value:

setconfig

config

object

required

global

object

optional

instances

array [object {2}]

optional

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

getConfiguration

restoreConfiguration