getServerInformation

Testing Env

https://{{host}}:8092

POST

/json-rpc/server

WebsocketHTTP/S

Retrieve basic information about the Hyperion server and the host it runs on. This information is static and won't change during runtime.

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

{
    "command": "sysinfo",
    "info": {
        "hyperion": {
            "build": "LordGrey-fca1bf35/7ba4644d-1744983554",
            "buildType": "Debug",
            "configDatabaseFile": "/home/thomas/hyperion.ng-lordgrey-test/test-beta2/db/hyperion.db",
            "gitremote": "https://github.com/Lord-Grey/hyperion.ng",
            "id": "ba85a700-65fe-51e8-97d5-a24dbf47c547",
            "isGuiMode": true,
            "readOnlyMode": false,
            "time": "Apr 22 2025 11:17:41",
            "version": "2.0.17-beta.3"
        },
        "system": {
            "architecture": "x86_64",
            "cpuHardware": "",
            "cpuModelName": "Intel(R) Core(TM) i9-14900K",
            "cpuModelType": "183",
            "cpuRevision": "",
            "domainName": "speedport.ip",
            "hostName": "ubuntu2404",
            "isUserAdmin": false,
            "kernelType": "linux",
            "kernelVersion": "6.8.0-58-generic",
            "prettyName": "Ubuntu 24.04.2 LTS",
            "productType": "ubuntu",
            "productVersion": "24.04",
            "pyVersion": "3.12.3",
            "qtVersion": "6.9.0",
            "wordSize": "64"
        }
    },
    "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:

sysinfo

tan

integer

optional

Transaction number for tracking requests and responses.

>= 0

Example:

4711

Examples

Responses

🟢200Success

application/json

Body

object {0}

getSubscriptionInformation

getImageSnapshot