Sign in
Authentication

Ping server and get status/version

Does not require authentication. If you provide authentication (auth query/header or Bearer), the server may return additional session and library metadata.

get/ping

Query parameters

versionstring

API version the client understands (optional).

authstring

Optional session/API key. May extend session and return additional data when provided.

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

Changes