Deploy a game server
edgegap_deployStart one authoritative dedicated game server from an application version, placed near the players you specify. This is the recommended way to host a multiplayer match: the server owns the game state, so no player hosts it.
Instructions
Start one authoritative dedicated game server from an application version, placed near the players you specify. This is the recommended way to host a multiplayer match: the server owns the game state, so no player hosts it. Returns immediately with a request_id; the server is still starting and has no connection details yet. Follow this call with edgegap_wait_for_deployment to get the address players connect to. Always stop deployments you started for testing. Every deployment is tagged "edgegap-mcp" in addition to any tags you pass, so edgegap_list_deployments with only_agent_deployments: true finds them all. Runs until stopped or until the version's max_duration, which the result reports. Refused, with nothing sent, if the API token appears in an env var or tag, if the version uses the "latest" docker tag, or when too many agent deployments are already running (EDGEGAP_MAX_AGENT_DEPLOYMENTS, default 5): stop finished ones first. Env vars named like secrets are hidden in the dashboard.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| env | No | Environment variables for this deployment only. Values are never echoed back. | |
| tags | No | Extra tags for filtering later, e.g. ["agent-test"]. "edgegap-mcp" is always added. | |
| users | Yes | Where the players are. Exactly one of these two is required. | |
| dry_run | No | Show the exact request (method, host, path, body) with secrets masked, and send nothing. Local checks still run. Use it to confirm a billable or destructive call before making it. | |
| version | Yes | Version name within the application. | |
| cpu_units | No | Override the version CPU (with memory_mb). Not in the published v2 spec, so the API may ignore it; a version with the size you need is the reliable way. | |
| memory_mb | No | Override the version memory (with cpu_units). Same caveat as cpu_units. | |
| application | Yes | Application name. |