Stop a server
Stops a running server. The status is updated to stopped immediately, and infrastructure cleanup happens in the background.
Optionally provide a shutdown_reason for analytics (e.g., PROCESS_EXITED, TTL_EXPIRED). PlayFlow also calls this automatically when the game process exits or TTL expires.
Authorizations
Path Parameters
Server instance ID to stop.
Query Parameters
Reason for stopping the server. Used for analytics and debugging. Common values: PROCESS_EXITED, TTL_EXPIRED, SHUTDOWN_SIGNAL, STARTUP_FAILURE_URL, STARTUP_FAILURE_DOWNLOAD, STARTUP_FAILURE_EXECUTABLE.
Response
Server stop initiated. Status is updated immediately; machine cleanup happens in the background.
Response returned after successfully stopping a server.
Confirmation message, e.g., "Server stopped successfully".