How to Enable the Palworld REST API | GPORTAL

Quick answer: Enable the Palworld REST API by setting RESTAPIEnabled=True and a RESTAPIPort in PalWorldSettings.ini, with an AdminPassword for authentication. The REST API exposes HTTP endpoints to read the player list and server metrics and to send announcements, save the world or shut down – ideal for dashboards and automation.

At a glance

• Enable: RESTAPIEnabled=True
• Port: RESTAPIPort
• Auth: AdminPassword
• Interface: HTTP endpoints (REST)
• Use for: Dashboards, automation, monitoring

Table of contents

1. What is the Palworld REST API?
2. How do I enable the REST API?
3. What can I do with the REST API?
4. REST API vs. RCON – which should I use?
5. What can I automate with the REST API?
6. FAQ

The Palworld REST API lets tools and scripts manage your server programmatically – reading player info, sending announcements and triggering saves or shutdowns over HTTP. This guide shows how to enable the REST API on your GPORTAL Palworld server.

What is the Palworld REST API?

The REST API is an HTTP interface built into the Palworld dedicated server. It lets external applications query server information and send administrative actions in a structured way, which is ideal for dashboards and automation.

How do I enable the REST API?

1. Open PalWorldSettings.ini in the web interface or via FTP.
2. Set RESTAPIEnabled=True.
3. Set RESTAPIPort to the listening port for your server.
4. Make sure an AdminPassword is set – the API uses it for authentication.
5. Save and restart the server.

What can I do with the REST API?

Typical uses include reading the current player list and server metrics, sending in-game announcements, saving the world and shutting the server down on a schedule. It pairs well with RCON for a full remote-management setup.

REST API vs. RCON – which should I use?

Both let you manage your server remotely, but they differ in style. RCON sends console commands over a game protocol and is widely supported by existing bots. The REST API exposes structured HTTP endpoints that are easy to call from scripts, dashboards and web apps, and return machine-readable data. If you are building a status page or automation, the REST API is usually the better fit; many admins enable both.

What can I automate with the REST API?

Typical automations include a live status page showing the current player list and server metrics, scheduled in-game announcements before restarts, automatic world saves at set intervals, and controlled shutdowns for maintenance windows. Because the endpoints return structured data, they integrate cleanly with monitoring and community tools.

Related topics

• How to enable RCON on your Palworld server
• Overview of admin commands in Palworld
• Palworld server settings explained

FAQ

Is the Palworld REST API enabled by default?

No. You must set RESTAPIEnabled=True and define a RESTAPIPort in PalWorldSettings.ini, then restart the server.

What is the difference between RCON and the REST API?

RCON sends console commands over a game protocol, while the REST API exposes structured HTTP endpoints. Many admins enable both.

Is the Palworld REST API on by default?

No. Set RESTAPIEnabled=True and a RESTAPIPort in PalWorldSettings.ini, then restart the server.

Does the REST API need an admin password?

Yes. It authenticates with your server’s AdminPassword, so set a strong one before enabling the API.

What data does the Palworld REST API return?

Server information such as the current player list and metrics, plus endpoints to trigger announcements, saves and shutdowns.

Still have questions? Our support team is happy to help.

similar articles