PocketMC REST API Reference

The PocketMC desktop client runs an embedded HTTP daemon on port 25585 by default when Remote Control is enabled. All endpoints accept and return standard JSON.

Core Endpoints

GET /api/v1/health

Returns health status, active application version, host OS platform, and count of running Minecraft instances.

GET /api/v1/health HTTP/1.1
Host: localhost:25585

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": "ok",
  "version": "1.9.3",
  "platform": "win-x64",
  "activeInstances": 2
}

GET /api/v1/instances

Lists all configured server instances with their live runtime statuses, CPU and RAM metrics, allocated memory, and player counts.

GET /api/v1/instances HTTP/1.1
Host: localhost:25585
Authorization: Bearer <session_token>

HTTP/1.1 200 OK
Content-Type: application/json

[
  {
    "id": "paper-121",
    "name": "PaperMC Survival",
    "software": "PaperMC",
    "version": "1.21.1",
    "javaVersion": "21",
    "port": 25565,
    "status": "running",
    "playersOnline": 4,
    "maxPlayers": 20,
    "memoryMb": 4096
  }
]

POST /api/v1/instances/{id}/start

Starts the target Minecraft server instance. Automatically sets up Adoptium JRE runtimes and maps active Playit tunnels.

POST /api/v1/instances/paper-121/start HTTP/1.1
Host: localhost:25585
Authorization: Bearer <session_token>

HTTP/1.1 200 OK
Content-Type: application/json

{
  "success": true,
  "message": "Instance paper-121 started successfully."
}

POST /api/v1/instances/{id}/stop

Initiates a graceful shutdown via RCON save-all and stop to ensure clean world saves without corruption.

GET /api/v1/instances/{id}/logs

Retrieves real-time console log streams. All personal identifiers, IP addresses, and tokens are automatically redacted by the daemon before serialization.

POST /api/v1/instances/{id}/backup

Creates a full ZIP snapshot with SHA-256 integrity hashing, automatically skipping temporary lock files (e.g. session.lock), and replicates to configured cloud providers.