Application

All application endpoints

Get all your applications and their main details

get
Authorizations
PRIVATE-TOKENstringRequired
Header parameters
RANGED-DATAstringOptional

Example header and default range: RANGED-DATA:start=0,results=25

Responses
chevron-right
200

OK

application/json
idstringRead-onlyRequired

Application ID

typeinteger · integerRequired

The list of application type can be found in: GET /application/type

managementProtocolinteger · integerRequired

The protocol used to manage the application (defaults to None when not set):

  • 0: None
  • 1: A2S
  • 2: ARCUS
namestringRequired

The public name of your application

websiteUrlstringOptional

The url to your application's website

descriptionstringOptional

A short description of your application

developerNamestringOptional

The name of the application's developer

publisherNamestringOptional

The name of the application's publisher

stopDefaultOsGroupinteger · integerOptional

The default operating system group being used for the stop method. If you have a Windows and Linux ApplicationBuild you can overwrite this on the ApplicationBuild level. Must be one of:

  • 1: Windows
  • 2: Linux (default)
stopMethodinteger · integerOptional

The stop method that will be used on restart or destroy of an application instance. The default is hard kill, list of types can be found in: GET /v3/application/stopMethod

stopTimeoutinteger · integerOptional

The timeout that will be used on restart or destroy of an application instance, in seconds. The default is 0 (no timeout)

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

inUseinteger · integerRead-onlyRequired

If the application currently in use or not

get
/v3/application

Create an application

post
Authorizations
PRIVATE-TOKENstringRequired
Body
idstringRead-onlyRequired

Application ID

typeinteger · integerRequired

The list of application type can be found in: GET /application/type

managementProtocolinteger · integerRequired

The protocol used to manage the application (defaults to None when not set):

  • 0: None
  • 1: A2S
  • 2: ARCUS
namestringRequired

The public name of your application

websiteUrlstringOptional

The url to your application's website

descriptionstringOptional

A short description of your application

developerNamestringOptional

The name of the application's developer

publisherNamestringOptional

The name of the application's publisher

stopDefaultOsGroupinteger · integerOptional

The default operating system group being used for the stop method. If you have a Windows and Linux ApplicationBuild you can overwrite this on the ApplicationBuild level. Must be one of:

  • 1: Windows
  • 2: Linux (default)
stopMethodinteger · integerOptional

The stop method that will be used on restart or destroy of an application instance. The default is hard kill, list of types can be found in: GET /v3/application/stopMethod

stopTimeoutinteger · integerOptional

The timeout that will be used on restart or destroy of an application instance, in seconds. The default is 0 (no timeout)

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

inUseinteger · integerRead-onlyRequired

If the application currently in use or not

Responses
chevron-right
200

OK

application/json
idstringRead-onlyRequired

Application ID

typeinteger · integerRequired

The list of application type can be found in: GET /application/type

managementProtocolinteger · integerRequired

The protocol used to manage the application (defaults to None when not set):

  • 0: None
  • 1: A2S
  • 2: ARCUS
namestringRequired

The public name of your application

websiteUrlstringOptional

The url to your application's website

descriptionstringOptional

A short description of your application

developerNamestringOptional

The name of the application's developer

publisherNamestringOptional

The name of the application's publisher

stopDefaultOsGroupinteger · integerOptional

The default operating system group being used for the stop method. If you have a Windows and Linux ApplicationBuild you can overwrite this on the ApplicationBuild level. Must be one of:

  • 1: Windows
  • 2: Linux (default)
stopMethodinteger · integerOptional

The stop method that will be used on restart or destroy of an application instance. The default is hard kill, list of types can be found in: GET /v3/application/stopMethod

stopTimeoutinteger · integerOptional

The timeout that will be used on restart or destroy of an application instance, in seconds. The default is 0 (no timeout)

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

inUseinteger · integerRead-onlyRequired

If the application currently in use or not

post
/v3/application

Get the details of the given application

get
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
applicationIdstringRequired

The Id of the application for which to fetch the information

Responses
chevron-right
200

OK

application/json
idstringRead-onlyRequired

Application ID

typeinteger · integerRequired

The list of application type can be found in: GET /application/type

managementProtocolinteger · integerRequired

The protocol used to manage the application (defaults to None when not set):

  • 0: None
  • 1: A2S
  • 2: ARCUS
namestringRequired

The public name of your application

websiteUrlstringOptional

The url to your application's website

descriptionstringOptional

A short description of your application

developerNamestringOptional

The name of the application's developer

publisherNamestringOptional

The name of the application's publisher

stopDefaultOsGroupinteger · integerOptional

The default operating system group being used for the stop method. If you have a Windows and Linux ApplicationBuild you can overwrite this on the ApplicationBuild level. Must be one of:

  • 1: Windows
  • 2: Linux (default)
stopMethodinteger · integerOptional

The stop method that will be used on restart or destroy of an application instance. The default is hard kill, list of types can be found in: GET /v3/application/stopMethod

stopTimeoutinteger · integerOptional

The timeout that will be used on restart or destroy of an application instance, in seconds. The default is 0 (no timeout)

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

inUseinteger · integerRead-onlyRequired

If the application currently in use or not

get
/v3/application/{applicationId}

Update a application's mutable properties

put
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
applicationIdstringRequired

The Id of the application to update

Body
idstringRead-onlyRequired

Application ID

typeinteger · integerRequired

The list of application type can be found in: GET /application/type

managementProtocolinteger · integerRequired

The protocol used to manage the application (defaults to None when not set):

  • 0: None
  • 1: A2S
  • 2: ARCUS
namestringRequired

The public name of your application

websiteUrlstringOptional

The url to your application's website

descriptionstringOptional

A short description of your application

developerNamestringOptional

The name of the application's developer

publisherNamestringOptional

The name of the application's publisher

stopDefaultOsGroupinteger · integerOptional

The default operating system group being used for the stop method. If you have a Windows and Linux ApplicationBuild you can overwrite this on the ApplicationBuild level. Must be one of:

  • 1: Windows
  • 2: Linux (default)
stopMethodinteger · integerOptional

The stop method that will be used on restart or destroy of an application instance. The default is hard kill, list of types can be found in: GET /v3/application/stopMethod

stopTimeoutinteger · integerOptional

The timeout that will be used on restart or destroy of an application instance, in seconds. The default is 0 (no timeout)

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

inUseinteger · integerRead-onlyRequired

If the application currently in use or not

Responses
chevron-right
200

OK

application/json
idstringRead-onlyRequired

Application ID

typeinteger · integerRequired

The list of application type can be found in: GET /application/type

managementProtocolinteger · integerRequired

The protocol used to manage the application (defaults to None when not set):

  • 0: None
  • 1: A2S
  • 2: ARCUS
namestringRequired

The public name of your application

websiteUrlstringOptional

The url to your application's website

descriptionstringOptional

A short description of your application

developerNamestringOptional

The name of the application's developer

publisherNamestringOptional

The name of the application's publisher

stopDefaultOsGroupinteger · integerOptional

The default operating system group being used for the stop method. If you have a Windows and Linux ApplicationBuild you can overwrite this on the ApplicationBuild level. Must be one of:

  • 1: Windows
  • 2: Linux (default)
stopMethodinteger · integerOptional

The stop method that will be used on restart or destroy of an application instance. The default is hard kill, list of types can be found in: GET /v3/application/stopMethod

stopTimeoutinteger · integerOptional

The timeout that will be used on restart or destroy of an application instance, in seconds. The default is 0 (no timeout)

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

inUseinteger · integerRead-onlyRequired

If the application currently in use or not

put
/v3/application/{applicationId}

Delete a given application

delete
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
applicationIdstringRequired

The Id of the application to delete

Responses
delete
/v3/application/{applicationId}

No content

Get the list of available application types.

get
Authorizations
PRIVATE-TOKENstringRequired
Responses
chevron-right
200

OK

application/json
typeIdinteger · integerRead-onlyRequired

Application type ID

typeDescriptionstringRead-onlyRequired

Application type description

get
/v3/application/type
Deprecated

Get all the installs of an application

get
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
applicationIdstringRequired

The Id of the application for which to fetch the installs

Responses
chevron-right
200

OK

application/json
idinteger · integerRead-onlyRequired

Application install ID

applicationIdstringRequired

Application install assigned to applicationId

applicationTypeinteger · integer · nullableRequired

The list of Application types can be found in: GET /application/type

createdAtinteger · integerRead-onlyRequired

Application install created at timestamp

namestringRequired

Application install name

versionstringRequired

Application install version

osGroupIdinteger · integerRequired

Operating system group ID (1 = windows, 2 = linux)

activeinteger · integerRequired

Application install active

releaseNotesstring · nullableOptional

Application install release notes

filePathstringRead-onlyRequired

Path of the file on the file server

fileSizeinteger · integerRead-onlyRequired

File size in bytes

fileSHA256stringRead-onlyRequired

Archive file SHA-256 hash

executableSHA256stringRead-onlyRequired

SHA-256 hash of the executable in the archive

statusinteger · integerRead-onlyRequired

Status of application install.

installHasExeinteger · integerRequired

Does the archive contain the game instance executable?

get
/v3/application/{applicationId}/install

Get all the application builds created for the given application

get
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
applicationIdstringRequired

The Id of the application for which to fetch the application builds

Query parameters
labelsstringOptional

Label expressions can be used to apply more specific search parameters and can be written in standard SQL query language. E.g. region_id=123 or multiple filters: region_id=123 and fleet_id=456 or host_id=46256 The provided filter query needs to be url encoded. E.g. region_id%3D123 or multiple filters: region_id%3D123%20and%20fleet_id%3D456%20or%20host_id%3D46256 The total would look like: /application/{applicationId}/applicationBuild?labels=region_id%3D123%20and%20fleet_id%3D456%20or%20host_id%3D46256 If you want to filter on a non-numeric label such as region_name, you have to wrap the value in double quotes: region_name="Rotterdam". For more information about labels check details

Responses
chevron-right
200

OK

application/json
idstringRead-onlyRequired

Application build ID

namestringRequired

The name of the application build

applicationIdstring · nullableRequired

The ID of the application. May be null if buildProvisioningStorageType is LegacyFTP

hostCapacityTemplateIdstringOptional

The ID of the host capacity template

typeinteger · integerRead-onlyRequired

The application build, list of types can be found in: GET /application/type

executablestringRequired

The executable name including the path originating from the root directory of the software structure

startupParametersstringOptional

The startup parameters required for an executable

instanceDoesReadyCallbackinteger · integerOptional

Set to 1 if a deployed application instance will inform the platform it's done with initializing and is ready to accept players. Defaults to 0 if not set, which means an instance's status will go directly to ONLINE (4) after starting

installIdinteger · integerOptionalDeprecated

ID of the application install (legacy FTP, will be removed, may not be updated)

osIdinteger · integerRequired

ID of the operating system, list of operating systems can be found in: GET /v3/operatingsystem

stopMethodinteger · integer · nullableOptional

The stop method that will be used on restart or destroy of an application instance. The default is taken from the value of GET /v3/application/stopMethod - any value submitted here overrides that Application default

stopTimeoutinteger · integer · nullableOptional

The timeout that will be used on restart or destroy of an application instance. The default is taken from the value of Application.stopTimeout - any value submitted here overrides that Application default

createdAtinteger · integerRead-onlyRequired

When the application build was created (unix timestamp)

buildProvisioningStorageTypeinteger · integerOptional

Type of storage being used GET /v3/buildProvisioning/storage/registration/types. Default: 0

runAsRootinteger · integerRequired

Controls whether to run this build as root or as a non-privileged user. Warning: This currently only works for builds deployed onto a Linux operating system. Windows builds will always run as administrator

  • 0: run as non-privileged user
  • 1: run as root user (default)
get
/v3/application/{applicationId}/applicationBuild

Get all the application builds which have application instances created for the given application

get
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
applicationIdstringRequired

The Id of the application for which to fetch the application builds

Responses
chevron-right
200

OK

application/json
idstringRead-onlyRequired

Application build ID

namestringRequired

The name of the application build

applicationIdstring · nullableRequired

The ID of the application. May be null if buildProvisioningStorageType is LegacyFTP

hostCapacityTemplateIdstringOptional

The ID of the host capacity template

typeinteger · integerRead-onlyRequired

The application build, list of types can be found in: GET /application/type

executablestringRequired

The executable name including the path originating from the root directory of the software structure

startupParametersstringOptional

The startup parameters required for an executable

instanceDoesReadyCallbackinteger · integerOptional

Set to 1 if a deployed application instance will inform the platform it's done with initializing and is ready to accept players. Defaults to 0 if not set, which means an instance's status will go directly to ONLINE (4) after starting

installIdinteger · integerOptionalDeprecated

ID of the application install (legacy FTP, will be removed, may not be updated)

osIdinteger · integerRequired

ID of the operating system, list of operating systems can be found in: GET /v3/operatingsystem

stopMethodinteger · integer · nullableOptional

The stop method that will be used on restart or destroy of an application instance. The default is taken from the value of GET /v3/application/stopMethod - any value submitted here overrides that Application default

stopTimeoutinteger · integer · nullableOptional

The timeout that will be used on restart or destroy of an application instance. The default is taken from the value of Application.stopTimeout - any value submitted here overrides that Application default

createdAtinteger · integerRead-onlyRequired

When the application build was created (unix timestamp)

buildProvisioningStorageTypeinteger · integerOptional

Type of storage being used GET /v3/buildProvisioning/storage/registration/types. Default: 0

runAsRootinteger · integerRequired

Controls whether to run this build as root or as a non-privileged user. Warning: This currently only works for builds deployed onto a Linux operating system. Windows builds will always run as administrator

  • 0: run as non-privileged user
  • 1: run as root user (default)
get
/v3/application/{applicationId}/applicationBuild/inUse

Get stop methods of an application

get
Authorizations
PRIVATE-TOKENstringRequired
Responses
chevron-right
200

OK

application/json
get
/v3/application/stopMethod

Get the list of deployment environment using given applicationId

get
Authorizations
PRIVATE-TOKENstringRequired
Responses
chevron-right
200

OK

application/json
idstringRead-onlyRequired

Deployment environment ID

namestringRequired

The public name of your deployment environment

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

get
/v3/application/{applicationId}/deploymentEnvironment

Get the list of fleets using given applicationId

get
Authorizations
PRIVATE-TOKENstringRequired
Responses
chevron-right
200

OK

application/json
idstringRead-onlyRequired

Fleet ID

namestringRequired

The name of the fleet

deploymentEnvironmentIdstringRequired

Deployment environment ID to which the fleet is assigned

deploymentProfileIdstringOptional

The DeploymentProfileTemplate's ID, used for scaling, that is attached to this Fleet

gameDeploymentTemplateIdstringOptional

The GameDeploymentTemplate's ID that is attached to this Fleet

utilityDeploymentTemplateIdstringOptional

The UtilityDeploymentTemplate's ID that is attached to this Fleet

dependencyDeploymentTemplateIdstringOptional

The DependencyDeploymentTemplate's ID that is attached to this Fleet

hostCapacityTemplateIdstringOptional

The HostCapacityTemplate's ID that is attached to this Fleet

operationalStatusinteger · integerRead-onlyRequired

0: Manual, 1: Automatic deployment enabled, 2: Automatic scaling enabled (implies automatic deployment)

isGameLiftbooleanRequired

When it is active it cannot be disabled anymore

get
/v3/application/{applicationId}/fleet

Get a list of deployment templates for a given applicationId

get
Authorizations
PRIVATE-TOKENstringRequired
Responses
chevron-right
200

OK

application/json
or
or
get
/v3/application/{applicationId}/deploymentTemplate

Get all your application properties for given applicationId

get
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
applicationIdstringRequired

The Id of the application for which to fetch the properties

Responses
chevron-right
200

OK

application/json
idstringRead-onlyRequired

The application property ID

propertyTypeinteger · integerRequired

The application property type. For a list of application property types see GET /v3/application/property/type

propertyKeystringRequired

The application property key. Only hyphens (-), underscores (_), lowercase characters and numbers are allowed. Keys must start with a lowercase character

propertyValuestringOptional

The application property value

get
/v3/application/{applicationId}/property

Create a property of given applicationId

post
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
applicationIdstringRequired

The Id of the application for which the property will be created

Body
idstringRead-onlyRequired

The application property ID

propertyTypeinteger · integerRequired

The application property type. For a list of application property types see GET /v3/application/property/type

propertyKeystringRequired

The application property key. Only hyphens (-), underscores (_), lowercase characters and numbers are allowed. Keys must start with a lowercase character

propertyValuestringOptional

The application property value

Responses
chevron-right
200

OK

application/json
idstringRead-onlyRequired

The application property ID

propertyTypeinteger · integerRequired

The application property type. For a list of application property types see GET /v3/application/property/type

propertyKeystringRequired

The application property key. Only hyphens (-), underscores (_), lowercase characters and numbers are allowed. Keys must start with a lowercase character

propertyValuestringOptional

The application property value

post
/v3/application/{applicationId}/property

Get the property for given applicationId and given propertyId

get
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
applicationIdstringRequired

The Id of the application the property belongs to

propertyIdstringRequired

Id of the property to fetch

Responses
chevron-right
200

OK

application/json
idstringRead-onlyRequired

The application property ID

propertyTypeinteger · integerRequired

The application property type. For a list of application property types see GET /v3/application/property/type

propertyKeystringRequired

The application property key. Only hyphens (-), underscores (_), lowercase characters and numbers are allowed. Keys must start with a lowercase character

propertyValuestringOptional

The application property value

get
/v3/application/{applicationId}/property/{propertyId}

Update the given property of given applicationId

put
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
applicationIdstringRequired

The Id of the application the property belongs to

propertyIdstringRequired

The Id of the property to update

Body
idstringRead-onlyRequired

The application property ID

propertyTypeinteger · integerRequired

The application property type. For a list of application property types see GET /v3/application/property/type

propertyKeystringRequired

The application property key. Only hyphens (-), underscores (_), lowercase characters and numbers are allowed. Keys must start with a lowercase character

propertyValuestringOptional

The application property value

Responses
chevron-right
200

OK

application/json
idstringRead-onlyRequired

The application property ID

propertyTypeinteger · integerRequired

The application property type. For a list of application property types see GET /v3/application/property/type

propertyKeystringRequired

The application property key. Only hyphens (-), underscores (_), lowercase characters and numbers are allowed. Keys must start with a lowercase character

propertyValuestringOptional

The application property value

put
/v3/application/{applicationId}/property/{propertyId}

Delete the given property of the applicationId

delete
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
applicationIdstringRequired

The Id of the application for which to delete the property

propertyIdstringRequired

Property Id to delete

Responses
delete
/v3/application/{applicationId}/property/{propertyId}

No content

Get a list of all the possible application property types

get
Authorizations
PRIVATE-TOKENstringRequired
Responses
chevron-right
200

OK

application/json
typeIdinteger · integerRead-onlyRequired

Application type ID

typeDescriptionstringRead-onlyRequired

Application type description

get
/v3/application/property/type

Last updated

Was this helpful?