Skip to main content

​
Overview

The Lavalink REST API provides HTTP endpoints for player control, track loading, session management, and server information. All v4 routes are prefixed with /v4.

​
Authentication

Most endpoints require the Authorization header with your configured Lavalink password.
​
Authorization
string
required
The password configured in your Lavalink server configuration
Authorization: youshallnotpass

​
API Versioning

Lavalink uses versioned API routes:
  • v4 - Current version (prefix: /v4)
  • v3 - Legacy version (prefix: /v3, available in v3.7.0+)
  • Unversioned routes were removed in v4 (except /version)

​
Error Responses

When an error occurs, Lavalink returns a JSON error response. Add ?trace=true to receive the full stack trace.
​
timestamp
integer
required
Unix timestamp in milliseconds when the error occurred
​
status
integer
required
The HTTP status code
​
error
string
required
The HTTP status code message
​
message
string
required
The error message describing what went wrong
​
path
string
required
The request path that triggered the error
​
trace
string
The full stack trace (only included when ?trace=true query parameter is present)
{
  "timestamp": 1667857581613,
  "status": 404,
  "error": "Not Found",
  "trace": "...",
  "message": "Session not found",
  "path": "/v4/sessions/xtaug914v9k5032f/players/817327181659111454"
}
Retrieve detailed information about the Lavalink server. 
GET /v4/info

​
Response

​
version
object
required
Semantic version information
​
buildTime
integer
required
Unix timestamp in milliseconds when this Lavalink build was created
​
git
object
required
Git repository information
​
jvm
string
required
The JVM version running Lavalink
​
lavaplayer
string
required
The Lavaplayer version being used
​
sourceManagers
array
required
List of enabled source managers (e.g., [“youtube”, “soundcloud”])
​
filters
array
required
List of enabled audio filters (e.g., [“equalizer”, “karaoke”, “timescale”])
​
plugins
array
required
List of enabled plugins
curl -X GET 'http://localhost:2333/v4/info' \
  -H 'Authorization: youshallnotpass'
Retrieve the Lavalink version string. 
GET /version
This is the only unversioned endpoint that still exists in v4.

​
Response

Returns a plain text version string. 
curl -X GET 'http://localhost:2333/version'
Retrieve current statistics about the Lavalink server. 
GET /v4/stats

​
Response

​
players
integer
required
The number of players connected to this node
​
playingPlayers
integer
required
The number of players currently playing a track
​
uptime
integer
required
The uptime of the node in milliseconds
​
memory
object
required
Memory usage statistics
​
cpu
object
required
CPU usage statistics
The frameStats field is always null for this REST endpoint. It’s only available via the WebSocket stats OP when players are active.
curl -X GET 'http://localhost:2333/v4/stats' \
  -H 'Authorization: youshallnotpass'

​
Insomnia Collection

An Insomnia collection with all endpoints is available in the Lavalink repository at Insomnia.json.

Build docs developers (and LLMs) love

Get started for freeTalk to us