renun/Sunshine
1
0
Fork 0
mirror of https://github.com/LizardByte/Sunshine.git synced 2025-08-10 00:52:16 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
Files
ec0cdcf0fa711df47bda9e54a4177b7b1199e45d
Sunshine/docs/api.md
ReenigneArcher ec0cdcf0fa docs(api): improve api documentation (#3343)
2024-10-30 20:34:18 +00:00

1.4 KiB
Raw Blame History

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.

GET /api/apps

@copydoc confighttp::getApps()

GET /api/logs

@copydoc confighttp::getLogs()

POST /api/apps

@copydoc confighttp::saveApp()

DELETE /api/apps{index}

@copydoc confighttp::deleteApp()

POST /api/covers/upload

@copydoc confighttp::uploadCover()

GET /api/config

@copydoc confighttp::getConfig()

GET /api/configLocale

@copydoc confighttp::getLocale()

POST /api/config

@copydoc confighttp::saveConfig()

POST /api/restart

@copydoc confighttp::restart()

POST /api/password

@copydoc confighttp::savePassword()

POST /api/pin

@copydoc confighttp::savePin()

POST /api/clients/unpair-all

@copydoc confighttp::unpairAll()

POST /api/clients/unpair

@copydoc confighttp::unpair()

GET /api/clients/list

@copydoc confighttp::listClients()

GET /api/apps/close

@copydoc confighttp::closeApp()

[TOC]