Application

All application endpoints

Get all your applications and their main details

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Header parameters

RANGED-DATAstringOptional

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

Responses

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

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/application

HTTPcURLJavaScriptPython

GET /v3/application HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "type": 1,
    "managementProtocol": 1,
    "name": "text",
    "websiteUrl": "text",
    "description": "text",
    "developerName": "text",
    "publisherName": "text",
    "stopDefaultOsGroup": 1,
    "stopMethod": 1,
    "stopTimeout": 1,
    "createdAt": 1,
    "inUse": 1
  }
]

Create an application

post

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Body

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

Responses

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

403

Invalid credentials

422

Unprocessable Entity

500

Internal Server Error

application/json

post

/v3/application

HTTPcURLJavaScriptPython

POST /v3/application HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 188

{
  "type": 1,
  "managementProtocol": 1,
  "name": "text",
  "websiteUrl": "text",
  "description": "text",
  "developerName": "text",
  "publisherName": "text",
  "stopDefaultOsGroup": 1,
  "stopMethod": 1,
  "stopTimeout": 1
}

[
  {
    "id": "text",
    "type": 1,
    "managementProtocol": 1,
    "name": "text",
    "websiteUrl": "text",
    "description": "text",
    "developerName": "text",
    "publisherName": "text",
    "stopDefaultOsGroup": 1,
    "stopMethod": 1,
    "stopTimeout": 1,
    "createdAt": 1,
    "inUse": 1
  }
]

Get the details of the given application

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

applicationIdstringRequired

The Id of the application for which to fetch the information

Responses

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

403

Invalid credentials

404

Invalid applicationId

500

Internal Server Error

application/json

get

/v3/application/{applicationId}

HTTPcURLJavaScriptPython

GET /v3/application/{applicationId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "type": 1,
    "managementProtocol": 1,
    "name": "text",
    "websiteUrl": "text",
    "description": "text",
    "developerName": "text",
    "publisherName": "text",
    "stopDefaultOsGroup": 1,
    "stopMethod": 1,
    "stopTimeout": 1,
    "createdAt": 1,
    "inUse": 1
  }
]

Update a application's mutable properties

put

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

applicationIdstringRequired

The Id of the application to update

Body

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

Responses

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

403

Invalid credentials

404

Invalid applicationId

405

Application type can not be changed

422

Unprocessable Entity

500

Internal Server Error

application/json

put

/v3/application/{applicationId}

HTTPcURLJavaScriptPython

PUT /v3/application/{applicationId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 188

{
  "type": 1,
  "managementProtocol": 1,
  "name": "text",
  "websiteUrl": "text",
  "description": "text",
  "developerName": "text",
  "publisherName": "text",
  "stopDefaultOsGroup": 1,
  "stopMethod": 1,
  "stopTimeout": 1
}

[
  {
    "id": "text",
    "type": 1,
    "managementProtocol": 1,
    "name": "text",
    "websiteUrl": "text",
    "description": "text",
    "developerName": "text",
    "publisherName": "text",
    "stopDefaultOsGroup": 1,
    "stopMethod": 1,
    "stopTimeout": 1,
    "createdAt": 1,
    "inUse": 1
  }
]

Delete a given application

delete

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

applicationIdstringRequired

The Id of the application to delete

Responses

204

No Content

403

Invalid credentials

404

Invalid applicationId

409

Application is in use

500

Internal Server Error

application/json

delete

/v3/application/{applicationId}

HTTPcURLJavaScriptPython

DELETE /v3/application/{applicationId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content

Get the list of available application types.

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Responses

200

OK

application/json

typeIdinteger · integerRead-onlyRequired

Application type ID

typeDescriptionstringRead-onlyRequired

Application type description

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/application/type

HTTPcURLJavaScriptPython

GET /v3/application/type HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "typeId": 1,
    "typeDescription": "text"
  }
]

Deprecated

Get all the installs of an application

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

applicationIdstringRequired

The Id of the application for which to fetch the installs

Responses

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?

403

Invalid credentials

404

Invalid applicationId

500

Internal Server Error

application/json

get

/v3/application/{applicationId}/install

HTTPcURLJavaScriptPython

GET /v3/application/{applicationId}/install HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "applicationId": "text",
    "applicationType": 1,
    "createdAt": 1,
    "name": "text",
    "version": "text",
    "osGroupId": 1,
    "active": 1,
    "releaseNotes": "text",
    "filePath": "text",
    "fileSize": 1,
    "fileSHA256": "text",
    "executableSHA256": "text",
    "status": 1,
    "installHasExe": 1
  }
]

Get all the application builds created for the given application

get

Authorizations

ApiKey

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

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)

403

Invalid credentials

404

Invalid applicationId

422

Labels error

500

Internal Server Error

application/json

get

/v3/application/{applicationId}/applicationBuild

HTTPcURLJavaScriptPython

GET /v3/application/{applicationId}/applicationBuild HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "applicationId": "text",
    "hostCapacityTemplateId": "text",
    "type": 1,
    "executable": "text",
    "startupParameters": "text",
    "instanceDoesReadyCallback": 1,
    "osId": 1,
    "stopMethod": 1,
    "stopTimeout": 1,
    "createdAt": 1,
    "label": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "applicationBuildFile": {
      "id": "text",
      "buildProvisioningFileId": "text",
      "buildProvisioningRegistrationId": "text",
      "fileName": "text",
      "fileSize": 1,
      "version": "text",
      "md5CheckSum": "text",
      "path": "text",
      "domain": "text",
      "createdAt": 1,
      "changedAt": 1,
      "availableOnCDN": 1
    },
    "buildProvisioningStorageType": 1,
    "runAsRoot": 1
  }
]

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

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

applicationIdstringRequired

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

Responses

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)

403

Invalid credentials

404

Invalid applicationId

422

Labels error

500

Internal Server Error

application/json

get

/v3/application/{applicationId}/applicationBuild/inUse

HTTPcURLJavaScriptPython

GET /v3/application/{applicationId}/applicationBuild/inUse HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "applicationId": "text",
    "hostCapacityTemplateId": "text",
    "type": 1,
    "executable": "text",
    "startupParameters": "text",
    "instanceDoesReadyCallback": 1,
    "osId": 1,
    "stopMethod": 1,
    "stopTimeout": 1,
    "createdAt": 1,
    "label": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "applicationBuildFile": {
      "id": "text",
      "buildProvisioningFileId": "text",
      "buildProvisioningRegistrationId": "text",
      "fileName": "text",
      "fileSize": 1,
      "version": "text",
      "md5CheckSum": "text",
      "path": "text",
      "domain": "text",
      "createdAt": 1,
      "changedAt": 1,
      "availableOnCDN": 1
    },
    "buildProvisioningStorageType": 1,
    "runAsRoot": 1
  }
]

Get stop methods of an application

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Responses

200

OK

application/json

403

Invalid credentials

404

Invalid applicationId

500

Internal Server Error

application/json

get

/v3/application/stopMethod

HTTPcURLJavaScriptPython

GET /v3/application/stopMethod HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "linux": [
      {
        "id": 1,
        "description": "text"
      }
    ],
    "windows": [
      {
        "id": 1,
        "description": "text"
      }
    ]
  }
]

Get the list of deployment environment using given applicationId

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Responses

200

OK

application/json

idstringRead-onlyRequired

Deployment environment ID

namestringRequired

The public name of your deployment environment

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

403

Invalid credentials

404

Invalid applicationId

500

Internal Server Error

application/json

get

/v3/application/{applicationId}/deploymentEnvironment

HTTPcURLJavaScriptPython

GET /v3/application/{applicationId}/deploymentEnvironment HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "createdAt": 1
  }
]

Get the list of fleets using given applicationId

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Responses

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

403

Invalid credentials

404

Invalid applicationId

500

Internal Server Error

application/json

get

/v3/application/{applicationId}/fleet

HTTPcURLJavaScriptPython

GET /v3/application/{applicationId}/fleet HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "deploymentEnvironmentId": "text",
    "deploymentProfileId": "text",
    "gameDeploymentTemplateId": "text",
    "utilityDeploymentTemplateId": "text",
    "dependencyDeploymentTemplateId": "text",
    "hostCapacityTemplateId": "text",
    "operationalStatus": 1,
    "isGameLift": true
  }
]

Get a list of deployment templates for a given applicationId

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Responses

200

OK

application/json

or

or

403

Invalid credentials

404

Invalid applicationId

500

Internal Server Error

application/json

get

/v3/application/{applicationId}/deploymentTemplate

HTTPcURLJavaScriptPython

GET /v3/application/{applicationId}/deploymentTemplate HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "fleetIds": [
      "text"
    ],
    "name": "text",
    "inUse": 1,
    "createdAt": 1,
    "gameDeploymentTemplateBuild": [
      {
        "applicationBuildId": "text"
      }
    ]
  }
]

Get all your application properties for given applicationId

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

applicationIdstringRequired

The Id of the application for which to fetch the properties

Responses

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

403

Invalid credentials

404

Invalid applicationId

500

Internal Server Error

application/json

get

/v3/application/{applicationId}/property

HTTPcURLJavaScriptPython

GET /v3/application/{applicationId}/property HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "propertyType": 1,
    "propertyKey": "text",
    "propertyValue": "text"
  }
]

Create a property of given applicationId

post

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

applicationIdstringRequired

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

Body

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

Responses

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

403

Invalid credentials

404

Invalid applicationId

409

Network port is already in use by another network port property

422

Unprocessable Entity

500

Internal Server Error

application/json

post

/v3/application/{applicationId}/property

HTTPcURLJavaScriptPython

POST /v3/application/{applicationId}/property HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "propertyType": 1,
  "propertyKey": "text",
  "propertyValue": "text"
}

[
  {
    "id": "text",
    "propertyType": 1,
    "propertyKey": "text",
    "propertyValue": "text"
  }
]

Get the property for given applicationId and given propertyId

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

applicationIdstringRequired

The Id of the application the property belongs to

propertyIdstringRequired

Id of the property to fetch

Responses

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

403

Invalid credentials

404

Invalid applicationId or propertyId

500

Internal Server Error

application/json

get

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

HTTPcURLJavaScriptPython

GET /v3/application/{applicationId}/property/{propertyId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "propertyType": 1,
    "propertyKey": "text",
    "propertyValue": "text"
  }
]

Update the given property of given applicationId

put

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

applicationIdstringRequired

The Id of the application the property belongs to

propertyIdstringRequired

The Id of the property to update

Body

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

Responses

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

403

Invalid credentials

404

Invalid applicationId or propertyId

409

Network port is already in use by another network port property

422

Unprocessable Entity

500

Internal Server Error

application/json

put

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

HTTPcURLJavaScriptPython

PUT /v3/application/{applicationId}/property/{propertyId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "propertyType": 1,
  "propertyKey": "text",
  "propertyValue": "text"
}

[
  {
    "id": "text",
    "propertyType": 1,
    "propertyKey": "text",
    "propertyValue": "text"
  }
]

Delete the given property of the applicationId

delete

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

applicationIdstringRequired

The Id of the application for which to delete the property

propertyIdstringRequired

Property Id to delete

Responses

204

No Content

403

Invalid credentials

404

Invalid applicationId or propertyId

422

Unprocessable Entity

500

Internal Server Error

application/json

delete

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

HTTPcURLJavaScriptPython

DELETE /v3/application/{applicationId}/property/{propertyId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content

Get a list of all the possible application property types

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Responses

200

OK

application/json

typeIdinteger · integerRead-onlyRequired

Application type ID

typeDescriptionstringRead-onlyRequired

Application type description

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/application/property/type

HTTPcURLJavaScriptPython

GET /v3/application/property/type HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "typeId": 1,
    "typeDescription": "text"
  }
]