getConfiguration

Testing Env

https://{{host}}:8092

POST

/json-rpc/config

WebsocketHTTP/S

Get configuration items which are global or instance specific.
Sets of configuration items can be filtered by provided a list of configuration items to be returned.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://localhost:8092/json-rpc/config' \
--header 'Content-Type: application/json' \
--data-raw '{
    "command": "config",
    "subcommand": "getconfig",
    "tan": 4711
}'

Response Example

Success - Global filter

{
    "command": "config-getconfig",
    "info": {
        "global": {
            "settings": {
                "cecEvents": {
                    "actions": [
                        {
                            "action": "Suspend",
                            "event": "standby"
                        },
                        {
                            "action": "Resume",
                            "event": "set stream path"
                        }
                    ],
                    "enable": false
                },
                "general": {
                    "configVersion": "2.0.17-beta.3",
                    "name": "My Hyperion Config",
                    "showOptHelp": true,
                    "watchedVersionBranch": "Stable"
                }
            },
            "uuid": "ba85a700-65fe-51e8-97d5-a24dbf47c547"
        }
    },
    "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

Allowed value:

config

subcommand

enum<string>

required

Allowed value:

getconfig

configFilter

object

optional

global

object

optional

instances

object

optional

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 (completeConfiguration)

optional

Information requested

global

object

optional

instanceIds

array[integer]

optional

>= 0 items

instances

array [object {4}]

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

renameInstance

updateConfiguration