Hyperion
  1. Operational Controls
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
          POST
        • setInstanceState
          POST
        • switchInstance
          POST
        • setSystemState
          POST
        • setSubscriptions
          POST
    • Configuration
      • createInstance
      • deleteInstance
      • renameInstance
      • getConfiguration
      • updateConfiguration
      • restoreConfiguration
      • getSchemas
  1. Operational Controls

setSubscriptions

Testing Env
https://{{host}}:8092
Testing Env
https://{{host}}:8092
POST
/json-rpc/system/subscriptions/subscribe
During a serverinfo request the caller can optionally subscribe to updates, either to specific parts or all available data.
These updates will be pushed whenever a server-side data change occurs, without the need for the caller to poll.
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location -g --request POST 'https://localhost:8092/json-rpc/system/subscriptions/subscribe' \
--header 'Content-Type: application/json' \
--data-raw '{
    "command": "serverinfo",
    "subscribe": [
        "components-update"
    ],
    "tan": 4711
}'
Response Response Example
Success
Caller subscribed sucessfully to given events
{
    "command": "serverinfo-subscribe",
    "info": {},
    "success": true,
    "tan": 4711
}

Request

Body Params application/json

Examples

Responses

🟢200Success
application/json
Body

Modified at 2025-05-18 14:30:34
Previous
setSystemState
Next
createInstance
Built with