mirror of
https://github.com/hyperion-project/hyperion.ng.git
synced 2025-03-01 10:33:28 +00:00
JSON-API Commands Overview
This commit is contained in:
LordGrey
123
doc/development/JSON-API _Commands_Overview.md
Normal file
123
doc/development/JSON-API _Commands_Overview.md
Normal file
@@ -0,0 +1,123 @@
|
||||
# JSON-API Commands Overview
|
||||
|
||||
## Commands & Sub-Commands
|
||||
|
||||
List of commands and related sub-commands which can be used via JSON-API requests.
|
||||
|
||||
_Authorization (via password or bearer token)_
|
||||
|
||||
**No** - No authorization required<br>
|
||||
**Yes** - Authorization required, but can be disabled for local network calls<br>
|
||||
**Admin**: Authorization is always required
|
||||
|
||||
_Instance specific_
|
||||
|
||||
**Yes** - A specific instance can be addressed<br>
|
||||
**No** - The command is not instance related
|
||||
|
||||
_http/s Support_
|
||||
|
||||
**Yes** - Command can be used by individual http/s requests<br>
|
||||
**No** - Applies only to WebSocket or http/s sessions
|
||||
|
||||
| Command | Sub-Command | Authorization | Instance specifc | http/s Support |
|
||||
|:---------------|-------------------------|:--------------|:-----------------|:---------------|
|
||||
| adjustment | - | Yes | Yes | Yes |
|
||||
| authorize | adminRequired | No | No | Yes |
|
||||
| authorize | answerRequest | Admin | No | No |
|
||||
| authorize | createToken | Admin | No | No |
|
||||
| authorize | deleteToken | Admin | No | Yes |
|
||||
| authorize | getPendingTokenRequests | Admin | No | No |
|
||||
| authorize | getTokenList | Admin | No | Yes |
|
||||
| authorize | login | No | No | No |
|
||||
| authorize | logout | No | No | No |
|
||||
| authorize | newPassword | Admin | No | Yes |
|
||||
| authorize | newPasswordRequired | No | No | Yes |
|
||||
| authorize | renameToken | Admin | No | Yes |
|
||||
| authorize | requestToken | No | No | Yes |
|
||||
| authorize | tokenRequired | No | No | Yes |
|
||||
| clear | - | Yes | Yes | Yes |
|
||||
| clearall | - | Yes | Yes | Yes |
|
||||
| color | - | Yes | Yes | Yes |
|
||||
| componentstate | - | Yes | Yes | Yes |
|
||||
| config | getconfig | Admin | Yes | Yes |
|
||||
| config | getschema | Admin | Yes | Yes |
|
||||
| config | reload | Admin | Yes | Yes |
|
||||
| config | restoreconfig | Admin | Yes | Yes |
|
||||
| config | setconfig | Admin | Yes | Yes |
|
||||
| correction | - | Yes | Yes | Yes |
|
||||
| create-effect | - | Yes | Yes | Yes |
|
||||
| delete-effect | - | Yes | Yes | Yes |
|
||||
| effect | - | Yes | Yes | Yes |
|
||||
| image | - | Yes | Yes | Yes |
|
||||
| inputsource | discover | Yes | No | Yes |
|
||||
| inputsource | getProperties | Yes | No | Yes |
|
||||
| instance | createInstance | Admin | No | Yes |
|
||||
| instance | deleteInstance | Admin | No | Yes |
|
||||
| instance | saveName | Admin | No | Yes |
|
||||
| instance | startInstance | Yes | No | Yes |
|
||||
| instance | stopInstance | Yes | No | Yes |
|
||||
| instance | switchTo | Yes | No | Yes |
|
||||
| ledcolors | imagestream-start | Yes | Yes | Yes |
|
||||
| ledcolors | imagestream-stop | Yes | Yes | Yes |
|
||||
| ledcolors | ledstream-start | Yes | Yes | Yes |
|
||||
| ledcolors | ledstream-stop | Yes | Yes | Yes |
|
||||
| leddevice | addAuthorization | Yes | Yes | Yes |
|
||||
| leddevice | discover | Yes | Yes | Yes |
|
||||
| leddevice | getProperties | Yes | Yes | Yes |
|
||||
| leddevice | identify | Yes | Yes | Yes |
|
||||
| logging | start | Yes | No | Yes |
|
||||
| logging | stop | Yes | Yes | Yes |
|
||||
| logging | update | Yes | Yes | Yes |
|
||||
| processing | - | Yes | Yes | Yes |
|
||||
| serverinfo | - | Yes | Yes | Yes |
|
||||
| serverinfo | getInfo | Yes | Yes | Yes |
|
||||
| serverinfo | subscribe | Yes | Yes | No |
|
||||
| serverinfo | unsubscribe | Yes | Yes | No |
|
||||
| serverinfo | getSubscriptions | Yes | Yes | No |
|
||||
| serverinfo | getSubscriptionCommands | No | No | No |
|
||||
| service | discover | Yes | No | Yes |
|
||||
| sourceselect | - | Yes | No | Yes |
|
||||
| sysinfo | - | Yes | No | Yes |
|
||||
| system | restart | Yes | No | Yes |
|
||||
| system | resume | Yes | No | Yes |
|
||||
| system | suspend | Yes | No | Yes |
|
||||
| system | toggleSuspend | Yes | No | Yes |
|
||||
| system | idle | Yes | No | Yes |
|
||||
| system | toggleIdle | Yes | No | Yes |
|
||||
| temperature | - | Yes | Yes | Yes |
|
||||
| transform | - | Yes | Yes | Yes |
|
||||
| videomode | - | Yes | No | Yes |
|
||||
|
||||
## Subscription updates
|
||||
|
||||
List of updates which can be subscribed to via the `serverinfo/subscribe`request.
|
||||
|
||||
_Instance specific_
|
||||
|
||||
**Yes** - A specific instance can be addressed<br>
|
||||
**No** - The command is not instance related
|
||||
|
||||
_in "all"_
|
||||
|
||||
**Yes** - Updates are subscribed using "all" as the command<br>
|
||||
**No** - Subscription is only triggered via JSON-API request
|
||||
|
||||
| Subscription Command | Instance specific | in "all" |
|
||||
|:-------------------------|:-------------------|:---------|
|
||||
| adjustment-update | Yes | Yes |
|
||||
| components-update | Yes | Yes |
|
||||
| effects-update | Yes | Yes |
|
||||
| event-update | No | Yes |
|
||||
| imageToLedMapping-update | Yes | Yes |
|
||||
| image-update | Yes | No |
|
||||
| instance-update | Yes | Yes |
|
||||
| led-colors-update | Yes | Yes |
|
||||
| leds-update | Yes | No |
|
||||
| logmsg-update | No | No |
|
||||
| priorities-update | Yes | Yes |
|
||||
| settings-update | Yes | Yes |
|
||||
| token-update | No | Yes |
|
||||
| videomode-update | No | Yes |
|
||||
|
||||
|
||||
Reference in New Issue
Block a user