---
title: "Changes to Authenticate and start a session (deprecated)"
method: POST
path: "/handshake"
---

# Changes to Authenticate and start a session (deprecated)

`POST /handshake`

> Every recorded change to this operation, newest first.

## Timeline

Changed in 7 of 57 revisions.

- **2026-07-31** `e8e6b266ea29`: 37 info
- **2026-07-31** `2ff18e50dcc1`: 30 info
- **2026-07-31** `531d5bc1344e`: 1 info
- **2026-07-31** `aff89ca1eeff`: 1 info
- **2026-07-31** `7ed7a764efd9`: 1 info
- **2026-02-26** `c3f202b17eb7`: 2 info
- **2026-02-19** `07f53972fdd7`: 2 info

## Changes

- **2026-07-31** `e8e6b266ea29`: 37 info
  - api operation id `handshake` was added
  - the endpoint scheme security `BearerAuth` was added to the API
  - the endpoint scheme security `ApiKeyAuthQuery` was removed from the API
  - added optional request body
  - added the non-success response with the status `401`
  - added the non-success response with the status `403`
  - added the non-success response with the status `500`
  - the response property `add` became required for the status `200`
  - the response property `albums` became required for the status `200`
  - the response property `api` became required for the status `200`
  - the response property `artists` became required for the status `200`
  - the response property `auth` became required for the status `200`
  - the response property `catalogs` became required for the status `200`
  - the response property `clean` became required for the status `200`
  - the response property `genres` became required for the status `200`
  - the response property `labels` became required for the status `200`
  - the response property `licenses` became required for the status `200`
  - the response property `live_streams` became required for the status `200`
  - the response property `max_album` became required for the status `200`
  - the response property `max_artist` became required for the status `200`
  - the response property `max_podcast` became required for the status `200`
  - the response property `max_podcast_episode` became required for the status `200`
  - the response property `max_song` became required for the status `200`
  - the response property `max_video` became required for the status `200`
  - the response property `playlists` became required for the status `200`
  - the response property `playlists_searches` became required for the status `200`
  - the response property `podcast_episodes` became required for the status `200`
  - the response property `podcasts` became required for the status `200`
  - the response property `searches` became required for the status `200`
  - the response property `session_expire` became required for the status `200`
  - the response property `shares` became required for the status `200`
  - the response property `songs` became required for the status `200`
  - the response property `streamtoken` became required for the status `200`
  - the response property `update` became required for the status `200`
  - the response property `username` became required for the status `200`
  - the response property `users` became required for the status `200`
  - the response property `videos` became required for the status `200`
- **2026-07-31** `2ff18e50dcc1`: 30 info
  - added the optional property `add` to the response with the `200` status
  - added the optional property `albums` to the response with the `200` status
  - added the optional property `api` to the response with the `200` status
  - added the optional property `artists` to the response with the `200` status
  - added the optional property `auth` to the response with the `200` status
  - added the optional property `catalogs` to the response with the `200` status
  - added the optional property `clean` to the response with the `200` status
  - added the optional property `genres` to the response with the `200` status
  - added the optional property `labels` to the response with the `200` status
  - added the optional property `licenses` to the response with the `200` status
  - added the optional property `live_streams` to the response with the `200` status
  - added the optional property `max_album` to the response with the `200` status
  - added the optional property `max_artist` to the response with the `200` status
  - added the optional property `max_podcast` to the response with the `200` status
  - added the optional property `max_podcast_episode` to the response with the `200` status
  - added the optional property `max_song` to the response with the `200` status
  - added the optional property `max_video` to the response with the `200` status
  - added the optional property `playlists` to the response with the `200` status
  - added the optional property `playlists_searches` to the response with the `200` status
  - added the optional property `podcast_episodes` to the response with the `200` status
  - added the optional property `podcasts` to the response with the `200` status
  - added the optional property `searches` to the response with the `200` status
  - added the optional property `session_expire` to the response with the `200` status
  - added the optional property `shares` to the response with the `200` status
  - added the optional property `songs` to the response with the `200` status
  - added the optional property `streamtoken` to the response with the `200` status
  - added the optional property `update` to the response with the `200` status
  - added the optional property `username` to the response with the `200` status
  - added the optional property `users` to the response with the `200` status
  - added the optional property `videos` to the response with the `200` status
- **2026-07-31** `531d5bc1344e`: 1 info
  - `query` request parameter `auth` was deprecated
- **2026-07-31** `aff89ca1eeff`: 1 info
  - endpoint reactivated
- **2026-07-31** `7ed7a764efd9`: 1 info
  - added the non-success response with the status `400`
- **2026-02-26** `c3f202b17eb7`: 2 info
  - the endpoint scheme security `ApiKeyAuthHeader` was added to the API
  - the endpoint scheme security `ApiKeyAuthQuery` was added to the API
- **2026-02-19** `07f53972fdd7`: 2 info
  - the endpoint scheme security `ApiKeyAuthHeader` was removed from the API
  - the endpoint scheme security `ApiKeyAuthQuery` was removed from the API

---

[Operation](https://skmtc.dev/ampache/apis/ampache-rest-api/docs/handshake/post.md) - [API](https://skmtc.dev/ampache/apis/ampache-rest-api.md) - [Page](https://skmtc.dev/ampache/apis/ampache-rest-api/changes/handshake/post)