Gameye Session API Overview

the gameye session api provides a simple, agnostic way to host containerized game sessions it handles all the complexity of geographic distribution, capacity management, and scaling so you can focus on delivering great gaming experiences key features global deployment host sessions in various regions worldwide to minimize latency containerized sessions each game session runs in its own isolated container easy scaling no need to worry about server capacity or hardware management session management start, list, and stop game sessions with simple api calls artifact collection download files (like logs or save data) from game servers location monitoring check which regions are available for hosting your game tag verification verify if specific image versions are available in the fleet log streaming access server logs for debugging and monitoring enhanced error handling detailed error responses with correlation ids v2 improvements the latest version of our api includes significant improvements standardized region names using a mix of standardized region names including both cloud regions (like eu west 1 ) and data center locations for clearer geographic understanding advanced session filtering new filtering options including the ability to exclude sessions based on specific criteria detailed container states more granular status information for containers improved error responses structured error format with correlation ids for better debugging dedicated port range updated port range (20000 30000) to prevent conflicts with linux ephemeral ports optional session ids system can generate rfc4122 compliant uuids when session id is not provided enhanced logging options standard api access and advanced elastic based solution how it works authentication every request requires a bearer token for authentication session creation you request a session in a specific region with your game image session allocation gameye finds an available server in the requested region container deployment your game server is deployed as a container session management you can list active sessions and stop them when needed cleanup after stopping a session, you can download artifacts if needed use cases multiplayer game servers host game matches in containers tournament infrastructure scale up for esports events global gaming provide low latency experiences worldwide development & testing use the sandbox environment for testing getting started to start using the api obtain an api token from gameye choose which environment to use (production or sandbox) make your first api call to create a session check the authentication guide to learn how to properly authenticate your requests api versioning this documentation covers version 1 2 1 of the gameye session api, which incorporates the enhanced features described in our migration guide