DeploymentProfile

(Cloud) deployment and scaling configuration

Get all the deployment profiles you have created

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

The deployment profile ID

fleetIdsstring[]Read-onlyRequired

IDs of the fleets in which this deployment profile is being used

namestringRequired

This deployment profile's name

descriptionstringOptional

This deployment profile's description

strategyTypeinteger · integerRequired

Possible values:

1: Round robin

minimumCapacityinteger · integerRequired

The minimum amount of game instances that should always be deployed for each deployment region in this deployment profile. Can be overridden per deployment region

maximumCapacityinteger · integer · nullableOptional

The maximum amount of game instances that can be deployed in each region. Can be overridden per region. Null value means that there is no maximumCapacity

bufferValueinteger · integerRequired

Global buffer value, to be applied to individual deployment regions. Can be overridden per region

bufferValueTypeinteger · integerRequired

Possible values:

0: Absolute value
1: Percentage value (must be accompanied by bufferValueMin and bufferValueMax)

bufferValueMininteger · integer · nullableOptional

The minimum absolute bufferValue when using a percentage, to prevent bufferValue from going too low

bufferValueMaxinteger · integer · nullableOptional

The maximum absolute bufferValue when using a percentage, to prevent bufferValue from going too high

markedForDeletioninteger · integerRead-onlyRequired

When 1, markedForDeletion will propagate to all deployment regions of this deployment profile. Scaling down will happen slowly as application instances get removed naturally. After all application instances are removed, the deployment profile is set to inactive

Example: 1

inUseinteger · integerRead-onlyRequired

Possible values:

0: Deployment profile has no active application instances
1: Deployment profile has active application instance(s)

createdAtinteger · integerRead-onlyRequired

Unix timestamp of creation time

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/deploymentProfile

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

[
  {
    "id": "text",
    "fleetIds": [
      "text"
    ],
    "name": "text",
    "description": "text",
    "strategyType": 1,
    "minimumCapacity": 1,
    "maximumCapacity": 1,
    "bufferValue": 1,
    "bufferValueType": 1,
    "bufferValueMin": 1,
    "bufferValueMax": 1,
    "markedForDeletion": 1,
    "inUse": 1,
    "deploymentRegions": [
      {
        "id": "text",
        "name": "text",
        "i3dDcLocationIds": [
          1
        ],
        "i3dDcLocationIdsToBeRemoved": [
          1
        ],
        "minimumCapacity": 1,
        "maximumCapacity": 1,
        "bufferValue": 1,
        "bufferValueType": 1,
        "bufferValueMin": 1,
        "bufferValueMax": 1,
        "strategyType": 1,
        "markedForDeletion": 1,
        "containers": [
          {
            "id": "text",
            "markedForDeletion": 1,
            "containerLocations": [
              {
                "id": "text",
                "cloudProviderId": 1,
                "dcLocationId": 1,
                "primaryInstanceTypeName": "text",
                "primaryInstanceTypeStatus": 1,
                "secondaryInstanceTypeName": "text",
                "secondaryInstanceTypeStatus": 1,
                "markedForDeletion": 1
              }
            ]
          }
        ],
        "inUse": 1
      }
    ],
    "createdAt": 1
  }
]

Create a new deployment profile

post

Authorizations

PRIVATE-TOKENstringRequired

Body

idstringRead-onlyRequired

The deployment profile ID

fleetIdsstring[]Read-onlyRequired

IDs of the fleets in which this deployment profile is being used

namestringRequired

This deployment profile's name

descriptionstringOptional

This deployment profile's description

strategyTypeinteger · integerRequired

Possible values:

1: Round robin

minimumCapacityinteger · integerRequired

The minimum amount of game instances that should always be deployed for each deployment region in this deployment profile. Can be overridden per deployment region

maximumCapacityinteger · integer · nullableOptional

The maximum amount of game instances that can be deployed in each region. Can be overridden per region. Null value means that there is no maximumCapacity

bufferValueinteger · integerRequired

Global buffer value, to be applied to individual deployment regions. Can be overridden per region

bufferValueTypeinteger · integerRequired

Possible values:

0: Absolute value
1: Percentage value (must be accompanied by bufferValueMin and bufferValueMax)

bufferValueMininteger · integer · nullableOptional

The minimum absolute bufferValue when using a percentage, to prevent bufferValue from going too low

bufferValueMaxinteger · integer · nullableOptional

The maximum absolute bufferValue when using a percentage, to prevent bufferValue from going too high

markedForDeletioninteger · integerRead-onlyRequired

Example: 1

inUseinteger · integerRead-onlyRequired

Possible values:

0: Deployment profile has no active application instances
1: Deployment profile has active application instance(s)

createdAtinteger · integerRead-onlyRequired

Unix timestamp of creation time

Responses

200

application/json

idstringRead-onlyRequired

The deployment profile ID

fleetIdsstring[]Read-onlyRequired

IDs of the fleets in which this deployment profile is being used

namestringRequired

This deployment profile's name

descriptionstringOptional

This deployment profile's description

strategyTypeinteger · integerRequired

Possible values:

1: Round robin

minimumCapacityinteger · integerRequired

The minimum amount of game instances that should always be deployed for each deployment region in this deployment profile. Can be overridden per deployment region

maximumCapacityinteger · integer · nullableOptional

The maximum amount of game instances that can be deployed in each region. Can be overridden per region. Null value means that there is no maximumCapacity

bufferValueinteger · integerRequired

Global buffer value, to be applied to individual deployment regions. Can be overridden per region

bufferValueTypeinteger · integerRequired

Possible values:

0: Absolute value
1: Percentage value (must be accompanied by bufferValueMin and bufferValueMax)

bufferValueMininteger · integer · nullableOptional

The minimum absolute bufferValue when using a percentage, to prevent bufferValue from going too low

bufferValueMaxinteger · integer · nullableOptional

The maximum absolute bufferValue when using a percentage, to prevent bufferValue from going too high

markedForDeletioninteger · integerRead-onlyRequired

Example: 1

inUseinteger · integerRead-onlyRequired

Possible values:

0: Deployment profile has no active application instances
1: Deployment profile has active application instance(s)

createdAtinteger · integerRead-onlyRequired

Unix timestamp of creation time

403

Invalid credentials

422

Unprocessable Entity

500

Internal Server Error

application/json

post

/v3/deploymentProfile

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

{
  "name": "text",
  "description": "text",
  "strategyType": 1,
  "minimumCapacity": 1,
  "maximumCapacity": 1,
  "bufferValue": 1,
  "bufferValueType": 1,
  "bufferValueMin": 1,
  "bufferValueMax": 1
}

[
  {
    "id": "text",
    "fleetIds": [
      "text"
    ],
    "name": "text",
    "description": "text",
    "strategyType": 1,
    "minimumCapacity": 1,
    "maximumCapacity": 1,
    "bufferValue": 1,
    "bufferValueType": 1,
    "bufferValueMin": 1,
    "bufferValueMax": 1,
    "markedForDeletion": 1,
    "inUse": 1,
    "deploymentRegions": [
      {
        "id": "text",
        "name": "text",
        "i3dDcLocationIds": [
          1
        ],
        "i3dDcLocationIdsToBeRemoved": [
          1
        ],
        "minimumCapacity": 1,
        "maximumCapacity": 1,
        "bufferValue": 1,
        "bufferValueType": 1,
        "bufferValueMin": 1,
        "bufferValueMax": 1,
        "strategyType": 1,
        "markedForDeletion": 1,
        "containers": [
          {
            "id": "text",
            "markedForDeletion": 1,
            "containerLocations": [
              {
                "id": "text",
                "cloudProviderId": 1,
                "dcLocationId": 1,
                "primaryInstanceTypeName": "text",
                "primaryInstanceTypeStatus": 1,
                "secondaryInstanceTypeName": "text",
                "secondaryInstanceTypeStatus": 1,
                "markedForDeletion": 1
              }
            ]
          }
        ],
        "inUse": 1
      }
    ],
    "createdAt": 1
  }
]

Get all the deployment profiles you have created

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

The deployment profile ID

fleetIdsstring[]Read-onlyRequired

IDs of the fleets in which this deployment profile is being used

namestringRequired

This deployment profile's name

descriptionstringOptional

This deployment profile's description

strategyTypeinteger · integerRequired

Possible values:

1: Round robin

minimumCapacityinteger · integerRequired

The minimum amount of game instances that should always be deployed for each deployment region in this deployment profile. Can be overridden per deployment region

maximumCapacityinteger · integer · nullableOptional

The maximum amount of game instances that can be deployed in each region. Can be overridden per region. Null value means that there is no maximumCapacity

bufferValueinteger · integerRequired

Global buffer value, to be applied to individual deployment regions. Can be overridden per region

bufferValueTypeinteger · integerRequired

Possible values:

0: Absolute value
1: Percentage value (must be accompanied by bufferValueMin and bufferValueMax)

bufferValueMininteger · integer · nullableOptional

The minimum absolute bufferValue when using a percentage, to prevent bufferValue from going too low

bufferValueMaxinteger · integer · nullableOptional

The maximum absolute bufferValue when using a percentage, to prevent bufferValue from going too high

markedForDeletioninteger · integerRead-onlyRequired

Example: 1

inUseinteger · integerRead-onlyRequired

Possible values:

0: Deployment profile has no active application instances
1: Deployment profile has active application instance(s)

createdAtinteger · integerRead-onlyRequired

Unix timestamp of creation time

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/deploymentProfile/summary

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

[
  {
    "id": "text",
    "fleetIds": [
      "text"
    ],
    "name": "text",
    "description": "text",
    "strategyType": 1,
    "minimumCapacity": 1,
    "maximumCapacity": 1,
    "bufferValue": 1,
    "bufferValueType": 1,
    "bufferValueMin": 1,
    "bufferValueMax": 1,
    "markedForDeletion": 1,
    "inUse": 1,
    "createdAt": 1
  }
]

Get the given deployment profile

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

deploymentProfileIdstringRequired

The Id of the deployment profile

Responses

200

application/json

idstringRead-onlyRequired

The deployment profile ID

fleetIdsstring[]Read-onlyRequired

IDs of the fleets in which this deployment profile is being used

namestringRequired

This deployment profile's name

descriptionstringOptional

This deployment profile's description

strategyTypeinteger · integerRequired

Possible values:

1: Round robin

minimumCapacityinteger · integerRequired

The minimum amount of game instances that should always be deployed for each deployment region in this deployment profile. Can be overridden per deployment region

maximumCapacityinteger · integer · nullableOptional

The maximum amount of game instances that can be deployed in each region. Can be overridden per region. Null value means that there is no maximumCapacity

bufferValueinteger · integerRequired

Global buffer value, to be applied to individual deployment regions. Can be overridden per region

bufferValueTypeinteger · integerRequired

Possible values:

0: Absolute value
1: Percentage value (must be accompanied by bufferValueMin and bufferValueMax)

bufferValueMininteger · integer · nullableOptional

The minimum absolute bufferValue when using a percentage, to prevent bufferValue from going too low

bufferValueMaxinteger · integer · nullableOptional

The maximum absolute bufferValue when using a percentage, to prevent bufferValue from going too high

markedForDeletioninteger · integerRead-onlyRequired

Example: 1

inUseinteger · integerRead-onlyRequired

Possible values:

0: Deployment profile has no active application instances
1: Deployment profile has active application instance(s)

createdAtinteger · integerRead-onlyRequired

Unix timestamp of creation time

403

Invalid credentials

404

Invalid deploymentProfileId

500

Internal Server Error

application/json

get

/v3/deploymentProfile/{deploymentProfileId}

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

[
  {
    "id": "text",
    "fleetIds": [
      "text"
    ],
    "name": "text",
    "description": "text",
    "strategyType": 1,
    "minimumCapacity": 1,
    "maximumCapacity": 1,
    "bufferValue": 1,
    "bufferValueType": 1,
    "bufferValueMin": 1,
    "bufferValueMax": 1,
    "markedForDeletion": 1,
    "inUse": 1,
    "deploymentRegions": [
      {
        "id": "text",
        "name": "text",
        "i3dDcLocationIds": [
          1
        ],
        "i3dDcLocationIdsToBeRemoved": [
          1
        ],
        "minimumCapacity": 1,
        "maximumCapacity": 1,
        "bufferValue": 1,
        "bufferValueType": 1,
        "bufferValueMin": 1,
        "bufferValueMax": 1,
        "strategyType": 1,
        "markedForDeletion": 1,
        "containers": [
          {
            "id": "text",
            "markedForDeletion": 1,
            "containerLocations": [
              {
                "id": "text",
                "cloudProviderId": 1,
                "dcLocationId": 1,
                "primaryInstanceTypeName": "text",
                "primaryInstanceTypeStatus": 1,
                "secondaryInstanceTypeName": "text",
                "secondaryInstanceTypeStatus": 1,
                "markedForDeletion": 1
              }
            ]
          }
        ],
        "inUse": 1
      }
    ],
    "createdAt": 1
  }
]

Update given deployment profile

put

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

deploymentProfileIdstringRequired

The Id of the deployment profile

Body

idstringRead-onlyRequired

The deployment profile ID

fleetIdsstring[]Read-onlyRequired

IDs of the fleets in which this deployment profile is being used

namestringRequired

This deployment profile's name

descriptionstringOptional

This deployment profile's description

strategyTypeinteger · integerRequired

Possible values:

1: Round robin

minimumCapacityinteger · integerRequired

The minimum amount of game instances that should always be deployed for each deployment region in this deployment profile. Can be overridden per deployment region

maximumCapacityinteger · integer · nullableOptional

The maximum amount of game instances that can be deployed in each region. Can be overridden per region. Null value means that there is no maximumCapacity

bufferValueinteger · integerRequired

Global buffer value, to be applied to individual deployment regions. Can be overridden per region

bufferValueTypeinteger · integerRequired

Possible values:

0: Absolute value
1: Percentage value (must be accompanied by bufferValueMin and bufferValueMax)

bufferValueMininteger · integer · nullableOptional

The minimum absolute bufferValue when using a percentage, to prevent bufferValue from going too low

bufferValueMaxinteger · integer · nullableOptional

The maximum absolute bufferValue when using a percentage, to prevent bufferValue from going too high

markedForDeletioninteger · integerRead-onlyRequired

Example: 1

inUseinteger · integerRead-onlyRequired

Possible values:

0: Deployment profile has no active application instances
1: Deployment profile has active application instance(s)

createdAtinteger · integerRead-onlyRequired

Unix timestamp of creation time

Responses

200

application/json

idstringRead-onlyRequired

The deployment profile ID

fleetIdsstring[]Read-onlyRequired

IDs of the fleets in which this deployment profile is being used

namestringRequired

This deployment profile's name

descriptionstringOptional

This deployment profile's description

strategyTypeinteger · integerRequired

Possible values:

1: Round robin

minimumCapacityinteger · integerRequired

The minimum amount of game instances that should always be deployed for each deployment region in this deployment profile. Can be overridden per deployment region

maximumCapacityinteger · integer · nullableOptional

The maximum amount of game instances that can be deployed in each region. Can be overridden per region. Null value means that there is no maximumCapacity

bufferValueinteger · integerRequired

Global buffer value, to be applied to individual deployment regions. Can be overridden per region

bufferValueTypeinteger · integerRequired

Possible values:

0: Absolute value
1: Percentage value (must be accompanied by bufferValueMin and bufferValueMax)

bufferValueMininteger · integer · nullableOptional

The minimum absolute bufferValue when using a percentage, to prevent bufferValue from going too low

bufferValueMaxinteger · integer · nullableOptional

The maximum absolute bufferValue when using a percentage, to prevent bufferValue from going too high

markedForDeletioninteger · integerRead-onlyRequired

Example: 1

inUseinteger · integerRead-onlyRequired

Possible values:

0: Deployment profile has no active application instances
1: Deployment profile has active application instance(s)

createdAtinteger · integerRead-onlyRequired

Unix timestamp of creation time

403

Invalid credentials

404

Invalid deploymentProfileId

409

The deployment profile can't be updated because it is marked for deletion

422

Unprocessable Entity

500

Internal Server Error

application/json

put

/v3/deploymentProfile/{deploymentProfileId}

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

{
  "name": "text",
  "description": "text",
  "strategyType": 1,
  "minimumCapacity": 1,
  "maximumCapacity": 1,
  "bufferValue": 1,
  "bufferValueType": 1,
  "bufferValueMin": 1,
  "bufferValueMax": 1
}

[
  {
    "id": "text",
    "fleetIds": [
      "text"
    ],
    "name": "text",
    "description": "text",
    "strategyType": 1,
    "minimumCapacity": 1,
    "maximumCapacity": 1,
    "bufferValue": 1,
    "bufferValueType": 1,
    "bufferValueMin": 1,
    "bufferValueMax": 1,
    "markedForDeletion": 1,
    "inUse": 1,
    "deploymentRegions": [
      {
        "id": "text",
        "name": "text",
        "i3dDcLocationIds": [
          1
        ],
        "i3dDcLocationIdsToBeRemoved": [
          1
        ],
        "minimumCapacity": 1,
        "maximumCapacity": 1,
        "bufferValue": 1,
        "bufferValueType": 1,
        "bufferValueMin": 1,
        "bufferValueMax": 1,
        "strategyType": 1,
        "markedForDeletion": 1,
        "containers": [
          {
            "id": "text",
            "markedForDeletion": 1,
            "containerLocations": [
              {
                "id": "text",
                "cloudProviderId": 1,
                "dcLocationId": 1,
                "primaryInstanceTypeName": "text",
                "primaryInstanceTypeStatus": 1,
                "secondaryInstanceTypeName": "text",
                "secondaryInstanceTypeStatus": 1,
                "markedForDeletion": 1
              }
            ]
          }
        ],
        "inUse": 1
      }
    ],
    "createdAt": 1
  }
]

Delete given deployment profile (it will delete all the application instances if there are any)

delete

A task will be created and returned (response 200) if the deployment profile is in use, the deployment profile will be mark for deletion and after all the application instances are deleted the deployment profile will be deleted. If not in use, then the deployment profile will be immediately deleted and no content will be returned (status 204)

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

deploymentProfileIdstringRequired

Id of the deployment profile to delete

Query parameters

methodIdintegerOptional

Id for the method of deletion: hard-kill = 1, graceful=2

startTimeintegerOptional

Unix timestamp. When to start deleting the containerLocation and its contents. Default = now

endTimeintegerOptional

Unix timestamp. Time limit in which to delete all remaining game servers immediately (not graceful). Default = 0 (no limit)

Responses

200

application/json

idinteger · integerRead-onlyRequired

Task ID

namestringRead-onlyRequired

Task name

batchIdinteger · integerRead-onlyRequired

The ID of the batch the task belongs to

categoryIdinteger · integerRead-onlyRequired

The ID of the task category. Valid values are:

1: game server

entityIdinteger · integerRead-onlyRequired

The ID of the entity the task is being executed for. E.g. a game server ID (categoryId 1)

currentActionIdxinteger · integerRead-onlyRequired

Currently active action index - relates to the action index as found in the template.

executeAtinteger · integerRead-onlyRequired

Unix timestamp indicating the start of execution.

lastActivityAtinteger · integerRead-onlyRequired

Unix timestamp indicating lastest activity.

finishedAtinteger · integerRead-onlyRequired

Unix timestamp at which the task was finished.

resultCodeinteger · integerRead-onlyRequired

The result of the task. 0: pending, 1: in progress, 2: paused, 125: cancelled, 126: done with error, 127: done

resultTextstringRead-onlyRequired

The result of the task in message form.

204

No Content

403

Invalid credentials

404

Invalid deploymentProfileId

409

Unable to delete due to deployment profile being in-use

422

Invalid startTime and/or endTime

500

Internal Server Error

application/json

delete

/v3/deploymentProfile/{deploymentProfileId}

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

[
  {
    "id": 1,
    "name": "text",
    "batchId": 1,
    "categoryId": 1,
    "entityId": 1,
    "currentActionIdx": 1,
    "executeAt": 1,
    "lastActivityAt": 1,
    "finishedAt": 1,
    "resultCode": 1,
    "resultText": "text"
  }
]

Get the given deployment region

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

deploymentRegionIdstringRequired

The Id of the deployment region

Responses

200

application/json

idstringRead-onlyRequired

This deployment region's ID

namestringRequired

The name of the deployment region

i3dDcLocationIdsinteger · integer[]Required

All the i3D.net DC location IDs configured for this deployment region. You can get available IDs via GET /cloud/dcLocation

i3dDcLocationIdsToBeRemovedinteger · integer[]Optional

i3D.net data center location IDs scheduled for removal from this region

minimumCapacityinteger · integer · nullableOptional

The minimum amount of game instances that should always be deployed in this region. Null value means that the minimumCapacity provided in the deployment profile will persist

maximumCapacityinteger · integer · nullableOptional

The maximum amount of game instances that can be deployed in this region. Null value means that the maximumCapacity provided in the deployment profile will persist

bufferValueinteger · integer · nullableOptional

Override for DeploymentProfile.bufferValue, to be applied only to this deployment region. Null value means that the bufferValue provided in the deployment profile will persist

bufferValueTypeinteger · integer · nullableOptional

Override for DeploymentProfile.bufferValueType. Possible values:

0: Absolute value
1: Percentage value (must be accompanied by bufferValueMin and bufferValueMax) Null value means that the bufferValueType provided in the deployment profile will persist

bufferValueMininteger · integer · nullableOptional

Override for DeploymentProfile.bufferValueMin. The minimum absolute bufferValue when using a percentage, to prevent bufferValue from going too low. Null value means that the bufferValueMin provided in the deployment profile will persist. Note: if this value is supplied (not null) with your request, bufferValue and bufferValueType become required parameters. See POST /deploymentProfile/{deploymentProfileId} for more information

bufferValueMaxinteger · integer · nullableOptional

Override for DeploymentProfile.bufferValueMax. The maximum absolute bufferValue when using a percentage, to prevent bufferValue from going too high. Null value means that the bufferValueMax provided in the deployment profile will persist. Note: if this value is supplied (not null) with your request, bufferValue and bufferValueType become required parameters. See POST /deploymentProfile/{deploymentProfileId} for more information

strategyTypeinteger · integer · nullableOptional

Override value for DeploymentProfile.strategyType. Possible values:

0: Use default
1: Round robin
null: The strategyType provided in the deployment profile will persist

markedForDeletioninteger · integerRead-onlyRequired

If set to 1, all application instances will be gracefully removed inside the deployment region. Afterwards this deployment region will be set to inactive

inUseinteger · integerRead-onlyRequired

Possible values:

0: Deployment region has no active application instances
1: Deployment region has active application instance(s)

403

Invalid credentials

404

Invalid deploymentRegionId

500

Internal Server Error

application/json

get

/v3/deploymentRegion/{deploymentRegionId}

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

[
  {
    "id": "text",
    "name": "text",
    "i3dDcLocationIds": [
      1
    ],
    "i3dDcLocationIdsToBeRemoved": [
      1
    ],
    "minimumCapacity": 1,
    "maximumCapacity": 1,
    "bufferValue": 1,
    "bufferValueType": 1,
    "bufferValueMin": 1,
    "bufferValueMax": 1,
    "strategyType": 1,
    "markedForDeletion": 1,
    "containers": [
      {
        "id": "text",
        "markedForDeletion": 1,
        "containerLocations": [
          {
            "id": "text",
            "cloudProviderId": 1,
            "dcLocationId": 1,
            "primaryInstanceTypeName": "text",
            "primaryInstanceTypeStatus": 1,
            "secondaryInstanceTypeName": "text",
            "secondaryInstanceTypeStatus": 1,
            "markedForDeletion": 1
          }
        ]
      }
    ],
    "inUse": 1
  }
]

Update given deployment region

put

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

deploymentRegionIdstringRequired

Id of the deployment region to update

Body

idstringRead-onlyRequired

This deployment region's ID

namestringRequired

The name of the deployment region

i3dDcLocationIdsinteger · integer[]Required

All the i3D.net DC location IDs configured for this deployment region. You can get available IDs via GET /cloud/dcLocation

i3dDcLocationIdsToBeRemovedinteger · integer[]Optional

i3D.net data center location IDs scheduled for removal from this region

minimumCapacityinteger · integer · nullableOptional

The minimum amount of game instances that should always be deployed in this region. Null value means that the minimumCapacity provided in the deployment profile will persist

maximumCapacityinteger · integer · nullableOptional

The maximum amount of game instances that can be deployed in this region. Null value means that the maximumCapacity provided in the deployment profile will persist

bufferValueinteger · integer · nullableOptional

Override for DeploymentProfile.bufferValue, to be applied only to this deployment region. Null value means that the bufferValue provided in the deployment profile will persist

bufferValueTypeinteger · integer · nullableOptional

Override for DeploymentProfile.bufferValueType. Possible values:

0: Absolute value
1: Percentage value (must be accompanied by bufferValueMin and bufferValueMax) Null value means that the bufferValueType provided in the deployment profile will persist

bufferValueMininteger · integer · nullableOptional

bufferValueMaxinteger · integer · nullableOptional

strategyTypeinteger · integer · nullableOptional

Override value for DeploymentProfile.strategyType. Possible values:

0: Use default
1: Round robin
null: The strategyType provided in the deployment profile will persist

markedForDeletioninteger · integerRead-onlyRequired

If set to 1, all application instances will be gracefully removed inside the deployment region. Afterwards this deployment region will be set to inactive

inUseinteger · integerRead-onlyRequired

Possible values:

0: Deployment region has no active application instances
1: Deployment region has active application instance(s)

Responses

200

application/json

idstringRead-onlyRequired

This deployment region's ID

namestringRequired

The name of the deployment region

i3dDcLocationIdsinteger · integer[]Required

All the i3D.net DC location IDs configured for this deployment region. You can get available IDs via GET /cloud/dcLocation

i3dDcLocationIdsToBeRemovedinteger · integer[]Optional

i3D.net data center location IDs scheduled for removal from this region

minimumCapacityinteger · integer · nullableOptional

The minimum amount of game instances that should always be deployed in this region. Null value means that the minimumCapacity provided in the deployment profile will persist

maximumCapacityinteger · integer · nullableOptional

The maximum amount of game instances that can be deployed in this region. Null value means that the maximumCapacity provided in the deployment profile will persist

bufferValueinteger · integer · nullableOptional

Override for DeploymentProfile.bufferValue, to be applied only to this deployment region. Null value means that the bufferValue provided in the deployment profile will persist

bufferValueTypeinteger · integer · nullableOptional

Override for DeploymentProfile.bufferValueType. Possible values:

0: Absolute value
1: Percentage value (must be accompanied by bufferValueMin and bufferValueMax) Null value means that the bufferValueType provided in the deployment profile will persist

bufferValueMininteger · integer · nullableOptional

bufferValueMaxinteger · integer · nullableOptional

strategyTypeinteger · integer · nullableOptional

Override value for DeploymentProfile.strategyType. Possible values:

0: Use default
1: Round robin
null: The strategyType provided in the deployment profile will persist

markedForDeletioninteger · integerRead-onlyRequired

If set to 1, all application instances will be gracefully removed inside the deployment region. Afterwards this deployment region will be set to inactive

inUseinteger · integerRead-onlyRequired

Possible values:

0: Deployment region has no active application instances
1: Deployment region has active application instance(s)

403

Invalid credentials

404

Invalid deploymentRegionId

409

The deployment region can't be updated because it is marked for deletion

422

Unprocessable Entity

500

Internal Server Error

application/json

put

/v3/deploymentRegion/{deploymentRegionId}

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

{
  "name": "text",
  "i3dDcLocationIds": [
    1
  ],
  "i3dDcLocationIdsToBeRemoved": [
    1
  ],
  "minimumCapacity": 1,
  "maximumCapacity": 1,
  "bufferValue": 1,
  "bufferValueType": 1,
  "bufferValueMin": 1,
  "bufferValueMax": 1,
  "strategyType": 1,
  "containers": [
    {
      "containerLocations": [
        {
          "cloudProviderId": 1,
          "dcLocationId": 1,
          "primaryInstanceTypeName": "text",
          "secondaryInstanceTypeName": "text"
        }
      ]
    }
  ]
}

[
  {
    "id": "text",
    "name": "text",
    "i3dDcLocationIds": [
      1
    ],
    "i3dDcLocationIdsToBeRemoved": [
      1
    ],
    "minimumCapacity": 1,
    "maximumCapacity": 1,
    "bufferValue": 1,
    "bufferValueType": 1,
    "bufferValueMin": 1,
    "bufferValueMax": 1,
    "strategyType": 1,
    "markedForDeletion": 1,
    "containers": [
      {
        "id": "text",
        "markedForDeletion": 1,
        "containerLocations": [
          {
            "id": "text",
            "cloudProviderId": 1,
            "dcLocationId": 1,
            "primaryInstanceTypeName": "text",
            "primaryInstanceTypeStatus": 1,
            "secondaryInstanceTypeName": "text",
            "secondaryInstanceTypeStatus": 1,
            "markedForDeletion": 1
          }
        ]
      }
    ],
    "inUse": 1
  }
]

Delete given deployment profile region (it will delete all the application instances if there are any)

delete

A task will be created and returned (response 200) if the deployment region is in use, the deployment region will be mark for deletion and after all the application instances are deleted the deployment region will be deleted. If not in use, then the deployment region will be immediately deleted and no content will be returned (status 204)

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

deploymentRegionIdstringRequired

Id of the deployment profile region to delete

Query parameters

methodIdintegerOptional

Id for the method of deletion: hard-kill = 1, graceful=2

startTimeintegerOptional

Unix timestamp. When to start deleting the containerLocation and its contents. Default = now

endTimeintegerOptional

Unix timestamp. Time limit in which to delete all remaining game servers immediately (not graceful). Default = 0 (no limit)

Responses

200

application/json

idinteger · integerRead-onlyRequired

Task ID

namestringRead-onlyRequired

Task name

batchIdinteger · integerRead-onlyRequired

The ID of the batch the task belongs to

categoryIdinteger · integerRead-onlyRequired

The ID of the task category. Valid values are:

1: game server

entityIdinteger · integerRead-onlyRequired

The ID of the entity the task is being executed for. E.g. a game server ID (categoryId 1)

currentActionIdxinteger · integerRead-onlyRequired

Currently active action index - relates to the action index as found in the template.

executeAtinteger · integerRead-onlyRequired

Unix timestamp indicating the start of execution.

lastActivityAtinteger · integerRead-onlyRequired

Unix timestamp indicating lastest activity.

finishedAtinteger · integerRead-onlyRequired

Unix timestamp at which the task was finished.

resultCodeinteger · integerRead-onlyRequired

The result of the task. 0: pending, 1: in progress, 2: paused, 125: cancelled, 126: done with error, 127: done

resultTextstringRead-onlyRequired

The result of the task in message form.

204

No Content

403

Invalid credentials

404

Invalid deploymentRegionId

500

Internal Server Error

application/json

delete

/v3/deploymentRegion/{deploymentRegionId}

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

[
  {
    "id": 1,
    "name": "text",
    "batchId": 1,
    "categoryId": 1,
    "entityId": 1,
    "currentActionIdx": 1,
    "executeAt": 1,
    "lastActivityAt": 1,
    "finishedAt": 1,
    "resultCode": 1,
    "resultText": "text"
  }
]

Create a new deployment region for the given profile

post

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

deploymentProfileIdstringRequired

The Id of the deployment profile

Body

idstringRead-onlyRequired

This deployment region's ID

namestringRequired

The name of the deployment region

i3dDcLocationIdsinteger · integer[]Required

All the i3D.net DC location IDs configured for this deployment region. You can get available IDs via GET /cloud/dcLocation

i3dDcLocationIdsToBeRemovedinteger · integer[]Optional

i3D.net data center location IDs scheduled for removal from this region

minimumCapacityinteger · integer · nullableOptional

The minimum amount of game instances that should always be deployed in this region. Null value means that the minimumCapacity provided in the deployment profile will persist

maximumCapacityinteger · integer · nullableOptional

The maximum amount of game instances that can be deployed in this region. Null value means that the maximumCapacity provided in the deployment profile will persist

bufferValueinteger · integer · nullableOptional

Override for DeploymentProfile.bufferValue, to be applied only to this deployment region. Null value means that the bufferValue provided in the deployment profile will persist

bufferValueTypeinteger · integer · nullableOptional

Override for DeploymentProfile.bufferValueType. Possible values:

0: Absolute value
1: Percentage value (must be accompanied by bufferValueMin and bufferValueMax) Null value means that the bufferValueType provided in the deployment profile will persist

bufferValueMininteger · integer · nullableOptional

bufferValueMaxinteger · integer · nullableOptional

strategyTypeinteger · integer · nullableOptional

Override value for DeploymentProfile.strategyType. Possible values:

0: Use default
1: Round robin
null: The strategyType provided in the deployment profile will persist

markedForDeletioninteger · integerRead-onlyRequired

If set to 1, all application instances will be gracefully removed inside the deployment region. Afterwards this deployment region will be set to inactive

inUseinteger · integerRead-onlyRequired

Possible values:

0: Deployment region has no active application instances
1: Deployment region has active application instance(s)

Responses

200

application/json

idstringRead-onlyRequired

This deployment region's ID

namestringRequired

The name of the deployment region

i3dDcLocationIdsinteger · integer[]Required

All the i3D.net DC location IDs configured for this deployment region. You can get available IDs via GET /cloud/dcLocation

i3dDcLocationIdsToBeRemovedinteger · integer[]Optional

i3D.net data center location IDs scheduled for removal from this region

minimumCapacityinteger · integer · nullableOptional

The minimum amount of game instances that should always be deployed in this region. Null value means that the minimumCapacity provided in the deployment profile will persist

maximumCapacityinteger · integer · nullableOptional

The maximum amount of game instances that can be deployed in this region. Null value means that the maximumCapacity provided in the deployment profile will persist

bufferValueinteger · integer · nullableOptional

Override for DeploymentProfile.bufferValue, to be applied only to this deployment region. Null value means that the bufferValue provided in the deployment profile will persist

bufferValueTypeinteger · integer · nullableOptional

Override for DeploymentProfile.bufferValueType. Possible values:

0: Absolute value
1: Percentage value (must be accompanied by bufferValueMin and bufferValueMax) Null value means that the bufferValueType provided in the deployment profile will persist

bufferValueMininteger · integer · nullableOptional

bufferValueMaxinteger · integer · nullableOptional

strategyTypeinteger · integer · nullableOptional

Override value for DeploymentProfile.strategyType. Possible values:

0: Use default
1: Round robin
null: The strategyType provided in the deployment profile will persist

markedForDeletioninteger · integerRead-onlyRequired

If set to 1, all application instances will be gracefully removed inside the deployment region. Afterwards this deployment region will be set to inactive

inUseinteger · integerRead-onlyRequired

Possible values:

0: Deployment region has no active application instances
1: Deployment region has active application instance(s)

403

Invalid credentials

404

Invalid deploymentProfileId

409

No new deployment region can be created for given deployment profile because it is marked for deletion

422

Unprocessable Entity

500

Internal Server Error

application/json

post

/v3/deploymentProfile/{deploymentProfileId}/deploymentRegion

POST /v3/deploymentProfile/{deploymentProfileId}/deploymentRegion HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 350

{
  "name": "text",
  "i3dDcLocationIds": [
    1
  ],
  "i3dDcLocationIdsToBeRemoved": [
    1
  ],
  "minimumCapacity": 1,
  "maximumCapacity": 1,
  "bufferValue": 1,
  "bufferValueType": 1,
  "bufferValueMin": 1,
  "bufferValueMax": 1,
  "strategyType": 1,
  "containers": [
    {
      "containerLocations": [
        {
          "cloudProviderId": 1,
          "dcLocationId": 1,
          "primaryInstanceTypeName": "text",
          "secondaryInstanceTypeName": "text"
        }
      ]
    }
  ]
}

[
  {
    "id": "text",
    "name": "text",
    "i3dDcLocationIds": [
      1
    ],
    "i3dDcLocationIdsToBeRemoved": [
      1
    ],
    "minimumCapacity": 1,
    "maximumCapacity": 1,
    "bufferValue": 1,
    "bufferValueType": 1,
    "bufferValueMin": 1,
    "bufferValueMax": 1,
    "strategyType": 1,
    "markedForDeletion": 1,
    "containers": [
      {
        "id": "text",
        "markedForDeletion": 1,
        "containerLocations": [
          {
            "id": "text",
            "cloudProviderId": 1,
            "dcLocationId": 1,
            "primaryInstanceTypeName": "text",
            "primaryInstanceTypeStatus": 1,
            "secondaryInstanceTypeName": "text",
            "secondaryInstanceTypeStatus": 1,
            "markedForDeletion": 1
          }
        ]
      }
    ],
    "inUse": 1
  }
]

Delete given deployment profile container (it will delete all the application instances if there are any)

delete

A task will be created and returned (response 200) if the deployment container is in use, the deployment container will be mark for deletion and after all the application instances are deleted the deployment container will be deleted. If not in use, then the deployment container will be immediately deleted and no content will be returned (status 204)

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

deploymentContainerIdstringRequired

Id of the deployment profile container to delete

Query parameters

methodIdintegerOptional

Id for the method of deletion: hard-kill = 1, graceful=2

startTimeintegerOptional

Unix timestamp. When to start deleting the containerLocation and its contents. Default = now

endTimeintegerOptional

Unix timestamp. Time limit in which to delete all remaining game servers immediately (not graceful). Default = 0 (no limit)

Responses

200

application/json

idinteger · integerRead-onlyRequired

Task ID

namestringRead-onlyRequired

Task name

batchIdinteger · integerRead-onlyRequired

The ID of the batch the task belongs to

categoryIdinteger · integerRead-onlyRequired

The ID of the task category. Valid values are:

1: game server

entityIdinteger · integerRead-onlyRequired

The ID of the entity the task is being executed for. E.g. a game server ID (categoryId 1)

currentActionIdxinteger · integerRead-onlyRequired

Currently active action index - relates to the action index as found in the template.

executeAtinteger · integerRead-onlyRequired

Unix timestamp indicating the start of execution.

lastActivityAtinteger · integerRead-onlyRequired

Unix timestamp indicating lastest activity.

finishedAtinteger · integerRead-onlyRequired

Unix timestamp at which the task was finished.

resultCodeinteger · integerRead-onlyRequired

The result of the task. 0: pending, 1: in progress, 2: paused, 125: cancelled, 126: done with error, 127: done

resultTextstringRead-onlyRequired

The result of the task in message form.

204

No Content

403

Invalid credentials

404

Invalid deploymentContainerId

422

Unprocessable Entity

500

Internal Server Error

application/json

delete

/v3/deploymentContainer/{deploymentContainerId}

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

[
  {
    "id": 1,
    "name": "text",
    "batchId": 1,
    "categoryId": 1,
    "entityId": 1,
    "currentActionIdx": 1,
    "executeAt": 1,
    "lastActivityAt": 1,
    "finishedAt": 1,
    "resultCode": 1,
    "resultText": "text"
  }
]

Delete given deployment profile containerLocation (it will delete all the application instances if there are any)

delete

A task will be created and returned (response 200) if the deployment container location is in use, the deployment container location will be mark for deletion and after all the application instances are deleted the deployment container location will be deleted. If not in use, then the deployment container location will be immediately deleted and no content will be returned (status 204)

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

deploymentContainerLocationIdstringRequired

Id of the deployment profile containerLocation to delete

Query parameters

methodIdintegerOptional

Id for the method of deletion: hard-kill = 1, graceful=2

startTimeintegerOptional

Unix timestamp. When to start deleting the containerLocation and its contents. Default = now

endTimeintegerOptional

Unix timestamp. Time limit in which to delete all remaining game servers immediately (not graceful). Default = 0 (no limit)

Responses

200

application/json

idinteger · integerRead-onlyRequired

Task ID

namestringRead-onlyRequired

Task name

batchIdinteger · integerRead-onlyRequired

The ID of the batch the task belongs to

categoryIdinteger · integerRead-onlyRequired

The ID of the task category. Valid values are:

1: game server

entityIdinteger · integerRead-onlyRequired

The ID of the entity the task is being executed for. E.g. a game server ID (categoryId 1)

currentActionIdxinteger · integerRead-onlyRequired

Currently active action index - relates to the action index as found in the template.

executeAtinteger · integerRead-onlyRequired

Unix timestamp indicating the start of execution.

lastActivityAtinteger · integerRead-onlyRequired

Unix timestamp indicating lastest activity.

finishedAtinteger · integerRead-onlyRequired

Unix timestamp at which the task was finished.

resultCodeinteger · integerRead-onlyRequired

The result of the task. 0: pending, 1: in progress, 2: paused, 125: cancelled, 126: done with error, 127: done

resultTextstringRead-onlyRequired

The result of the task in message form.

204

No Content

403

Invalid credentials

404

Invalid deploymentContainerLocationId

500

Internal Server Error

application/json

delete

/v3/deploymentContainerLocation/{deploymentContainerLocationId}

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

[
  {
    "id": 1,
    "name": "text",
    "batchId": 1,
    "categoryId": 1,
    "entityId": 1,
    "currentActionIdx": 1,
    "executeAt": 1,
    "lastActivityAt": 1,
    "finishedAt": 1,
    "resultCode": 1,
    "resultText": "text"
  }
]

Cancel the deletion of given deployment profile (it will stop deletion but what has been deleted is lost already)

put

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

deploymentProfileIdstringRequired

Id of the deployment profile to stop deleting

Responses

204

No Content

403

Invalid credentials

404

Invalid deploymentProfileId

500

Internal Server Error

application/json

put

/v3/deploymentProfile/{deploymentProfileId}/canceldelete

PUT /v3/deploymentProfile/{deploymentProfileId}/canceldelete HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content

Cancel deletion of given deployment region (it will stop deletion but what has been deleted is lost already)

put

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

deploymentRegionIdintegerRequired

Id of the deployment region to stop deleting

Responses

204

No Content

403

Invalid credentials

404

Invalid deploymentRegionId

422

Unprocessable Entity

500

Internal Server Error

application/json

put

/v3/deploymentRegion/{deploymentRegionId}/canceldelete

PUT /v3/deploymentRegion/{deploymentRegionId}/canceldelete HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content

Cancel delete given cloud deployment container

put

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

deploymentContainerIdstringRequired

Id of the deployment container to stop deleting

Responses

200

application/json

idstringRead-onlyRequired

The deployment profile ID

fleetIdsstring[]Read-onlyRequired

IDs of the fleets in which this deployment profile is being used

namestringRequired

This deployment profile's name

descriptionstringOptional

This deployment profile's description

strategyTypeinteger · integerRequired

Possible values:

1: Round robin

minimumCapacityinteger · integerRequired

The minimum amount of game instances that should always be deployed for each deployment region in this deployment profile. Can be overridden per deployment region

maximumCapacityinteger · integer · nullableOptional

The maximum amount of game instances that can be deployed in each region. Can be overridden per region. Null value means that there is no maximumCapacity

bufferValueinteger · integerRequired

Global buffer value, to be applied to individual deployment regions. Can be overridden per region

bufferValueTypeinteger · integerRequired

Possible values:

0: Absolute value
1: Percentage value (must be accompanied by bufferValueMin and bufferValueMax)

bufferValueMininteger · integer · nullableOptional

The minimum absolute bufferValue when using a percentage, to prevent bufferValue from going too low

bufferValueMaxinteger · integer · nullableOptional

The maximum absolute bufferValue when using a percentage, to prevent bufferValue from going too high

markedForDeletioninteger · integerRead-onlyRequired

Example: 1

inUseinteger · integerRead-onlyRequired

Possible values:

0: Deployment profile has no active application instances
1: Deployment profile has active application instance(s)

createdAtinteger · integerRead-onlyRequired

Unix timestamp of creation time

403

Invalid credentials

404

Invalid deploymentRegionId

422

Unprocessable Entity

500

Internal Server Error

application/json

put

/v3/deploymentContainer/{deploymentContainerId}/canceldelete

PUT /v3/deploymentContainer/{deploymentContainerId}/canceldelete HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "fleetIds": [
      "text"
    ],
    "name": "text",
    "description": "text",
    "strategyType": 1,
    "minimumCapacity": 1,
    "maximumCapacity": 1,
    "bufferValue": 1,
    "bufferValueType": 1,
    "bufferValueMin": 1,
    "bufferValueMax": 1,
    "markedForDeletion": 1,
    "inUse": 1,
    "deploymentRegions": [
      {
        "id": "text",
        "name": "text",
        "i3dDcLocationIds": [
          1
        ],
        "i3dDcLocationIdsToBeRemoved": [
          1
        ],
        "minimumCapacity": 1,
        "maximumCapacity": 1,
        "bufferValue": 1,
        "bufferValueType": 1,
        "bufferValueMin": 1,
        "bufferValueMax": 1,
        "strategyType": 1,
        "markedForDeletion": 1,
        "containers": [
          {
            "id": "text",
            "markedForDeletion": 1,
            "containerLocations": [
              {
                "id": "text",
                "cloudProviderId": 1,
                "dcLocationId": 1,
                "primaryInstanceTypeName": "text",
                "primaryInstanceTypeStatus": 1,
                "secondaryInstanceTypeName": "text",
                "secondaryInstanceTypeStatus": 1,
                "markedForDeletion": 1
              }
            ]
          }
        ],
        "inUse": 1
      }
    ],
    "createdAt": 1
  }
]

Cancel deletion of given deployment profile containerLocation

put

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

deploymentContainerLocationIdstringRequired

Id of the deployment containerLocation to stop deleting

Responses

204

No Content

403

Invalid credentials

404

Invalid deploymentContainerLocationId

422

Unprocessable Entity

500

Internal Server Error

application/json

put

/v3/deploymentContainerLocation/{deploymentContainerLocationId}/canceldelete

PUT /v3/deploymentContainerLocation/{deploymentContainerLocationId}/canceldelete HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content

Get a list of deployment region properties

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

deploymentRegionIdstringRequired

The Id of the deployment region

Header parameters

RANGED-DATAstringOptional

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

Responses

200

application/json

idstringRead-onlyRequired

Deployment region property ID

applicationPropertyIdstringRequired

The application property ID that this regional property overrides

propertyValuestringRequired

The overridden value of the application property

403

Invalid credentials

404

Invalid deploymentRegionId

500

Internal Server Error

application/json

get

/v3/deploymentRegion/{deploymentRegionId}/property

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

[
  {
    "id": "text",
    "applicationPropertyId": "text",
    "propertyValue": "text"
  }
]

Create a new deployment region property

post

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

deploymentRegionIdstringRequired

The Id of the deployment region

Body

idstringRead-onlyRequired

Deployment region property ID

applicationPropertyIdstringRequired

The application property ID that this regional property overrides

propertyValuestringRequired

The overridden value of the application property

Responses

200

application/json

idstringRead-onlyRequired

Deployment region property ID

applicationPropertyIdstringRequired

The application property ID that this regional property overrides

propertyValuestringRequired

The overridden value of the application property

403

Invalid credentials

404

Invalid deploymentRegionId or applicationPropertyId

422

Unprocessable Entity

500

Internal Server Error

application/json

post

/v3/deploymentRegion/{deploymentRegionId}/property

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

{
  "applicationPropertyId": "text",
  "propertyValue": "text"
}

[
  {
    "id": "text",
    "applicationPropertyId": "text",
    "propertyValue": "text"
  }
]

Get a specific deployment region property

get

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

deploymentRegionIdstringRequired

The Id of the deployment region

propertyIdstringRequired

The Id of the deployment region property

Responses

200

application/json

idstringRead-onlyRequired

Deployment region property ID

applicationPropertyIdstringRequired

The application property ID that this regional property overrides

propertyValuestringRequired

The overridden value of the application property

403

Invalid credentials

404

Invalid deploymentRegionId or propertyId

500

Internal Server Error

application/json

get

/v3/deploymentRegion/{deploymentRegionId}/property/{propertyId}

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

[
  {
    "id": "text",
    "applicationPropertyId": "text",
    "propertyValue": "text"
  }
]

Update a deployment region property

put

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

deploymentRegionIdstringRequired

The Id of the deployment region

propertyIdstringRequired

The Id of the deployment region property

Body

idstringRead-onlyRequired

Deployment region property ID

applicationPropertyIdstringRequired

The application property ID that this regional property overrides

propertyValuestringRequired

The overridden value of the application property

Responses

200

application/json

idstringRead-onlyRequired

Deployment region property ID

applicationPropertyIdstringRequired

The application property ID that this regional property overrides

propertyValuestringRequired

The overridden value of the application property

403

Invalid credentials

404

Invalid deploymentRegionId or propertyId

422

Unprocessable Entity

500

Internal Server Error

application/json

put

/v3/deploymentRegion/{deploymentRegionId}/property/{propertyId}

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

{
  "applicationPropertyId": "text",
  "propertyValue": "text"
}

[
  {
    "id": "text",
    "applicationPropertyId": "text",
    "propertyValue": "text"
  }
]

Deletes a deployment region property (does not delete the application property)

delete

Authorizations

PRIVATE-TOKENstringRequired

Path parameters

deploymentRegionIdstringRequired

The Id of the deployment region

propertyIdstringRequired

The Id of the deployment region property

Responses

204

No Content

403

Invalid credentials

404

Invalid deploymentRegionId or propertyId

422

Unprocessable Entity

500

Internal Server Error

application/json

delete

/v3/deploymentRegion/{deploymentRegionId}/property/{propertyId}

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

No content

Last updated 11 months ago

Was this helpful?

hashtagGet all the deployment profiles you have created

hashtagCreate a new deployment profile

hashtagGet all the deployment profiles you have created

hashtagGet the given deployment profile

hashtagUpdate given deployment profile

hashtagDelete given deployment profile (it will delete all the application instances if there are any)

hashtagGet the given deployment region

hashtagUpdate given deployment region

hashtagDelete given deployment profile region (it will delete all the application instances if there are any)

hashtagCreate a new deployment region for the given profile

hashtagDelete given deployment profile container (it will delete all the application instances if there are any)

hashtagDelete given deployment profile containerLocation (it will delete all the application instances if there are any)

hashtagCancel the deletion of given deployment profile (it will stop deletion but what has been deleted is lost already)

hashtagCancel deletion of given deployment region (it will stop deletion but what has been deleted is lost already)

hashtagCancel delete given cloud deployment container

hashtagCancel deletion of given deployment profile containerLocation

hashtagGet a list of deployment region properties

hashtagCreate a new deployment region property

hashtagGet a specific deployment region property

hashtagUpdate a deployment region property

hashtagDeletes a deployment region property (does not delete the application property)

Get all the deployment profiles you have created

Create a new deployment profile

Get all the deployment profiles you have created

Get the given deployment profile

Update given deployment profile

Delete given deployment profile (it will delete all the application instances if there are any)

Get the given deployment region

Update given deployment region

Delete given deployment profile region (it will delete all the application instances if there are any)

Create a new deployment region for the given profile

Delete given deployment profile container (it will delete all the application instances if there are any)

Delete given deployment profile containerLocation (it will delete all the application instances if there are any)

Cancel the deletion of given deployment profile (it will stop deletion but what has been deleted is lost already)

Cancel deletion of given deployment region (it will stop deletion but what has been deleted is lost already)

Cancel delete given cloud deployment container

Cancel deletion of given deployment profile containerLocation

Get a list of deployment region properties

Create a new deployment region property

Get a specific deployment region property

Update a deployment region property

Deletes a deployment region property (does not delete the application property)