Gameye Match API (0.7.0)

Download OpenAPI specification:Download

The Gameye Match API let's you spawn containerized game servers without having to worry about geographic capacity or scalability. All API endpoints together offer a complete suite of features to host a dedicated server based multiplayer game.

Authentication

We use Bearer Tokens for authentication. You must send this token in the Authorization header in all requests.

Authorization: Bearer <token>

api-token

We use Bearer Tokens for authentication. You must send this token in the Authorization header in all requests.

Authorization: Bearer <token>

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "token"

Create a match Deprecated

Create a new on-demand game server.

The config object can be used to pass any dynamic parameters directly to the game server executable. Either as a startup parameters, configfile or environment variable. For more info see https://docs.gameye.com/docs/using-the-igniter-tool

Important

In extreme cases it can take up 50 seconds to start a server, after which we produce a time-out. Please adjust the time-out settings of your client accordingly.

Authorizations:
Request Body schema: application/json
matchKey
required
string non-empty

unique match id

gameKey
required
string non-empty

game id

locationKeys
required
Array of strings non-empty

location id

for available locations see https://docs.gameye.com/docs/choosing-your-server-locations

templateKey
required
string non-empty

template id

required
object

any custom parameters you want to add

endCallbackUrl
string non-empty

URL to call when the match has ended, optional

restart
boolean

A flag that indicates whether the match should always restart or not. This is an optional field and will yield 'false' if not provided.

sortAdvantages
Array of strings
Default: ["price"]

A list of advantages to sort on whilst searching for an appropriate machine to run the match on.

Responses

Request samples

Content type
application/json
{
  • "matchKey": "my-awesome-match",
  • "gameKey": "shooter-game",
  • "locationKeys": [
    ],
  • "templateKey": "deathmatch",
  • "config": {
    },
  • "endCallbackUrl": "https://mybackend/matchid",
  • "restart": true,
  • "sortAdvantages": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "my-awesome-match",
  • "image": "shooter-game",
  • "location": "eu-west",
  • "host": "127.0.0.1",
  • "port": {
    },
  • "created": 1589471457344
}

Create a match Deprecated

Create a new on-demand game server.

The config object can be used to pass any dynamic parameters directly to the game server executable. Either as a startup parameters, configfile or environment variable. For more info see https://docs.gameye.com/docs/using-the-igniter-tool

Important

In extreme cases it can take up 50 seconds to start a server, after which we produce a time-out. Please adjust the time-out settings of your client accordingly.

Authorizations:
Request Body schema: application/json
matchKey
required
string non-empty

unique match id

gameKey
required
string non-empty

game id

locationKeys
required
Array of strings non-empty

location id

for available locations see https://docs.gameye.com/docs/choosing-your-server-locations

templateKey
required
string non-empty

template id

required
object

any custom parameters you want to add

endCallbackUrl
string non-empty

URL to call when the match has ended, optional

restart
boolean

A flag that indicates whether the match should always restart or not. This is an optional field and will yield 'false' if not provided.

sortAdvantages
Array of strings
Default: ["price"]

A list of advantages to sort on whilst searching for an appropriate machine to run the match on.

Responses

Request samples

Content type
application/json
{
  • "matchKey": "my-awesome-match",
  • "gameKey": "shooter-game",
  • "locationKeys": [
    ],
  • "templateKey": "deathmatch",
  • "config": {
    },
  • "endCallbackUrl": "https://mybackend/matchid",
  • "restart": true,
  • "sortAdvantages": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "my-awesome-match",
  • "image": "shooter-game",
  • "location": "eu-west",
  • "host": "127.0.0.1",
  • "port": {
    },
  • "created": 1589471457344
}

Stop a match

Force shutdown the game server.

The game server process inside the container will receive SIGTERM.

Important

Depending on the game server it can take up to 20 seconds before the shutdown is completed.

Authorizations:
Request Body schema: application/json
matchKey
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "matchKey": "my-awesome-match"
}

Stop a match Deprecated

Force shutdown the game server.

The game server process inside the container will receive SIGTERM.

Important

Depending on the game server it can take up to 20 seconds before the shutdown is completed.

Authorizations:
Request Body schema: application/json
matchKey
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "matchKey": "my-awesome-match"
}

Get all matches

Fetches a list of all active matches.

Note that this list only displays active matches. When the game server process stops, the match is almost instantly removed from the list.

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "match": {
    }
}

Get all matches Deprecated

Fetches a list of all active matches.

Note that this list only displays active matches. When the game server process stops, the match is almost instantly removed from the list.

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "match": {
    }
}

Get match logs

Fetch the output that the game server writes to standard out (stdout).

This endpoint can used to provide secure and automated access to debug server related issues.

Important

Note that the logs can only be fetched after the match is stopped and that the logs are available up to four hours after the match has entered the stopped state.

Authorizations:
query Parameters
matchKey
required
string non-empty

Responses

Response samples

Content type
application/json
{
  • "3": {
    },
  • "4": {
    },
  • "5": {
    },
  • "6": {
    }
}

Get match logs Deprecated

Fetch the output that the game server writes to standard out (stdout).

This endpoint can used to provide secure and automated access to debug server related issues.