Start a new game session in a specific region. Each session needs a unique ID, which you'll need to create yourself.

Each call to the API to launch a session must be a UUID to avoid any issues.

Launch a session

The unique ID for the session. (use a UUID.)

The location or region that you'd prefer to host the game session in. (Check our regions and locations page.)

location

The name of the image for your game, hosted inside a container. 

image

The list of environment variables you want to feed the container when it starts. [can be left blank]

The list of program console arguments to feed to the application that's hosted inside the container. [can be left blank]

args

Tells us whether we must automatically restart this session if it fails to launch. (We won't restart if you manually shut it down.) 

restart

Add your own metadata about the session that we'll store inside the configuration.

labels

Tag of the image that the session will run. This tag needs to be available
or it'll throw a 404. If you don't specify a priority, we'll run it with the highest priority.

version

Use this to collect details like CPU, memory and network information. Useful for debugging.

enableMetrics

although not depicted in the API responses, 420 is still returned for sessions that failed to start.

Open API spec

List current sessions

Gameye 

What is Gameye?

Getting ready to start

1. Set up your Docker Hub account

2: Set up your organization on Gameye

3. Sort and push your Docker file

4. Configure your ports

5. Start the API call

Getting started

Stop a session

Download your artifacts

Get real-time logs

Get all logs

List available locations

API endpoints

Regions and locations

Error handling

Using Photon Fusion

Integrations

Orchestrator V2 Migration Guide

Using container labels

Using  variables

Selecting the correct build

Generating logs

Customer dashboard

Using Gameye

Creating a Dockerhub account

Install Docker on CentOS

Install Docker on Ubuntu or Debian

Working with Docker

Guides

Getting support

Giving feedback

Support

Troubleshooting problems

Troubleshooting

How do I start using Gameye?

Do you require authorisation to use the API?

How does Gameye scale?

What is the difference between a location and a region?

Is Gameye free to use?

FAQs

Docker

Container

Region

Image Registry

Bare metal

Flex metal

Cloud

Matchmaker

Glossary

Changelogs