Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

iTechGuides is reader-supported. When you buy through links on our site, we may earn an affiliate commission. As an Amazon Associate I earn from qualifying purchases. Learn more

Enable the Palworld REST API by editing the server’s active PalWorldSettings.ini, not the shipped default file. Stop the dedicated server, copy the default configuration into the platform-specific directory if necessary, set RESTAPIEnabled=True and a RESTAPIPort, restart the server, then verify the authenticated /v1/api/settings endpoint. Keep that port on a LAN or private network: Pocketpair warns that the API is not designed for direct Internet exposure.

What the Palworld REST API does

The Palworld REST API is an HTTP interface for administering and monitoring a dedicated server. Once enabled, an authorized client can query server information, list players, read settings, publish announcements, kick or ban players, remove bans, save the world, shut down or force-stop the server, retrieve a world-actor snapshot, and read metrics.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

Because several operations change the running server, treat the API as an administrative control plane rather than as a public game-service endpoint. Use HTTP Basic Authentication, restrict network access to trusted clients, and avoid putting the API directly on the public Internet.

Before you edit anything

  • Have console or file access to the dedicated-server machine. You must be able to stop and start the server process and edit its files.
  • Know the administrative password. The AdminPassword value is the password used to obtain administrative privileges. The API documentation specifies HTTP Basic Authentication.
  • Choose an unused private listener port. The examples below use 8212 only as an example. The API does not require that universal port; use the value you configure.
  • Plan the access boundary first. Prefer a private LAN, VPN, or another authenticated network path. Do not forward the API port from your router to the Internet as a quick way to solve remote access.
  • Back up the active settings file. Copy the file before editing so you can restore the previous line if a syntax mistake prevents the server from loading the settings.

Find the active PalWorldSettings.ini

Palworld has a shipped default settings file and an active, platform-specific file. Only the active file is used for the server’s current options. Editing DefaultPalWorldSettings.ini does not apply the change to an existing server.

#1 Best Overall
Sale
Compressed Air Duster,130000RPM Super Power Cordless Air Duster,Rechargeable Brushless Blower,3 Gear Adjustable Blower with LED Light,Dust Remover for Computer/House/Outdoor/Car
  • Powerful Turbo Fan:CAGIWIRU Electric Air Duster have reached speed up to 130000RPM,Can efficient remove dust and debris.With LED light and Three Adjustable Speed to meet with different cleaning tasks.
  • With Attached USB C Fasting Charging cable.Charing 3 hours,Enjoy up to 240 minutes of use on the lowest setting, For third speed can use for 25mins.with four charging options to meet with your needs.
  • Wide Application: attached 5 different nozzles,making it suitable for a variety of scenes, such as car,pet, pc, keyboards, and other electronic devices. It also serves for office and home clean duster.
  • Handy Design & Portable:Cordless air duster electric nozzle is Light weight and small size, design and comfortable to hold and space saving, convenient to carry around. You can put it in your room or inside the car without taking up space.
  • Economical &Reusable: Built durable materials with a long-lasting battery,our CAGIWIRU air duster it's a sustainable alternative to disposable air cans.
Platform Active file path What to do if it is missing
Windows dedicated server PalSavedConfigWindowsServerPalWorldSettings.ini Start the server once, then stop it and check the directory again.
Linux SteamCMD dedicated server Pal/Saved/Config/LinuxServer/PalWorldSettings.ini Start the server once, then stop it and check the directory again.

Pocketpair documents that the configuration directories are created after the server has started. If you installed the server but have never launched it, start it once, allow initialization to finish, and stop it cleanly before making the edit.

Enable the API on Windows

1. Stop the dedicated server

Stop the Palworld server through the control panel, service manager, or the console command your installation uses. Do not edit the file while the process is writing settings. Wait until the server process has exited before opening the configuration.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

2. Start once if the configuration directory does not exist

Launch the server, wait for normal startup messages, and stop it. This creates the Windows server configuration tree under the installation’s Pal directory.

3. Copy the default file into the active location

Locate the shipped DefaultPalWorldSettings.ini. Copy it to:

PalSavedConfigWindowsServerPalWorldSettings.ini

If an active PalWorldSettings.ini already exists, back it up instead of overwriting it. Preserve its existing settings, world rules, passwords, and other values.

4. Edit OptionSettings

Open the active file in a plain-text editor. Palworld stores the options in one OptionSettings=(...) assignment. Add the two API fields inside that existing parenthesized value, separated by commas:

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
OptionSettings=(...,RESTAPIEnabled=True,RESTAPIPort=8212,...)

This is a conceptual example, not a complete replacement line. Keep every existing option and its original syntax. If the file already contains either field, change its value rather than adding a duplicate. Set RESTAPIEnabled=True to turn the interface on, and set RESTAPIPort to the private port your clients will use.

Rank #2
EVEO® Screen Cleaner Spray Kit (Streak-Free) TV Screen Cleaner for Smart TV, Lcd, LEd, Oled | Computer Screen Cleaner Spray and Wipe Microfiber Cloth - TV, Monitor, Laptop, iPad, Car - 6.7oz 1 Pack
  • Screen Cleaner is Your Screen’s New Bestfriend! - EVEO is proud to present a screen cleaner that’s perfectly suited for your TV. Meet your new screen cleaner, computer screen cleaner, laptop cleaner, iPad cleaner, Macbook,tv cleaner or any other electronic device. Our screen cleaner spray and wipe along with the included plush microfiber cloth, easily removes dust, fingerprints & other smudges on the screen’s surface. Clean effectively for a streak-free screen
  • Gentle on your Screens - Our screen cleaner spray and wipes is compatible to be used even for the most sensitive LCD, LED, CRT, and OLED screens in proper use. Be at ease knowing that this product is compatible with all the major brands: LG, SONY, Samsung, Sharp, iPad, iPhone, Android screens, Kindle, PC monitors - we’ve got you covered! Can be used as LCD screen cleaner, tv cleaner, smart tv screen cleaner, and more
  • Premium Super Soft Plush Microfiber Cloth - Included in this efficient screen cleaning kit. This screen cleaner spray and wipe has our signature plush microfiber cloth specially designed to comply with screens and monitors and leave them streak-free. Has been shown to effectively absorbs stubborn stains, zero streaks, and no fiber shedding. Always use this together with our screen cleaner for the best results
  • Easy-to-Use Screen Cleaner Kit + microfiber cleaning cloth - The EVEO Screen Cleaning Kit will easily be your new favorite tool when it comes to taking care of the things you love most, quick and easy solution for a streak-free screen. Simply screw on the sprayer gun on the screen cleaner bottle. Spray the cleaning liquid onto the microfiber cloth, then wipe the screen until desired cleanliness & shine is achieved.
  • Quality Screen Care Kit Worth Purchasing - Enjoy a convenient Screen Cleaner anytime, anywhere you need it. Your satisfaction is our top priority. We stand behind the quality of our products and that’s why, you shouldn’t be worrying at all. We manufacture the Best Screen Cleaner. and can be used for laptop cleaning kit, laptop screen cleaner, tv screen cleaner for smart tv. MacBook screen cleaner, monitor cleaner or screen cleaner spray for electronic devices with microfiber cleaning cloth

5. Save and restart

Save the file, close the editor, and start the dedicated server again. The API settings are read during startup; changing the file while the server is running does not reload the listener.

Enable the API on Linux with SteamCMD

1. Stop the server process

Use your service manager, screen/tmux session, container control, or hosting panel to stop Palworld. Confirm that the process has ended before editing the file.

2. Initialize the directories when needed

If Pal/Saved/Config/LinuxServer is absent, launch the server once and shut it down normally. The directory is created during startup.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

3. Copy the default configuration

Copy the shipped default settings file to the Linux active path:

Pal/Saved/Config/LinuxServer/PalWorldSettings.ini

Use the path relative to your Palworld server installation. Keep a backup of any existing active file, and do not edit the default file as a substitute for the active one.

4. Add the API settings without replacing the line

Edit the active file and insert the fields into its existing OptionSettings value:

OptionSettings=(...,RESTAPIEnabled=True,RESTAPIPort=8212,...)

Retain the commas, parentheses, and all unrelated options. A malformed or truncated OptionSettings line can cause settings to be ignored or prevent a normal startup. If the fields are already present, update them in place.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
Rank #3
Sale
BladeHawks RGB Gaming Mouse Pad Extra Large Extended 31.5x12 Inch-Black | LED mouse pad with 14 lighting modes, covers keyboard & mouse, anti-slip rubber base, waterproof surface, USB powered
  • 【Large size】:Measuring 800 x 300 mm/ 31. 5×12 inches, which is wider and taller than others. Large mouse pad can perfectly fit your keyboard and mouse of any size, and there is also ample space for peripherals such as phones, tablets, etc.
  • 【LED backlight mouse pad】:Blade Hawks RGB mouse pad provides 7 static modes and 7 dynamic modes will give you the options you are looking for. Power-off memory function remembers the last lighting mode you selected. The super glow fiber Chroma will give you a colorful gaming setup that you want.
  • 【Anti-slip rubber base】:Made from Natural rubber, this gaming mousepad will firmly grip your desktop, allowing you to enjoy the ultimate precision in the games you are most passionate about. It also comes with a texture that enhances this ability even further.
  • 【Smooth and waterproof surface】: Micro-textured cloth surface, for extremely precise mouse control and a smooth movement. When liquid splashes on the gaming mouse pad, it forms water droplets and slides down. Will not delay your work or gameplay.
  • 【Plug and play】: This mouse and keyboard pad is powered by USB, plug and play, no driver required. One button control light modes. Press one time to change the lighting mode, press twice to change the brightness, press and hold about 3 seconds turn ON/OFF.

5. Restart and inspect the startup log

Save the file and restart the service. Check the server log for a clean startup and then test the API from an allowed client. A restart is required for the new listener and authentication settings to take effect.

Understand the three different port settings

Port confusion is a common cause of failed tests. The API port, the game port, and the community-server public port serve different purposes.

Setting Purpose Example or location
RESTAPIPort TCP listener used by the Palworld REST API. 8212 in the example OptionSettings line.
RESTAPIEnabled Enables or disables the REST API listener. True enables it.
-port=8211 Game-server listener used by Palworld clients. It does not select the REST API port.
-publicport Community-server external/public-port setting. It does not change the server’s listening port or the API listener.

For example, a server can accept game traffic on 8211 while its REST API listens on 8212. A client testing the API must connect to the configured RESTAPIPort, not automatically to the game port.

Protect the API before making it reachable

Use HTTP Basic Authentication

The documented API access method is HTTP Basic Authentication. Configure and protect the server’s administrative password, then send credentials over a private, trusted path. Basic Authentication itself is not a replacement for network isolation, so do not treat possession of the port as harmless.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

Keep the listener private

Pocketpair’s warning is explicit: “These APIs are not designed to be exposed directly to the Internet. Publishing directly to the Internet may result in unauthorized manipulation of the server, which may interfere with play.” Use a LAN, VPN, firewall-restricted private interface, or another access boundary that limits which machines can reach the port.

On the host firewall, allow inbound TCP traffic to the configured RESTAPIPort only from the management subnet or specific administrative addresses. Do not open the game port and assume that it also grants API access, and do not expose the API merely because the game server itself is public.

Separate game access from administration

Players need the game-server port; administrators and monitoring tools need the REST API port. Keep those rules separate in the operating-system firewall and in any cloud or router security group. If remote administration is required, place the administrator’s device on a VPN or private overlay and leave the API port un-forwarded to the public Internet.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
Rank #4
Sale
Vaydeer Wrist Rest for Keyboard and Mouse, Computer Ergonomic Wrist Support Pad, Soft Memory Foam Arm Cushion for Desk, Palm Hand Office Laptop Typing
  • 【Softer and More Comfortable】Vaydeer wrist rest has unique diamond pattern, which is the combination of softness and aesthetics. The materials of wrist rest are improved into higher quality memory foam and covered with silky smooth lycra. The computer wrist rest makes you as comfortable and cushiony as like rest your wrists on clouds.
  • 【Ergonomic Wrist Saver】The wrist rests for keyboard and mouse comes with a 17.32×3.15×0.83 inch keyboard wrist pad and a 5.94×3.15×0.83 inch mouse wrist support. Based on ergonomic design, the unique concave shape is the perfect fit for your wrist joints. The wrist rest pad fits most computer keyboards and laptops, improve hand and wrist posture, release your wrist and arm stress.
  • 【Non-Slip Rubber Bottom】Featuring an anti-skid silicone base on the bottom, this wrist keyboard support stays firmly in place on your desk, preventing the padding from sliding around, ensuring stable and consistent wrist support during extended computer sessions.
  • 【Better Experience & Pain Relief】Our keyboard arm rest is beneficial to alleviate the soreness caused by direct contact and friction between your arm and a hard desk surface, reducing the risk of wrist fatigue or carpal tunnel. The soft texture of memory foam can evenly distribute the pressure around your wrists and provide good support with just enough give.
  • 【Helpful in Multiple Scenarios】Whether you're working, studying, writing, typing, gaming, this keyboard and mouse rest combo is an essential accessory to add comfort and support to your hands and wrists. It’s also a great gift for men, women, family, friend, coworker, gamer, teacher, etc.

Test the REST API with the settings endpoint

The official API example uses /v1/api as the base path, and the settings operation is GET /settings. Together, they produce the following practical check:

curl -u '<username>:<password>' 
  -H 'Accept: application/json' 
  'http://<server-host>:<RESTAPIPort>/v1/api/settings'

Replace the angle-bracket values in your shell command with the credentials and host that are valid for your private deployment. Keep the command inside your trusted network; do not paste real credentials into a shared script, public issue, or chat log.

What a successful response tells you

  • The client reached the host and the configured API port.
  • The server loaded the active PalWorldSettings.ini.
  • The response should include RESTAPIEnabled and RESTAPIPort, allowing you to compare the running values with the file you edited.
  • The credentials were accepted by the API’s Basic Authentication layer.

Test from the right network location

Run the command from a machine that is permitted by the host firewall and private network. Testing from the server itself can prove that the process is listening locally, but it does not prove that the intended management workstation can reach the port. Test from that workstation after the local check succeeds.

Independent reader supportYour contribution helps us test, update, and keep practical guides available for everyone.Support on Ko-Fi

Troubleshoot common failures

The file is missing

Start the dedicated server once, let initialization complete, stop it, and check the platform-specific directory again. Windows uses WindowsServer; Linux SteamCMD uses LinuxServer. Do not create a similarly named file in an unrelated directory and expect it to be loaded.

Free tools Windows power users keep installed

One-click scans. No signup required.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

The API is still unavailable after editing

  1. Confirm that you changed PalWorldSettings.ini, not DefaultPalWorldSettings.ini.
  2. Verify that RESTAPIEnabled=True appears inside the existing OptionSettings=(...) value.
  3. Check that RESTAPIPort is a valid, unused port and that no duplicate setting later in the line overrides it.
  4. Stop and start the server; a file edit alone does not reload the API.
  5. Confirm that the client is connecting to the configured API port rather than -port=8211 or a community public port.
  6. Check the host firewall, cloud security group, container port mapping, and any VPN policy for the private interface.

The connection is refused or times out

A refusal usually means that no process is listening on the address and port, while a timeout often indicates a firewall or routing problem. First verify that the server restarted successfully and that the configured RESTAPIPort is the one being tested. Then test locally on the host, followed by the allowed client. Review firewall rules and private-network routes before changing the Palworld configuration again.

The response is HTTP 401 Unauthorized

A 401 response means the request reached the API but authentication was not accepted. Check the Basic Authentication username and password, confirm that the password is the server’s configured administrative password, and ensure that shell quoting has not altered special characters. A correct network path with incorrect credentials still returns an unauthorized response.

The server ignores the new values

Look for edits made to the wrong copy of the file, especially the shipped default file. Compare the running values returned by /v1/api/settings with the active file, then restart after correcting it. Preserve the complete OptionSettings syntax; replacing the whole line with the shortened example can discard unrelated settings.

Best Value
Sale
Under Desk Cable Management Tray No Drill, Metal Mesh Cable Management Under Desk with Clamp Mount, 2 Hole Cable Tray with Wire Management and Cord Organizer for Home Office Standing Desk
  • 【No Drill Mounted】Cable management tray can be assembled in as little as 3 minutes or less-simply. Side clips easily clampe the edge of desk, pass through the holes on the sides, and secure excess cables with baskets. Desk cable management supports inward or outward installation to meet your needs in different scenarios, and provides you with great convenience when collecting and organizing wires.
  • 【Rubber Pad Protects Desk】Wire organizer under desk built-in soft rubber pads on the clamp protect your desk from scratches, so you will not damage your furniture or office.
  • 【Sturdy and Beautiful】Cord management under desk is made of high-quality carbon steel and holds about 15 lbs. The wire basket has 2 holes on each side of the tray to enable your cables to pass freely. Cable baskets are suitable for desk thickness use from 0.4" to 2.4".
  • 【Space Saving & Keep Organized】Desk cable management tray holds all your power cords, outlet strips, USB hubs and computer transformers hidden from your feet, and the data cables will not enter the vacuum cleaner to keep your desk clean and tidy. Desk wire organizer is also suitable for use in the kitchen and outdoors.
  • 【Reduce Safety Risks】Cable tray under desk keeps all plugs away from your kids, no more worry about tripping. Using 2 holes wire tray saves extra space, helps you easily cabling and wire protection. The mesh design is not easy to accumulate dust, but avoids safety accidents caused by messy wires.

The server fails to start after the edit

Restore the backup of the active file, start the server, and confirm that the previous configuration works. Then reapply the two API fields carefully, maintaining commas and parentheses. Make one small change at a time so a syntax error can be isolated without losing world or gameplay settings.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

What you can do after verification

Once the authenticated settings request works, the documented API scope includes:

  • Server information and the player list.
  • Current settings.
  • Announcements.
  • Player kick, ban, and unban operations.
  • World save, shutdown, and force-stop operations.
  • A world-actor snapshot.
  • Metrics.

Read-only queries and mutating operations should not receive identical access. Restrict administrative clients, protect credentials, log who performs changes, and consider whether an automation job really needs permission to stop or modify the server.

Self-hosted and managed-server considerations

The configuration steps are conceptually the same, but responsibility differs by operating model.

Consideration Self-hosted server Managed server
Editing the ini file You control the active path, backup, and syntax. You need file-manager, console, or support access that permits editing the active file.
Keeping the API private You configure the host firewall, router, VPN, and private routes. You must configure the provider’s firewall or private-network controls; do not assume a public panel URL is a private API path.
Restarting after changes You control the service or process lifecycle. You may need the provider’s restart action and must account for scheduled restarts.
Backups and recovery You maintain configuration and world backups. Confirm what the service backs up and whether you can download the active configuration before editing.
Observability You inspect local logs, process state, firewall logs, and API responses. You may depend on provider logs, port mappings, and monitoring features.
Cost and control Hardware, bandwidth, uptime, and administration are your responsibility. The service may reduce maintenance but can limit network, file, and restart controls; pricing and features vary by provider.

Regardless of who runs the machine, the security rule is unchanged: the API port should be reachable only by trusted administrative clients.

What’s actually slowing this PC down?

Pick the symptom - the matching free tool is one click away.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

Operational checklist

  • Stop the server before editing.
  • Start it once first if the platform-specific configuration directory has not been created.
  • Back up the active PalWorldSettings.ini.
  • Edit the active Windows or Linux file, never only DefaultPalWorldSettings.ini.
  • Set RESTAPIEnabled=True and a deliberate RESTAPIPort inside the existing OptionSettings value.
  • Keep the API on a LAN, VPN, or other private access boundary.
  • Allow the API port through the firewall only for trusted management clients.
  • Restart the server.
  • Run an authenticated GET /v1/api/settings request.
  • Confirm that the returned RESTAPIEnabled and RESTAPIPort match the intended configuration.
  • Keep administrative credentials out of public scripts and logs.

Key distinction to remember

The REST API is a separate administrative listener. RESTAPIEnabled=True turns it on, RESTAPIPort selects its port, -port=8211 controls game traffic, and -publicport does not replace either one. When the settings endpoint responds with valid authentication from an allowed private client, the API is enabled and the running server is using the file you intended.

Product prices and availability are accurate as of the date/time indicated and are subject to change. Any price and availability information displayed on Amazon at the time of purchase will apply.