Hyperion
  1. Configuration
Hyperion
  • JSON-RPC API Introduction
  • JSON-API Commands Overview
  • Connect to Hyperion
  • Components & Priorities
  • Hyperion API
    • Authorization
      • API Authentication - Introduction
      • createToken
      • renameToken
      • deleteToken
      • getTokenlist
      • tokenRequired
      • adminRequired
      • newPasswordRequired
      • requestToken
      • newPassword
      • answerRequest
      • getPendingTokenRequests
      • login
      • logout
    • Information
      • getSystemInformation
      • getSubscriptionInformation
      • getServerInformation
      • getImageSnapshot
      • getLedsSnapshot
    • Controls
      • Input Controls
        • setColor
        • setEffect
        • setImage
        • clear
        • clearAll
        • selectSource
      • Output Controls
        • adjustColors
        • setLedMapping
        • setVideomode
      • Subscription Controls
        • liveImageStream
        • liveLedColorStream
      • Operational Controls
        • setComponentState
        • setInstanceState
        • switchInstance
        • setSystemState
        • setSubscriptions
    • Configuration
      • createInstance
        POST
      • deleteInstance
        POST
      • renameInstance
        POST
      • getConfiguration
        POST
      • updateConfiguration
        POST
      • restoreConfiguration
        POST
      • getSchemas
        POST
  1. Configuration

updateConfiguration

Testing Env
https://{{host}}:8092
Testing Env
https://{{host}}:8092
POST
/json-rpc/config/update
Update configuration items.
Sets of configuration items can be given differentiating global ones and instance specific.

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 Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://localhost:8092/json-rpc/config/update' \
--header 'Authorization: Bearer <token>' \
--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 Response Example
Success
{
    "command": "config-setconfig",
    "success": true,
    "tan": 4711
}
Modified at 2025-05-18 17:25:11
Previous
getConfiguration
Next
restoreConfiguration
Built with