Use a public host
Set Public host in Server GUI to a reachable DNS name or public IP. Server GUI blocks loopback, private, CGNAT, documentation, benchmark, link-local, reserved, path-like, and host-with-port values for public listings.
Server viewer
Publish a server listing.
Reachable hosts can appear on the main-site server viewer at /servers.html. Each listing shows live sessions with name, slots, password status, version/protocol, MOTD, world label, and last-seen health.
Listing path/server/api/servers
Status refresh30s
PrivacyNo secrets
ModeOpt-in
Host setup
Advertise from the server.
Enable listing
Tick Advertise on CaretakerMP server list. Fill the listing key provided for your host so the public viewer can trust the status updates.
Start server
The server sends live status updates to the CaretakerMP server list. Server GUI stops the local server cleanly so the listing disappears when the session ends.
Listing setup
What the website reads.
List
GET /server/api/serversreturns active public recordsStatus update
POST /server/api/servers/heartbeat/keeps one server listing freshListing service
caretakermp.com/server/apimain-site server listListing key
Host-owned listingtrusted status updatesSite path
Connect the live server list.
Use the main listing path
/server/api/servers returns the public JSON used by the server viewer. Hosts should keep their profiles pointed at the full status-update URL with the trailing slash.
Keep private files private
The server list publishes public session data only. Private listing keys, package files, and local paths are never shown as downloads.
Use the site path
Current packages use only /server/api for the public server list, so the same viewer works from the website and from the launcher.
Privacy
What is never published.
No secrets
Status updates send public session metadata plus passwordProtected. They never send the server password, listing key, player identities, save paths, or local file paths.
Short-lived records
The website keeps records for a short time. If a host stops sending updates or shuts down cleanly, the public listing disappears automatically.