HostCapacityTemplate

Controls the capacity of each host

Get the details of all your host capacity templates

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

The ID of the Host Capacity Template

fleetIdsstring[]Read-onlyRequired

IDs of the Fleets that use this Host Capacity Template

applicationBuildIdsstring[]Read-onlyRequired

IDs of the Application Builds that use this Host Capacity Template

namestringRequired

The public name of your Host Capacity Template

inUseinteger · integerRequired

1 if the Host Capacity Template is in use by a Fleet or Application Build, 0 if it is not.

createdAtinteger · integerRead-onlyRequired

The Unix timestamp at which this element is created

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/hostCapacityTemplate

HTTPcURLJavaScriptPython

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

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

Create a host capacity template

post

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Body

application/json

idstringRead-onlyRequired

The ID of the Host Capacity Template

fleetIdsstring[]Read-onlyRequired

IDs of the Fleets that use this Host Capacity Template

applicationBuildIdsstring[]Read-onlyRequired

IDs of the Application Builds that use this Host Capacity Template

namestringRequired

The public name of your Host Capacity Template

inUseinteger · integerRequired

1 if the Host Capacity Template is in use by a Fleet or Application Build, 0 if it is not.

createdAtinteger · integerRead-onlyRequired

The Unix timestamp at which this element is created

Responses

200

OK

application/json

idstringRead-onlyRequired

The ID of the Host Capacity Template

fleetIdsstring[]Read-onlyRequired

IDs of the Fleets that use this Host Capacity Template

applicationBuildIdsstring[]Read-onlyRequired

IDs of the Application Builds that use this Host Capacity Template

namestringRequired

The public name of your Host Capacity Template

inUseinteger · integerRequired

1 if the Host Capacity Template is in use by a Fleet or Application Build, 0 if it is not.

createdAtinteger · integerRead-onlyRequired

The Unix timestamp at which this element is created

403

Invalid credentials

422

Unprocessable Entity

500

Internal Server Error

application/json

post

/v3/hostCapacityTemplate

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "inUse": 1
}

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

Get the details of the given host capacity template

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

hostCapacityTemplateIdstringRequired

The Id of the host capacity template

Responses

200

OK

application/json

idstringRead-onlyRequired

The ID of the Host Capacity Template

fleetIdsstring[]Read-onlyRequired

IDs of the Fleets that use this Host Capacity Template

applicationBuildIdsstring[]Read-onlyRequired

IDs of the Application Builds that use this Host Capacity Template

namestringRequired

The public name of your Host Capacity Template

inUseinteger · integerRequired

1 if the Host Capacity Template is in use by a Fleet or Application Build, 0 if it is not.

createdAtinteger · integerRead-onlyRequired

The Unix timestamp at which this element is created

403

Invalid credentials

404

Invalid hostCapacityTemplateId

500

Internal Server Error

application/json

get

/v3/hostCapacityTemplate/{hostCapacityTemplateId}

HTTPcURLJavaScriptPython

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

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

Update given host capacity template

put

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

hostCapacityTemplateIdstringRequired

The Id of the host capacity template

Body

application/json

idstringRead-onlyRequired

The ID of the Host Capacity Template

fleetIdsstring[]Read-onlyRequired

IDs of the Fleets that use this Host Capacity Template

applicationBuildIdsstring[]Read-onlyRequired

IDs of the Application Builds that use this Host Capacity Template

namestringRequired

The public name of your Host Capacity Template

inUseinteger · integerRequired

1 if the Host Capacity Template is in use by a Fleet or Application Build, 0 if it is not.

createdAtinteger · integerRead-onlyRequired

The Unix timestamp at which this element is created

Responses

200

OK

application/json

idstringRead-onlyRequired

The ID of the Host Capacity Template

fleetIdsstring[]Read-onlyRequired

IDs of the Fleets that use this Host Capacity Template

applicationBuildIdsstring[]Read-onlyRequired

IDs of the Application Builds that use this Host Capacity Template

namestringRequired

The public name of your Host Capacity Template

inUseinteger · integerRequired

1 if the Host Capacity Template is in use by a Fleet or Application Build, 0 if it is not.

createdAtinteger · integerRead-onlyRequired

The Unix timestamp at which this element is created

403

Invalid credentials

404

Invalid hostCapacityTemplateId

422

Unprocessable Entity

500

Internal Server Error

application/json

put

/v3/hostCapacityTemplate/{hostCapacityTemplateId}

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "inUse": 1
}

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

Delete given host capacity template

delete

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

hostCapacityTemplateIdstringRequired

The Id of the host capacity template

Responses

204

No Content

403

Invalid credentials

404

Invalid hostCapacityTemplateId

409

Cannot delete

500

Internal Server Error

application/json

delete

/v3/hostCapacityTemplate/{hostCapacityTemplateId}

HTTPcURLJavaScriptPython

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

No content

Get all fleets that are using the given host capacity template

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

hostCapacityTemplateIdstringRequired

The Id of the host capacity template

Header parameters

RANGED-DATAstringOptional

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

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 hostCapacityTemplateId

500

Internal Server Error

application/json

get

/v3/hostCapacityTemplate/{hostCapacityTemplateId}/fleet

HTTPcURLJavaScriptPython

GET /v3/hostCapacityTemplate/{hostCapacityTemplateId}/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 all application builds that are using the given host capacity template

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

hostCapacityTemplateIdstringRequired

The Id of the host capacity template

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

404

Invalid hostCapacityTemplateId

500

Internal Server Error

application/json

get

/v3/hostCapacityTemplate/{hostCapacityTemplateId}/applicationBuild

HTTPcURLJavaScriptPython

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