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=8212AdminPassword:Set a strong admin password
RESTAPIEnabled:Must be set to True
RESTAPIPort:Default is 8212
PalDefender API Configuration
1Enabling PalDefender API
To enable the REST API, open Win64/PalDefender/RESTAPI/RESTConfig.json and change "Enabled" to "true"
2Port Configuration
The default port is 17993.
3Token Management
Start the server once to generate the example token. Every JSON file in the Win64/PalDefender/RESTAPI/Tokens/ directory is considered a valid token!
Token File Format:
token-example.json
{
"Token": "DblJITQxmavSbIWyYIEwHiND2SkMsq1LGesgmlhgzNgu230TGRlNFoWp5cavqgoa"
}Give each token a descriptive name so you know what it's used for
The token inside can be manually changed - treat these like passwords and make them hard to guess
You can create as many tokens as you want
Console Output Example:
[16:42:28][info] [RESTAPI] Loaded 'RESTConfig.json'.
[16:42:28][info] [RESTAPI] Loaded 1 Bearer token.4Configure in PalAPI Profile
After setting up PalDefender, configure the connection in your PalAPI profile:
Sign in to PalAPI and connect your server
Go to your Profile page (click your avatar)
Enter Port: 17993 and your API Key
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