modl.gg
Developer API

Update Server

Update a player's current server.

POST /v1/minecraft/players/update-server

Update the server a player is currently connected to. This is used to track which server a player is on for cross-server features.

Authentication

Requires the X-API-Key header with your server's API key.

X-API-Key: your-api-key-here

Request

Headers

HeaderTypeRequiredDescription
X-API-KeystringYesYour server's API key.
Content-TypestringYesMust be application/json.

Body

FieldTypeRequiredDescription
minecraftUuidstringYesThe player's Minecraft UUID.
serverNamestringYesThe name of the server the player is now on. Must not be blank.
{
  "minecraftUuid": "550e8400-e29b-41d4-a716-446655440000",
  "serverName": "survival-2"
}

Response

200 OK

{
  "status": 200,
  "success": true
}

Error Responses

Status CodeDescription
400Invalid request body or missing required fields.
401Missing or invalid API key.
404Player not found for the given UUID.
429Rate limit exceeded.
500Internal server error.

On this page