Get started

Upgrading

What changes between releases and what to do about it. Read only the guides between the version you run and the one you are moving to.

RESTHeart

A release that changes an existing behavior has its own upgrade guide. A release that is not listed here only adds features, and upgrading to it needs no change on your side.

To move across several releases, read every guide between the two versions, oldest first.

Upgrade guides

Guide Who is affected

9.11 → 9.12

Deployments that use restheart-accounts with teams, or restheart-stripe. The tokens no longer carry the active team.

9.8 → 9.9

Deployments with a service already bound to /mcp, and a few other behaviors around the new MCP server, the AI module and data constraints. No data migration.

9.5 → 9.6

Deployments that rely on requests with no Origin header, or on secure = false services skipping the VETOER authorizers.

9.4 → 9.5

Deployments that use restheart-accounts: "tenant" becomes "team" in endpoints, claims and configuration.

v8 → v9

Every deployment coming from RESTHeart 8 or earlier: Java 25, the new Docker images, OAuth 2.0 and the security changes.

Before you upgrade

  • Read the release notes on GitHub for the full list of changes in each version.

  • Try the new version against a copy of your configuration and data first.

  • For the documentation of RESTHeart 8, use the version menu at the top of the sidebar.