MultiConnectMultiConnectDocs Website home
MultiConnectCloud › Server Deployments

9. How clients find your servers

Every container has its own address, and addresses change when containers are replaced. Choose one of these ways for clients to find a server.

Your setup How clients find a server
MultiConnectSDK with an SDK App linked The client connects with its SDK key and MultiConnectCloud picks the server. Nothing else to set up. See the Developer Guide
Your own backend Your backend keeps the list of healthy containers from webhooks and hands each client an address
Direct lookup from the client The client asks the connection lookup with a client-distributable access key (below)

In Combined mode, a client connects to a combined server. In Master–Worker mode, a client connects to a master, and the master assigns it to a worker.

Connection details on the dashboard

The deployment page shows, for you:

Panel Shows
Endpoints The deployment's main address. View all endpoints lists every one
Connections Every live container with its region, role, address, protocol, Healthy or Unhealthy, and Draining — retires ... if it is retiring
Containers Each container's region, role, port, build version, CPU, RAM, storage and health

The connection lookup

These calls answer "where should this client connect?" from your client or backend, without MultiConnectSDK.

You need an access key attached to the deployment:

  1. On Access Keys, click Create Access Key. For a key that ships inside a game client, turn on Client-distributable (connection lookup only): it can only look up connection details. Copy the Access Key and Secret. They are shown once.
  2. Open your deployment from the dashboard, and on its Access Keys panel search for the key and attach it. A deployment can have up to 5 keys.

Every call is an HTTPS POST to https://api.multiconnectcloud.com with a JSON body and four headers:

Header Value
X-MC-Key Your Access Key
X-MC-Timestamp The current time in ISO 8601 UTC, such as 2026-01-15T10:30:00Z. It must be within 5 minutes of the server's clock
X-MC-Nonce A new random value for every request. A reused nonce is refused
X-MC-Signature Lowercase hex HMAC-SHA256 of {key}:{timestamp}:{nonce}:{path}, keyed with your Secret

{path} is the URL path you call, such as /api/PublicNew/ServerDeployments/GetConnection. Your deployment id is in the dashboard address bar on the deployment's page, after /deployments/, and inside your servers as MC_DEPLOYMENT_ID.

Path Body Returns
/api/PublicNew/ServerDeployments/GetConnection deploymentId, optional regionId, optional buildVersion One healthy master (Master–Worker) or combined server, never a worker and never a retiring container. If the preferred region has nothing healthy, another region is returned
/api/PublicNew/ServerDeployments/GetCombinedServerInfo deploymentId, optional regionId, buildVersion, includeRetiring Every combined server
/api/PublicNew/ServerDeployments/GetMasterServerInfo The same Every master
/api/PublicNew/ServerDeployments/GetWorkerServerInfo The same, plus optional masterRegionId Every worker, optionally only those reporting to one master region
/api/PublicNew/ServerDeployments/ReleaseRetiringContainers deploymentId, optional containerId or buildVersion Ends the grace period early. Not allowed with a client-distributable key

Each server in a result has containerId, regionId, region, role, ip, port, transport, wsUrl (the wss:// address, when WebSocket is on), buildVersion, generation, isHealthy, retiresAt (set while it is retiring) and, for workers, masterRegionId.

Region ids: 1 India, 2 North America, 3 Europe, 4 South America, 5 Africa, 6 East Asia, 7 West Asia.

Every answer is HTTP 200 with a JSON body. Check status (true or false) and message. The lookup allows 60 requests a minute from each IP address.

Script 9.1: Ask where to connect (bash)

KEY="your-access-key"
SECRET="your-secret"
URL_PATH="/api/PublicNew/ServerDeployments/GetConnection"
TS=$(date -u +%Y-%m-%dT%H:%M:%SZ)
NONCE=$(openssl rand -hex 16)
SIG=$(printf '%s' "$KEY:$TS:$NONCE:$URL_PATH" | openssl dgst -sha256 -hmac "$SECRET" -hex | sed 's/^.* //')

curl -s -X POST "https://api.multiconnectcloud.com$URL_PATH" \
  -H "Content-Type: application/json" \
  -H "X-MC-Key: $KEY" -H "X-MC-Timestamp: $TS" -H "X-MC-Nonce: $NONCE" -H "X-MC-Signature: $SIG" \
  -d '{"deploymentId":"k3J9aQ2xV0mP","regionId":3}'

A successful answer carries the chosen server in connection, with message "Connect to this server."