Setup Guide

Complete guide to configure your Palworld server and PalDefender for use with PalAPI

Server REST API Configuration

1Enable REST API

To allow PalAPI to communicate with your server, REST API must be enabled. In your PalWorldSettings.ini file, ensure this section is configured:

PalWorldSettings.ini
AdminPassword="YourPassword",RESTAPIEnabled=True,RESTAPIPort=8212
AdminPassword:Set a strong admin password
RESTAPIEnabled:Must be set to True
RESTAPIPort:Default is 8212. If you're using a Game Server Provider (GSP), use the port they assigned for the REST API.

PalDefender API Configuration

1Enabling PalDefender API

To enable the REST API, open Pal/Binaries/Win64/PalDefender/RESTAPI/RESTConfig.json and change "Enabled" to "true"

2Port Configuration

The default port is 17993. If you're using a Game Server Provider (GSP), they may assign you a different port, use the one provided to you. You can change it manually in RESTConfig.json.

3Token Management

Place a JSON file inside Pal/Binaries/Win64/PalDefender/RESTAPI/Tokens/. Every JSON file in that folder is treated as a valid bearer token.

Token File Format:

mytoken.json
{
    "Token": "<your-64-character-token-here>"
}

Token Generator

Treat these like passwords. Use a long, random string, 64 characters is recommended. You can create as many token files as you want.

4Configure in PalAPI

After setting up PalDefender, link it to your server in PalAPI:

Sign in to PalAPI and go to the Servers page
Find your server and open its PalDefender configuration
Enter your PalDefender port and the token from your JSON file
Save your settings

Ready to Connect!

Once you've completed both configurations, you can connect your server to PalAPI and start managing your Palworld server with ease.

Connect Your Server