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

# Ping server and get status/version

`GET /ping`

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.

## Query parameters

- `version` 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` — HTTP 400 Bad Request (errors 4705, 4710).
- `401` — HTTP 401 Unauthorized (error 4701).
- `403` — HTTP 403 Forbidden (errors 4700, 4703, 4742).
- `500` — HTTP 500 Internal Server Error (error 4702).

---

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