Creates and launches a new game server instance. The server starts in launching status and transitions to running when the game process opens its configured ports (typically 10–30 seconds, or ~5 seconds if a pool server is available).
The response includes network_ports with the connection details (host + external_port) that game clients need to connect.
Plan limits: Free plan allows 1 active server with a 1-hour TTL and small compute. Pro plan unlocks unlimited servers with all compute sizes.
Build resolution: Uses the latest ready build matching version_tag (defaults to "default"). Pin to a specific build with the version parameter.
Deployment region. Determines where the server runs physically. Case-insensitive. Available regions: us-east, us-south, us-west, eu-north, eu-west, eu-uk, ap-south, sea, ap-north, ap-southeast, south-america-brazil, south-america-chile, south-america, south-africa, ea. Note: south-america and ea are legacy aliases for south-america-brazil and ap-north.
Command-line arguments passed to your game executable. Accessible in your game via PLAYFLOW_STARTUP_ARGS env var or the config API. Example: "-map forest -maxplayers 16 -tickrate 64".
Machine size for the server. Shared CPU: micro (512MB), small (1GB), medium (2GB), large (4GB), xlarge (8GB). Dedicated CPU: dedicated-small (2GB), dedicated-medium (4GB), dedicated-large (8GB), dedicated-xlarge (16GB). Free plan is limited to "small".
Time-to-live in seconds (60–86400). The server automatically stops after this duration. Free plan servers are forced to 3600 (1 hour). Omit for no auto-shutdown.
Automatically restart the game process if it crashes or exits unexpectedly. Uses on-failure restart policy with max 10 retries. After 10 failures, the machine is destroyed.
Arbitrary key-value data attached to this server. Accessible in your game via PLAYFLOW_CUSTOM_DATA env var or the config API at localhost:9090/v1/config. Example: {"map": "forest", "mode": "ranked"}.
Additional environment variables injected into the game container. Merged with project-level defaults (server-level values override project defaults). Example: {"LOG_LEVEL": "debug"}.
Override the project-level port configuration for this specific server. If omitted, the project's default port_configs are used.
Show child attributes
Response
201 - application/json
Server created and launching. The network_ports array contains connection details for game clients. Poll GET /servers/{instance_id} until status is running.
Complete details of a game server instance, including connection info, status, and configuration.
Current server status. "launching": machine is being created and game is starting up. "running": game is ready and accepting connections. "stopped": server has been shut down.
ISO 8601 timestamp of the last update to this server record.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Documentation - PlayFlow Cloud","colors":{"primary":"#2563EB","light":"#60A5FA","dark":"#1E3A8A"},"logo":{"light":"https://mintcdn.com/playflow/eqeqAmqAMsOYKFZn/logo/svgs/3.svg?fit=max\u0026auto=format\u0026n=eqeqAmqAMsOYKFZn\u0026q=85\u0026s=ec6b551d72d9a0550eceaf8372781505","dark":"https://mintcdn.com/playflow/eqeqAmqAMsOYKFZn/logo/svgs/4.svg?fit=max\u0026auto=format\u0026n=eqeqAmqAMsOYKFZn\u0026q=85\u0026s=56ed179b4ec9ff9a3b8c659b610385e1"},"favicon":"https://mintcdn.com/playflow/eqeqAmqAMsOYKFZn/favicon.svg?fit=max\u0026auto=format\u0026n=eqeqAmqAMsOYKFZn\u0026q=85\u0026s=4f01ae4525de4b30fd0fef06c5145d06","navbar":{"links":[{"href":"https://discord.gg/P5w45Vx5Q8","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.playflowcloud.com"}},"footer":{"socials":{"x":"https://x.com/PlayFlowCloud","github":"https://github.com/PlayFlowCloud","linkedin":"https://www.linkedin.com/company/84953462"}},"seo":{"metatags":{"description":"Official documentation for PlayFlow Cloud. Learn to build, deploy, and scale multiplayer games with our tools for server hosting, matchmaking, and lobbies.","keywords":"PlayFlow, PlayFlow Cloud, game development, multiplayer, Unity, Unreal Engine, Godot, game servers, server hosting, matchmaking, lobbies, WebGL, game backend, documentation","author":"PlayFlow Cloud","robots":"index, follow","googlebot":"index, follow","language":"en","copyright":"Copyright 2025 PlayFlow Cloud","distribution":"global","coverage":"Worldwide","category":"Game Development","og:title":"PlayFlow Cloud Documentation","og:description":"Official documentation for PlayFlow Cloud. Learn to build, deploy, and scale multiplayer games with our tools for server hosting, matchmaking, and lobbies.","og:type":"website","og:site_name":"PlayFlow Cloud","og:url":"https://docs.playflowcloud.com","og:locale":"en_US","twitter:card":"summary_large_image","twitter:site":"@PlayFlowCloud","twitter:creator":"@PlayFlowCloud","twitter:title":"PlayFlow Cloud Documentation","twitter:description":"Official documentation for PlayFlow Cloud. Learn to build, deploy, and scale multiplayer games with our tools for server hosting, matchmaking, and lobbies."},"indexing":"all"},"icons":{"library":"lucide"},"integrations":{"posthog":{"apiKey":"phc_fBrC62lJ5zi3r6ItRQsm4NcKIJOvc2e73YZtSaTpYxy"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Community","icon":"discord","href":"https://discord.gg/P5w45Vx5Q8"},{"anchor":"Blog","icon":"newspaper","href":"https://playflowcloud.com/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"playflow","hasAudioNarration":false,"actualSubdomain":"playflow","customDomains":["docs.playflowcloud.com"],"gitSource":{"type":"github","owner":"playflowcloud","repo":"playflow-core","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a551e6696ba02c71ec13582","collectionId":"3524da5f-fd4d-49f3-a07a-bea7ab61d2ef","schemaVersion":"v3"},"feedback":{"thumbs":false},"entitlements":{},"buildId":"6a551e6696ba02c71ec13582:success","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"Documentation","count":37},{"language":"default","tag":"API Reference","count":36},{"language":"default","tag":"Endpoints","count":35},{"language":"default","tag":"Lobbies","count":18},{"language":"default","tag":"Lobbies \u0026 Matchmaking","count":12},{"language":"default","tag":"Getting Started","count":10},{"language":"default","tag":"Guides","count":8},{"language":"default","tag":"Servers","count":8},{"language":"default","tag":"Quick Start Guides","count":7},{"language":"default","tag":"Unity SDK","count":6}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/servers/start-a-new-server","slug":"/api-reference/servers/start-a-new-server","pageMetadata":{"title":"Start a new server","description":"Creates and launches a new game server instance. The server starts in `launching` status and transitions to `running` when the game process opens its configured ports (typically 10–30 seconds, or ~5 seconds if a pool server is available).\n\nThe response includes `network_ports` with the connection details (host + external_port) that game clients need to connect.\n\n**Plan limits:** Free plan allows 1 active server with a 1-hour TTL and `small` compute. Pro plan unlocks unlimited servers with all compute sizes.\n\n**Build resolution:** Uses the latest `ready` build matching `version_tag` (defaults to `\"default\"`). Pin to a specific build with the `version` parameter.","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc post /api/v3/servers/start","href":"/api-reference/servers/start-a-new-server","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Creates and launches a new game server instance. The server starts in \", _jsx(_components.code, {\n children: \"launching\"\n }), \" status and transitions to \", _jsx(_components.code, {\n children: \"running\"\n }), \" when the game process opens its configured ports (typically 10–30 seconds, or ~5 seconds if a pool server is available).\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The response includes \", _jsx(_components.code, {\n children: \"network_ports\"\n }), \" with the connection details (host + external_port) that game clients need to connect.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Plan limits:\"\n }), \" Free plan allows 1 active server with a 1-hour TTL and \", _jsx(_components.code, {\n children: \"small\"\n }), \" compute. Pro plan unlocks unlimited servers with all compute sizes.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Build resolution:\"\n }), \" Uses the latest \", _jsx(_components.code, {\n children: \"ready\"\n }), \" build matching \", _jsx(_components.code, {\n children: \"version_tag\"\n }), \" (defaults to \", _jsx(_components.code, {\n children: \"\\\"default\\\"\"\n }), \"). Pin to a specific build with the \", _jsx(_components.code, {\n children: \"version\"\n }), \" parameter.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Start a new server","description":"Creates and launches a new game server instance. The server starts in `launching` status and transitions to `running` when the game process opens its configured ports (typically 10–30 seconds, or ~5 seconds if a pool server is available).\n\nThe response includes `network_ports` with the connection details (host + external_port) that game clients need to connect.\n\n**Plan limits:** Free plan allows 1 active server with a 1-hour TTL and `small` compute. Pro plan unlocks unlimited servers with all compute sizes.\n\n**Build resolution:** Uses the latest `ready` build matching `version_tag` (defaults to `\"default\"`). Pin to a specific build with the `version` parameter.","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc post /api/v3/servers/start","href":"/api-reference/servers/start-a-new-server","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"startServer","tags":["Servers"],"summary":"Start a new server","description":"Creates and launches a new game server instance. The server starts in `launching` status and transitions to `running` when the game process opens its configured ports (typically 10–30 seconds, or ~5 seconds if a pool server is available).\n\nThe response includes `network_ports` with the connection details (host + external_port) that game clients need to connect.\n\n**Plan limits:** Free plan allows 1 active server with a 1-hour TTL and `small` compute. Pro plan unlocks unlimited servers with all compute sizes.\n\n**Build resolution:** Uses the latest `ready` build matching `version_tag` (defaults to `\"default\"`). Pin to a specific build with the `version` parameter.","requestBody":"c7d7ab34-42b0-4376-90b3-970251302f0d","responses":{"201":"5835f633-6179-4bb3-936b-6fcfbcd8f59f"},"method":"post","type":"path","servers":["10dc6c24-ec8f-48c6-85d3-b4e04b596923"],"security":["0648c24c-6553-4c47-aec3-e48fcddd9e9d"],"path":"/api/v3/servers/start","baseUrlOptions":["https://api.computeflow.cloud"],"title":"Start a new server","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Display name for this server instance. Visible in the dashboard and API responses. Example: \"ranked-match-1\", \"lobby-eu-west\".","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"region":{"type":"string","minLength":1,"description":"Deployment region. Determines where the server runs physically. Case-insensitive. Available regions: us-east, us-south, us-west, eu-north, eu-west, eu-uk, ap-south, sea, ap-north, ap-southeast, south-america-brazil, south-america-chile, south-america, south-africa, ea. Note: south-america and ea are legacy aliases for south-america-brazil and ap-north.","isRequired":true,"uniqueKey":"region","typeLabel":"string"},"startup_args":{"type":"string","description":"Command-line arguments passed to your game executable. Accessible in your game via PLAYFLOW_STARTUP_ARGS env var or the config API. Example: \"-map forest -maxplayers 16 -tickrate 64\".","uniqueKey":"startup_args","typeLabel":"string"},"compute_size":{"type":"string","enum":["micro","small","medium","large","xlarge","dedicated-small","dedicated-medium","dedicated-large","dedicated-xlarge","persistent-small","persistent-medium","persistent-large","persistent-xlarge"],"default":"small","description":"Machine size for the server. Shared CPU: micro (512MB), small (1GB), medium (2GB), large (4GB), xlarge (8GB). Dedicated CPU: dedicated-small (2GB), dedicated-medium (4GB), dedicated-large (8GB), dedicated-xlarge (16GB). Free plan is limited to \"small\".","uniqueKey":"compute_size","typeLabel":"enum\u003cstring>"},"version_tag":{"type":"string","description":"Build name to deploy (e.g., \"default\", \"beta\", \"staging\"). Uses the latest ready build with this name. If omitted, defaults to \"default\".","uniqueKey":"version_tag","typeLabel":"string"},"version":{"type":"integer","description":"Specific build version number to deploy. Overrides version_tag to pin to an exact build version. Useful for rollbacks or testing specific builds.","uniqueKey":"version","typeLabel":"integer"},"ttl":{"type":"integer","minimum":60,"maximum":86400,"description":"Time-to-live in seconds (60–86400). The server automatically stops after this duration. Free plan servers are forced to 3600 (1 hour). Omit for no auto-shutdown.","uniqueKey":"ttl","typeLabel":"integer"},"auto_restart":{"type":"boolean","default":false,"description":"Automatically restart the game process if it crashes or exits unexpectedly. Uses on-failure restart policy with max 10 retries. After 10 failures, the machine is destroyed.","uniqueKey":"auto_restart","typeLabel":"boolean"},"custom_data":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"custom_data.additionalProperties","typeLabel":"any"},"description":"Arbitrary key-value data attached to this server. Accessible in your game via PLAYFLOW_CUSTOM_DATA env var or the config API at localhost:9090/v1/config. Example: {\"map\": \"forest\", \"mode\": \"ranked\"}.","uniqueKey":"custom_data","typeLabel":"object"},"match_id":{"type":"string","description":"Match identifier for matchmaking integration. Auto-generated if not provided. Use this to link servers to your matchmaking system.","uniqueKey":"match_id","typeLabel":"string"},"environment_variables":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"environment_variables.additionalProperties","typeLabel":"string"},"description":"Additional environment variables injected into the game container. Merged with project-level defaults (server-level values override project defaults). Example: {\"LOG_LEVEL\": \"debug\"}.","uniqueKey":"environment_variables","typeLabel":"object"},"port_configs":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Unique name for this port (e.g., \"game_udp\", \"voice_tcp\"). Used to identify the port in network_ports responses.","isRequired":true,"uniqueKey":"port_configs.items.[INDEX].name","typeLabel":"string"},"internal_port":{"type":"integer","minimum":1,"maximum":65535,"description":"Port number your game server listens on inside the container (1–65535). This is the port your game code binds to.","isRequired":true,"uniqueKey":"port_configs.items.[INDEX].internal_port","typeLabel":"integer"},"protocol":{"type":"string","enum":["udp","tcp"],"description":"Network protocol. Use \"udp\" for real-time game traffic (FPS, racing) or \"tcp\" for reliable connections (turn-based, WebSocket).","isRequired":true,"uniqueKey":"port_configs.items.[INDEX].protocol","typeLabel":"enum\u003cstring>"},"tls_enabled":{"type":"boolean","default":false,"description":"Enable automatic TLS termination for this port. Only valid for TCP ports. Clients connect with TLS and PlayFlow terminates it before forwarding to your server.","uniqueKey":"port_configs.items.[INDEX].tls_enabled","typeLabel":"boolean"}},"required":["name","internal_port","protocol"],"description":"Override the project-level port configuration for a specific server. Allows customizing ports on a per-server basis at start time.","uniqueKey":"port_configs.items.[INDEX]","typeLabel":"object"},"description":"Override the project-level port configuration for this specific server. If omitted, the project's default port_configs are used.","uniqueKey":"port_configs","typeLabel":"object[]"}},"required":["name","region"],"description":"Configuration for starting a new game server instance.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","region":"\u003cstring>","startup_args":"\u003cstring>","compute_size":"small","version_tag":"\u003cstring>","version":123,"ttl":43230,"auto_restart":false,"custom_data":{},"match_id":"\u003cstring>","environment_variables":{},"port_configs":[{"name":"\u003cstring>","internal_port":32768,"tls_enabled":false}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"5835f633-6179-4bb3-936b-6fcfbcd8f59f":{"description":"Server created and launching. The `network_ports` array contains connection details for game clients. Poll `GET /servers/{instance_id}` until status is `running`.","content":{"application/json":{"schema":{"type":"object","properties":{"instance_id":{"type":"string","description":"Unique identifier for this server instance (UUID). Use this to reference the server in all other API calls.","isRequired":true,"uniqueKey":"instance_id","typeLabel":"string"},"name":{"type":"string","description":"Display name of the server, as provided when starting.","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"status":{"type":"string","enum":["launching","running","stopped"],"description":"Current server status. \"launching\": machine is being created and game is starting up. \"running\": game is ready and accepting connections. \"stopped\": server has been shut down.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"network_ports":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Port name matching the port_configs entry (e.g., \"game_udp\").","isRequired":true,"uniqueKey":"network_ports.items.[INDEX].name","typeLabel":"string"},"internal_port":{"type":"number","description":"Port number the game server listens on inside the container.","isRequired":true,"uniqueKey":"network_ports.items.[INDEX].internal_port","typeLabel":"number"},"external_port":{"type":"number","description":"Public port number that players connect to from outside.","isRequired":true,"uniqueKey":"network_ports.items.[INDEX].external_port","typeLabel":"number"},"protocol":{"type":"string","enum":["udp","tcp"],"description":"Network protocol for this port.","isRequired":true,"uniqueKey":"network_ports.items.[INDEX].protocol","typeLabel":"enum\u003cstring>"},"host":{"type":"string","description":"Hostname or IP address players connect to. For UDP: a proxy IPv4 address. For TCP: \"connect.computeflow.cloud\" (Fly.io L7 routing).","isRequired":true,"uniqueKey":"network_ports.items.[INDEX].host","typeLabel":"string"},"tls_enabled":{"type":"boolean","description":"Whether TLS termination is enabled for this port (TCP only).","isRequired":true,"uniqueKey":"network_ports.items.[INDEX].tls_enabled","typeLabel":"boolean"}},"required":["name","internal_port","external_port","protocol","host","tls_enabled"],"description":"A network port mapping showing how external traffic reaches your game server. Use host:external_port as the connection address for game clients.","uniqueKey":"network_ports.items.[INDEX]","typeLabel":"object"},"description":"List of allocated network ports with connection details. Give host:external_port to game clients for connecting. Empty if the server has stopped.","isRequired":true,"uniqueKey":"network_ports","typeLabel":"object[]"},"startup_args":{"oneOf":[{"type":"string","description":"Command-line arguments passed to the game executable. Null if none were provided.","isRequired":true,"uniqueKey":"startup_args.oneOf.0","typeLabel":"string"},{"type":"null","description":"Command-line arguments passed to the game executable. Null if none were provided.","isRequired":true,"uniqueKey":"startup_args.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"startup_args","typeLabel":"string | null"},"service_type":{"type":"string","enum":["match_based","persistent_world"],"description":"Server type. \"match_based\" (default): short-lived servers for individual matches. \"persistent_world\": long-running servers for persistent game worlds.","isRequired":true,"uniqueKey":"service_type","typeLabel":"enum\u003cstring>"},"compute_size":{"type":"string","description":"Machine size this server is running on (e.g., \"small\", \"medium\", \"dedicated-large\").","isRequired":true,"uniqueKey":"compute_size","typeLabel":"string"},"region":{"type":"string","description":"Region where this server is deployed (e.g., \"us-east\", \"eu-west\").","isRequired":true,"uniqueKey":"region","typeLabel":"string"},"version_tag":{"type":"string","description":"Build name this server was started with (e.g., \"default\", \"beta\").","isRequired":true,"uniqueKey":"version_tag","typeLabel":"string"},"version":{"oneOf":[{"type":"number","description":"Build version number this server is running. Null if no specific version was resolved.","isRequired":true,"uniqueKey":"version.oneOf.0","typeLabel":"number"},{"type":"null","description":"Build version number this server is running. Null if no specific version was resolved.","isRequired":true,"uniqueKey":"version.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"version","typeLabel":"number | null"},"started_at":{"oneOf":[{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the server transitioned to \"running\" status (game ports opened). Null if still launching or never reached running state.","isRequired":true,"uniqueKey":"started_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"ISO 8601 timestamp when the server transitioned to \"running\" status (game ports opened). Null if still launching or never reached running state.","isRequired":true,"uniqueKey":"started_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"started_at","typeLabel":"string\u003cdate-time> | null"},"stopped_at":{"oneOf":[{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the server was stopped. Null if the server is still active.","isRequired":true,"uniqueKey":"stopped_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"ISO 8601 timestamp when the server was stopped. Null if the server is still active.","isRequired":true,"uniqueKey":"stopped_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"stopped_at","typeLabel":"string\u003cdate-time> | null"},"auto_restart":{"type":"boolean","description":"Whether the game process auto-restarts on crash (max 10 retries).","isRequired":true,"uniqueKey":"auto_restart","typeLabel":"boolean"},"custom_data":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"custom_data.oneOf.0.additionalProperties","typeLabel":"any"},"description":"Arbitrary metadata attached to this server. Null if no custom data was provided.","isRequired":true,"uniqueKey":"custom_data.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{}],"uniqueKey":"custom_data.oneOf.1.additionalProperties","typeLabel":"any"},"description":"Arbitrary metadata attached to this server. Null if no custom data was provided.","isRequired":true,"uniqueKey":"custom_data.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"custom_data","typeLabel":"object | null"},"ttl":{"oneOf":[{"type":"number","description":"Time-to-live in seconds. The server auto-stops after this duration from start. Null if no TTL was set (server runs until explicitly stopped).","isRequired":true,"uniqueKey":"ttl.oneOf.0","typeLabel":"number"},{"type":"null","description":"Time-to-live in seconds. The server auto-stops after this duration from start. Null if no TTL was set (server runs until explicitly stopped).","isRequired":true,"uniqueKey":"ttl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"ttl","typeLabel":"number | null"},"is_pool_server":{"type":"boolean","description":"Whether this server was claimed from the pre-provisioned pool. Pool servers have faster startup times (~5s vs ~30s).","isRequired":true,"uniqueKey":"is_pool_server","typeLabel":"boolean"},"pool_claimed_at":{"oneOf":[{"type":"string","format":"date-time","description":"ISO 8601 timestamp when this pool server was claimed for use. Null for non-pool servers or unclaimed pool machines.","isRequired":true,"uniqueKey":"pool_claimed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"ISO 8601 timestamp when this pool server was claimed for use. Null for non-pool servers or unclaimed pool machines.","isRequired":true,"uniqueKey":"pool_claimed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"pool_claimed_at","typeLabel":"string\u003cdate-time> | null"},"match_id":{"oneOf":[{"type":"string","description":"Match identifier for matchmaking integration. Auto-generated if not provided at start time.","isRequired":true,"uniqueKey":"match_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Match identifier for matchmaking integration. Auto-generated if not provided at start time.","isRequired":true,"uniqueKey":"match_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"match_id","typeLabel":"string | null"},"created_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the server instance was created in the database.","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp of the last update to this server record.","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"}},"required":["instance_id","name","status","network_ports","startup_args","service_type","compute_size","region","version_tag","version","started_at","stopped_at","auto_restart","custom_data","ttl","is_pool_server","pool_claimed_at","match_id","created_at","updated_at"],"description":"Complete details of a game server instance, including connection info, status, and configuration.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"instance_id":"\u003cstring>","name":"\u003cstring>","status":"launching","network_ports":[{"name":"\u003cstring>","internal_port":123,"external_port":123,"protocol":"udp","host":"\u003cstring>","tls_enabled":true}],"startup_args":"\u003cstring>","service_type":"match_based","compute_size":"\u003cstring>","region":"\u003cstring>","version_tag":"\u003cstring>","version":123,"started_at":"2023-11-07T05:31:56Z","stopped_at":"2023-11-07T05:31:56Z","auto_restart":true,"custom_data":{},"ttl":123,"is_pool_server":true,"pool_claimed_at":"2023-11-07T05:31:56Z","match_id":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"0648c24c-6553-4c47-aec3-e48fcddd9e9d":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"api-key","scopes":[]}}},"servers":{"10dc6c24-ec8f-48c6-85d3-b4e04b596923":{"url":"https://api.computeflow.cloud"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"api-key","scopes":[]},"schema":{"title":"api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"api-key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"https://api.computeflow.cloud/api/doc"},"subdomain":"playflow","siteName":"Documentation - PlayFlow Cloud","title":"PlayFlow Cloud Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-13T17:20:49.273Z","originalFileLocation":"api-reference/servers/start-a-new-server.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Creates and launches a new game server instance. The server starts in launching status and transitions to running when the game process opens its configured ports (typically 10–30 seconds, or ~5 seconds if a pool server is available). The response includes network_ports with the connection details (host + external_port) that game clients need to connect. Plan limits: Free plan allows 1 active server with a 1-hour TTL and small compute. Pro plan unlocks unlimited servers with all compute sizes. Build resolution: Uses the latest ready build matching version_tag (defaults to \u0026quot;default\u0026quot;). Pin to a specific build with the version parameter.\">\u003cmeta data-mint-head name=\"keywords\" content=\"PlayFlow, PlayFlow Cloud, game development, multiplayer, Unity, Unreal Engine, Godot, game servers, server hosting, matchmaking, lobbies, WebGL, game backend, documentation\">\u003cmeta data-mint-head name=\"application-name\" content=\"Documentation - PlayFlow Cloud\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/playflow/bdsieV7iirvG9AV3/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/playflow/bdsieV7iirvG9AV3/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/playflow/bdsieV7iirvG9AV3/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/playflow/bdsieV7iirvG9AV3/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/playflow/bdsieV7iirvG9AV3/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/playflow/bdsieV7iirvG9AV3/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/playflow/bdsieV7iirvG9AV3/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/playflow/bdsieV7iirvG9AV3/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/playflow/bdsieV7iirvG9AV3/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"PlayFlow Cloud Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Official documentation for PlayFlow Cloud. Learn to build, deploy, and scale multiplayer games with our tools for server hosting, matchmaking, and lobbies.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"PlayFlow Cloud\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.playflowcloud.com/api-reference/servers/start-a-new-server\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://playflow.mintlify.app/_mintlify/api/og/v2?division=Servers\u0026amp;title=Start+a+new+server\u0026amp;description=Creates+and+launches+a+new+game+server+instance.+The+server+starts+in+%60launching%60+status+and+transitions+to+%60running%60+when+the+game+process+opens+its+configured\u0026amp;theme=efdcb79398ff0a4a395f8bf0\u0026amp;signature=bbc2ceb3a29579b0f905c2f8350a1aef31f137a3365b6bc97f4424f52a8b5102\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"PlayFlow Cloud Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Official documentation for PlayFlow Cloud. Learn to build, deploy, and scale multiplayer games with our tools for server hosting, matchmaking, and lobbies.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://playflow.mintlify.app/_mintlify/api/og/v2?division=Servers\u0026amp;title=Start+a+new+server\u0026amp;description=Creates+and+launches+a+new+game+server+instance.+The+server+starts+in+%60launching%60+status+and+transitions+to+%60running%60+when+the+game+process+opens+its+configured\u0026amp;theme=efdcb79398ff0a4a395f8bf0\u0026amp;signature=bbc2ceb3a29579b0f905c2f8350a1aef31f137a3365b6bc97f4424f52a8b5102\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/playflow/bdsieV7iirvG9AV3/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Documentation - PlayFlow Cloud\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2563EB\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"author\" content=\"PlayFlow Cloud\">\u003cmeta data-mint-head name=\"googlebot\" content=\"index, follow\">\u003cmeta data-mint-head name=\"language\" content=\"en\">\u003cmeta data-mint-head name=\"copyright\" content=\"Copyright 2025 PlayFlow Cloud\">\u003cmeta data-mint-head name=\"distribution\" content=\"global\">\u003cmeta data-mint-head name=\"coverage\" content=\"Worldwide\">\u003cmeta data-mint-head name=\"category\" content=\"Game Development\">\u003cmeta data-mint-head name=\"twitter:creator\" content=\"@PlayFlowCloud\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.playflowcloud.com/api-reference/servers/start-a-new-server\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/servers/start-a-new-server.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.playflowcloud.com/#organization\",\"name\":\"Documentation - PlayFlow Cloud\",\"url\":\"https://docs.playflowcloud.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/playflow/eqeqAmqAMsOYKFZn/logo/svgs/3.svg?fit=max\u0026auto=format\u0026n=eqeqAmqAMsOYKFZn\u0026q=85\u0026s=ec6b551d72d9a0550eceaf8372781505\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.playflowcloud.com#website\",\"name\":\"Documentation - PlayFlow Cloud\",\"url\":\"https://docs.playflowcloud.com\",\"publisher\":{\"@id\":\"https://docs.playflowcloud.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.playflowcloud.com/api-reference/servers/start-a-new-server#webpage\",\"url\":\"https://docs.playflowcloud.com/api-reference/servers/start-a-new-server\",\"name\":\"Start a new server\",\"description\":\"Creates and launches a new game server instance. The server starts in launching status and transitions to running when the game process opens its configured ports (typically 10–30 seconds, or ~5 seconds if a pool server is available). The response includes network_ports with the connection details (host + external_port) that game clients need to connect. Plan limits: Free plan allows 1 active server with a 1-hour TTL and small compute. Pro plan unlocks unlimited servers with all compute sizes. Build resolution: Uses the latest ready build matching version_tag (defaults to \\\"default\\\"). Pin to a specific build with the version parameter.\",\"dateModified\":\"2026-07-13T17:20:49.273Z\",\"isPartOf\":{\"@id\":\"https://docs.playflowcloud.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.playflowcloud.com/api-reference/servers/start-a-new-server#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.playflowcloud.com/api-reference/servers/start-a-new-server#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.playflowcloud.com/api-reference/servers/get-the-authoritative-match-roster\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Servers\",\"item\":\"https://docs.playflowcloud.com/api-reference/servers/get-the-authoritative-match-roster\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Start a new server\",\"item\":\"https://docs.playflowcloud.com/api-reference/servers/start-a-new-server\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.playflowcloud.com/api-reference/servers/start-a-new-server#apireference\",\"headline\":\"Start a new server\",\"name\":\"Start a new server\",\"description\":\"Creates and launches a new game server instance. The server starts in launching status and transitions to running when the game process opens its configured ports (typically 10–30 seconds, or ~5 seconds if a pool server is available). The response includes network_ports with the connection details (host + external_port) that game clients need to connect. Plan limits: Free plan allows 1 active server with a 1-hour TTL and small compute. Pro plan unlocks unlimited servers with all compute sizes. Build resolution: Uses the latest ready build matching version_tag (defaults to \\\"default\\\"). Pin to a specific build with the version parameter.\",\"url\":\"https://docs.playflowcloud.com/api-reference/servers/start-a-new-server\",\"mainEntityOfPage\":{\"@id\":\"https://docs.playflowcloud.com/api-reference/servers/start-a-new-server#webpage\"},\"dateModified\":\"2026-07-13T17:20:49.273Z\",\"publisher\":{\"@id\":\"https://docs.playflowcloud.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.playflowcloud.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Documentation - PlayFlow Cloud\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Documentation - PlayFlow Cloud","nav":{"global":{"anchors":[{"anchor":"Community","icon":"discord","href":"https://discord.gg/P5w45Vx5Q8"},{"anchor":"Blog","icon":"newspaper","href":"https://playflowcloud.com/"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Overview","icon":"book-open","pages":[{"title":"API Introduction","icon":"book-open","href":"/api-reference/introduction"}]},{"group":"Endpoints","icon":"code","pages":[{"group":"Servers","pages":[{"title":"Get the authoritative match roster","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc get /api/v3/servers/{instance_id}/roster","href":"/api-reference/servers/get-the-authoritative-match-roster"},{"title":"Override backfill state (server-authoritative)","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc patch /api/v3/servers/{instance_id}/backfill","href":"/api-reference/servers/override-backfill-state-server-authoritative"},{"title":"Close backfill (server-authoritative)","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc post /api/v3/servers/{instance_id}/backfill/lock","href":"/api-reference/servers/close-backfill-server-authoritative"},{"title":"List servers","description":"Returns a paginated list of game servers for your project. By default, only servers in `running` status are returned. Use `include_launching=true` to also see servers that are still starting up, or `include_pool=true` to include pre-provisioned pool machines.","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc get /api/v3/servers","href":"/api-reference/servers/list-servers"},{"title":"Start a new server","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc post /api/v3/servers/start","href":"/api-reference/servers/start-a-new-server"},{"title":"Get server details","description":"Returns the full details of a specific server instance, including its current status, network ports, configuration, and metadata. Use this to poll for status changes (e.g., wait for `launching` → `running`) or to get connection info for game clients.","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc get /api/v3/servers/{instance_id}","href":"/api-reference/servers/get-server-details"},{"title":"Stop a server","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc delete /api/v3/servers/{instance_id}","href":"/api-reference/servers/stop-a-server"},{"title":"Update server custom_data","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc post /api/v3/servers/{instance_id}/update","href":"/api-reference/servers/update-server-custom_data"},{"title":"Restart a server","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc post /api/v3/servers/{instance_id}/restart","href":"/api-reference/servers/restart-a-server"},{"title":"Get server runtime logs","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc get /api/v3/servers/{instance_id}/logs","href":"/api-reference/servers/get-server-runtime-logs"},{"title":"Get server resource metrics","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc get /api/v3/servers/{instance_id}/metrics","href":"/api-reference/servers/get-server-resource-metrics"},{"title":"Get server log-volume histogram","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc get /api/v3/servers/{instance_id}/log-histogram","href":"/api-reference/servers/get-server-log-volume-histogram"}]},{"group":"Projects","pages":[{"title":"Get project-wide log-volume histogram","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc get /api/v3/projects/log-histogram","href":"/api-reference/projects/get-project-wide-log-volume-histogram"},{"title":"Get project-wide server logs","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc get /api/v3/projects/logs","href":"/api-reference/projects/get-project-wide-server-logs"},{"title":"Get project settings","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc get /api/v3/projects/settings","href":"/api-reference/projects/get-project-settings"},{"title":"Update project settings","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc post /api/v3/projects/settings","href":"/api-reference/projects/update-project-settings"}]},{"group":"Builds","pages":[{"title":"List builds","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc get /api/v3/builds","href":"/api-reference/builds/list-builds"},{"title":"Get presigned upload URL","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc post /api/v3/builds/upload-url","href":"/api-reference/builds/get-presigned-upload-url"},{"title":"Create build from Docker image","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc post /api/v3/builds/docker-image","href":"/api-reference/builds/create-build-from-docker-image"},{"title":"Get build details","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc get /api/v3/builds/{build_id}","href":"/api-reference/builds/get-build-details"},{"title":"Delete a build","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc delete /api/v3/builds/{build_id}","href":"/api-reference/builds/delete-a-build"},{"title":"Get build processing logs","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc get /api/v3/builds/{build_id}/logs","href":"/api-reference/builds/get-build-processing-logs"}]},{"group":"Lobbies","pages":[{"title":"Browse lobbies","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc get /api/v3/lobbies/{config}","href":"/api-reference/lobbies/browse-lobbies"},{"title":"Create a lobby","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc post /api/v3/lobbies/{config}","href":"/api-reference/lobbies/create-a-lobby"},{"title":"Join a lobby","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc post /api/v3/lobbies/{config}/join","href":"/api-reference/lobbies/join-a-lobby"},{"title":"Get my lobby","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc get /api/v3/lobbies/{config}/me","href":"/api-reference/lobbies/get-my-lobby"},{"title":"Leave a lobby","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc delete /api/v3/lobbies/{config}/me","href":"/api-reference/lobbies/leave-a-lobby"},{"title":"Update my player state","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc patch /api/v3/lobbies/{config}/me","href":"/api-reference/lobbies/update-my-player-state"},{"title":"Update lobby settings","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc patch /api/v3/lobbies/{config}/me/settings","href":"/api-reference/lobbies/update-lobby-settings"},{"title":"Kick a player","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc delete /api/v3/lobbies/{config}/me/players/{playerId}","href":"/api-reference/lobbies/kick-a-player"},{"title":"Start the game","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc post /api/v3/lobbies/{config}/me/start","href":"/api-reference/lobbies/start-the-game"},{"title":"Start matchmaking","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc post /api/v3/lobbies/{config}/me/matchmaking","href":"/api-reference/lobbies/start-matchmaking"},{"title":"Cancel matchmaking","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc delete /api/v3/lobbies/{config}/me/matchmaking","href":"/api-reference/lobbies/cancel-matchmaking"},{"title":"End the current match","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc post /api/v3/lobbies/{config}/me/end-match","href":"/api-reference/lobbies/end-the-current-match"},{"title":"Confirm a found match","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc post /api/v3/lobbies/{config}/me/confirm-match","href":"/api-reference/lobbies/confirm-a-found-match"},{"title":"Decline a found match","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc delete /api/v3/lobbies/{config}/me/confirm-match","href":"/api-reference/lobbies/decline-a-found-match"},{"title":"Send a player heartbeat","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc post /api/v3/lobbies/{config}/me/heartbeat","href":"/api-reference/lobbies/send-a-player-heartbeat"},{"title":"Subscribe to lobby events (SSE)","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc get /api/v3/lobbies/{config}/me/events","href":"/api-reference/lobbies/subscribe-to-lobby-events-sse"},{"title":"Get lobby by ID","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc get /api/v3/lobbies/{config}/{id}","href":"/api-reference/lobbies/get-lobby-by-id"},{"title":"Delete a lobby by ID (admin)","deprecated":null,"version":null,"openapi":"https://api.computeflow.cloud/api/doc delete /api/v3/lobbies/{config}/{id}","href":"/api-reference/lobbies/delete-a-lobby-by-id-admin"}]}]}]}]},"title":"PlayFlow Cloud Documentation","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","Page-n7I5XbKb.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}