Archiving realms¶
Archiving a realm removes it from the active realm hierarchy for a game in the Beamable Portal. Use this workflow when you need to retire a game environment that your team no longer uses
Only admins can archive realms. Developers and testers can log into Portal, but they cannot complete this action
*!!! warning "Archive child realms first"
Archive realms from the visual top of the hierarchy display down toward the production realm. This usually means starting with the `-dev` realm, unless your game has additional child realms above it in the hierarchy
Archive a realm¶
-
Log into Portal
-
Open the Games view
-
Find the realm you want to archive in the realm hierarchy
-
In the Cyan-Teal area of the realm card, click the Ellipsis (three-dot) menu

- Open the realm card menu

-
In the upper-right corner of the realm card, click the three-dot menu
-
Select Archive Realm
- Click Archive
Stop running Microservices¶
You cannot archive a realm while it has running Microservices. If Archive Realm is disabled and Portal shows a message that the realm has Microservices running, stop those services before you archive the realm
-
Enter the realm you want to archive
-
Go to Operate > Microservices
-
Find a running Microservice and click its three-dot menu
-
Wait until Portal marks the Microservice as stopped
-
Repeat this process for each running Microservice in the realm
After all Microservices in the realm are stopped, return to the realm card and archive the realm
*!!! tip "Stop services one at a time"
Wait until each Microservice is marked as stopped before stopping the next one. This keeps the Portal state clear and makes the archive flow smoother
Archive a game's realm hierarchy¶
To archive a full game hierarchy, repeat the archive workflow for each realm. Start at the visual top of the hierarchy display and move downward until you reach the production realm
Although Beamable teams often describe development realms as "lower" environments, the Portal hierarchy displays them visually above production. In practice, archive from the least important child realm toward the most important parent realm. The usual order is:
-
Development realm, such as
-dev -
Staging or QA realms
-
Production realm
The production realm's Archive button may appear grayed out. You can still click it after the child realms have been archived
*!!! note "If you cannot archive a realm"
Confirm that your account has the admin role for the game. If you have a developer or tester role, Portal will not let you archive realms

