mirror/Sunshine
1
0
Fork 0
mirror of https://github.com/LizardByte/Sunshine.git synced 2024-12-27 06:16:15 +00:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity
410f8c2e70
Sunshine/docs/api.md
ReenigneArcher ec0cdcf0fa
Some checks are pending
CI / GitHub Env Debug (push) Waiting to run
Details
CI / Setup Release (push) Waiting to run
Details
CI / Setup Flatpak Matrix (push) Waiting to run
Details
CI / Linux Flatpak (push) Blocked by required conditions
Details
CI / Linux ${{ matrix.type }} (--appimage-build, 22.04, AppImage) (push) Blocked by required conditions
Details
CI / Homebrew (${{ matrix.os_name }}-${{ matrix.os_version }}${{ matrix.release == true && ' (Release)' || '' }}) (macos, 13) (push) Blocked by required conditions
Details
CI / Homebrew (${{ matrix.os_name }}-${{ matrix.os_version }}${{ matrix.release == true && ' (Release)' || '' }}) (macos, 14) (push) Blocked by required conditions
Details
CI / Homebrew (${{ matrix.os_name }}-${{ matrix.os_version }}${{ matrix.release == true && ' (Release)' || '' }}) (ubuntu, latest) (push) Blocked by required conditions
Details
CI / Homebrew (${{ matrix.os_name }}-${{ matrix.os_version }}${{ matrix.release == true && ' (Release)' || '' }}) (ubuntu, latest, true) (push) Blocked by required conditions
Details
CI / Macports (macOS-${{ matrix.os_version }}) (13, true) (push) Blocked by required conditions
Details
CI / Macports (macOS-${{ matrix.os_version }}) (14) (push) Blocked by required conditions
Details
CI / Windows (push) Blocked by required conditions
Details
CI Docker / Check Dockerfiles (push) Waiting to run
Details
CI Docker / Setup Release (push) Blocked by required conditions
Details
CI Docker / Docker${{ matrix.tag }} (push) Blocked by required conditions
Details
CodeQL / Get language matrix (push) Waiting to run
Details
CodeQL / Analyze (${{ matrix.name }}) (push) Blocked by required conditions
Details
localize / Update Localization (push) Waiting to run
Details
Build GH-Pages / update_pages (push) Waiting to run
Details
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]