Customise the game proxy messages

Players reach your customers' Minecraft servers through Coritan's game proxy. On the Game proxy page you choose the join addresses those servers get, and you write the text players see in their server list and when the proxy turns them away. Every text you leave blank uses the platform's wording, which the form shows as the field's placeholder.

• You need the owner or admin role in the organization.
• To give join addresses a domain of your own, first ask support to add it as a base domain. The page lists the nameservers to delegate it to.

1. Go to Organizations, open your organization, then Growth, then Game proxy.
2. In the Join addresses card, under Join address for new servers, choose whether a new Minecraft server gets a join address, made of its name and the base domain: Given on their own, Not given, or the platform default, which the first option says.
3. Under Base domain, choose the domain join addresses end in. The list holds your organization's own base domains and the ones the platform shares with every organization, which it marks as the platform's. You cannot choose a disabled domain, and the list says when a domain is not delegated yet. To go back to the default, choose the first option, Default, with the domain it stands for: your own base domain when you have one, else the platform's.
4. Choose Save changes. A message confirms the domain new servers join under.

In the Server list and kick messages card, fill in the texts you want to change:

Two more settings sit under the texts:

• Status cache (seconds) is how long the proxy reuses a server's answer to the server list, from 1 to 10 seconds.
• Favicon (data URL) is the icon beside your text in the server list: a 64×64 PNG, pasted as a data:image/png;base64, URL. Once you have one, tick Remove the custom favicon to go back to the platform's icon.

To go back to the platform's wording for a text, empty the field: the hint under it shows the text it inherits. Then choose Save changes.

Each card saves on its own and sends only what you changed. Its footer counts the changes, and Discard puts the saved values back.

Players see your texts in their server list and on the proxy's screens. New Minecraft servers get join addresses, or not, as you chose, on the base domain the Base domain hint names.

Favicon must be a data:image/png;base64,... URI

Paste the icon as a PNG data URL. Other image types are refused.

Favicon too large. Favicon must be a 64 by 64 PNG under about 22 KB. or Favicon must be a 64 by 64 PNG under about 22 KB.

Use a PNG that is exactly 64×64 pixels and under about 22 KB. A server-list status holds only 32,767 bytes, shared with the message and the player sample, so a larger icon would blank the entry.

Enter a whole number of seconds from 1 to 10, or leave it empty to inherit.

The status cache takes 1–10 seconds. Leave it empty to use the platform's value.

The Base domain hint says no base domain is set

Neither your organization nor the platform has a base domain, so we cannot give out join addresses yet. Contact support.

• Organization integrations
• Host DNS zones for your organization
• Let customers run their servers

Both routes need an owner's or admin's access token, sent as Authorization: Bearer $CORITAN_TOKEN.

GET /api/v1/orgs/acme/gameproxy/settings answers your settings next to the platform's:

PUT /api/v1/orgs/acme/gameproxy/settings changes only the fields you send, and goes on the audit log. The texts are version_name, generic_ping_description, offline_motd, online_motd, generic_join_response, rejoin_message and blocked_message, plus favicon and status_cache_ttl_seconds (1–10). Send clear_ and the field name set to true, such as clear_offline_motd, to go back to the platform's value. Send auto_provision_minecraft to switch join addresses on or off, or inherit_auto_provision: true to follow the platform.

Send base_domain_id to choose one of the base_domains the GET lists: your own or the platform's. Any other id answers 422 with Choose a base domain from this organization's list. Send clear_base_domain: true to go back to default_base_domain; sent with a base_domain_id, it answers 422.

curl -X PUT "https://api.coritan.com/api/v1/orgs/acme/gameproxy/settings" \
  -H "Authorization: Bearer $CORITAN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"offline_motd": "This server is asleep. Start it from your dashboard.", "clear_blocked_message": true}'

The answer carries effective_auto_provision_minecraft and effective_base_domain after the change.