Hyperion
  1. Authorization
Hyperion
  • JSON-RPC API Introduction
  • JSON-API Commands Overview
  • Connect to Hyperion
  • Components & Priorities
  • Hyperion API
    • Authorization
      • API Authentication - Introduction
      • createToken
        POST
      • renameToken
        POST
      • deleteToken
        POST
      • getTokenlist
        POST
      • tokenRequired
        POST
      • adminRequired
        POST
      • newPasswordRequired
        POST
      • requestToken
        POST
      • newPassword
        POST
      • answerRequest
        POST
      • getPendingTokenRequests
        POST
      • login
        POST
      • logout
        POST
    • 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
        • setInstanceState
        • switchInstance
        • setSystemState
        • setSubscriptions
    • Configuration
      • createInstance
      • deleteInstance
      • renameInstance
      • getConfiguration
      • updateConfiguration
      • restoreConfiguration
      • getSchemas
  1. Authorization

logout

Testing Env
https://{{host}}:8092
Testing Env
https://{{host}}:8092
POST
/json-rpc/authorize/logout
Websocket
Logout. Hyperion does not verify the login state, this call will always return a success.
Logging out will stop all streaming data services and subscriptions
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://localhost:8092/json-rpc/authorize/logout' \
--header 'Content-Type: application/json' \
--data-raw '{
    "command": "authorize",
    "subcommand": "logout",
    "tan": 4711
}'
Response Response Example
HTTP/S not supported
{
    "command": "authorize-logout",
    "error": "Command not supported via single API calls using HTTP/S",
    "success": false,
    "tan": 4711
}

Request

Body Params application/json
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:
logout
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
login
Next
getSystemInformation
Built with