AMampache
Authentication

Ping server and get status/version

Changed on

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

Request

  • Base URL
    https://develop.ampache.dev/rest/8/json
  • URL
    https://develop.ampache.dev/rest/8/json/ping
  • Auth
    • none
    • or HTTP bearer
    • or API key in header auth
    • or API key in query parameter auth

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

Changes

  • e8e6b266ea29Revision changes
    • warning

      deleted the query request parameter auth

    • info

      api operation id ping was added

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 2ff18e50dcc1Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status