Albums12

Artists7

Artwork7

Authentication7

Bookmarks17

Browsing, Indexes and Lists14

Catalogs18

Collections8

Genres6

Labels5

Licenses3

Live Streams5

Localplay1

Maintenance4

Now Playing6

Playback Control18

Playlist Folders8

Playlists18

Podcasts13

Preferences7

Ratings and Flags18

Search2

Shares13

Social6

Song1

Songs8

Streaming and Downloads9

Users7

Utilities7

Videos3

Authentication

Authenticate and start a session (deprecated)

Changed on Jul 31, 2026

When you do not have an API key you can request a session token using handshake which can then be used as your authentication token.

post/handshake

Request

Base URL
https://develop.ampache.dev/rest/8/json
URL
https://develop.ampache.dev/rest/8/json/handshake
Auth
- none
- or HTTP bearer
- or API key in header auth

Query parameters

authstring

Passphrase (timestamp + password hash) or API key. This is a credential, not an existing session token, so it is not the same value as the auth security scheme. Omit it when authenticating with a Bearer token or the auth header. Prefer sending it in the request body rather than the query string.

userstring

Username (required for login/password authentication).

timestampinteger

UNIX time used in seed of password hash (required for login/password authentication).

versionstring

API version the client understands. 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.

Request body

userstring

Username (required for login/password authentication).

timestampinteger

UNIX time used in seed of password hash (required for login/password authentication).

versionstring

API version the client understands. 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

Session info or error

authstring nullable required

streamtokenstring nullable required

apistring required

updatestring required

addstring required

cleanstring required

max_songinteger required

max_albuminteger required

max_artistinteger required

max_videointeger required

max_podcastinteger required

max_podcast_episodeinteger required

songsinteger required

albumsinteger required

artistsinteger required

genresinteger required

playlistsinteger required

searchesinteger required

playlists_searchesinteger required

usersinteger required

catalogsinteger required

videosinteger required

podcastsinteger required

podcast_episodesinteger required

sharesinteger required

licensesinteger required

live_streamsinteger required

labelsinteger required

usernamestring required

Changes

Jul 31, 2026e8e6b266ea29 Revision changes
- info
  api operation id handshake was added
- info
  the endpoint scheme security BearerAuth was added to the API
- info
  the endpoint scheme security ApiKeyAuthQuery was removed from the API
- info
  added optional request body
- 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
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
Jul 31, 20262ff18e50dcc1 Revision 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

Operation history (7 revisions)