[Feature Request] Viability-Analysis - Replace RCON with the REST API

[jammsen]

Have you read the Important information text above

• Yes i did

Describe the feature

1. Create a list of classes and every single functions that use RCON for working right now
2. Analyse what can be transfered or migrated on what API endpoint
3. Side-Note: The log-level-spam will increase "massively" because of the many different requests, maybe add an filter? See Logs on my private Node-Gamedig implementation of the Livestats for https://jammsen.de/
4. Figure out what "deprecation" in Pocketpair terms means, it was deprecated on update v0.5.0, will they stop updating it and leave it in there for LAN-ONLY servers, or is it the Atlassian way, 2-3 releases after deprecation, it gets "removed".

Basic infos are from:
#304 (comment)
Context was about, upgrading deps and that includes rcon-cli or moving to something different if outdeads tool is unmaintained.

Additional information

• Would you be willing to help implement this feature?

Final checks

• I understand that this is a feature request function. I also understand that if i use this to report a bug report, that my issue might be un-answered closed.

[jammsen]

@thijsvanloef @Dashboy1998 @Callum027 @caleb-devops @thejcpalma

FYI - Really hope its okay to ping you, not sure if you already knew about this, just a headsup for your works. I already created an issue over at gamedig/node-gamedig#718 with @CosminPerRam too.

[jammsen]

I took some time with Claude, we analysed the project and wrote a migration scenario up:

Comprehensive RCON to REST API Migration Analysis

Overview

This analysis provides a complete migration plan for transitioning from RCON-based server management to the new REST API endpoints in the Palworld Dedicated Server Docker container.

Current Environment Configuration

RCON Configuration

• RCON_ENABLED=true
• RCON_PORT=25575
• RCON is used for player detection, broadcasts, backups, and server management
• rconcli = wrapper script (scripts/rconcli.sh) for standalone usage
• rcon = direct RCON calls for core server functions

REST API Configuration

• RESTAPI_ENABLED=true
• RESTAPI_PORT=8212
• Authentication: Basic Auth (admin:ADMIN_PASSWORD)

Detailed RCON Commands Migration Table

RCON Command	Type	File(s) where it's used	REST API Endpoint	Migration Priority	Migration Status	Notes
rconcli broadcast	Wrapper	includes/rcon.sh L8, L10, L15, L18, L20, L21, L26, L28, L30, L31, L35, L39, L43, L47, L51	POST /announce	CRITICAL	❌ Not Migrated	Core functionality - used extensively for all server communications. Most frequent command with 23+ instances across 3 files
		scripts/backupmanager.sh L141, L143, L145, L147
		scripts/restart.sh L32, L42, L44
rconcli save	Wrapper	includes/rcon.sh L9, L19, L29	POST /save	CRITICAL	❌ Not Migrated	Essential for data integrity during maintenance. Used in all critical server operations (shutdown, restart, backup)
		scripts/backupmanager.sh L144, L149
		scripts/restart.sh L43
rcon showplayers	Direct	includes/playerdetection.sh L23	GET /players	HIGH	❌ Not Migrated	Core player management functionality. Critical for player monitoring and webhook notifications
rcon -c "$RCON_CONFIG_FILE" showplayers	Direct	includes/rcon.sh L55	GET /players	HIGH	❌ Not Migrated	Uses config file for authentication. Part of server emptiness detection for automated restarts
rcon "Shutdown 10"	Direct	includes/rcon.sh L22	POST /shutdown	HIGH	❌ Not Migrated	Server lifecycle management with 10-second countdown. Critical for graceful shutdowns during restarts
		scripts/restart.sh L47
rcon -c "$RCON_CONFIG_FILE" "$full_command"	Direct	scripts/rconcli.sh L24	Various endpoints	MEDIUM	❌ Not Migrated	Generic RCON wrapper. Affects all scripts using rconcli. Requires endpoint mapping based on command type

Function-Level Analysis with Exact Locations

Function Name	File & Lines	RCON Commands Used	REST API Alternative	Priority
save_and_shutdown_server()	includes/rcon.sh L7-11	rconcli broadcast L8, L10 rconcli save L9	POST /announce + POST /save	CRITICAL
broadcast_automatic_restart()	includes/rcon.sh L13-23	rconcli broadcast L15, L18, L20, L21 rconcli save L19 rcon "Shutdown 10" L22	POST /announce + POST /save + POST /shutdown	CRITICAL
broadcast_backup_start()	includes/rcon.sh L25-32	rconcli broadcast L26, L28, L30, L31 rconcli save L29	POST /announce + POST /save	HIGH
broadcast_backup_success()	includes/rcon.sh L34-36	rconcli broadcast L35	POST /announce	MEDIUM
broadcast_backup_failed()	includes/rcon.sh L38-40	rconcli broadcast L39	POST /announce	MEDIUM
broadcast_player_join()	includes/rcon.sh L42-44	rconcli broadcast L43	POST /announce	LOW
broadcast_player_name_change()	includes/rcon.sh L46-48	rconcli broadcast L47	POST /announce	LOW
broadcast_player_leave()	includes/rcon.sh L50-52	rconcli broadcast L51	POST /announce	LOW
check_is_server_empty()	includes/rcon.sh L54-60	rcon -c "$RCON_CONFIG_FILE" showplayers L55	GET /players	MEDIUM
rcon_showplayers_with_retry()	includes/playerdetection.sh L17-51	rcon showplayers L23	GET /players	HIGH
create_backup()	scripts/backupmanager.sh L134-160	rconcli broadcast L141, L143, L145, L147 rconcli save L144, L149	POST /announce + POST /save	HIGH
run_rcon_cli()	scripts/rconcli.sh L10-26	rcon -c "$RCON_CONFIG_FILE" "$full_command" L24	Various endpoints	MEDIUM

Command Usage Statistics

Command	Total Occurrences	Files Affected
rconcli broadcast	23 instances	3 files
rconcli save	6 instances	3 files
rcon showplayers	2 instances	2 files
rcon "Shutdown X"	2 instances	2 files
rcon -c "$RCON_CONFIG_FILE"	2 instances	2 files

Potential Future Migration Opportunities

These REST API endpoints exist but corresponding RCON commands are not currently used in your scripts:

REST API Endpoint	Purpose	Current RCON Usage	Migration Opportunity
POST /kick	Kick player by userid	❌ No kick commands found	Future Enhancement - Add player moderation
POST /ban	Ban player by userid	❌ No ban commands found	Future Enhancement - Add player moderation
POST /unban	Unban player	❌ No unban commands found	Future Enhancement - Add player moderation
GET /info	Server information	❌ No info commands found	Future Enhancement - Server monitoring
GET /settings	Server settings	❌ No settings commands found	Future Enhancement - Config validation
GET /metrics	Server metrics	❌ No metrics commands found	Future Enhancement - Performance monitoring

Implementation Strategy

1. Create REST API wrapper functions in a new file (e.g., includes/restapi.sh)
2. Implement dual-mode support - check if REST API is enabled, fallback to RCON
3. Add environment variable: USE_RESTAPI_OVER_RCON=true/false
4. Gradual migration - migrate one function group at a time
5. Testing phase - run both APIs in parallel initially
6. Deprecation phase - warn about RCON usage
7. Final migration - remove RCON dependencies

New Environment Variables Needed

# REST API Configuration
RESTAPI_ENABLED=true                    # (already exists)
RESTAPI_PORT=8212                      # (already exists)
RESTAPI_BASE_URL="http://localhost:8212"  # NEW
RESTAPI_TIMEOUT=30                     # NEW - for curl timeout
USE_RESTAPI_OVER_RCON=false            # NEW - gradual migration flag
RESTAPI_RETRY_ATTEMPTS=3               # NEW - error handling
RESTAPI_AUTH_USER="admin"              # NEW - explicit auth config

Migration Recommendations by Priority

Phase 1: Critical Functions (MUST MIGRATE FIRST)

1. Create REST API wrapper (includes/restapi.sh)

   • Functions for POST /announce, POST /save, POST /shutdown
   • Error handling and retry logic
   • Dual-mode support (REST API + RCON fallback)

2. Update save_and_shutdown_server() (L7-11)

   • Highest impact - used by server lifecycle management
   • Dependencies: broadcast_automatic_restart() L13-23

Phase 2: High-Impact Functions

3. Migrate player detection (L54-60 & playerdetection.sh L17-51)

   • GET /players endpoint
   • Critical for: player monitoring, webhooks, server emptiness checks

4. Update backup functions (backupmanager.sh L134-160)

   • Business critical - data backup operations
   • Combines broadcasts + save operations

Phase 3: Medium Priority

5. Generic RCON wrapper (scripts/rconcli.sh)
   • Make rconcli REST API aware
   • Affects: All scripts using the wrapper

Phase 4: Low Priority

6. Player notification functions (L42-52)
   • Nice-to-have features
   • Can be migrated last

Migration Risk Assessment

Risk Level	Function	Impact if Broken	Mitigation
CRITICAL	save_and_shutdown_server()	Data loss, improper shutdowns	Dual-mode support, extensive testing
HIGH	Player detection functions	Monitoring breaks, webhooks fail	Graceful degradation
MEDIUM	Backup functions	Backup process communication	User notification alternatives
LOW	Player join/leave broadcasts	Reduced user experience	Non-essential feature

References

• Palworld REST API Documentation
• REST API Introduction
• RCON Documentation