DeploymentProfile
Example header and default range: RANGED-DATA:start=0,results=25
OK
The deployment profile ID
IDs of the fleets in which this deployment profile is being used
This deployment profile's name
This deployment profile's description
Possible values:
- 1: Round robin
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
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
Global buffer value, to be applied to individual deployment regions. Can be overridden per region
Possible values:
- 0: Absolute value
- 1: Percentage value (must be accompanied by
bufferValueMinandbufferValueMax)
The minimum absolute bufferValue when using a percentage, to prevent bufferValue from going too low
The maximum absolute bufferValue when using a percentage, to prevent bufferValue from going too high
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
1Possible values:
- 0: Deployment profile has no active application instances
- 1: Deployment profile has active application instance(s)
Unix timestamp of creation time
Invalid credentials
Internal Server Error
The deployment profile ID
IDs of the fleets in which this deployment profile is being used
This deployment profile's name
This deployment profile's description
Possible values:
- 1: Round robin
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
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
Global buffer value, to be applied to individual deployment regions. Can be overridden per region
Possible values:
- 0: Absolute value
- 1: Percentage value (must be accompanied by
bufferValueMinandbufferValueMax)
The minimum absolute bufferValue when using a percentage, to prevent bufferValue from going too low
The maximum absolute bufferValue when using a percentage, to prevent bufferValue from going too high
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
1Possible values:
- 0: Deployment profile has no active application instances
- 1: Deployment profile has active application instance(s)
Unix timestamp of creation time
OK
The deployment profile ID
IDs of the fleets in which this deployment profile is being used
This deployment profile's name
This deployment profile's description
Possible values:
- 1: Round robin
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
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
Global buffer value, to be applied to individual deployment regions. Can be overridden per region
Possible values:
- 0: Absolute value
- 1: Percentage value (must be accompanied by
bufferValueMinandbufferValueMax)
The minimum absolute bufferValue when using a percentage, to prevent bufferValue from going too low
The maximum absolute bufferValue when using a percentage, to prevent bufferValue from going too high
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
1Possible values:
- 0: Deployment profile has no active application instances
- 1: Deployment profile has active application instance(s)
Unix timestamp of creation time
Invalid credentials
Unprocessable Entity
Internal Server Error
Example header and default range: RANGED-DATA:start=0,results=25
OK
The deployment profile ID
IDs of the fleets in which this deployment profile is being used
This deployment profile's name
This deployment profile's description
Possible values:
- 1: Round robin
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
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
Global buffer value, to be applied to individual deployment regions. Can be overridden per region
Possible values:
- 0: Absolute value
- 1: Percentage value (must be accompanied by
bufferValueMinandbufferValueMax)
The minimum absolute bufferValue when using a percentage, to prevent bufferValue from going too low
The maximum absolute bufferValue when using a percentage, to prevent bufferValue from going too high
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
1Possible values:
- 0: Deployment profile has no active application instances
- 1: Deployment profile has active application instance(s)
Unix timestamp of creation time
Invalid credentials
Internal Server Error
The Id of the deployment profile
OK
The deployment profile ID
IDs of the fleets in which this deployment profile is being used
This deployment profile's name
This deployment profile's description
Possible values:
- 1: Round robin
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
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
Global buffer value, to be applied to individual deployment regions. Can be overridden per region
Possible values:
- 0: Absolute value
- 1: Percentage value (must be accompanied by
bufferValueMinandbufferValueMax)
The minimum absolute bufferValue when using a percentage, to prevent bufferValue from going too low
The maximum absolute bufferValue when using a percentage, to prevent bufferValue from going too high
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
1Possible values:
- 0: Deployment profile has no active application instances
- 1: Deployment profile has active application instance(s)
Unix timestamp of creation time
Invalid credentials
Invalid deploymentProfileId
Internal Server Error
The Id of the deployment profile
The deployment profile ID
IDs of the fleets in which this deployment profile is being used
This deployment profile's name
This deployment profile's description
Possible values:
- 1: Round robin
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
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
Global buffer value, to be applied to individual deployment regions. Can be overridden per region
Possible values:
- 0: Absolute value
- 1: Percentage value (must be accompanied by
bufferValueMinandbufferValueMax)
The minimum absolute bufferValue when using a percentage, to prevent bufferValue from going too low
The maximum absolute bufferValue when using a percentage, to prevent bufferValue from going too high
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
1Possible values:
- 0: Deployment profile has no active application instances
- 1: Deployment profile has active application instance(s)
Unix timestamp of creation time
OK
The deployment profile ID
IDs of the fleets in which this deployment profile is being used
This deployment profile's name
This deployment profile's description
Possible values:
- 1: Round robin
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
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
Global buffer value, to be applied to individual deployment regions. Can be overridden per region
Possible values:
- 0: Absolute value
- 1: Percentage value (must be accompanied by
bufferValueMinandbufferValueMax)
The minimum absolute bufferValue when using a percentage, to prevent bufferValue from going too low
The maximum absolute bufferValue when using a percentage, to prevent bufferValue from going too high
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
1Possible values:
- 0: Deployment profile has no active application instances
- 1: Deployment profile has active application instance(s)
Unix timestamp of creation time
Invalid credentials
Invalid deploymentProfileId
The deployment profile can't be updated because it is marked for deletion
Unprocessable Entity
Internal Server Error
Delete given deployment profile (it will delete all the application instances if there are any)
Id of the deployment profile to delete
Id for the method of deletion: hard-kill = 1, graceful=2
Unix timestamp. When to start deleting the containerLocation and its contents. Default = now
Unix timestamp. Time limit in which to delete all remaining game servers immediately (not graceful). Default = 0 (no limit)
OK
Task ID
Task name
The ID of the batch the task belongs to
The ID of the task category. Valid values are:
- 1: game server
The ID of the entity the task is being executed for. E.g. a game server ID (categoryId 1)
Currently active action index - relates to the action index as found in the template.
Unix timestamp indicating the start of execution.
Unix timestamp indicating lastest activity.
Unix timestamp at which the task was finished.
The result of the task. 0: pending, 1: in progress, 2: paused, 125: cancelled, 126: done with error, 127: done
The result of the task in message form.
No Content
Invalid credentials
Invalid deploymentProfileId
Unable to delete due to deployment profile being in-use
Invalid startTime and/or endTime
Internal Server Error
The Id of the deployment region
OK
This deployment region's ID
The name of the deployment region
All the i3D.net DC location IDs configured for this deployment region. You can get available IDs via GET /cloud/dcLocation
i3D.net data center location IDs scheduled for removal from this region
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
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
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
Override for DeploymentProfile.bufferValueType. Possible values:
- 0: Absolute value
- 1: Percentage value (must be accompanied by
bufferValueMinandbufferValueMax)Nullvalue means that thebufferValueTypeprovided in the deployment profile will persist
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
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
Override value for DeploymentProfile.strategyType. Possible values:
0: Use default1: Round robinnull: ThestrategyTypeprovided in the deployment profile will persist
If set to 1, all application instances will be gracefully removed inside the deployment region. Afterwards this deployment region will be set to inactive
Possible values:
- 0: Deployment region has no active application instances
- 1: Deployment region has active application instance(s)
Invalid credentials
Invalid deploymentRegionId
Internal Server Error
Id of the deployment region to update
This deployment region's ID
The name of the deployment region
All the i3D.net DC location IDs configured for this deployment region. You can get available IDs via GET /cloud/dcLocation
i3D.net data center location IDs scheduled for removal from this region
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
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
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
Override for DeploymentProfile.bufferValueType. Possible values:
- 0: Absolute value
- 1: Percentage value (must be accompanied by
bufferValueMinandbufferValueMax)Nullvalue means that thebufferValueTypeprovided in the deployment profile will persist
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
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
Override value for DeploymentProfile.strategyType. Possible values:
0: Use default1: Round robinnull: ThestrategyTypeprovided in the deployment profile will persist
If set to 1, all application instances will be gracefully removed inside the deployment region. Afterwards this deployment region will be set to inactive
Possible values:
- 0: Deployment region has no active application instances
- 1: Deployment region has active application instance(s)
OK
This deployment region's ID
The name of the deployment region
All the i3D.net DC location IDs configured for this deployment region. You can get available IDs via GET /cloud/dcLocation
i3D.net data center location IDs scheduled for removal from this region
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
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
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
Override for DeploymentProfile.bufferValueType. Possible values:
- 0: Absolute value
- 1: Percentage value (must be accompanied by
bufferValueMinandbufferValueMax)Nullvalue means that thebufferValueTypeprovided in the deployment profile will persist
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
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
Override value for DeploymentProfile.strategyType. Possible values:
0: Use default1: Round robinnull: ThestrategyTypeprovided in the deployment profile will persist
If set to 1, all application instances will be gracefully removed inside the deployment region. Afterwards this deployment region will be set to inactive
Possible values:
- 0: Deployment region has no active application instances
- 1: Deployment region has active application instance(s)
Invalid credentials
Invalid deploymentRegionId
The deployment region can't be updated because it is marked for deletion
Unprocessable Entity
Internal Server Error
Delete given deployment profile region (it will delete all the application instances if there are any)
Id of the deployment profile region to delete
Id for the method of deletion: hard-kill = 1, graceful=2
Unix timestamp. When to start deleting the containerLocation and its contents. Default = now
Unix timestamp. Time limit in which to delete all remaining game servers immediately (not graceful). Default = 0 (no limit)
OK
Task ID
Task name
The ID of the batch the task belongs to
The ID of the task category. Valid values are:
- 1: game server
The ID of the entity the task is being executed for. E.g. a game server ID (categoryId 1)
Currently active action index - relates to the action index as found in the template.
Unix timestamp indicating the start of execution.
Unix timestamp indicating lastest activity.
Unix timestamp at which the task was finished.
The result of the task. 0: pending, 1: in progress, 2: paused, 125: cancelled, 126: done with error, 127: done
The result of the task in message form.
No Content
Invalid credentials
Invalid deploymentRegionId
Internal Server Error
The Id of the deployment profile
This deployment region's ID
The name of the deployment region
All the i3D.net DC location IDs configured for this deployment region. You can get available IDs via GET /cloud/dcLocation
i3D.net data center location IDs scheduled for removal from this region
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
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
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
Override for DeploymentProfile.bufferValueType. Possible values:
- 0: Absolute value
- 1: Percentage value (must be accompanied by
bufferValueMinandbufferValueMax)Nullvalue means that thebufferValueTypeprovided in the deployment profile will persist
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
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
Override value for DeploymentProfile.strategyType. Possible values:
0: Use default1: Round robinnull: ThestrategyTypeprovided in the deployment profile will persist
If set to 1, all application instances will be gracefully removed inside the deployment region. Afterwards this deployment region will be set to inactive
Possible values:
- 0: Deployment region has no active application instances
- 1: Deployment region has active application instance(s)
OK
This deployment region's ID
The name of the deployment region
All the i3D.net DC location IDs configured for this deployment region. You can get available IDs via GET /cloud/dcLocation
i3D.net data center location IDs scheduled for removal from this region
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
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
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
Override for DeploymentProfile.bufferValueType. Possible values:
- 0: Absolute value
- 1: Percentage value (must be accompanied by
bufferValueMinandbufferValueMax)Nullvalue means that thebufferValueTypeprovided in the deployment profile will persist
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
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
Override value for DeploymentProfile.strategyType. Possible values:
0: Use default1: Round robinnull: ThestrategyTypeprovided in the deployment profile will persist
If set to 1, all application instances will be gracefully removed inside the deployment region. Afterwards this deployment region will be set to inactive
Possible values:
- 0: Deployment region has no active application instances
- 1: Deployment region has active application instance(s)
Invalid credentials
Invalid deploymentProfileId
No new deployment region can be created for given deployment profile because it is marked for deletion
Unprocessable Entity
Internal Server Error
Delete given deployment profile container (it will delete all the application instances if there are any)
Id of the deployment profile container to delete
Id for the method of deletion: hard-kill = 1, graceful=2
Unix timestamp. When to start deleting the containerLocation and its contents. Default = now
Unix timestamp. Time limit in which to delete all remaining game servers immediately (not graceful). Default = 0 (no limit)
OK
Task ID
Task name
The ID of the batch the task belongs to
The ID of the task category. Valid values are:
- 1: game server
The ID of the entity the task is being executed for. E.g. a game server ID (categoryId 1)
Currently active action index - relates to the action index as found in the template.
Unix timestamp indicating the start of execution.
Unix timestamp indicating lastest activity.
Unix timestamp at which the task was finished.
The result of the task. 0: pending, 1: in progress, 2: paused, 125: cancelled, 126: done with error, 127: done
The result of the task in message form.
No Content
Invalid credentials
Invalid deploymentContainerId
Unprocessable Entity
Internal Server Error
Delete given deployment profile containerLocation (it will delete all the application instances if there are any)
Id of the deployment profile containerLocation to delete
Id for the method of deletion: hard-kill = 1, graceful=2
Unix timestamp. When to start deleting the containerLocation and its contents. Default = now
Unix timestamp. Time limit in which to delete all remaining game servers immediately (not graceful). Default = 0 (no limit)
OK
Task ID
Task name
The ID of the batch the task belongs to
The ID of the task category. Valid values are:
- 1: game server
The ID of the entity the task is being executed for. E.g. a game server ID (categoryId 1)
Currently active action index - relates to the action index as found in the template.
Unix timestamp indicating the start of execution.
Unix timestamp indicating lastest activity.
Unix timestamp at which the task was finished.
The result of the task. 0: pending, 1: in progress, 2: paused, 125: cancelled, 126: done with error, 127: done
The result of the task in message form.
No Content
Invalid credentials
Invalid deploymentContainerLocationId
Internal Server Error
Cancel the deletion of given deployment profile (it will stop deletion but what has been deleted is lost already)
Id of the deployment profile to stop deleting
No Content
Invalid credentials
Invalid deploymentProfileId
Internal Server Error
No content
Cancel deletion of given deployment region (it will stop deletion but what has been deleted is lost already)
Id of the deployment region to stop deleting
No Content
Invalid credentials
Invalid deploymentRegionId
Unprocessable Entity
Internal Server Error
No content
Id of the deployment container to stop deleting
OK
The deployment profile ID
IDs of the fleets in which this deployment profile is being used
This deployment profile's name
This deployment profile's description
Possible values:
- 1: Round robin
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
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
Global buffer value, to be applied to individual deployment regions. Can be overridden per region
Possible values:
- 0: Absolute value
- 1: Percentage value (must be accompanied by
bufferValueMinandbufferValueMax)
The minimum absolute bufferValue when using a percentage, to prevent bufferValue from going too low
The maximum absolute bufferValue when using a percentage, to prevent bufferValue from going too high
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
1Possible values:
- 0: Deployment profile has no active application instances
- 1: Deployment profile has active application instance(s)
Unix timestamp of creation time
Invalid credentials
Invalid deploymentRegionId
Unprocessable Entity
Internal Server Error
Id of the deployment containerLocation to stop deleting
No Content
Invalid credentials
Invalid deploymentContainerLocationId
Unprocessable Entity
Internal Server Error
No content
The Id of the deployment region
Example header and default range: RANGED-DATA:start=0,results=25
OK
Deployment region property ID
The application property ID that this regional property overrides
The overridden value of the application property
Invalid credentials
Invalid deploymentRegionId
Internal Server Error
The Id of the deployment region
Deployment region property ID
The application property ID that this regional property overrides
The overridden value of the application property
OK
Deployment region property ID
The application property ID that this regional property overrides
The overridden value of the application property
Invalid credentials
Invalid deploymentRegionId or applicationPropertyId
Unprocessable Entity
Internal Server Error
The Id of the deployment region
The Id of the deployment region property
OK
Deployment region property ID
The application property ID that this regional property overrides
The overridden value of the application property
Invalid credentials
Invalid deploymentRegionId or propertyId
Internal Server Error
The Id of the deployment region
The Id of the deployment region property
Deployment region property ID
The application property ID that this regional property overrides
The overridden value of the application property
OK
Deployment region property ID
The application property ID that this regional property overrides
The overridden value of the application property
Invalid credentials
Invalid deploymentRegionId or propertyId
Unprocessable Entity
Internal Server Error
The Id of the deployment region
The Id of the deployment region property
No Content
Invalid credentials
Invalid deploymentRegionId or propertyId
Unprocessable Entity
Internal Server Error
No content
Last updated
Was this helpful?