7e286b90b6Introduces backend API endpoints for ViGEmBus status and installation, updates Windows build scripts to handle ViGEmBus versioning and installer download, and integrates ViGEmBus status and installation controls into the web UI. Removes legacy PowerShell scripts for gamepad driver management and related NSIS installer commands.
77 lines
1.7 KiB
Markdown
77 lines
1.7 KiB
Markdown
# API
|
|
|
|
Sunshine has a RESTful API which can be used to interact with the service.
|
|
|
|
Unless otherwise specified, authentication is required for all API calls. You can authenticate using
|
|
basic authentication with the admin username and password.
|
|
|
|
@htmlonly
|
|
<script src="api.js"></script>
|
|
@endhtmlonly
|
|
|
|
## GET /api/apps
|
|
@copydoc confighttp::getApps()
|
|
|
|
## POST /api/apps
|
|
@copydoc confighttp::saveApp()
|
|
|
|
## POST /api/apps/close
|
|
@copydoc confighttp::closeApp()
|
|
|
|
## DELETE /api/apps/{index}
|
|
@copydoc confighttp::deleteApp()
|
|
|
|
## GET /api/clients/list
|
|
@copydoc confighttp::getClients()
|
|
|
|
## POST /api/clients/unpair
|
|
@copydoc confighttp::unpair()
|
|
|
|
## POST /api/clients/unpair-all
|
|
@copydoc confighttp::unpairAll()
|
|
|
|
## GET /api/config
|
|
@copydoc confighttp::getConfig()
|
|
|
|
## GET /api/configLocale
|
|
@copydoc confighttp::getLocale()
|
|
|
|
## POST /api/config
|
|
@copydoc confighttp::saveConfig()
|
|
|
|
## POST /api/covers/upload
|
|
@copydoc confighttp::uploadCover()
|
|
|
|
## GET /api/logs
|
|
@copydoc confighttp::getLogs()
|
|
|
|
## POST /api/password
|
|
@copydoc confighttp::savePassword()
|
|
|
|
## POST /api/pin
|
|
@copydoc confighttp::savePin()
|
|
|
|
## POST /api/reset-display-device-persistence
|
|
@copydoc confighttp::resetDisplayDevicePersistence()
|
|
|
|
## POST /api/restart
|
|
@copydoc confighttp::restart()
|
|
|
|
## GET /api/vigembus/status
|
|
@copydoc confighttp::getViGEmBusStatus()
|
|
|
|
## POST /api/vigembus/install
|
|
@copydoc confighttp::installViGEmBus()
|
|
|
|
<div class="section_buttons">
|
|
|
|
| Previous | Next |
|
|
|:--------------------------------------------|--------------------------------------:|
|
|
| [Performance Tuning](performance_tuning.md) | [Troubleshooting](troubleshooting.md) |
|
|
|
|
</div>
|
|
|
|
<details style="display: none;">
|
|
<summary></summary>
|
|
[TOC]
|
|
</details>
|