Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Shyamalp16/CloudGaming/llms.txt

Use this file to discover all available pages before exploring further.

These endpoints are used by the C++ Host application to register with the matchmaking service and update availability status.

​
Heartbeat

Send heartbeat requests every 20-25 seconds to keep your host registered and available.
Registers a new host or refreshes an existing host’s TTL. This endpoint serves dual purposes:
  • Initial Registration: When a host first starts, it sends its details to become available for matchmaking
  • Keep-Alive: Ongoing heartbeats refresh the 30-second TTL to prevent expiration
POST /api/host/heartbeat

​
Request Body

​
hostId
string
required
Unique identifier for this host session. Generate a UUID when the host application starts.Example: "550e8400-e29b-41d4-a716-446655440000"
​
roomId
string
required
Room identifier used for WebRTC signaling. This is passed to clients for peer connection establishment.Example: "room-abc123xyz"
​
region
string
default:"config default"
Geographic region code for this host. Used for client-side region filtering.Supported values: us-east-1, us-west-1, eu-central, local
​
status
string
default:"idle"
Current availability status of the host.
  • idle - Ready to accept new connections
  • busy - Currently in an active session
Defaults to idle for new registrations.

​
Request Example

curl -X POST https://api.yourdomain.com/api/host/heartbeat \
  -H "Content-Type: application/json" \
  -d '{
    "hostId": "550e8400-e29b-41d4-a716-446655440000",
    "roomId": "room-abc123xyz",
    "region": "us-east-1",
    "status": "idle"
  }'

​
Response

​
success
boolean
Indicates whether the heartbeat was successfully processed.
​
ttl
number
Time-to-live in seconds before the host entry expires. Always returns 30.

​
Response Example

{
  "success": true,
  "ttl": 30
}

​
Implementation Notes

  • Send heartbeats every 20-25 seconds to maintain a safety buffer before the 30-second TTL expires
  • If the host crashes or loses connectivity, the Redis entry automatically expires
  • The same endpoint handles both initial registration and subsequent heartbeats
  • Store your hostId and roomId in memory - they should remain constant for the host’s lifetime

​
Update Status

Call this endpoint immediately when a client connects to mark yourself as busy.
Updates the host’s availability status. Typically called when:
  • A peer successfully connects via WebRTC signaling (set to busy)
  • A session ends and the host becomes available again (set to idle)
POST /api/host/status

​
Request Body

​
hostId
string
required
The unique identifier for your host session. Must match the hostId used in heartbeat requests.Example: "550e8400-e29b-41d4-a716-446655440000"
​
status
string
required
The new status for this host.
  • idle - Host is available for new matches
  • busy - Host is currently serving a client

​
Request Example

curl -X POST https://api.yourdomain.com/api/host/status \
  -H "Content-Type: application/json" \
  -d '{
    "hostId": "550e8400-e29b-41d4-a716-446655440000",
    "status": "busy"
  }'

​
Response

​
success
boolean
Indicates whether the status update was successful.

​
Response Example

{
  "success": true
}

​
Typical Flow

  1. Host starts: Send heartbeat with status: "idle"
  2. Client connects: Call /api/host/status with status: "busy"
  3. Continue heartbeats: Keep sending heartbeats (status persists)
  4. Session ends: Call /api/host/status with status: "idle"
  5. Host shuts down: Stop sending heartbeats (entry expires automatically)

​
Error Handling

If the host’s Redis entry has expired (no heartbeat for 30+ seconds), status updates will fail silently. Always ensure heartbeats are running before updating status.
{
  "success": false,
  "error": "Host not found"
}

Build docs developers (and LLMs) love

Get started for freeTalk to us