Docs

Connect a game with an API key

Create a Roblox Open Cloud API key with the right permissions, add it to Modhelm and keep it working. No HttpService needed.

Why an API key

Modhelm bans and unbans players through Roblox Open Cloud, the official API that the Creator Hub uses as well. Roblox enforces the bans itself in every server of your game. Nothing runs inside your game, and Allow HTTP Requests in your game settings can stay off.

The key belongs to you. You can see, change or revoke it in the Creator Dashboard at any time. Modhelm stores it encrypted and never shows it again, only the last four characters.

Create the key

Open the Creator Dashboard and go to Open Cloud → API Keys. For a group game, switch to the group first.
Click Create API Key and give it a name like Modhelm.
Under Access Permissions, add the API system for user restrictions (scope universe.user-restriction).
Choose your experience, or switch off Restrict by Experience to allow all your games, including future ones.
Select the operations Read and Write.
Optional: add the systems from the table below for in-game reports.
Optional: under Security, add our IP address to Accepted IP Addresses (see below).
Leave the expiration date empty, then click Save & Generate Key and copy the key. Roblox shows it only once.

Permissions

Permission	Operations	Needed for
`universe.user-restriction`	Read, Write	Required. Bans, temp bans, unbans and the ban list
`memory-store.queue`	Dequeue, Discard	Optional. In-game reports from your game
`universe-messaging-service`	Publish	Optional. Reserved for upcoming features such as kicks without a ban

Modhelm also loads the name and icon of your game. That works without an extra permission.

Keys without the optional permissions work normally. The dashboard simply shows in-game reports as not active.

IP restriction (optional)

If you want the key to work only from Modhelm's servers, add this address under Accepted IP Addresses:

187.124.189.36

Do not use the IP restriction for a key that you also use inside your game. Roblox game servers have other addresses.

Add it to Modhelm

In the dashboard open Games → Add game, enter the Universe ID and paste the key. You find the Universe ID in the Creator Dashboard on the overview page of your experience, or with Copy Universe ID in the menu of the experience card.

Modhelm checks the key with Roblox and shows one of these states:

OK: everything is set
Missing permissions: the key works, but a required permission or your game is not covered. Fix it in the Creator Dashboard and click Check again
Invalid: the key is wrong, disabled or expired. Create a new one

The 60 day expiry

Roblox disables API keys that are not used for 60 days, even without an expiration date. Modhelm uses your key once a day for a short health check, so this does not happen while the bot is in your server.

If a key stops working anyway (for example because it was regenerated), Modhelm posts a warning in your log channel and shows it in the dashboard. Open the key in the Creator Dashboard, switch Enable Key on or create a new key, and update it in Modhelm.

Common problems

Message	What to do
Invalid API key	Copy the key again, without spaces. If it was regenerated, paste the new one
Missing permission user restrictions	Add the user restriction system with Read and Write
Universe not covered	Add your experience to the key or switch off Restrict by Experience
Too many requests	Roblox allows only two ban changes per player per minute. Modhelm waits and tries again by itself
Ban not visible in the Creator Hub	Wait a few seconds and reload. Check the log channel for errors