v38

latestOpenAPI 3.0.3AGPL-3.0raw.githubusercontent.com2026-08-022461333.9 MB
Authentication

Ping server and get status/version

Returns server, version and compatible without authentication. Authenticating (Bearer token, auth header or auth query parameter) extends the session and adds the handshake fields to the response.

get/ping

Query parameters

versionstring

API version the client understands (optional). REST callers should omit it -- the version in the URL path wins; if both are sent and disagree, the path version is used and this parameter is ignored.

Response

Ping response (contents may vary based on whether authentication is provided).

serverstring required
versionstring required
compatiblestring required
authstring nullable
streamtokenstring nullable
apistring
updatestring
addstring
cleanstring
max_songinteger
max_albuminteger
max_artistinteger
max_videointeger
max_podcastinteger
max_podcast_episodeinteger
songsinteger
albumsinteger
artistsinteger
genresinteger
playlistsinteger
searchesinteger
playlists_searchesinteger
usersinteger
catalogsinteger
videosinteger
podcastsinteger
podcast_episodesinteger
sharesinteger
licensesinteger
live_streamsinteger
labelsinteger
usernamestring