Fleet

All fleet endpoints

Get a list of fleets

get

Authorizations

PRIVATE-TOKENstringRequired

Header parameters

RANGED-DATAstringOptional

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

Responses

200

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

500

Internal Server Error

application/json

get

/v3/fleet

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

Create a new fleet

post

Authorizations

PRIVATE-TOKENstringRequired

Body

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

Responses

200

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

422

Unprocessable Entity

500

Internal Server Error

application/json

post

/v3/fleet

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

{
  "name": "text",
  "deploymentEnvironmentId": "text",
  "deploymentProfileId": "text",
  "gameDeploymentTemplateId": "text",
  "utilityDeploymentTemplateId": "text",
  "dependencyDeploymentTemplateId": "text",
  "hostCapacityTemplateId": "text",
  "isGameLift": true
}

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

Get a specific fleet by Id

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

fleetIdstringRequired

The Id of the fleet

Responses

200

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 fleetId

500

Internal Server Error

application/json

get

/v3/fleet/{fleetId}

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

Update given fleet

put

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

fleetIdstringRequired

The Id of the fleet

Body

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

Responses

200

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 fleetId

422

Unprocessable Entity

500

Internal Server Error

application/json

put

/v3/fleet/{fleetId}

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

{
  "name": "text",
  "deploymentEnvironmentId": "text",
  "deploymentProfileId": "text",
  "gameDeploymentTemplateId": "text",
  "utilityDeploymentTemplateId": "text",
  "dependencyDeploymentTemplateId": "text",
  "hostCapacityTemplateId": "text",
  "isGameLift": true
}

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

Removes an existing fleet. Note that it may not have any active servers assigned to it.

delete

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

fleetIdstringRequired

The ID of the fleet

Responses

204

No Content

403

Invalid credentials

404

Invalid fleetId

409

Fleet in use, cannot delete

500

Internal Server Error

application/json

delete

/v3/fleet/{fleetId}

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

No content

Update the operational status of the given fleet

put

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

fleetIdstringRequired

The Id of the fleet

Body

operationalStatusinteger · integerRequired

The operational status for the fleet

Responses

200

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 fleetId

422

Unprocessable Entity

500

Internal Server Error

application/json

put

/v3/fleet/{fleetId}/operationalStatus

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

{
  "operationalStatus": 1
}

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

Get all hosts reserved for the given fleet

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

fleetIdstringRequired

The Id of the fleet

Header parameters

RANGED-DATAstringOptional

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

Responses

200

application/json

idinteger · integerRead-onlyRequired

The ID of this host

userIdinteger · integerRead-onlyRequired

The ID of the user who owns this server

serverIdinteger · integerRead-onlyRequired

The ID of the physical machine

serverNamestringRead-onlyRequired

The name of the physical machine

serverTypeinteger · integerRead-onlyRequired

The type of the server:

1: Bare metal server
2: Flex metal server
3: Virtual machine

projectNamestringOptional

The name of the project for the host

clientServerNamestringOptional

The name of the server defined by client

clientStatestringOptional

Client statement for the host

liveHostNamestringRead-onlyRequired

The host name

isVirtualinteger · integerRead-onlyRequiredDeprecated

0 if this is a bare metal server, 1 if it's a VM. Use serverType instead

categorystringRead-onlyRequired

Host category. Normally "Dedicated Game Servers" or "Dedicated Servers", but can be "Broken" if the server is in a degraded state

osIdinteger · integerRead-onlyRequired

Operating system ID, must be one of GET /v3/operatingsystem

locationIdinteger · integerRead-onlyRequired

Legacy location ID (not used for ODP)

dcLocationIdinteger · integerRead-onlyRequired

Datacenter location ID. Points to one of GET /v3/cloud/dcLocation

instanceTypestringRead-onlyRequired

The instance type of this server, which is one of GET /v3/host/instanceType for a bare metal, or one of GET /v3/cloud/instanceType for a virtual machine

fleetIdstringRead-onlyRequired

The fleet ID, if this host has been assigned to a fleet If 0, the host has not been assigned to a fleet, otherwise, the fleet is assigned to this host and the host can serve application instances for that fleet.

newFleetIdstring · nullableRead-onlyRequired

The ID of a new fleet that is to be assigned to this host after performing a bulkReserve operation at POST /v3/fleet/host/bulkReserve

fleetAssociatedSinceinteger · integerRead-onlyRequired

Unix timestamp when fleet assigned to the host

rackNamestringRead-onlyRequired

The name of the rack the host is located

dateStartstringRead-onlyRequired

The date at which this host became active

dateEndstringRead-onlyRequired

The date at which this host will expire

dateCancelledstringRead-onlyRequired

The date at which this host was cancelled

dateEndContractstringRead-onlyRequired

The date at which the contract ends (if applicable)

contractPeriodinteger · integerRead-onlyRequired

The contract period in months

extendPeriodinteger · integerRead-onlyRequired

The service extend period in months

cancellationPeriodinteger · integerRead-onlyRequired

The cancellation period in months

purchaseOrderstringRead-onlyRequired

Purchase order, if one has been supplied via our billing department

paymentTerminteger · integerRead-onlyRequired

The payment term in days (how many days are invoices generated before dateEnd)

pricePerMonthstringRead-onlyRequired

The price of this host per month in cents (see currencyId for currency)

pricePerTbOverusestringRead-onlyRequired

The price of traffic overuse in cents (per TB) (see currencyId for currency)

currencyIdinteger · integerRead-onlyRequired

The currency of the pricePerMonth field:

0: EURO
1: USD
9: YEN

bandwidthBillingTypeinteger · integerRead-onlyRequired

The bandwidth billing method for this service:

1: unmetered connection
2: measured in TB per month
3: measured in mbit 95th percentile

bandwidthContractualinteger · integerRead-onlyRequired

The contractual maximum bandwidth usage value. In GB if bandwidthBillingType equals 2, in mbit otherwise

brandstringRead-onlyRequired

The server manufacturer brand name

modelstringRead-onlyRequired

The model of the server

numCpuinteger · integerRead-onlyRequired

Number of CPUs in this host

cpuInfostringRead-onlyRequired

cpuTypestringRead-onlyRequired

cpuLoadnumber · floatRead-onlyRequired

Percentage of cpu used across all cores

memUsedinteger · integerRead-onlyRequired

The amount of memory that is used by the host (in megabytes)

memMaxinteger · integerRead-onlyRequired

The amount of memory that is available on the host (in megabytes)

memFreeinteger · integerRead-onlyRequired

The amount of free memory that is available on the host (in megabytes)

isReserveinteger · integerRead-onlyRequired

If the host is reserved for a fleet isReserve set to 1

serviceTagstringRead-onlyRequired

The service tag of the host

isODPinteger · integerRead-onlyRequired

If the host is available for game hosting platform isODP set to 1

fmOrderIdstring · nullableRead-onlyRequired

ID of Flex Metal order if this is a flex metal server

installStatusstring · nullableRead-onlyRequired

Status of server auto install if it was started by one. (created / installing / finished / failed)

statusstringRead-onlyRequired

Whether the host is running or not

uptimeinteger · integerOptional

The uptime of the host. Read-only. Only provided if the server checked-in recently

trafficSuminteger · integerRead-onlyRequired

Monthly traffic of all incoming and outgoing bandwidth in GB or Mbit depending on host configuration

freeIncomingTrafficbooleanRead-onlyRequired

Whether the host has free incoming traffic or not

outgoingTrafficSuminteger · integerRead-onlyRequired

The outgoing traffic (Mbit or GB)

incomingTrafficSuminteger · integerRead-onlyRequired

The incoming traffic (Mbit or GB)

403

Invalid credentials

404

Invalid fleetId

500

Internal Server Error

application/json

get

/v3/fleet/{fleetId}/host/reserved

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

[
  {
    "id": 1,
    "userId": 1,
    "serverId": 1,
    "serverName": "text",
    "serverType": 1,
    "projectName": "text",
    "clientServerName": "text",
    "clientState": "text",
    "liveHostName": "text",
    "category": "text",
    "osId": 1,
    "locationId": 1,
    "dcLocationId": 1,
    "instanceType": "text",
    "fleetId": "text",
    "newFleetId": "text",
    "fleetAssociatedSince": 1,
    "rackName": "text",
    "dateStart": "text",
    "dateEnd": "text",
    "dateCancelled": "text",
    "dateEndContract": "text",
    "contractPeriod": 1,
    "extendPeriod": 1,
    "cancellationPeriod": 1,
    "purchaseOrder": "text",
    "paymentTerm": 1,
    "pricePerMonth": "text",
    "pricePerTbOveruse": "text",
    "currencyId": 1,
    "bandwidthBillingType": 1,
    "bandwidthContractual": 1,
    "ipAddress": [
      {
        "ipAddress": "text",
        "version": 1,
        "type": 1,
        "private": 1,
        "interface": 1,
        "macAddress": "text",
        "rDns": "text",
        "vlanId": 1,
        "gateway": "text",
        "netmask": "text",
        "prefix": 1
      }
    ],
    "brand": "text",
    "model": "text",
    "numCpu": 1,
    "cpuInfo": "text",
    "cpuType": "text",
    "cpuLoad": 1,
    "cpu": {
      "socket": 1,
      "cores": 1,
      "threads": 1,
      "info": "text",
      "type": "text"
    },
    "memUsed": 1,
    "memMax": 1,
    "memFree": 1,
    "disk": [
      {
        "diskType": "text",
        "diskMedium": "text",
        "model": "text",
        "product": "text",
        "diskSerial": "text",
        "firmwareVersion": "text",
        "rotationRate": 1,
        "sectorSizeLogical": 1,
        "sectorSizePhysical": 1,
        "size": 1
      }
    ],
    "memory": [
      {
        "brand": "text",
        "model": "text",
        "size": 1,
        "speed": 1,
        "ecc": 1,
        "memoryBank": 1,
        "memoryType": "text",
        "memorySlot": "text",
        "memorySerial": "text"
      }
    ],
    "isReserve": 1,
    "labels": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "serviceTag": "text",
    "isODP": 1,
    "fmOrderId": "text",
    "installStatus": "text",
    "status": "text",
    "uptime": 1,
    "trafficSum": 1,
    "uplinks": [
      {
        "uplinkId": 1,
        "aggregate": true
      }
    ],
    "freeIncomingTraffic": true,
    "outgoingTrafficSum": 1,
    "incomingTrafficSum": 1
  }
]

Reserve a list of hosts for a specific new fleet. The existing application instances on these servers will be automatically scaled down.

post

Authorizations

PRIVATE-TOKENstringRequired

Header parameters

X-Trace-Id:stringOptional

Response header which you can use to fetch the status of the bulk reservation of hosts by using endpoint GET /v3/fleet/host/bulkReserve/{traceId}/status

Body

fleetIdstringRequired

Fleet ID

hostsinteger · integer[]Required

List of host ID's

methodIdinteger · integerOptional

Stop method type, list of types can be found in: GET /v3/application/stopMethod

timeoutinteger · integerOptional

Stop method timeout in seconds, default value is 1800 seconds

Responses

204

No Content

403

Invalid credentials

422

Unprocessable Entity

500

Internal Server Error

application/json

post

/v3/fleet/host/bulkReserve

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

{
  "fleetId": "text",
  "hosts": [
    1
  ],
  "methodId": 1,
  "timeout": 1
}

No content

Progress for the bulk reserve you have done, base on the trace id you received in the header when you have created the bulk reserve

get

Authorizations

PRIVATE-TOKENstringRequired

Responses

200

application/json

oldFleetIdstringRequired

Fleet ID that was assigned to the host prior to bulk reservation.

newFleetIdstringRequired

Fleet ID that will be assigned to the host after completion of bulk reservation.

hostIdinteger · integerRequired

ID of the host.

inProgressinteger · integerRequired

When the value is 1 then the host is not changed to the new fleet ID, when value is 0 than the host is changed to the new fleet ID.

403

Invalid credentials

404

Not Found

500

Internal Server Error

application/json

get

/v3/fleet/host/bulkReserve/{traceId}/status

GET /v3/fleet/host/bulkReserve/{traceId}/status HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "oldFleetId": "text",
    "newFleetId": "text",
    "hostId": 1,
    "inProgress": 1
  }
]

Get all your hosts for a fleet.

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

fleetIdstringRequired

The Id of the fleet

Header parameters

RANGED-DATAstringOptional

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

Responses

200

application/json

idinteger · integerRead-onlyRequired

The ID of this host

userIdinteger · integerRead-onlyRequired

The ID of the user who owns this server

serverIdinteger · integerRead-onlyRequired

The ID of the physical machine

serverNamestringRead-onlyRequired

The name of the physical machine

serverTypeinteger · integerRead-onlyRequired

The type of the server:

1: Bare metal server
2: Flex metal server
3: Virtual machine

projectNamestringOptional

The name of the project for the host

clientServerNamestringOptional

The name of the server defined by client

clientStatestringOptional

Client statement for the host

liveHostNamestringRead-onlyRequired

The host name

isVirtualinteger · integerRead-onlyRequiredDeprecated

0 if this is a bare metal server, 1 if it's a VM. Use serverType instead

categorystringRead-onlyRequired

Host category. Normally "Dedicated Game Servers" or "Dedicated Servers", but can be "Broken" if the server is in a degraded state

osIdinteger · integerRead-onlyRequired

Operating system ID, must be one of GET /v3/operatingsystem

locationIdinteger · integerRead-onlyRequired

Legacy location ID (not used for ODP)

dcLocationIdinteger · integerRead-onlyRequired

Datacenter location ID. Points to one of GET /v3/cloud/dcLocation

instanceTypestringRead-onlyRequired

The instance type of this server, which is one of GET /v3/host/instanceType for a bare metal, or one of GET /v3/cloud/instanceType for a virtual machine

fleetIdstringRead-onlyRequired

newFleetIdstring · nullableRead-onlyRequired

The ID of a new fleet that is to be assigned to this host after performing a bulkReserve operation at POST /v3/fleet/host/bulkReserve

fleetAssociatedSinceinteger · integerRead-onlyRequired

Unix timestamp when fleet assigned to the host

rackNamestringRead-onlyRequired

The name of the rack the host is located

dateStartstringRead-onlyRequired

The date at which this host became active

dateEndstringRead-onlyRequired

The date at which this host will expire

dateCancelledstringRead-onlyRequired

The date at which this host was cancelled

dateEndContractstringRead-onlyRequired

The date at which the contract ends (if applicable)

contractPeriodinteger · integerRead-onlyRequired

The contract period in months

extendPeriodinteger · integerRead-onlyRequired

The service extend period in months

cancellationPeriodinteger · integerRead-onlyRequired

The cancellation period in months

purchaseOrderstringRead-onlyRequired

Purchase order, if one has been supplied via our billing department

paymentTerminteger · integerRead-onlyRequired

The payment term in days (how many days are invoices generated before dateEnd)

pricePerMonthstringRead-onlyRequired

The price of this host per month in cents (see currencyId for currency)

pricePerTbOverusestringRead-onlyRequired

The price of traffic overuse in cents (per TB) (see currencyId for currency)

currencyIdinteger · integerRead-onlyRequired

The currency of the pricePerMonth field:

0: EURO
1: USD
9: YEN

bandwidthBillingTypeinteger · integerRead-onlyRequired

The bandwidth billing method for this service:

1: unmetered connection
2: measured in TB per month
3: measured in mbit 95th percentile

bandwidthContractualinteger · integerRead-onlyRequired

The contractual maximum bandwidth usage value. In GB if bandwidthBillingType equals 2, in mbit otherwise

brandstringRead-onlyRequired

The server manufacturer brand name

modelstringRead-onlyRequired

The model of the server

numCpuinteger · integerRead-onlyRequired

Number of CPUs in this host

cpuInfostringRead-onlyRequired

cpuTypestringRead-onlyRequired

cpuLoadnumber · floatRead-onlyRequired

Percentage of cpu used across all cores

memUsedinteger · integerRead-onlyRequired

The amount of memory that is used by the host (in megabytes)

memMaxinteger · integerRead-onlyRequired

The amount of memory that is available on the host (in megabytes)

memFreeinteger · integerRead-onlyRequired

The amount of free memory that is available on the host (in megabytes)

isReserveinteger · integerRead-onlyRequired

If the host is reserved for a fleet isReserve set to 1

serviceTagstringRead-onlyRequired

The service tag of the host

isODPinteger · integerRead-onlyRequired

If the host is available for game hosting platform isODP set to 1

fmOrderIdstring · nullableRead-onlyRequired

ID of Flex Metal order if this is a flex metal server

installStatusstring · nullableRead-onlyRequired

Status of server auto install if it was started by one. (created / installing / finished / failed)

statusstringRead-onlyRequired

Whether the host is running or not

uptimeinteger · integerOptional

The uptime of the host. Read-only. Only provided if the server checked-in recently

trafficSuminteger · integerRead-onlyRequired

Monthly traffic of all incoming and outgoing bandwidth in GB or Mbit depending on host configuration

freeIncomingTrafficbooleanRead-onlyRequired

Whether the host has free incoming traffic or not

outgoingTrafficSuminteger · integerRead-onlyRequired

The outgoing traffic (Mbit or GB)

incomingTrafficSuminteger · integerRead-onlyRequired

The incoming traffic (Mbit or GB)

403

Invalid credentials

404

Invalid fleetId

500

Internal Server Error

application/json

get

/v3/fleet/{fleetId}/host

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

[
  {
    "id": 1,
    "userId": 1,
    "serverId": 1,
    "serverName": "text",
    "serverType": 1,
    "projectName": "text",
    "clientServerName": "text",
    "clientState": "text",
    "liveHostName": "text",
    "category": "text",
    "osId": 1,
    "locationId": 1,
    "dcLocationId": 1,
    "instanceType": "text",
    "fleetId": "text",
    "newFleetId": "text",
    "fleetAssociatedSince": 1,
    "rackName": "text",
    "dateStart": "text",
    "dateEnd": "text",
    "dateCancelled": "text",
    "dateEndContract": "text",
    "contractPeriod": 1,
    "extendPeriod": 1,
    "cancellationPeriod": 1,
    "purchaseOrder": "text",
    "paymentTerm": 1,
    "pricePerMonth": "text",
    "pricePerTbOveruse": "text",
    "currencyId": 1,
    "bandwidthBillingType": 1,
    "bandwidthContractual": 1,
    "ipAddress": [
      {
        "ipAddress": "text",
        "version": 1,
        "type": 1,
        "private": 1,
        "interface": 1,
        "macAddress": "text",
        "rDns": "text",
        "vlanId": 1,
        "gateway": "text",
        "netmask": "text",
        "prefix": 1
      }
    ],
    "brand": "text",
    "model": "text",
    "numCpu": 1,
    "cpuInfo": "text",
    "cpuType": "text",
    "cpuLoad": 1,
    "cpu": {
      "socket": 1,
      "cores": 1,
      "threads": 1,
      "info": "text",
      "type": "text"
    },
    "memUsed": 1,
    "memMax": 1,
    "memFree": 1,
    "disk": [
      {
        "diskType": "text",
        "diskMedium": "text",
        "model": "text",
        "product": "text",
        "diskSerial": "text",
        "firmwareVersion": "text",
        "rotationRate": 1,
        "sectorSizeLogical": 1,
        "sectorSizePhysical": 1,
        "size": 1
      }
    ],
    "memory": [
      {
        "brand": "text",
        "model": "text",
        "size": 1,
        "speed": 1,
        "ecc": 1,
        "memoryBank": 1,
        "memoryType": "text",
        "memorySlot": "text",
        "memorySerial": "text"
      }
    ],
    "isReserve": 1,
    "labels": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "serviceTag": "text",
    "isODP": 1,
    "fmOrderId": "text",
    "installStatus": "text",
    "status": "text",
    "uptime": 1,
    "trafficSum": 1,
    "uplinks": [
      {
        "uplinkId": 1,
        "aggregate": true
      }
    ],
    "freeIncomingTraffic": true,
    "outgoingTrafficSum": 1,
    "incomingTrafficSum": 1
  }
]

Reserve the given host for the given fleet Id

put

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

fleetIdstringRequired

The Id of the fleet

hostIdintegerRequired

The Id of the host

Responses

204

No Content

403

Invalid credentials

404

Invalid fleetId

409

Host is already reserved

500

Internal Server Error

application/json

put

/v3/fleet/{fleetId}/host/{hostId}/reserve

PUT /v3/fleet/{fleetId}/host/{hostId}/reserve HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content

Remove a fleet reservation from the given host. Sets `fleetId` to `0` only if no application instances are deployed on it.

put

There are three situations you need to be aware of when un-reserving a fleet:

You have application instances on the host and auto-scaling is enabled: Eventually the host is scaled down and its fleetId will be set to 0, at which point it may be re-purposed for another fleet
You have application instances on the host and auto-scaling is not enabled: The host is not automatically scaled down and you will need to manually scale down the application instances on this host for it to be available for another fleet
You have no application instances: The host is unreserved and its fleetId is immediately set to 0, allowing the host to be re-purposed for another fleet

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

fleetIdstringRequired

The ID of the fleet

hostIdintegerRequired

The ID of the host

Responses

204

No Content

403

Invalid credentials

404

Invalid fleetId or hostId

409

Host cannot be unreserved

500

Internal Server Error

application/json

put

/v3/fleet/{fleetId}/host/{hostId}/unreserve

PUT /v3/fleet/{fleetId}/host/{hostId}/unreserve HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content

Get the list of applications for the given fleet

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

fleetIdstringRequired

The Id of the fleet

Responses

200

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 fleetId

500

Internal Server Error

application/json

get

/v3/fleet/{fleetId}/application/inUse

GET /v3/fleet/{fleetId}/application/inUse 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
  }
]

Get the list of application builds for the given fleet

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

fleetIdstringRequired

The Id of the fleet

Responses

200

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 fleetId

500

Internal Server Error

application/json

get

/v3/fleet/{fleetId}/applicationBuild/inUse

GET /v3/fleet/{fleetId}/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 a list of environment variables for a fleet

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

fleetIdstringRequired

The Id of the fleet

Responses

200

application/json

idstring · nullableRequired

of game lift environment variable

typestringRequired

of game lift environment variable:

awsgl_endpoint
awsgl_region
awsgl_token
awsgl_hostname
awsgl_fleetid
raw_value

namestring · nullableRequired

of game lift environment variable, e.g. "AWS_TOKEN_ID"

400

Bad request

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/fleet/{fleetId}/gameLiftDeploymentEnvironmentVariables

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

[
  {
    "id": "text",
    "type": "text",
    "name": "text"
  }
]

Add or update environment variables for a fleet

put

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

fleetIdstringRequired

The Id of the fleet

Bodyobject[]

idstring · nullableRequired

of game lift environment variable

typestringRequired

of game lift environment variable:

awsgl_endpoint
awsgl_region
awsgl_token
awsgl_hostname
awsgl_fleetid
raw_value

namestring · nullableRequired

of game lift environment variable, e.g. "AWS_TOKEN_ID"

Responses

200

application/json

idstring · nullableRequired

of game lift environment variable

typestringRequired

of game lift environment variable:

awsgl_endpoint
awsgl_region
awsgl_token
awsgl_hostname
awsgl_fleetid
raw_value

namestring · nullableRequired

of game lift environment variable, e.g. "AWS_TOKEN_ID"

400

Bad request

403

Invalid credentials

500

Internal Server Error

application/json

put

/v3/fleet/{fleetId}/gameLiftDeploymentEnvironmentVariables

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

[
  {
    "id": "text",
    "type": "text",
    "name": "text"
  }
]

[
  {
    "id": "text",
    "type": "text",
    "name": "text"
  }
]

Get current fleet telemetry

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

fleetIdstringRequired

The Id of the fleet

Responses

200

application/json

hostsinteger · integerRequired

The number of hosts

instancesinteger · integerRequired

The number of instances

playersinteger · integerRequired

The number of players

403

Invalid credentials

404

Invalid fleetId

500

Internal Server Error

application/json

get

/v3/telemetry/fleet/{fleetId}/current

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

[
  {
    "hosts": 1,
    "instances": 1,
    "players": 1
  }
]

Last updated 11 months ago

Was this helpful?

hashtagGet a list of fleets

hashtagCreate a new fleet

hashtagGet a specific fleet by Id

hashtagUpdate given fleet

hashtagRemoves an existing fleet. Note that it may not have any active servers assigned to it.

hashtagUpdate the operational status of the given fleet

hashtagGet all hosts reserved for the given fleet

hashtagReserve a list of hosts for a specific new fleet. The existing application instances on these servers will be automatically scaled down.

hashtagProgress for the bulk reserve you have done, base on the trace id you received in the header when you have created the bulk reserve

hashtagGet all your hosts for a fleet.

hashtagReserve the given host for the given fleet Id

hashtagRemove a fleet reservation from the given host. Sets `fleetId` to `0` only if no application instances are deployed on it.

hashtagGet the list of applications for the given fleet

hashtagGet the list of application builds for the given fleet

hashtagGet a list of environment variables for a fleet

hashtagAdd or update environment variables for a fleet

hashtagGet current fleet telemetry

Get a list of fleets

Create a new fleet

Get a specific fleet by Id

Update given fleet

Removes an existing fleet. Note that it may not have any active servers assigned to it.

Update the operational status of the given fleet

Get all hosts reserved for the given fleet

Reserve a list of hosts for a specific new fleet. The existing application instances on these servers will be automatically scaled down.

Progress for the bulk reserve you have done, base on the trace id you received in the header when you have created the bulk reserve

Get all your hosts for a fleet.

Reserve the given host for the given fleet Id

Remove a fleet reservation from the given host. Sets `fleetId` to `0` only if no application instances are deployed on it.

Get the list of applications for the given fleet

Get the list of application builds for the given fleet

Get a list of environment variables for a fleet

Add or update environment variables for a fleet

Get current fleet telemetry