---
title: "Ping server and get status/version"
method: GET
path: "/ping"
tags: ["Authentication"]
---

# Ping server and get status/version

`GET /ping`

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

## Query parameters

- `version` string
- `auth` string

## Response `200`

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

- PingResponse — `server`, `version` and `compatible` are always returned. Sending a valid `auth` extends the session and adds the handshake fields (`session_expire`, server counts, ...).
  - `server` string, required
  - `version` string, required
  - `compatible` string, required
  - `auth` string, nullable
  - `streamtoken` string, nullable
  - `api` string
  - `session_expire` union
    - integer
    - string
  - `update` string
  - `add` string
  - `clean` string
  - `max_song` integer
  - `max_album` integer
  - `max_artist` integer
  - `max_video` integer
  - `max_podcast` integer
  - `max_podcast_episode` integer
  - `songs` integer
  - `albums` integer
  - `artists` integer
  - `genres` integer
  - `playlists` integer
  - `searches` integer
  - `playlists_searches` integer
  - `users` integer
  - `catalogs` integer
  - `videos` integer
  - `podcasts` integer
  - `podcast_episodes` integer
  - `shares` integer
  - `licenses` integer
  - `live_streams` integer
  - `labels` integer
  - `username` string

## Other responses

- `400` — Ampache API error response payload.

## Changes

- **2026-07-21** `2ff18e50dcc1` — 33 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
  - …29 more
- **2026-07-17** `9abb9bf6d3bf` — 1 info
  - removed the non-success response with the status `400`
- **2026-06-25** `7ed7a764efd9` — 1 info
  - added the non-success response with the status `400`
- **2026-02-26** `c3f202b17eb7` — 1 info
  - the endpoint scheme security `ApiKeyAuthQuery` was added to the API
- **2026-02-25** `eea2ec5b84be` — 1 info
  - the endpoint scheme security `ApiKeyAuthQuery` was removed from the API

[Change history](https://skmtc.dev/ampache/apis/ampache-rest-api/changes/ping/get.md)

---

[API](https://skmtc.dev/ampache/apis/ampache-rest-api.md) · [All operations](https://skmtc.dev/ampache/apis/ampache-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ampache/ampache-rest-api/revisions/2ff18e50dcc1/schema)