POST /application — Create an application
POST https://api.sandbox-gameye.gameye.net/application
Section titled “POST https://api.sandbox-gameye.gameye.net/application”Creates a new application. An application is the registration of a container image repository with its resource requirements and regional availability. Once created, you can enable specific image tags for pre-loading and then start sessions using the application name.
Requires the application:write scope.
Request Body
Section titled “Request Body”| Field | Type | Required | Description | Example |
|---|---|---|---|---|
name | string | Yes | The name of the application. Used as the image field when starting sessions. | "my-game-server" |
registry | string | Yes | The container registry to pull images from. | "dockerhub" |
repository | string | Yes | The repository path within the registry. | "myorg/my-game-server" |
tagKeep | integer | Yes | The number of image tags to retain in the fleet. | 5 |
networkMode | string | Yes | The container networking mode. | "bridge" |
nodePool | string | Yes | The node pool to deploy this application onto. | "default" |
regions | array | Yes | The list of region names where this application is available. | ["europe", "us-east"] |
limits | object | Yes | Hard resource limits for the container. See below. | |
reservation | object | Yes | Soft resource reservations used for scheduling. See below. | |
ports | array | Yes | Port bindings to expose from the container. See below. |
limits and reservation objects
Section titled “limits and reservation objects”| Field | Type | Required | Description |
|---|---|---|---|
cpu | number | Yes | CPU cores (e.g. 1.0 = 1 core). |
ram | number | Yes | RAM in megabytes. |
gpu | number | No | GPU units (omit if not needed). |
Port binding object
Section titled “Port binding object”| Field | Type | Required | Description |
|---|---|---|---|
requested | integer | Yes | The container port to expose. |
protocol | string | Yes | Protocol: "tcp" or "udp". |
tls | boolean | Yes | Whether TLS termination is applied at the host. |
Code Examples
Section titled “Code Examples”curl -X POST 'https://api.sandbox-gameye.gameye.net/application' \--header 'Authorization: Bearer YOUR_TOKEN' \--header 'Content-Type: application/json' \--data '{ "name": "my-game-server", "registry": "dockerhub", "repository": "myorg/my-game-server", "tagKeep": 5, "networkMode": "bridge", "nodePool": "default", "regions": ["europe"], "limits": { "cpu": 2.0, "ram": 4096 }, "reservation": { "cpu": 1.0, "ram": 2048 }, "ports": [ { "requested": 7777, "protocol": "udp", "tls": false } ]}'const response = await fetch('https://api.sandbox-gameye.gameye.net/application', { method: 'POST', headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json', }, body: JSON.stringify({ name: 'my-game-server', registry: 'dockerhub', repository: 'myorg/my-game-server', tagKeep: 5, networkMode: 'bridge', nodePool: 'default', regions: ['europe'], limits: { cpu: 2.0, ram: 4096 }, reservation: { cpu: 1.0, ram: 2048 }, ports: [{ requested: 7777, protocol: 'udp', tls: false }], }),});Responses
Section titled “Responses”The application was successfully created.
You are not authorized. Make sure your bearer token is correct.
An application with the given name already exists.
Bad request. The given request has invalid syntax.