Open instances
Listing your group's instances that anyone can join on modbot.co, and how to turn it off.
Modbot can tell Modbot Cloud which of your group's instances are open to everyone, so they appear on modbot.co/instances alongside every other group that has this on. It is a way for people to find your events without being in your Discord.
It is on when you install Modbot.
What is sent
| Your group | Its VRChat id, its name, its icon and its banner |
| Each open public instance | The world's id, name and picture; the instance's VRChat location and join link; the region; when the instance opened |
What is not sent
- Any instance that is not open to everyone. An instance set to group members only, or to members and
their friends, is filtered out before the report is built. Only
groupAccessType(public)is sent, and an instance whose access type VRChat did not state is treated as not public. - Any count of people. No head count, no member count. The report has no field for one.
- Anybody's name or id. No members, no moderators, no visitors.
- Your server's address, and anything at all from your moderation records. This report does not carry them. Your server's address does go to Modbot Cloud in the separate usage report, which has its own switch.
How often
Every five minutes, and again the moment an instance opens or closes.
Each report replaces the whole list, so:
- An instance that closes is gone from the page on the next report.
- A Modbot that stops reporting — switched off, redeployed, offline — has its instances dropped after twenty minutes, and is forgotten entirely after seven days.
Turning it off
Settings → Server, on the This install panel, the switch List this group's public instances on modbot.co.
Turning it off asks Cloud to drop what it already has, so the group leaves the page straight away rather than waiting to be dropped.
Setting MODBOT_CLOUD_DISABLED=1 stops it too, along with everything else this server would send to
Modbot Cloud. See Environment variables.
A public demo (MODBOT_DEMO) never reports anything: its instances are made up.
Running your own
The whole path is in this repository, so you can run it end to end yourself.
MODBOT_CLOUD_ENDPOINTon your Modbot points it at your own Cloud.- Your Cloud takes reports at
PUT /api/v1/public-instancesand serves them atGET /api/v1/public-instances, which needsINSTANCES_API_KEY(orROOT_API_KEY). It still answers at/api/v1/public-rooms, the path before 2026-09-17, and still reads a report whose list is calledrooms, so a Modbot that has not been updated keeps its place on the page. - Your landing page reads that feed with
MODBOT_CLOUD_PROXY_URLandMODBOT_CLOUD_API_KEY, holds the answer for a minute, and serves it to browsers at/api/instances. The key stays on the server.
A Modbot claims its place on Cloud with an id and a secret it makes up on its first report. Cloud keeps only a hash of the secret, and one group can only be reported by one Modbot at a time.