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
API
API endpoints

Open API spec

3min

If you need these commands on hand, you can download the Open API YAML file.

The Gameye Session API offers an agnostic way of hosting containerized game sessions without needing to worry about geographic capacity or scalability issues. The API gives you a suite of features to host your multiplayer game.

How do you authenticate?

All our endpoints need authorization. You can do this through Bearer Token Authentication.

You'll need to ask our support team for your Bearer Token. Then, make sure you add it in the header of each request.

For example, if you wanted to use the endpoint to list current sessions, you'd write:

Authorization: Bearer <token>


Api token (HTTP)

Send a bearer token (“token” Formatted) in the Authorization http header to authenticate with the API.



This is the documentation for version 1.2.1 of the API. Last update on Jun 1, 2023.

Updated 22 Jun 2023
Did this page help you?
PREVIOUS
5. Start the API call
NEXT
Launch a session
Docs powered by
Archbee
Authorization: Bearer <token>