Whitelist

Base: /api/whitelist

Allow players by name or UUID, also before their first visit

Handler: WhitelistHandler

GET /api/whitelist

Get whitelist

Returns whether the whitelist is enabled and all entries.

Response Example

[
  {
    "uuid": "1234...",
    "name": "Steve"
  }
]

cURL

curl -X GET 'http://localhost:5550/api/whitelist' \
  -H 'X-Admin-Token: YOUR_TOKEN'

Internal Behavior

Reads whitelist.json.

POST /api/whitelist

Add to whitelist

Adds a player. Unknown names are resolved through Hytale's whitelist command; success is only reported when Hytale confirms.

Request Body

Field	Type	Required	Description
`name`	string	No	Player name (name or uuid required)
`uuid`	string	No	Player UUID

Response Example

{
  "success": true,
  "uuid": "1234...",
  "name": "Steve"
}

cURL

curl -X POST 'http://localhost:5550/api/whitelist' \
  -H 'X-Admin-Token: YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"name": "NewPlayer"}'

Internal Behavior

Writes whitelist.json or runs whitelist add <name>.

DELETE /api/whitelist/{name}

Remove from whitelist

Removes a player from the whitelist.

Parameters

Name	Type	Required	Description
`name`	string	Yes	Player name or UUID (URL encoded)

Response Example

{
  "success": true,
  "player": "Steve"
}

cURL

curl -X DELETE 'http://localhost:5550/api/whitelist/Eranio' \
  -H 'X-Admin-Token: YOUR_TOKEN'

Internal Behavior

Writes whitelist.json.