Hyperion

login

Testing Env

https://{{host}}:8092

POST

/json-rpc/authorize/login

Websocket

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://localhost:8092/json-rpc/authorize/login' \
--header 'Content-Type: application/json' \
--data-raw '{
    "command": "authorize",
    "subcommand": "login",
    "password": "e3SiajXybun5AuD"
}'

Response Example

200 - Success - HTTP/S not supported

{
    "command": "authorize-login",
    "error": "Command not supported via single API calls using HTTP/S",
    "success": false,
    "tan": 0
}

Request

Body Params application/json

optional

One of

object

command

enum<string>

required

Main instruction field. For authentication, always set to 'authorize'.

Allowed value:

authorize

subcommand

enum<string>

required

Defines the specific authorization action, such as login, logout, etc.

Allowed value:

password

string

required

Current password. Must be at least 8 characters long.

>= 8 characters

token

string

optional

Authentication token string, typically UUID format (min length 36).

>= 36 characters

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

🟢200OK

Modified at 2025-05-19 19:50:03

getPendingTokenRequests

logout