Applications

Get an Application Version

Retrieve the specifications of an application version.

get/v1/app/{app_name}/version/{version_name}

Request

  • Base URL: https://api.edgegap.com
  • URL: https://api.edgegap.com/v1/app/{app_name}/version/{version_name}
  • Auth: API key in header authorization

Path parameters

app_namestring required

The name of the application

version_namestring required

The name of the application version

Response

Success

namestring required

This is the identifier for your version. It’s often linked to a build version, but can be any unique name.

is_activeboolean

This boolean tells the system whether this version can be deployed or is deactivated.

docker_repositorystring required

‘docker_repository’ is named incorrectly, this property references the Docker registry where this version’s container image is hosted (e.g., ‘registry.edgegap.com’ or ‘docker.io’).

docker_imagestring required

The Docker image for your version, usually including a namespace or project.

docker_tagstring required

The Docker tag for your version. It must be valid according to your Docker image.

private_usernamestring

The username used to access your container registry. This is not your Edgegap account credential.

private_tokenstring

The token or password used to access your container registry. This is not your Edgegap account password.

req_cpuinteger required

The number of vCPU units required to run your server container (1024 units = 1 vCPU).

req_memoryinteger required

The amount of memory in MB required to run your server container (1024 MB = 1 GB). It can be at most twice the number of vCPU units requested.

req_videointeger

Units of GPU needed (1024 = 1 GPU)

max_durationinteger

The maximum duration in minutes the app version can run before being automatically stopped. If omitted, the default is 1440 minutes (24 hours).

force_cacheboolean

Enable faster deployments by caching your container across all Edgegap locations. Recommended for live games.

caching_percentnumber

Current caching percentage on scale 0-1, with 1 meaning 100% global cache coverage. Values above 0.8 are considered to be a good caching coverage level.

kindstring

Specifies whether the app version is a default or session-based version (e.g., “default” or “session”).

time_to_deployinteger

Time in seconds to wait for the app version to deploy before marking it as failed. Useful for enforcing strict deployment time limits.

verify_imageboolean

By enabling the verify_image option, your image information (docker_repository, docker_image, docker_tag) will be tested to ensure the image can be pulled successfully.

termination_grace_period_secondsinteger

Termination grace period in seconds after sending the SIGTERM signal to the container. Allows graceful shutdown and post-processing before the container stops.

endpoint_storagestring

The name of the endpoint storage to use to store the container logs at the end of the deployment. This will overwrite the default storage in the app version.

commandstring nullable

Entrypoint/command override for your container. This replaces the default command and should be used with caution.

argumentsstring nullable

Arguments to pass to the container’s command. This replace the default arguments and should be used with caution

create_timestring date-time

The creation time of the app version

last_updatedstring date-time

The last update time of the app version

dns_configstring

The name of the DNS configuration to link with your deployment.

will_deploy_in_mainland_chinaboolean

If true, the app version will only be deployed in Mainland China locations. Otherwise, it will never deploy in Mainland China locations.

restart_policy'always' | 'never' | 'on_failure'

The restart policy for the deployment. The default is to always restart unless you terminate the deployment.

Example response

{
  "name": "1.0.0",
  "is_active": true,
  "docker_repository": "docker.io",
  "docker_image": "edgegap/lyrastartergame",
  "docker_tag": "25.05.30-16.45.19-04",
  "private_username": "my_username",
  "private_token": "my_password",
  "req_cpu": 1536,
  "req_memory": 3072,
  "max_duration": 30,
  "force_cache": true,
  "caching_percent": 0.8,
  "time_to_deploy": 300,
  "session_config": {
    "kind": "Seat",
    "sockets": 10,
    "empty_ttl": 60
  },
  "ports": [
    {
      "port": 7777,
      "protocol": "UDP",
      "to_check": true,
      "name": "game_port"
    }
  ],
  "envs": [
    {
      "key": "MAP_ID",
      "value": "forest1"
    }
  ],
  "verify_image": true,
  "termination_grace_period_seconds": 5,
  "endpoint_storage": "my-storage",
  "command": "null | 'string'",
  "arguments": "null | 'string'",
  "restart_policy": "always"
}

Changes

No recorded changes to this operation across all 1 revision of this API.