GET /application — List applications

GET https://api.sandbox-gameye.gameye.net/application

Returns all applications registered to your account.

Requires the application:read scope.

Code Examples

cURL

curl 'https://api.sandbox-gameye.gameye.net/application' \
--header 'Authorization: Bearer YOUR_TOKEN' \
--header 'Accept: application/json'

JavaScript

const response = await fetch('https://api.sandbox-gameye.gameye.net/application', {
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Accept': 'application/json',
  },
});
const { applications } = await response.json();

Python

import requests

response = requests.get(
    'https://api.sandbox-gameye.gameye.net/application',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Accept': 'application/json',
    },
)
applications = response.json()['applications']

Responses

200

A list of all registered applications.

Field	Type	Required	Description
name	string	Yes	The application name (used as image when starting sessions).
repository	string	Yes	The repository path within the registry.
tagKeep	integer	Yes	Number of tags retained in the fleet.
networkMode	string	Yes	Container networking mode.
limits	object	Yes	Hard resource limits (cpu, ram, optional gpu).
reservation	object	Yes	Soft resource reservations (cpu, ram, optional gpu).
ports	array	Yes	Port bindings (requested, protocol, tls).
regions	array	Yes	Regions where the application is available.
registry	string	No	The container registry.
nodePool	string	No	The node pool this application deploys onto.

{
  "applications": [
    {
      "name": "my-game-server",
      "repository": "myorg/my-game-server",
      "tagKeep": 5,
      "networkMode": "bridge",
      "limits": { "cpu": 2.0, "ram": 4096 },
      "reservation": { "cpu": 1.0, "ram": 2048 },
      "registry": "dockerhub",
      "nodePool": "default",
      "regions": ["europe"],
      "ports": [
        { "requested": 7777, "protocol": "udp", "tls": false }
      ]
    }
  ]
}

401

You are not authorized. Make sure your bearer token is correct.

403

Your API token does not have the required permissions to invoke this endpoint.