whitelist.json

Stores the server’s whitelist. When enabled, only players whose UUID is in the list can connect. Disabled by default.

File: whitelist.json
Provider: HytaleWhitelistProvider

Format

{
  "enabled": false,
  "list": [
    "550e8400-e29b-41d4-a716-446655440000",
    "660e8400-e29b-41d4-a716-446655440000"
  ]
}

Field	Type	Default	Description
enabled	boolean	false	Whether the whitelist is active
list	UUID[]	[]	UUIDs allowed to connect

When enabled is false, the whitelist has no effect — all players can connect (subject to bans and other access providers).

API

The built-in HytaleWhitelistProvider is not directly accessible from the mod API. For custom allowlist logic, register an AccessProvider. See Access Control for the full API.

Commands

Command	Description
/whitelist enable	Enable the whitelist
/whitelist disable	Disable the whitelist
/whitelist add <player>	Add a player
/whitelist remove <player>	Remove a player
/whitelist list	Show all whitelisted players
/whitelist status	Show whether whitelist is enabled
/whitelist clear	Remove all entries

See Access Control Commands for details.