Files
Sunshine/docs/api.md
ReenigneArcher 40ac718691
Some checks failed
CI / GitHub Env Debug (push) Has been cancelled
CI / Setup Release (push) Has been cancelled
CI / Setup Flatpak Matrix (push) Has been cancelled
CI Docker / Check Dockerfiles (push) Has been cancelled
CodeQL / Get language matrix (push) Has been cancelled
localize / Update Localization (push) Has been cancelled
Build GH-Pages / prep (push) Has been cancelled
CI / Linux Flatpak (push) Has been cancelled
CI / Linux ${{ matrix.type }} (--appimage-build, 22.04, AppImage) (push) Has been cancelled
CI / Homebrew (${{ matrix.os_name }}-${{ matrix.os_version }}${{ matrix.release == true && ' (Release)' || '' }}) (macos, 13) (push) Has been cancelled
CI / Homebrew (${{ matrix.os_name }}-${{ matrix.os_version }}${{ matrix.release == true && ' (Release)' || '' }}) (macos, 14) (push) Has been cancelled
CI / Homebrew (${{ matrix.os_name }}-${{ matrix.os_version }}${{ matrix.release == true && ' (Release)' || '' }}) (ubuntu, latest) (push) Has been cancelled
CI / Homebrew (${{ matrix.os_name }}-${{ matrix.os_version }}${{ matrix.release == true && ' (Release)' || '' }}) (ubuntu, latest, true) (push) Has been cancelled
CI / Windows (push) Has been cancelled
CI Docker / Setup Release (push) Has been cancelled
CI Docker / Docker${{ matrix.tag }} (push) Has been cancelled
CodeQL / Analyze (${{ matrix.name }}) (push) Has been cancelled
Build GH-Pages / call-jekyll-build (push) Has been cancelled
fix(confighttp): do not return 200 on errors (#3385)
Co-authored-by: Lukas Senionis <22381748+FrogTheFrog@users.noreply.github.com>
2025-01-10 15:12:52 -05:00

1.6 KiB

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()

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/reset-display-device-persistence

@copydoc confighttp::resetDisplayDevicePersistence()

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()

POST /api/apps/close

@copydoc confighttp::closeApp()

[TOC]