Update available: how to update an agent

What the update notices mean, how to update safely and keep the server enrolled, and the alert for outdated agents.

TroubleshootingUpdated 2 min read

Where you see it

  • A dismissible Update available line on the server page, "this server runs (version)".
  • A pill in the Agent column and an Agents panel under Settings, Servers & agents, with the version per server, the latest, and the status.
  • "N servers need an agent update" in the Servers & agents summary.
  • Optionally an alert: the agent_outdated alert kind is on every plan and opt-in. It checks every 15 minutes and sends one notification per server.

What the statuses mean

  • Outdated: a newer release exists.
  • Unsupported: your version is below the minimum we still support.
  • Known bad: that build has a known problem. Update soon.

Servers on basic mode or Roblox have no version to compare, so they show nothing.

How to update

  1. Open Agent versions and find your agent. Download the latest file and compare its SHA-256 with the one listed (sha256sum).
  2. Stop the server, or for hot-loading frameworks replace the file in place.
  3. Replace the old file with the new one. Delete the old file so two copies do not load.
  4. Start the server and run the agent's status command.

Keep the agent's data folder (for example plugins/ServerStats/, serverstats-data/ or carbon/data/ServerStats/). It holds agent.key and the saved state, so the server stays enrolled and open sessions continue. Rust and FiveM reload without a server restart.

Guides with exact paths: Paper and Velocity, FiveM and RedM, Rust, Hytale, sidecar.

Questions

Will the agent update itself?

No. The notice is a hint only. Agents never download or install anything from it. You replace the file yourself.

Do I need a new claim code after updating?

No. Keep the agent's data folder; it holds the key that keeps the server enrolled.

Related

TroubleshootingWrong version or unsupported server softwareWhich server software and game versions each agent supports, and what to do when your version is not listed.Getting startedInstall the agent for your gameWhich install route each game uses (plugin, mod, sidecar or basic mode) and where the step-by-step guide is.Using the dashboardAlertsRules, Channels, the weekly report and the Discord bot. Alerts go to email, Discord, Slack, Telegram, browser push or a signed webhook.
Still stuck? Email [email protected] with the server name and what you see. For a rejected claim code or no data, include the output of the agent’s status command.