Palworld REST API for Server Owners: What It Does and How to Use It
Newer Palworld server builds include a REST API for managing the server from scripts or tools. It is intended to replace RCON, which is considered deprecated.
Enabling it
The API is off by default. In PalWorldSettings.ini, set RESTAPIEnabled=True, and set a strong AdminPassword. The API port is commonly RESTAPIPort=8212. Restart the server afterward. Key names and defaults can change between updates, so confirm them in the official documentation for your version.
How it works
Requests go over plain HTTP to an address like http://server-ip:8212/v1/api. Authentication uses HTTP Basic auth with the username admin and your AdminPassword.
Commonly reported endpoints
- GET /info: server name and version.
- GET /players: connected players and their IDs.
- GET /settings: current effective settings.
- GET /metrics: health data such as player count and uptime.
- POST /save: force a world save.
- POST /announce: send an in-game message.
- POST /shutdown: graceful shutdown with a countdown.
- POST /kick and POST /ban: remove players.
- POST /unban: lift a ban.
Not every build offers every endpoint, so test each one.
Example
A simple status check uses curl with the admin login against the info path. A 401 response means the username or password is wrong. A refused connection usually means the API is disabled or the port is not open to you.
Security
The API uses unencrypted HTTP and is not meant to face the open internet. Only open the port if you truly need remote access, and prefer a tunnel or other protection. Use a long, unique AdminPassword, because it may also protect in-game admin and RCON.
Useful ideas
- Announce a restart, then save, then shut down.
- Check player count before maintenance.
- Log metrics to spot slow performance.
On our panel
Your panel assigns ports, so ask us in Discord whether the REST port is available on your server before enabling it. Meanwhile, the Console tab remains the simplest way to run commands.