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
  • Schemas
    • Default Folder
    • request
    • response
    • notification
    • instance - multiple
    • instance - single
    • tan
    • priorityParameters
    • imageDetails
    • completeConfiguration
  1. Operational Controls

setComponentState

Testing Env
https://{{host}}:8092
Testing Env
https://{{host}}:8092
POST
/json-rpc/component
Enable or disable selected components at runtime. To get the current state and available components see getSystemInformation and or Components

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
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location --globoff 'https://localhost:8092/json-rpc/component' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "command": "componentstate",
    "instance": [
        0
    ],
    "componentstate": {
        "component": "LEDDEVICE",
        "state": false
    },
    "tan": 4711
}'
Response Response Example
Success
{
    "command": "componentstate",
    "success": true,
    "tan": 4711
}
Modified at 2026-05-04 19:30:02
Previous
liveLedColorStream
Next
setInstanceState
Built with