How to enable the REST API in Palworld

Set RESTAPIEnabled=True in PalWorldSettings.ini and restart the server to manage the server over HTTP, for example to list players or save the world.

RESTAPIEnabled

Toggles the server's REST API for managing it over HTTP, such as listing players or saving.

RESTAPIEnabled=<True|False>

Examples

RESTAPIEnabled=True

Enable the HTTP API.

Values

Value	What it does
True	On
FalseDefault	Off

Arguments

True|FalseRequired: True to enable the REST API.

What it does

The REST API offers admin functions over HTTP for dashboards and tools. It uses the AdminPassword for authentication. Pocketpair's docs advise against exposing it directly to the internet; keep it on a private network or behind a firewall.

The game's own description: Enable the REST API.

Good to know

Edit PalWorldSettings.ini while the server is stopped; changes apply after a restart.

Run it on your server

Admin commands are typed in game chat after /AdminPassword, or from the console on the server page. Settings go in world settings and apply at the next start. New to this? Start a Palworld server first.

Your own
Palworld server.

Start a Palworld server All commands

From $0.03 an hour, only while it runs. New accounts get 6 free tokens.