Skip to content

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.

FieldTypeRequiredDescriptionExample
namestringYesThe name of the application. Used as the image field when starting sessions."my-game-server"
registrystringYesThe container registry to pull images from."dockerhub"
repositorystringYesThe repository path within the registry."myorg/my-game-server"
tagKeepintegerYesThe number of image tags to retain in the fleet.5
networkModestringYesThe container networking mode."bridge"
nodePoolstringYesThe node pool to deploy this application onto."default"
regionsarrayYesThe list of region names where this application is available.["europe", "us-east"]
limitsobjectYesHard resource limits for the container. See below.
reservationobjectYesSoft resource reservations used for scheduling. See below.
portsarrayYesPort bindings to expose from the container. See below.
FieldTypeRequiredDescription
cpunumberYesCPU cores (e.g. 1.0 = 1 core).
ramnumberYesRAM in megabytes.
gpunumberNoGPU units (omit if not needed).
FieldTypeRequiredDescription
requestedintegerYesThe container port to expose.
protocolstringYesProtocol: "tcp" or "udp".
tlsbooleanYesWhether TLS termination is applied at the host.
cURL
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 }
]
}'
JavaScript
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 }],
}),
});

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.