ApplicationBuild

All application build endpoints

Get The build provisioning storage types for storing application build file

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

ID of the build provisioning storage type

descriptionstringRead-onlyRequired

Description of the build provisioning storage type

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/applicationBuild/storage/types

HTTPcURLJavaScriptPython

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

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

Get all your application builds

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 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

422

Labels error

500

Internal Server Error

application/json

get

/v3/applicationBuild

HTTPcURLJavaScriptPython

GET /v3/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
  }
]

Create a new application build

post

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Body

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)

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

409

Conflict

422

Unprocessable Entity

500

Internal Server Error

application/json

post

/v3/applicationBuild

HTTPcURLJavaScriptPython

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

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

[
  {
    "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 a specific application build

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

applicationBuildIdstringRequired

The Id of the application build

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 applicationBuildId

500

Internal Server Error

application/json

get

/v3/applicationBuild/{applicationBuildId}

HTTPcURLJavaScriptPython

GET /v3/applicationBuild/{applicationBuildId} 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
  }
]

Update the given application build

put

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

applicationBuildIdstringRequired

The Id of the application build

Body

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)

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 applicationBuildId

409

Conflict

422

Unprocessable Entity

500

Internal Server Error

application/json

put

/v3/applicationBuild/{applicationBuildId}

HTTPcURLJavaScriptPython

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

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

[
  {
    "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
  }
]

Delete given application build

delete

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

applicationBuildIdstringRequired

The Id of the application build

Responses

204

No Content

403

Invalid credentials

404

Invalid applicationBuildId

409

applicationBuildId is in use

500

Internal Server Error

application/json

delete

/v3/applicationBuild/{applicationBuildId}

HTTPcURLJavaScriptPython

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

No content

Get a list of deployment environments for a given application build Id

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

applicationBuildIdstringRequired

The ID of the application build

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 applicationBuildId

500

Internal Server Error

application/json

get

/v3/applicationBuild/{applicationBuildId}/deploymentEnvironment

HTTPcURLJavaScriptPython

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

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

Get a list of fleets for a given application build Id

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

applicationBuildIdstringRequired

The ID of the application build

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 applicationBuildId

500

Internal Server Error

application/json

get

/v3/applicationBuild/{applicationBuildId}/fleet

HTTPcURLJavaScriptPython

GET /v3/applicationBuild/{applicationBuildId}/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 application build Id

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

applicationBuildIdstringRequired

The ID of the application build

Responses

200

OK

application/json

or

or

403

Invalid credentials

404

Invalid applicationBuildId

500

Internal Server Error

application/json

get

/v3/applicationBuild/{applicationBuildId}/deploymentTemplate

HTTPcURLJavaScriptPython

GET /v3/applicationBuild/{applicationBuildId}/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 the properties for the given applicationBuildId

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

applicationBuildIdstringRequired

The Id of the application build

Responses

200

OK

application/json

idstringRead-onlyRequired

The application build property ID

propertyTypeinteger · integerRead-onlyRequired

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

propertyKeystringRead-onlyRequired

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

propertyValuestringRequired

The application build property value

403

Invalid credentials

404

Invalid applicationBuildId

500

Internal Server Error

application/json

get

/v3/applicationBuild/{applicationBuildId}/property

HTTPcURLJavaScriptPython

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

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

Get given property for the given application build Id

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

applicationBuildIdstringRequired

The Id of the application build

propertyIdstringRequired

The Id of the application build property

Responses

200

OK

application/json

idstringRead-onlyRequired

The application build property ID

propertyTypeinteger · integerRead-onlyRequired

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

propertyKeystringRead-onlyRequired

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

propertyValuestringRequired

The application build property value

403

Invalid credentials

404

Invalid applicationBuildId or propertyId

500

Internal Server Error

application/json

get

/v3/applicationBuild/{applicationBuildId}/property/{propertyId}

HTTPcURLJavaScriptPython

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

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

Update given property for given application build

put

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

applicationBuildIdstringRequired

The Id of the application build

propertyIdstringRequired

The Id of the application build property to update

Body

application/json

idstringRead-onlyRequired

The application build property ID

propertyTypeinteger · integerRead-onlyRequired

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

propertyKeystringRead-onlyRequired

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

propertyValuestringRequired

The application build property value

Responses

200

OK

application/json

idstringRead-onlyRequired

The application build property ID

propertyTypeinteger · integerRead-onlyRequired

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

propertyKeystringRead-onlyRequired

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

propertyValuestringRequired

The application build property value

403

Invalid credentials

404

Invalid applicationBuildId 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/applicationBuild/{applicationBuildId}/property/{propertyId}

HTTPcURLJavaScriptPython

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

{
  "propertyValue": "text"
}

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

Get all configurations for the given applicationBuildId

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

applicationBuildIdstringRequired

The Id of the application build

Responses

200

OK

application/json

idstringRead-onlyRequired

Application build configuration ID

configPathstringRequired

Configuration file path

configNamestringRequired

Configuration file name

configContentstringRequired

Configuration file contents

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

403

Invalid credentials

404

Invalid applicationBuildId

500

Internal Server Error

application/json

get

/v3/applicationBuild/{applicationBuildId}/configuration

HTTPcURLJavaScriptPython

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

[
  {
    "id": "text",
    "configPath": "text",
    "configName": "text",
    "configContent": "text",
    "createdAt": 1
  }
]

Create a new configuration for the given applicationBuildId

post

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

applicationBuildIdstringRequired

The Id of the application build

Body

application/json

idstringRead-onlyRequired

Application build configuration ID

configPathstringRequired

Configuration file path

configNamestringRequired

Configuration file name

configContentstringRequired

Configuration file contents

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

Responses

200

OK

application/json

idstringRead-onlyRequired

Application build configuration ID

configPathstringRequired

Configuration file path

configNamestringRequired

Configuration file name

configContentstringRequired

Configuration file contents

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

403

Invalid credentials

404

Invalid applicationBuildId

422

Unprocessable Entity

500

Internal Server Error

application/json

post

/v3/applicationBuild/{applicationBuildId}/configuration

HTTPcURLJavaScriptPython

POST /v3/applicationBuild/{applicationBuildId}/configuration HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "configPath": "text",
  "configName": "text",
  "configContent": "text"
}

[
  {
    "id": "text",
    "configPath": "text",
    "configName": "text",
    "configContent": "text",
    "createdAt": 1
  }
]

Get a specific application build configuration

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

applicationBuildIdstringRequired

The Id of the application build

applicationBuildConfigurationIdstringRequired

The Id of the specific configuration

Responses

200

OK

application/json

idstringRead-onlyRequired

Application build configuration ID

configPathstringRequired

Configuration file path

configNamestringRequired

Configuration file name

configContentstringRequired

Configuration file contents

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

403

Invalid credentials

404

Invalid applicationBuildId or applicationBuildConfigurationId

500

Internal Server Error

application/json

get

/v3/applicationBuild/{applicationBuildId}/configuration/{applicationBuildConfigurationId}

HTTPcURLJavaScriptPython

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

[
  {
    "id": "text",
    "configPath": "text",
    "configName": "text",
    "configContent": "text",
    "createdAt": 1
  }
]

Update an existing configuration for given applicationBuildId

put

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

applicationBuildIdstringRequired

The Id of the application build

applicationBuildConfigurationIdstringRequired

The Id of the specific configuration

Body

application/json

idstringRead-onlyRequired

Application build configuration ID

configPathstringRequired

Configuration file path

configNamestringRequired

Configuration file name

configContentstringRequired

Configuration file contents

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

Responses

200

OK

application/json

idstringRead-onlyRequired

Application build configuration ID

configPathstringRequired

Configuration file path

configNamestringRequired

Configuration file name

configContentstringRequired

Configuration file contents

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

403

Invalid credentials

404

Invalid applicationBuildId or applicationBuildConfigurationId

422

Unprocessable Entity

500

Internal Server Error

application/json

put

/v3/applicationBuild/{applicationBuildId}/configuration/{applicationBuildConfigurationId}

HTTPcURLJavaScriptPython

PUT /v3/applicationBuild/{applicationBuildId}/configuration/{applicationBuildConfigurationId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "configPath": "text",
  "configName": "text",
  "configContent": "text"
}

[
  {
    "id": "text",
    "configPath": "text",
    "configName": "text",
    "configContent": "text",
    "createdAt": 1
  }
]

Delete given configuration from given applicationBuildId

delete

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

applicationBuildIdstringRequired

The Id of the application build

applicationBuildConfigurationIdstringRequired

The Id of the specific configuration

Responses

204

No Content

403

Invalid credentials

404

Invalid applicationBuildId or applicationBuildConfigurationId

500

Internal Server Error

application/json

delete

/v3/applicationBuild/{applicationBuildId}/configuration/{applicationBuildConfigurationId}

HTTPcURLJavaScriptPython

DELETE /v3/applicationBuild/{applicationBuildId}/configuration/{applicationBuildConfigurationId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content