DeploymentTemplate

All deployment template endpoints

Get all game deployment 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

Game deployment template ID

fleetIdsstring[]Read-onlyRequired

IDs of the fleets that use this template

namestringRequired

The public name of your game deployment template

inUseinteger · integerRead-onlyRequired

Indicates whether this game deployment template is used by one or more fleets. A template cannot be deleted as long as this value is 1.

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/deploymentTemplate/game

HTTPcURLJavaScriptPython

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

Create a game deployment template

post

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Body

application/json

idstringRead-onlyRequired

Game deployment template ID

fleetIdsstring[]Read-onlyRequired

IDs of the fleets that use this template

namestringRequired

The public name of your game deployment template

inUseinteger · integerRead-onlyRequired

Indicates whether this game deployment template is used by one or more fleets. A template cannot be deleted as long as this value is 1.

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

Responses

200

OK

application/json

idstringRead-onlyRequired

Game deployment template ID

fleetIdsstring[]Read-onlyRequired

IDs of the fleets that use this template

namestringRequired

The public name of your game deployment template

inUseinteger · integerRead-onlyRequired

Indicates whether this game deployment template is used by one or more fleets. A template cannot be deleted as long as this value is 1.

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

403

Invalid credentials

422

Unprocessable Entity

500

Internal Server Error

application/json

post

/v3/deploymentTemplate/game

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "gameDeploymentTemplateBuild": [
    {
      "applicationBuildId": "text"
    }
  ]
}

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

Get the details of game deployment template

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

deploymentTemplateIdstringRequired

The Id of the deployment template

Responses

200

OK

application/json

idstringRead-onlyRequired

Game deployment template ID

fleetIdsstring[]Read-onlyRequired

IDs of the fleets that use this template

namestringRequired

The public name of your game deployment template

inUseinteger · integerRead-onlyRequired

Indicates whether this game deployment template is used by one or more fleets. A template cannot be deleted as long as this value is 1.

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

403

Invalid credentials

404

Invalid deploymentTemplateId

500

Internal Server Error

application/json

get

/v3/deploymentTemplate/game/{deploymentTemplateId}

HTTPcURLJavaScriptPython

GET /v3/deploymentTemplate/game/{deploymentTemplateId} 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"
      }
    ]
  }
]

Update given game deployment template.

put

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

deploymentTemplateIdstringRequired

The Id of the deployment template

Body

application/json

idstringRead-onlyRequired

Game deployment template ID

fleetIdsstring[]Read-onlyRequired

IDs of the fleets that use this template

namestringRequired

The public name of your game deployment template

inUseinteger · integerRead-onlyRequired

Indicates whether this game deployment template is used by one or more fleets. A template cannot be deleted as long as this value is 1.

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

Responses

200

OK

application/json

idstringRead-onlyRequired

Game deployment template ID

fleetIdsstring[]Read-onlyRequired

IDs of the fleets that use this template

namestringRequired

The public name of your game deployment template

inUseinteger · integerRead-onlyRequired

Indicates whether this game deployment template is used by one or more fleets. A template cannot be deleted as long as this value is 1.

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

403

Invalid credentials

404

Invalid deploymentTemplateId

422

Unprocessable Entity

500

Internal Server Error

application/json

put

/v3/deploymentTemplate/game/{deploymentTemplateId}

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "gameDeploymentTemplateBuild": [
    {
      "applicationBuildId": "text"
    }
  ]
}

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

Delete given game deployment template.

delete

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

deploymentTemplateIdstringRequired

The Id of the deployment template

Responses

204

No Content

403

Invalid credentials

404

Invalid deploymentTemplateId

409

If the template is in use, it cannot be deleted

500

Internal Server Error

application/json

delete

/v3/deploymentTemplate/game/{deploymentTemplateId}

HTTPcURLJavaScriptPython

DELETE /v3/deploymentTemplate/game/{deploymentTemplateId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content

Get all fleets using the given game deploymentTemplateId

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

deploymentTemplateIdstringRequired

The Id of the deployment 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 deploymentTemplateId

500

Internal Server Error

application/json

get

/v3/deploymentTemplate/game/{deploymentTemplateId}/fleet

HTTPcURLJavaScriptPython

GET /v3/deploymentTemplate/game/{deploymentTemplateId}/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
  }
]

All your utility deployment 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

Utility deployment template ID

fleetIdsstring[]Read-onlyRequired

IDs of the fleets that use this template

namestringRequired

The name of your utility deployment template

inUseinteger · integerRead-onlyRequired

Indicates whether this utility deployment template is used by one or more fleets. A template cannot be deleted as long as this value is 1.

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/deploymentTemplate/utility

HTTPcURLJavaScriptPython

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

[
  {
    "id": "text",
    "fleetIds": [
      "text"
    ],
    "name": "text",
    "inUse": 1,
    "createdAt": 1,
    "utilityDeploymentTemplateBuild": [
      {
        "applicationBuildId": "text",
        "deployOn": 1,
        "installsPerLocation": 1
      }
    ]
  }
]

Create an instance of utility deployment template.

post

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Body

application/json

idstringRead-onlyRequired

Utility deployment template ID

fleetIdsstring[]Read-onlyRequired

IDs of the fleets that use this template

namestringRequired

The name of your utility deployment template

inUseinteger · integerRead-onlyRequired

Indicates whether this utility deployment template is used by one or more fleets. A template cannot be deleted as long as this value is 1.

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

Responses

200

OK

application/json

idstringRead-onlyRequired

Utility deployment template ID

fleetIdsstring[]Read-onlyRequired

IDs of the fleets that use this template

namestringRequired

The name of your utility deployment template

inUseinteger · integerRead-onlyRequired

Indicates whether this utility deployment template is used by one or more fleets. A template cannot be deleted as long as this value is 1.

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

403

Invalid credentials

404

Invalid deploymentTemplateId

422

Unprocessable Entity

500

Internal Server Error

application/json

post

/v3/deploymentTemplate/utility

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "utilityDeploymentTemplateBuild": [
    {
      "applicationBuildId": "text",
      "deployOn": 1,
      "installsPerLocation": 1
    }
  ]
}

[
  {
    "id": "text",
    "fleetIds": [
      "text"
    ],
    "name": "text",
    "inUse": 1,
    "createdAt": 1,
    "utilityDeploymentTemplateBuild": [
      {
        "applicationBuildId": "text",
        "deployOn": 1,
        "installsPerLocation": 1
      }
    ]
  }
]

Get the details of a utility deployment template

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

deploymentTemplateIdstringRequired

The Id of the deployment template

Responses

200

OK

application/json

idstringRead-onlyRequired

Utility deployment template ID

fleetIdsstring[]Read-onlyRequired

IDs of the fleets that use this template

namestringRequired

The name of your utility deployment template

inUseinteger · integerRead-onlyRequired

Indicates whether this utility deployment template is used by one or more fleets. A template cannot be deleted as long as this value is 1.

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

403

Invalid credentials

404

Invalid deploymentTemplateId

500

Internal Server Error

application/json

get

/v3/deploymentTemplate/utility/{deploymentTemplateId}

HTTPcURLJavaScriptPython

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

[
  {
    "id": "text",
    "fleetIds": [
      "text"
    ],
    "name": "text",
    "inUse": 1,
    "createdAt": 1,
    "utilityDeploymentTemplateBuild": [
      {
        "applicationBuildId": "text",
        "deployOn": 1,
        "installsPerLocation": 1
      }
    ]
  }
]

Update an instance of utility deployment template

put

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

deploymentTemplateIdstringRequired

The Id of the deployment template

Body

application/json

idstringRead-onlyRequired

Utility deployment template ID

fleetIdsstring[]Read-onlyRequired

IDs of the fleets that use this template

namestringRequired

The name of your utility deployment template

inUseinteger · integerRead-onlyRequired

Indicates whether this utility deployment template is used by one or more fleets. A template cannot be deleted as long as this value is 1.

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

Responses

200

OK

application/json

idstringRead-onlyRequired

Utility deployment template ID

fleetIdsstring[]Read-onlyRequired

IDs of the fleets that use this template

namestringRequired

The name of your utility deployment template

inUseinteger · integerRead-onlyRequired

Indicates whether this utility deployment template is used by one or more fleets. A template cannot be deleted as long as this value is 1.

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

403

Invalid credentials

404

Invalid deploymentTemplateId

422

Unprocessable Entity

500

Internal Server Error

application/json

put

/v3/deploymentTemplate/utility/{deploymentTemplateId}

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "utilityDeploymentTemplateBuild": [
    {
      "applicationBuildId": "text",
      "deployOn": 1,
      "installsPerLocation": 1
    }
  ]
}

[
  {
    "id": "text",
    "fleetIds": [
      "text"
    ],
    "name": "text",
    "inUse": 1,
    "createdAt": 1,
    "utilityDeploymentTemplateBuild": [
      {
        "applicationBuildId": "text",
        "deployOn": 1,
        "installsPerLocation": 1
      }
    ]
  }
]

Delete given utility deployment template

delete

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

deploymentTemplateIdstringRequired

The Id of the deployment template

Responses

204

No Content

403

Invalid credentials

404

Invalid deploymentTemplateId

409

If the template is in use, it cannot be deleted

500

Internal Server Error

application/json

delete

/v3/deploymentTemplate/utility/{deploymentTemplateId}

HTTPcURLJavaScriptPython

DELETE /v3/deploymentTemplate/utility/{deploymentTemplateId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content

Get list of fleet using utility deployment template Id

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

deploymentTemplateIdstringRequired

The Id of the deployment 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 deploymentTemplateId

500

Internal Server Error

application/json

get

/v3/deploymentTemplate/utility/{deploymentTemplateId}/fleet

HTTPcURLJavaScriptPython

GET /v3/deploymentTemplate/utility/{deploymentTemplateId}/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 dependency deployment 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

dependency Deployment template ID

namestringRequired

Name of the dependency deployment template

dependencyInstallerBuildIdstringRequired

Dependency installer build ID

dependencyUninstallerBuildIdstringRequired

Dependency uninstaller build ID

fleetIdsstring[]Read-onlyRequired

IDs of the fleets that use this template

inUseinteger · integerRead-onlyRequired

Indicates whether this dependency deployment template is used by one or more fleets. A template cannot be deleted as long as this value is 1.

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/deploymentTemplate/dependency

HTTPcURLJavaScriptPython

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

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

Create a dependency deployment template

post

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Body

application/json

idstringRead-onlyRequired

dependency Deployment template ID

namestringRequired

Name of the dependency deployment template

dependencyInstallerBuildIdstringRequired

Dependency installer build ID

dependencyUninstallerBuildIdstringRequired

Dependency uninstaller build ID

fleetIdsstring[]Read-onlyRequired

IDs of the fleets that use this template

inUseinteger · integerRead-onlyRequired

Indicates whether this dependency deployment template is used by one or more fleets. A template cannot be deleted as long as this value is 1.

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

Responses

200

OK

application/json

idstringRead-onlyRequired

dependency Deployment template ID

namestringRequired

Name of the dependency deployment template

dependencyInstallerBuildIdstringRequired

Dependency installer build ID

dependencyUninstallerBuildIdstringRequired

Dependency uninstaller build ID

fleetIdsstring[]Read-onlyRequired

IDs of the fleets that use this template

inUseinteger · integerRead-onlyRequired

Indicates whether this dependency deployment template is used by one or more fleets. A template cannot be deleted as long as this value is 1.

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

403

Invalid credentials

422

Unprocessable Entity

500

Internal Server Error

application/json

post

/v3/deploymentTemplate/dependency

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "dependencyInstallerBuildId": "text",
  "dependencyUninstallerBuildId": "text"
}

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

Get the details of dependency deployment template

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

deploymentTemplateIdstringRequired

The Id of the dependency deployment template

Responses

200

OK

application/json

idstringRead-onlyRequired

dependency Deployment template ID

namestringRequired

Name of the dependency deployment template

dependencyInstallerBuildIdstringRequired

Dependency installer build ID

dependencyUninstallerBuildIdstringRequired

Dependency uninstaller build ID

fleetIdsstring[]Read-onlyRequired

IDs of the fleets that use this template

inUseinteger · integerRead-onlyRequired

Indicates whether this dependency deployment template is used by one or more fleets. A template cannot be deleted as long as this value is 1.

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

403

Invalid credentials

404

Invalid deploymentTemplateId

500

Internal Server Error

application/json

get

/v3/deploymentTemplate/dependency/{deploymentTemplateId}

HTTPcURLJavaScriptPython

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

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

Update given dependency deployment template.

put

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

deploymentTemplateIdstringRequired

The Id of the dependency deployment template

Body

application/json

idstringRead-onlyRequired

dependency Deployment template ID

namestringRequired

Name of the dependency deployment template

dependencyInstallerBuildIdstringRequired

Dependency installer build ID

dependencyUninstallerBuildIdstringRequired

Dependency uninstaller build ID

fleetIdsstring[]Read-onlyRequired

IDs of the fleets that use this template

inUseinteger · integerRead-onlyRequired

Indicates whether this dependency deployment template is used by one or more fleets. A template cannot be deleted as long as this value is 1.

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

Responses

200

OK

application/json

idstringRead-onlyRequired

dependency Deployment template ID

namestringRequired

Name of the dependency deployment template

dependencyInstallerBuildIdstringRequired

Dependency installer build ID

dependencyUninstallerBuildIdstringRequired

Dependency uninstaller build ID

fleetIdsstring[]Read-onlyRequired

IDs of the fleets that use this template

inUseinteger · integerRead-onlyRequired

Indicates whether this dependency deployment template is used by one or more fleets. A template cannot be deleted as long as this value is 1.

createdAtinteger · integerRead-onlyRequired

UnixTimestamp

403

Invalid credentials

404

Invalid deploymentTemplateId

422

Unprocessable Entity

500

Internal Server Error

application/json

put

/v3/deploymentTemplate/dependency/{deploymentTemplateId}

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "dependencyInstallerBuildId": "text",
  "dependencyUninstallerBuildId": "text"
}

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

Delete given dependency deployment template.

delete

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

deploymentTemplateIdstringRequired

The Id of the dependency deployment template

Responses

204

No Content

403

Invalid credentials

404

Invalid deploymentTemplateId

409

If the template is in use, it cannot be deleted

500

Internal Server Error

application/json

delete

/v3/deploymentTemplate/dependency/{deploymentTemplateId}

HTTPcURLJavaScriptPython

DELETE /v3/deploymentTemplate/dependency/{deploymentTemplateId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content

Get all fleets using the given deploymentTemplateId

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

deploymentTemplateIdstringRequired

The Id of the dependency deployment 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 deploymentTemplateId

500

Internal Server Error

application/json

get

/v3/deploymentTemplate/dependency/{deploymentTemplateId}/fleet

HTTPcURLJavaScriptPython

GET /v3/deploymentTemplate/dependency/{deploymentTemplateId}/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
  }
]