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

setInstanceState

Testing Env
https://{{host}}:8092
Testing Env
https://{{host}}:8092
POST
/json-rpc/instance/state
WebsocketHTTP/S
An instance represents an LED hardware instance/device. It runs within its own scope with its own plugin settings, LED layout and calibration.
You can start & stop instances. Before selecting an instance, you should first get information about the available instances via serverinfo.
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location -g --request POST 'https://localhost:8092/json-rpc/instance/state' \
--header 'Content-Type: application/json' \
--data-raw '{
    "command": "instance",
    "subcommand": "startInstance",
    "instance": 1,
    "tan": 4711
}'
Response Response Example
Success
{
    "command": "instance-startInstance",
    "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:
instance
subcommand
enum<string> 
required
The type of sub-command to execute.
Allowed values:
startInstancestopInstance
instance
integer 
required
Instance index (0-254) to which the command applies.
>= 0<= 254
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
Previous
setComponentState
Next
switchInstance
Built with