restoreConfiguration

Testing Env

https://{{host}}:8092

POST

/json-rpc/confog/restore

Restore a complete configuration.
A restore will replace the current configuration database with the provided configuration. Instances are created in the order presented in the "instances" array.
Hyperion will be restarted afterwards to get the new setup activated.

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 --location -g --request POST 'https://localhost:8092/json-rpc/confog/restore' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "command": "config",
    "subcommand": "restoreconfig",
    "config": {
        "global": {
            "settings": {
                "cecEvents": null,
                "effects": null,
                "flatbufServer": null,
                "forwarder": null,
                "framegrabber": null,
                "general": null,
                "grabberAudio": null,
                "grabberV4L2": null,
                "jsonServer": null,
                "logger": null,
                "network": null,
                "osEvents": null,
                "protoServer": null,
                "schedEvents": null,
                "webConfig": null
            },
            "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
        },
        "instanceIds": [
            0
        ],
        "instances": [
            {
                "enabled": true,
                "id": 0,
                "name": "string",
                "settings": {
                    "backgroundEffect": null,
                    "blackborderdetector": null,
                    "boblightServer": null,
                    "color": null,
                    "device": null,
                    "foregroundEffect": null,
                    "instCapture": null,
                    "ledConfig": null,
                    "leds": null,
                    "smoothing": null
                }
            }
        ]
    },
    "tan": 4711
}'

Response Example

{
    "command": "config-restoreconfig",
    "info": "Restarting after importing configuration successfully.",
    "success": true,
    "tan": 4711
}

Modified at 2025-05-18 17:37:05

updateConfiguration

getSchemas