setSubscriptions

Testing Env

https://{{host}}:8092

POST

/json-rpc/system/subscriptions/subscribe

Websocket

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 Example

Shell

JavaScript

Java

Swift

cURL

Info & SubscribeSubscribe AllUnsubscribeUnsubscribe all

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 Example

Success

Caller subscribed sucessfully to given events

{
    "command": "serverinfo-subscribe",
    "info": {},
    "success": true,
    "tan": 4711
}

Request

Body Params application/json

command

enum<string>

required

The type of command to execute.

Allowed value:

serverinfo

subcommand

enum<string>

required

The type of sub-command to execute.

Allowed values:

subscribeunsubscribe

instance

integer

optional

Instance index (0-254) to which the command applies.

>= 0<= 254

array[string]

required

An empty list is applied to all subscriptions

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

Modified at 2025-05-18 14:30:34

setSystemState

createInstance