website logo
⌘K
What is Gameye?
Getting started
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
API
API endpoints
Regions and locations
Error handling
Guides
Integrations
Using Gameye
Working with Docker
Support
Getting support
Giving feedback
Troubleshooting
Troubleshooting problems
FAQs
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
Glossary
Docker
Container
Region
Image Registry
Bare metal
Flex metal
Cloud
Matchmaker
Changelogs
Docs powered by
Archbee
Getting started

5. Start the API call

3min

We’ll distribute your new image behind the scenes and get the sessions running. You just need to check that it’s working. Once we’ve pushed the image onto our servers, you should be able to call our API.

If nothing happens, then there’s a problem. We can work together to figure this out, just message our support team on Discord.

How do you know it’s working?

Whenever you successfully start a container through our API, it should return with an IP address and port for that container, which will let your players join the game.

Your API call should look like this:

API call to start a session




Updated 22 Jun 2023
Did this page help you?
PREVIOUS
4. Configure your ports
NEXT
Open API spec
Docs powered by
Archbee
API call to start a session