Lobby Service

This service is intended for peer-to-peer games utilizing Edgegap Distributed Relays, and does not currently support deploying dedicated servers. Please refer to our matchmaker for dedicated servers support, or reach out to us on Community Discord for help.

Lobby service is currently supported with no plans for deprecation. Stay tuned for private clusters and other announcements coming soon!

In order to be able to group players in your peer-to-peer game through our lobbies, you will need to deploy a service to manage them beforehand. This can easily be done through a few calls to our API.

To do so, you will need to get an API token from the Edgegap dashboard if you do not have one already. Once you have one, make sure to include it in the authorization headers of all your service requests

Creating a new service

Creating a new lobby service is as easy as sending a POST request to /v1/lobbies along with what you wish to name it.

{
  "name": "string"
}

The newly created service will not be ready to be used quite yet, you will then need to deploy it.

Deploying a service

To deploy a service, send a POST request to /v1/lobbies:deploy with the name of your service.

{
  "name": "string"
}

This will take a short while to complete after going through some validations. You can track its status by sending GET requests to /v1/lobbies/{service_name}, or by viewing it in your Relay Profiles in the dashboard once it is active and running.

Once that is the case, you will get a response that contains a URL when sending the previously mentionned GET request. This is the URL you will be querying in your game in order to manage the lobbies. The requests sent to this URL do not need to include the Edgegap API token in the authorization headers.

{
  "name": "string",
  "url": "string",
  "status": "string"
}

Terminating a service

If you wish to terminate a service, you simply need to send a POST request to /v1/lobbies:terminate along with the service's name.

{
  "name": "string"
}

This will not delete the service, but merely deactivate it. If you wish, you could still re-deploy it afterwards.