Game
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Internal Server Error
Deployment environment ID
The public name of your deployment environment
UnixTimestamp
OK
Invalid credentials
Unprocessable Entity
Internal Server Error
The Id of the deployment environment
OK
Invalid credentials
Invalid deploymentEnvironmentId
Internal Server Error
The Id of the deployment environment
Deployment environment ID
The public name of your deployment environment
UnixTimestamp
OK
Invalid credentials
Invalid deploymentEnvironmentId
Unprocessable Entity
Internal Server Error
The Id of the deployment environment
No Content
Invalid credentials
Invalid deploymentEnvironmentId
Cannot delete
Internal Server Error
No content
The Id of the deployment environment
OK
Invalid credentials
Invalid deploymentEnvironmentId
Internal Server Error
The Id of the deployment environment
OK
Invalid credentials
Invalid deploymentEnvironmentId
Internal Server Error
The Id of the deployment environment
OK
Invalid credentials
Invalid deploymentEnvironmentId
Internal Server Error
The Id of the deployment environment
The Id of the application
OK
Invalid credentials
Invalid deploymentEnvironmentId or applicationId
Internal Server Error
The Id of the deployment environment
OK
Invalid credentials
Invalid deploymentEnvironmentId
Internal Server Error
The Id of the deployment environment
OK
Invalid credentials
Invalid deploymentEnvironmentId
Internal Server Error
Note: bare metal servers and VMs are exposed in the same manner, as "dedicated servers". hostId can be found in the /host endpoint.
The Id of the deployment environment
Label expressions can be used to apply more specific search parameters and can be written in standard SQL query language.
E.g. region_id=123 or multiple filters: region_id=123 and fleet_id=456 or host_id=46256 The provided filter query needs to be url encoded. E.g.
region_id%3D123 or multiple filters: region_id%3D123%20and%20fleet_id%3D456%20or%20host_id%3D46256 The total would look like:
/deploymentEnvironment/{deploymentEnvironmentId}/applicationInstance?labels=region_id%3D123%20and%20fleet_id%3D456%20or%20host_id%3D46256
If you want to filter on a non-numeric label such as region_name, you have to wrap the value in double quotes: region_name="Rotterdam"
Warning: the labels query parameter is ignored when passing a PAGE-TOKEN and the original labels string will be used for that request instead.
More information on the use of labels can be found here.
Filter expression can be used to apply more specific search on most parameters in the application instance, it is written like
this E.G. regionId=123 or multiple filters: regionId=123 and fleetId=456, only the AND statement is supported at this time. You can also
search inside nested objects like metaData.key="testing" and metaData.value="test" You can only search on exact matches.
Warning: the filters query parameter is ignored when passing a PAGE-TOKEN and the original filters string will be used for that request
instead.
Warning: filtering on the following parameters is currently not supported and will give an error:
autoRestart, liveGameVersion, liveHostName, liveMap, liveRules, manuallyDeployed, markedForDeletion, numPlayers, numPlayersMax,
pid, pidChangedAt, startedAt, status, stoppedAt, updatedAt
Sort expression to sort your results in the order that you like E.G. "sort=fleetId=ASC and applicationId DESC" Be aware that all filters
and sorting should be url encoded.
Warning: the sort query parameter is ignored when passing a PAGE-TOKEN and the original sort string will be used for that request instead
Warning: sorting on the following parameters is currently not supported and will give an error:
autoRestart, liveGameVersion, liveHostName, liveMap, liveRules, manuallyDeployed, markedForDeletion, numPlayers, numPlayersMax,
pid, pidChangedAt, startedAt, status, stoppedAt, updatedAt
Example header and default range: RANGED-DATA: start=0,results=25
Warning: the start variable of the RANGED-DATA object has been deprecated for this endpoint. It is not possible to supply a start, see
PAGE-TOKEN header for a replacement
This token will be provided by this endpoint to allow for pagination functionality. By performing a request to this endpoint
without the PAGE-TOKEN you will retrieve the first page of search results. If a PAGE-TOKEN is returned, a next page may be requested by
supplying that token in the next request using the same PAGE-TOKEN key and value in the request header. If no PAGE-TOKEN is returned, the last
page has been reached and no further data can be requested. A returned PAGE-TOKEN is valid until the date specified in the Expires response
header. Example: PAGE-TOKEN: eyJjb25kaXRpb25zIjp7InVzZXJJZCI6NjY2ODI1fSwibGFiZWxz(...) (truncated for readability)
Expires header example: Expires: Fri, 08 Jan 2021 09:10:29 GMT
OK
PAGE-TOKEN did not have an expected structure and is invalid. Please try again by sending a request without a PAGE-TOKEN and restarting
Invalid credentials
Invalid deploymentEnvironmentId
PAGE-TOKEN is expired. Acquire a new PAGE-TOKEN by sending a request without a PAGE-TOKEN and try again
Internal Server Error
Fleet ID
The name of the fleet
Deployment environment ID to which the fleet is assigned
The DeploymentProfileTemplate's ID, used for scaling, that is attached to this Fleet
The GameDeploymentTemplate's ID that is attached to this Fleet
The UtilityDeploymentTemplate's ID that is attached to this Fleet
The DependencyDeploymentTemplate's ID that is attached to this Fleet
The HostCapacityTemplate's ID that is attached to this Fleet
0: Manual, 1: Automatic deployment enabled, 2: Automatic scaling enabled (implies automatic deployment)
When it is active it cannot be disabled anymore
OK
Invalid credentials
Unprocessable Entity
Internal Server Error
The Id of the fleet
Fleet ID
The name of the fleet
Deployment environment ID to which the fleet is assigned
The DeploymentProfileTemplate's ID, used for scaling, that is attached to this Fleet
The GameDeploymentTemplate's ID that is attached to this Fleet
The UtilityDeploymentTemplate's ID that is attached to this Fleet
The DependencyDeploymentTemplate's ID that is attached to this Fleet
The HostCapacityTemplate's ID that is attached to this Fleet
0: Manual, 1: Automatic deployment enabled, 2: Automatic scaling enabled (implies automatic deployment)
When it is active it cannot be disabled anymore
OK
Invalid credentials
Invalid fleetId
Unprocessable Entity
Internal Server Error
The ID of the fleet
No Content
Invalid credentials
Invalid fleetId
Fleet in use, cannot delete
Internal Server Error
No content
The Id of the fleet
The operational status for the fleet
OK
Invalid credentials
Invalid fleetId
Unprocessable Entity
Internal Server Error
The Id of the fleet
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Invalid fleetId
Internal Server Error
Reserve a list of hosts for a specific new fleet. The existing application instances on these servers will be automatically scaled down.
Response header which you can use to fetch the status of the bulk reservation of hosts by using endpoint
GET /v3/fleet/host/bulkReserve/{traceId}/status
Fleet ID
List of host ID's
Stop method type, list of types can be found in: GET /v3/application/stopMethod
Stop method timeout in seconds, default value is 1800 seconds
No Content
Invalid credentials
Unprocessable Entity
Internal Server Error
No content
Progress for the bulk reserve you have done, base on the trace id you received in the header when you have created the bulk reserve
OK
Invalid credentials
Not Found
Internal Server Error
The Id of the fleet
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Invalid fleetId
Internal Server Error
The Id of the fleet
The Id of the host
No Content
Invalid credentials
Invalid fleetId
Host is already reserved
Internal Server Error
No content
Remove a fleet reservation from the given host. Sets `fleetId` to `0` only if no application instances are deployed on it.
There are three situations you need to be aware of when un-reserving a fleet:
- You have application instances on the host and auto-scaling is enabled: Eventually the host is scaled down and its
fleetIdwill be set to0, at which point it may be re-purposed for another fleet - You have application instances on the host and auto-scaling is not enabled: The host is not automatically scaled down and you will need to manually scale down the application instances on this host for it to be available for another fleet
- You have no application instances: The host is unreserved and its
fleetIdis immediately set to0, allowing the host to be re-purposed for another fleet
The ID of the fleet
The ID of the host
No Content
Invalid credentials
Invalid fleetId or hostId
Host cannot be unreserved
Internal Server Error
No content
The Id of the fleet
OK
Invalid credentials
Invalid fleetId
Internal Server Error
The Id of the fleet
OK
Bad request
Invalid credentials
Internal Server Error
The Id of the fleet
of game lift environment variable
of game lift environment variable:
- awsgl_endpoint
- awsgl_region
- awsgl_token
- awsgl_hostname
- awsgl_fleetid
- raw_value
of game lift environment variable, e.g. "AWS_TOKEN_ID"
OK
Bad request
Invalid credentials
Internal Server Error
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Internal Server Error
Game deployment template ID
IDs of the fleets that use this template
The public name of your game deployment template
Indicates whether this game deployment template is used by one or more fleets. A template cannot be deleted as long as this value is 1.
UnixTimestamp
OK
Invalid credentials
Unprocessable Entity
Internal Server Error
The Id of the deployment template
OK
Invalid credentials
Invalid deploymentTemplateId
Internal Server Error
The Id of the deployment template
Game deployment template ID
IDs of the fleets that use this template
The public name of your game deployment template
Indicates whether this game deployment template is used by one or more fleets. A template cannot be deleted as long as this value is 1.
UnixTimestamp
OK
Invalid credentials
Invalid deploymentTemplateId
Unprocessable Entity
Internal Server Error
The Id of the deployment template
No Content
Invalid credentials
Invalid deploymentTemplateId
If the template is in use, it cannot be deleted
Internal Server Error
No content
The Id of the deployment template
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Invalid deploymentTemplateId
Internal Server Error
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Internal Server Error
Utility deployment template ID
IDs of the fleets that use this template
The name of your utility deployment template
Indicates whether this utility deployment template is used by one or more fleets. A template cannot be deleted as long as this value is 1.
UnixTimestamp
OK
Invalid credentials
Invalid deploymentTemplateId
Unprocessable Entity
Internal Server Error
The Id of the deployment template
OK
Invalid credentials
Invalid deploymentTemplateId
Internal Server Error
The Id of the deployment template
Utility deployment template ID
IDs of the fleets that use this template
The name of your utility deployment template
Indicates whether this utility deployment template is used by one or more fleets. A template cannot be deleted as long as this value is 1.
UnixTimestamp
OK
Invalid credentials
Invalid deploymentTemplateId
Unprocessable Entity
Internal Server Error
The Id of the deployment template
No Content
Invalid credentials
Invalid deploymentTemplateId
If the template is in use, it cannot be deleted
Internal Server Error
No content
The Id of the deployment template
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Invalid deploymentTemplateId
Internal Server Error
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Internal Server Error
dependency Deployment template ID
Name of the dependency deployment template
Dependency installer build ID
Dependency uninstaller build ID
IDs of the fleets that use this template
Indicates whether this dependency deployment template is used by one or more fleets. A template cannot be deleted as long as this value is 1.
UnixTimestamp
OK
Invalid credentials
Unprocessable Entity
Internal Server Error
The Id of the dependency deployment template
OK
Invalid credentials
Invalid deploymentTemplateId
Internal Server Error
The Id of the dependency deployment template
dependency Deployment template ID
Name of the dependency deployment template
Dependency installer build ID
Dependency uninstaller build ID
IDs of the fleets that use this template
Indicates whether this dependency deployment template is used by one or more fleets. A template cannot be deleted as long as this value is 1.
UnixTimestamp
OK
Invalid credentials
Invalid deploymentTemplateId
Unprocessable Entity
Internal Server Error
The Id of the dependency deployment template
No Content
Invalid credentials
Invalid deploymentTemplateId
If the template is in use, it cannot be deleted
Internal Server Error
No content
The Id of the dependency deployment template
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Invalid deploymentTemplateId
Internal Server Error
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Internal Server Error
The ID of the Host Capacity Template
IDs of the Fleets that use this Host Capacity Template
IDs of the Application Builds that use this Host Capacity Template
The public name of your Host Capacity Template
1 if the Host Capacity Template is in use by a Fleet or Application Build, 0 if it is not.
The Unix timestamp at which this element is created
OK
Invalid credentials
Unprocessable Entity
Internal Server Error
The Id of the host capacity template
OK
Invalid credentials
Invalid hostCapacityTemplateId
Internal Server Error
The Id of the host capacity template
The ID of the Host Capacity Template
IDs of the Fleets that use this Host Capacity Template
IDs of the Application Builds that use this Host Capacity Template
The public name of your Host Capacity Template
1 if the Host Capacity Template is in use by a Fleet or Application Build, 0 if it is not.
The Unix timestamp at which this element is created
OK
Invalid credentials
Invalid hostCapacityTemplateId
Unprocessable Entity
Internal Server Error
The Id of the host capacity template
No Content
Invalid credentials
Invalid hostCapacityTemplateId
Cannot delete
Internal Server Error
No content
The Id of the host capacity template
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Invalid hostCapacityTemplateId
Internal Server Error
The Id of the host capacity template
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Invalid hostCapacityTemplateId
Internal Server Error
The ID of the hostCapacityTemplate
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Internal Server Error
The ID of the hostCapacityTemplate
The ID of the Instance Type Capacity
The ID of the Host Capacity Template to which this element is linked
Cloud provider ID. For a list of cloud providers see GET /v3/cloud/provider
The instance type to which the capacity applies. This is the name of instance types found at various cloud providers.
See GET /cloud/instanceType (for virtual servers) and GET /host/instanceType (for bare metal servers)
1 if the instance type is a virtual server, 0 if it is a bare metal server
The capacity of the instance type
The Unix timestamp at which this element is created
OK
Invalid credentials
Unprocessable Entity
Internal Server Error
The Id of the instance type capacity
OK
Invalid credentials
Invalid instanceTypeCapacityId
Internal Server Error
The Id of the host capacity template
The ID of the Instance Type Capacity
The ID of the Host Capacity Template to which this element is linked
Cloud provider ID. For a list of cloud providers see GET /v3/cloud/provider
The instance type to which the capacity applies. This is the name of instance types found at various cloud providers.
See GET /cloud/instanceType (for virtual servers) and GET /host/instanceType (for bare metal servers)
1 if the instance type is a virtual server, 0 if it is a bare metal server
The capacity of the instance type
The Unix timestamp at which this element is created
OK
Invalid credentials
Invalid instanceTypeCapacityId
Unprocessable Entity
Internal Server Error
The Id of the host capacity template
No Content
Invalid credentials
Invalid instanceTypeCapacityId
Cannot delete
Internal Server Error
No content
Label expressions can be used to apply more specific search parameters and can be written in standard SQL query language.
E.g. region_id=123 or multiple filters: region_id=123 and fleet_id=456 or host_id=46256 The provided filter query needs to be url encoded. E.g.
region_id%3D123 or multiple filters: region_id%3D123%20and%20fleet_id%3D456%20or%20host_id%3D46256 The total would look like:
/host?labels=region_id%3D123%20and%20fleet_id%3D456%20or%20host_id%3D46256
If you want to filter on a non-numeric label such as region_name, you have to wrap the value in double quotes: region_name="Rotterdam"
Warning: the labels query parameter is ignored when passing a PAGE-TOKEN and the original labels string will be used for that request instead.
For more information about labels check details
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Internal Server Error
Fields return in response, only fields available in model can be filter out
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Internal Server Error
The ID of this host
The ID of the user who owns this server
The ID of the physical machine
The name of the physical machine
The type of the server:
- 1: Bare metal server
- 2: Flex metal server
- 3: Virtual machine
The name of the project for the host
The name of the server defined by client
Client statement for the host
The host name
0 if this is a bare metal server, 1 if it's a VM. Use serverType instead
Host category. Normally "Dedicated Game Servers" or "Dedicated Servers", but can be "Broken" if the server is in a degraded state
Operating system ID, must be one of GET /v3/operatingsystem
Legacy location ID (not used for ODP)
Datacenter location ID. Points to one of GET /v3/cloud/dcLocation
The instance type of this server, which is one of GET /v3/host/instanceType for a bare metal, or one of
GET /v3/cloud/instanceType for a virtual machine
The fleet ID, if this host has been assigned to a fleet
If 0, the host has not been assigned to a fleet, otherwise, the fleet is assigned to this host and the host can serve application instances for that fleet.
The ID of a new fleet that is to be assigned to this host after performing a bulkReserve operation at POST /v3/fleet/host/bulkReserve
Unix timestamp when fleet assigned to the host
The name of the rack the host is located
The date at which this host became active
The date at which this host will expire
The date at which this host was cancelled
The date at which the contract ends (if applicable)
The contract period in months
The service extend period in months
The cancellation period in months
Purchase order, if one has been supplied via our billing department
The payment term in days (how many days are invoices generated before dateEnd)
The price of this host per month in cents (see currencyId for currency)
The price of traffic overuse in cents (per TB) (see currencyId for currency)
The currency of the pricePerMonth field:
- 0: EURO
- 1: USD
- 9: YEN
The bandwidth billing method for this service:
- 1: unmetered connection
- 2: measured in TB per month
- 3: measured in mbit 95th percentile
The contractual maximum bandwidth usage value. In GB if bandwidthBillingType equals 2, in mbit otherwise
The server manufacturer brand name
The model of the server
Number of CPUs in this host
Percentage of cpu used across all cores
The amount of memory that is used by the host (in megabytes)
The amount of memory that is available on the host (in megabytes)
The amount of free memory that is available on the host (in megabytes)
If the host is reserved for a fleet isReserve set to 1
The service tag of the host
If the host is available for game hosting platform isODP set to 1
ID of Flex Metal order if this is a flex metal server
Status of server auto install if it was started by one. (created / installing / finished / failed)
Whether the host is running or not
The uptime of the host. Read-only. Only provided if the server checked-in recently
Monthly traffic of all incoming and outgoing bandwidth in GB or Mbit depending on host configuration
Whether the host has free incoming traffic or not
The outgoing traffic (Mbit or GB)
The incoming traffic (Mbit or GB)
OK
Invalid credentials
Not Found
Unprocessable Entity
Internal Server Error
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Internal Server Error
ID of the host to fetch invoices for
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Invalid host ID
Internal Server Error
Cancels a host. If you cancel a host you will continue to have access to the host until the end of the contract
ID of the host to cancel
cancelled successfully
Invalid credentials
Invalid host ID
Unable to cancel host
Internal Server Error
Reverts the cancellation of a host. You cannot revert the cancellation a host if the current date is equal to or past the end of contract date,
nor if the host was never cancelled
ID of the host to revert the cancellation for
cancellation was reverted successfully
Invalid credentials
Invalid host ID
Unable to revert cancellation of host
Internal Server Error
ID of the host to fetch traffic for
ID of the uplink to fetch traffic for
Start unix timestamp
End unix timestamp
OK
Invalid credentials
Invalid host ID or uplink ID
Internal Server Error
ID of the host to fetch traffic for
ID of the uplink to fetch traffic for
Base64 encoded image string
Invalid credentials
Invalid host ID or uplink ID
Internal Server Error
ID of the host to fetch traffic for
ID of the uplink to fetch traffic for
Base64 encoded image string
Invalid credentials
Invalid host ID or uplink ID
Internal Server Error
ID of the host to fetch traffic for
ID of the uplink to fetch traffic for
Base64 encoded image string
Invalid credentials
Invalid host ID or uplink ID
Internal Server Error
ID of the host to fetch traffic for
ID of the uplink to fetch traffic for
Base64 encoded image string
Invalid credentials
Invalid host ID or uplink ID
Internal Server Error
ID of the host to install
Perform a quick format of all drives. Default: true
For an overview of available SSH keys, see /v3/sshKey. Only required for Linux OSs, except Talos.
OK
Invalid host ID
Unprocessable entity
Internal Server Error
ID of the host to fetch install logs for
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Not Found
Internal Server Error
ID of the host to format disks for
Can be quick format or a full secure disk wipe. Available options: quick | fullwipe
OK
Invalid host ID
Unprocessable entity
Internal Server Error
ID of the host to fetch alert for
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Invalid host ID
Internal Server Error
ID of the host to create an alert for
Host alert ID
At what percentage of bandwidth usage to trigger the alert
Will send an email notification when alert is triggered
WIll create a ticket notification when alert is triggered
UNIX timestamp of the last time the alert was triggered
UNIX timestamp of the time the alert was created
OK
Invalid credentials
Invalid host ID
Unprocessable Entity
Internal Server Error
ID of the host that the alert belongs to
ID of the host alert to update
Host alert ID
At what percentage of bandwidth usage to trigger the alert
Will send an email notification when alert is triggered
WIll create a ticket notification when alert is triggered
UNIX timestamp of the last time the alert was triggered
UNIX timestamp of the time the alert was created
OK
Invalid credentials
Invalid host ID or alert ID
Unprocessable Entity
Internal Server Error
ID of the host that the alert belongs to
ID of the alert to delete
No Content
Invalid credentials
Invalid host ID or alert ID
Internal Server Error
No content
ID of the host to which IP address belongs to
IP address to set RDNS entry for
The hostname
The corresponding ip for the host
No Content
Invalid credentials
Invalid host ID or IP address
Internal Server Error
No content
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Internal Server Error
Application ID
The list of application type can be found in: GET /application/type
The protocol used to manage the application (defaults to None when not set):
- 0: None
- 1: A2S
- 2: ARCUS
The public name of your application
The url to your application's website
A short description of your application
The name of the application's developer
The name of the application's publisher
The default operating system group being used for the stop method. If you have a Windows and Linux ApplicationBuild you can overwrite this on the ApplicationBuild level. Must be one of:
- 1: Windows
- 2: Linux (default)
The stop method that will be used on restart or destroy of an application instance. The default is hard kill, list of types can be found in: GET /v3/application/stopMethod
The timeout that will be used on restart or destroy of an application instance, in seconds. The default is 0 (no timeout)
UnixTimestamp
If the application currently in use or not
OK
Invalid credentials
Unprocessable Entity
Internal Server Error
The Id of the application for which to fetch the information
OK
Invalid credentials
Invalid applicationId
Internal Server Error
The Id of the application to update
Application ID
The list of application type can be found in: GET /application/type
The protocol used to manage the application (defaults to None when not set):
- 0: None
- 1: A2S
- 2: ARCUS
The public name of your application
The url to your application's website
A short description of your application
The name of the application's developer
The name of the application's publisher
The default operating system group being used for the stop method. If you have a Windows and Linux ApplicationBuild you can overwrite this on the ApplicationBuild level. Must be one of:
- 1: Windows
- 2: Linux (default)
The stop method that will be used on restart or destroy of an application instance. The default is hard kill, list of types can be found in: GET /v3/application/stopMethod
The timeout that will be used on restart or destroy of an application instance, in seconds. The default is 0 (no timeout)
UnixTimestamp
If the application currently in use or not
OK
Invalid credentials
Invalid applicationId
Application type can not be changed
Unprocessable Entity
Internal Server Error
The Id of the application to delete
No Content
Invalid credentials
Invalid applicationId
Application is in use
Internal Server Error
No content
The Id of the application for which to fetch the installs
OK
Invalid credentials
Invalid applicationId
Internal Server Error
The Id of the application for which to fetch the application builds
Label expressions can be used to apply more specific search parameters and can be written in standard SQL query language.
E.g. region_id=123 or multiple filters: region_id=123 and fleet_id=456 or host_id=46256 The provided filter query needs to be url encoded. E.g.
region_id%3D123 or multiple filters: region_id%3D123%20and%20fleet_id%3D456%20or%20host_id%3D46256 The total would look like:
/application/{applicationId}/applicationBuild?labels=region_id%3D123%20and%20fleet_id%3D456%20or%20host_id%3D46256
If you want to filter on a non-numeric label such as region_name, you have to wrap the value in double quotes: region_name="Rotterdam".
For more information about labels check details
OK
Invalid credentials
Invalid applicationId
Labels error
Internal Server Error
Get all the application builds which have application instances created for the given application
The Id of the application for which to fetch the application builds
OK
Invalid credentials
Invalid applicationId
Labels error
Internal Server Error
The Id of the application for which to fetch the properties
OK
Invalid credentials
Invalid applicationId
Internal Server Error
The Id of the application for which the property will be created
The application property ID
The application property type. For a list of application property types see
GET /v3/application/property/type
The application property key. Only hyphens (-), underscores (_), lowercase characters and numbers are allowed. Keys must start with a lowercase character
The application property value
OK
Invalid credentials
Invalid applicationId
Network port is already in use by another network port property
Unprocessable Entity
Internal Server Error
The Id of the application the property belongs to
Id of the property to fetch
OK
Invalid credentials
Invalid applicationId or propertyId
Internal Server Error
The Id of the application the property belongs to
The Id of the property to update
The application property ID
The application property type. For a list of application property types see
GET /v3/application/property/type
The application property key. Only hyphens (-), underscores (_), lowercase characters and numbers are allowed. Keys must start with a lowercase character
The application property value
OK
Invalid credentials
Invalid applicationId or propertyId
Network port is already in use by another network port property
Unprocessable Entity
Internal Server Error
The Id of the application for which to delete the property
Property Id to delete
No Content
Invalid credentials
Invalid applicationId or propertyId
Unprocessable Entity
Internal Server Error
No content
Unix timestamp. Filter from time, default value is -1 day
Unix timestamp. Filter to time, default value is now
OK
Invalid credentials
Invalid applicationId
Internal Server Error
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Labels error
Internal Server Error
Application build ID
The name of the application build
The ID of the application. May be null if buildProvisioningStorageType is LegacyFTP
The ID of the host capacity template
The application build, list of types can be found in: GET /application/type
The executable name including the path originating from the root directory of the software structure
The startup parameters required for an executable
Set to 1 if a deployed application instance will inform the platform it's done with initializing and is ready to accept players. Defaults to 0 if not set, which means an instance's status will go directly to ONLINE (4) after starting
ID of the application install (legacy FTP, will be removed, may not be updated)
ID of the operating system, list of operating systems can be found in: GET /v3/operatingsystem
The stop method that will be used on restart or destroy of an application instance. The default is taken from the value of GET /v3/application/stopMethod - any value submitted here overrides that Application default
The timeout that will be used on restart or destroy of an application instance. The default is taken from the value of
Application.stopTimeout - any value submitted here overrides that Application default
When the application build was created (unix timestamp)
The application build file to be used for the application instance
Type of storage being used GET /v3/buildProvisioning/storage/registration/types. Default: 0
Controls whether to run this build as root or as a non-privileged user. Warning: This currently only works for builds deployed onto a Linux operating system. Windows builds will always run as administrator
- 0: run as non-privileged user
- 1: run as root user (default)
OK
Invalid credentials
Conflict
Unprocessable Entity
Internal Server Error
The Id of the application build
OK
Invalid credentials
Invalid applicationBuildId
Internal Server Error
The Id of the application build
Application build ID
The name of the application build
The ID of the application. May be null if buildProvisioningStorageType is LegacyFTP
The ID of the host capacity template
The application build, list of types can be found in: GET /application/type
The executable name including the path originating from the root directory of the software structure
The startup parameters required for an executable
Set to 1 if a deployed application instance will inform the platform it's done with initializing and is ready to accept players. Defaults to 0 if not set, which means an instance's status will go directly to ONLINE (4) after starting
ID of the application install (legacy FTP, will be removed, may not be updated)
ID of the operating system, list of operating systems can be found in: GET /v3/operatingsystem
The stop method that will be used on restart or destroy of an application instance. The default is taken from the value of GET /v3/application/stopMethod - any value submitted here overrides that Application default
The timeout that will be used on restart or destroy of an application instance. The default is taken from the value of
Application.stopTimeout - any value submitted here overrides that Application default
When the application build was created (unix timestamp)
The application build file to be used for the application instance
Type of storage being used GET /v3/buildProvisioning/storage/registration/types. Default: 0
Controls whether to run this build as root or as a non-privileged user. Warning: This currently only works for builds deployed onto a Linux operating system. Windows builds will always run as administrator
- 0: run as non-privileged user
- 1: run as root user (default)
OK
Invalid credentials
Invalid applicationBuildId
Conflict
Unprocessable Entity
Internal Server Error
The Id of the application build
No Content
Invalid credentials
Invalid applicationBuildId
applicationBuildId is in use
Internal Server Error
No content
The ID of the application build
OK
Invalid credentials
Invalid applicationBuildId
Internal Server Error
The ID of the application build
OK
Invalid credentials
Invalid applicationBuildId
Internal Server Error
The ID of the application build
OK
Invalid credentials
Invalid applicationBuildId
Internal Server Error
Unix timestamp. Filter from time, default value is -1 day
Unix timestamp. Filter to time, default value is now
OK
Invalid credentials
Invalid applicationBuildId
Internal Server Error
The Id of the application build
OK
Invalid credentials
Invalid applicationBuildId
Internal Server Error
The Id of the application build
The Id of the application build property
OK
Invalid credentials
Invalid applicationBuildId or propertyId
Internal Server Error
The Id of the application build
The Id of the application build property to update
The application build property ID
The application build property type. For a list of application property types see
GET /v3/application/property/type
The application build property key. Only hyphens (-), underscores (_), lowercase characters and numbers are allowed. Keys must start with a lowercase character
The application build property value
OK
Invalid credentials
Invalid applicationBuildId or propertyId
Network port is already in use by another network port property
Unprocessable Entity
Internal Server Error
The Id of the application build
OK
Invalid credentials
Invalid applicationBuildId
Internal Server Error
The Id of the application build
Application build configuration ID
Configuration file path
Configuration file name
Configuration file contents
UnixTimestamp
OK
Invalid credentials
Invalid applicationBuildId
Unprocessable Entity
Internal Server Error
The Id of the application build
The Id of the specific configuration
OK
Invalid credentials
Invalid applicationBuildId or applicationBuildConfigurationId
Internal Server Error
The Id of the application build
The Id of the specific configuration
Application build configuration ID
Configuration file path
Configuration file name
Configuration file contents
UnixTimestamp
OK
Invalid credentials
Invalid applicationBuildId or applicationBuildConfigurationId
Unprocessable Entity
Internal Server Error
The Id of the application build
The Id of the specific configuration
No Content
Invalid credentials
Invalid applicationBuildId or applicationBuildConfigurationId
Internal Server Error
No content
Deployment environment ID
Application ID
List of fleet ID
List of application build ID
OK
Invalid credentials
Internal Server Error
Patch job ID
Deployment environment ID
Application ID
Patch job type, you can find the list available patch job type GET /v3/patchJob/type
Name of the patch job method
Name of the patch job (unique)
Status of the patch job, you can find the list available patch job type GET /v3/patchJob/status
Stop method of an application instance, you can find the list available application instance stop methods GET /v3/application/stopMethod
Name of the stop method
Stop method timeout of an application instance in seconds
Comments for patch job
Start time when the patch job will be started. The default value is 0, this means start directly after creation of the patch job, else the patch job will start at the provided UTC timestamp
Timestamp when the patch job has been started in UTC
How many application instances are being patched
Timestamp when the patch job has been created
Timestamp when the patch job last has been changed
Timestamp when the patch job has been finished in UTC
If the patch job can be cancelled, when is 1 you can cancel the patch job else not
If filled in, this ID points to the patch job that has been reverted by this patch job
If filled in, this ID points to the PatchJob that has reverted this patch job
OK
Invalid credentials
Internal Server Error
The Id of the patch job for which to fetch the information
OK
Invalid credentials
Invalid patchJobId
Internal Server Error
The Id of the patch job
Patch job ID
Deployment environment ID
Application ID
Patch job type, you can find the list available patch job type GET /v3/patchJob/type
Name of the patch job method
Name of the patch job (unique)
Status of the patch job, you can find the list available patch job type GET /v3/patchJob/status
Stop method of an application instance, you can find the list available application instance stop methods GET /v3/application/stopMethod
Name of the stop method
Stop method timeout of an application instance in seconds
Comments for patch job
Start time when the patch job will be started. The default value is 0, this means start directly after creation of the patch job, else the patch job will start at the provided UTC timestamp
Timestamp when the patch job has been started in UTC
How many application instances are being patched
Timestamp when the patch job has been created
Timestamp when the patch job last has been changed
Timestamp when the patch job has been finished in UTC
If the patch job can be cancelled, when is 1 you can cancel the patch job else not
If filled in, this ID points to the patch job that has been reverted by this patch job
If filled in, this ID points to the PatchJob that has reverted this patch job
OK
Invalid credentials
Invalid patchJobId
Internal Server Error
The Id of the deployment environment
The Id of the application (game or utility)
OK
Invalid credentials
Invalid deploymentEnvironmentId or applicationId
Internal Server Error
The Id of the patch job
OK
Invalid credentials
Invalid patchJobId
Internal Server Error
The Id of the patch job
ID of a patch job email
Email address for reporting (unique)
If 1 progress report will be send, if 0 no progress report will be send
If 1 result report will be send, if 0 no result report will be send
Timestamp when the patch job email has been created
Timestamp when the patch job email last has been changed
OK
Invalid credentials
Invalid patchJobId
Internal Server Error
The Id of the patch job
No Content
Invalid credentials
Invalid patchJobId
unprocessable patchJob
Internal Server Error
No content
The Id of the patch job
The Id of the patch job report email
OK
Invalid credentials
Invalid patchJobId or reportEmailId
Internal Server Error
The Id of the patch job
OK
Invalid credentials
Invalid patchJobId
Internal Server Error
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Internal Server Error
Label expressions can be used to apply more specific search parameters and can be written in standard SQL query language.
E.g. region_id=123 or multiple filters: region_id=123 and fleet_id=456 or host_id=46256 The provided filter query needs to be url encoded. E.g.
region_id%3D123 or multiple filters: region_id%3D123%20and%20fleet_id%3D456%20or%20host_id%3D46256 The total would look like:
/applicationInstance?labels=region_id%3D123%20and%20fleet_id%3D456%20or%20host_id%3D46256
If you want to filter on a non-numeric label such as region_name, you have to wrap the value in double quotes: region_name="Rotterdam"
Warning: the labels query parameter is ignored when passing a PAGE-TOKEN and the original labels string will be used for that request
instead. More information on the use of labels can be found in the
label documentation.
Filter expression can be used to apply more specific search on most parameters in the application instance, it is written like
this E.G. regionId=123 or multiple filters: regionId=123 and fleetId=456, only the AND statement is supported at this time. You can also
search inside nested objects like metadata.key="testing" and metadata.value="test" You can only search on exact matches.
Warning: the filters query parameter is ignored when passing a PAGE-TOKEN and the original filters string will be used for that request
instead.
Warning: filtering on the following parameters is currently not supported and will give an error:
autoRestart, liveGameVersion, liveHostName, liveMap, liveRules, manuallyDeployed, markedForDeletion, numPlayers, numPlayersMax,
pid, pidChangedAt, startedAt, status, stoppedAt, updatedAt
Sort expression to sort your results in the order that you like E.G. sort=fleetId ASC, applicationId DESC Be aware that all filters
and sorting should be url encoded.
Warning: the sort query parameter is ignored when passing a PAGE-TOKEN and the original sort string will be used for that request instead
Warning: sorting on the following parameters is currently not supported and will give an error:
autoRestart, liveGameVersion, liveHostName, liveMap, liveRules, manuallyDeployed, markedForDeletion, numPlayers, numPlayersMax,
pid, pidChangedAt, startedAt, status, stoppedAt, updatedAt
Example header and default range: RANGED-DATA: start=0,results=25
Warning: the start variable of the RANGED-DATA object has been deprecated for this endpoint. It is not possible to supply a start, see
PAGE-TOKEN header for a replacement
This token will be provided by this endpoint to allow for pagination functionality. By performing a request to this endpoint
without the PAGE-TOKEN you will retrieve the first page of search results. If a PAGE-TOKEN is returned, a next page may be requested by
supplying that token in the next request using the same PAGE-TOKEN key and value in the request header. If no PAGE-TOKEN is returned, the last
page has been reached and no further data can be requested. A returned PAGE-TOKEN is valid until the date specified in the Expires response
header. Example: PAGE-TOKEN: eyJjb25kaXRpb25zIjp7InVzZXJJZCI6NjY2ODI1fSwibGFiZWxz(...) (truncated for readability)
Expires header example: Expires: Fri, 08 Jan 2021 09:10:29 GMT
OK
PAGE-TOKENdid not have an expected structure and is invalid. Please try again by sending a request without aPAGE-TOKENand restarting.- An invalid filter or sort column is provided
Invalid credentials
PAGE-TOKEN is expired. Acquire a new PAGE-TOKEN by sending a request without a PAGE-TOKEN and try again
Labels error
Internal Server Error
Label expressions can be used to apply more specific search parameters and can be written in standard SQL query language.
E.g. region_id=123 or multiple filters: region_id=123 and fleet_id=456 or host_id=46256 The provided filter query needs to be url encoded. E.g.
region_id%3D123 or multiple filters: region_id%3D123%20and%20fleet_id%3D456%20or%20host_id%3D46256 The total would look like:
/applicationInstance/summary?labels=region_id%3D123%20and%20fleet_id%3D456%20or%20host_id%3D46256
If you want to filter on a non-numeric label such as region_name, you have to wrap the value in double quotes: region_name="Rotterdam"
Warning: the labels query parameter is ignored when passing a PAGE-TOKEN and the original labels string will be used for that request
instead. More information on the use of labels can be found in the
label documentation.
Filter expression can be used to apply more specific search on most parameters in the application instance, it is written like
this E.G. regionId=123 or multiple filters: regionId=123 and fleetId=456, only the AND statement is supported at this time. You can also
search inside nested objects like metadata.key="testing" and metadata.value="test" You can only search on exact matches.
Warning: the filters query parameter is ignored when passing a PAGE-TOKEN and the original filters string will be used for that request
instead.
Warning: filtering on the following parameters is currently not supported and will give an error:
autoRestart, liveGameVersion, liveHostName, liveMap, liveRules, manuallyDeployed, markedForDeletion, numPlayers, numPlayersMax,
pid, pidChangedAt, startedAt, status, stoppedAt, updatedAt
Sort expression to sort your results in the order that you like E.G. sort=fleetId ASC, applicationId DESC Be aware that all filters
and sorting should be url encoded.
Warning: the sort query parameter is ignored when passing a PAGE-TOKEN and the original sort string will be used for that request instead
Warning: sorting on the following parameters is currently not supported and will give an error:
autoRestart, liveGameVersion, liveHostName, liveMap, liveRules, manuallyDeployed, markedForDeletion, numPlayers, numPlayersMax,
pid, pidChangedAt, startedAt, status, stoppedAt, updatedAt
Fields return in response, only fields available in model can be filter out
Example header and default range: RANGED-DATA: start=0,results=25
Warning: the start variable of the RANGED-DATA object has been deprecated for this endpoint. It is not possible to supply a start, see
PAGE-TOKEN header for a replacement
This token will be provided by this endpoint to allow for pagination functionality. By performing a request to this endpoint
without the PAGE-TOKEN you will retrieve the first page of search results. If a PAGE-TOKEN is returned, a next page may be requested by
supplying that token in the next request using the same PAGE-TOKEN key and value in the request header. If no PAGE-TOKEN is returned, the last
page has been reached and no further data can be requested. A returned PAGE-TOKEN is valid until the date specified in the Expires response
header. Example: PAGE-TOKEN: eyJjb25kaXRpb25zIjp7InVzZXJJZCI6NjY2ODI1fSwibGFiZWxz(...) (truncated for readability)
Expires header example: Expires: Fri, 08 Jan 2021 09:10:29 GMT
OK
PAGE-TOKENdid not have an expected structure and is invalid. Please try again by sending a request without aPAGE-TOKENand restarting.- An invalid filter or sort column is provided
Invalid credentials
PAGE-TOKEN is expired. Acquire a new PAGE-TOKEN by sending a request without a PAGE-TOKEN and try again
Labels error
Internal Server Error
Note: bare metal servers and VMs are exposed in the same manner, as "dedicated servers". hostId can be found in the /host endpoint.
The ID of the host
Label expressions can be used to apply more specific search parameters and can be written in standard SQL query language.
E.g. region_id=123 or multiple filters: region_id=123 and fleet_id=456 or host_id=46256 The provided filter query needs to be url encoded.
E.g. region_id%3D123 or multiple filters: region_id%3D123%20and%20fleet_id%3D456%20or%20host_id%3D46256 The total would look like:
/applicationInstance/host/{hostId}?labels=region_id%3D123%20and%20fleet_id%3D456%20or%20host_id%3D46256
If you want to filter on a non-numeric label such as region_name, you have to wrap the value in double quotes: region_name="Rotterdam"
Warning: the labels query parameter is ignored when passing a PAGE-TOKEN and the original labels string will be used for that request
instead. More information on the use of labels can be found in the
label documentation.
Filter expression can be used to apply more specific search on most parameters in the application instance, it is written like
this E.G. regionId=123 or multiple filters: regionId=123 and fleetId=456, only the AND statement is supported at this time. You can also
search inside nested objects like metadata.key="testing" and metadata.value="test" You can only search on exact matches.
Warning: the filters query parameter is ignored when passing a PAGE-TOKEN and the original filters string will be used for that request
instead.
Warning: filtering on the following parameters is currently not supported and will give an error:
autoRestart, liveGameVersion, liveHostName, liveMap, liveRules, manuallyDeployed, markedForDeletion, numPlayers,
numPlayersMax, pid, pidChangedAt, startedAt, status, stoppedAt, updatedAt
Sort expression to sort your results in the order that you like E.G. sort=fleetId ASC, applicationId DESC Be aware that all
filters and sorting should be url encoded.
Warning: the sort query parameter is ignored when passing a PAGE-TOKEN and the original sort string will be used for that request instead
Warning: sorting on the following parameters is currently not supported and will give an error:
autoRestart, liveGameVersion, liveHostName, liveMap, liveRules, manuallyDeployed, markedForDeletion, numPlayers,
numPlayersMax, pid, pidChangedAt, startedAt, status, stoppedAt, updatedAt
Example header and default range: RANGED-DATA: start=0,results=25
Warning: the start variable of the RANGED-DATA object has been deprecated for this endpoint. It is not possible to supply a start, see
PAGE-TOKEN header for a replacement
This token will be provided by this endpoint to allow for pagination functionality. By performing a request to this endpoint
without the PAGE-TOKEN you will retrieve the first page of search results. If a PAGE-TOKEN is returned, a next page may be requested by
supplying that token in the next request using the same PAGE-TOKEN key and value in the request header. If no PAGE-TOKEN is returned, the
last page has been reached and no further data can be requested. A returned PAGE-TOKEN is valid until the date specified in the Expires
response header. Example: PAGE-TOKEN: eyJjb25kaXRpb25zIjp7InVzZXJJZCI6NjY2ODI1fSwibGFiZWxz(...) (truncated for readability) Expires header
example: Expires: Fri, 08 Jan 2021 09:10:29 GMT
OK
PAGE-TOKENdid not have an expected structure and is invalid. Please try again by sending a request without aPAGE-TOKENand restarting.- An invalid filter or sort column is provided
Invalid credentials
Invalid hostId
PAGE-TOKEN is expired. Acquire a new PAGE-TOKEN by sending a request without a PAGE-TOKEN and try again
Labels error
Internal Server Error
Creates a new application instance entity in our database, on the provided host ID (can be a bare metal server or a VM). Afterwards you can deploy software on it. hostId equals hostID, found in the /host endpoint.
The ID of the fleet
The ID of the host
Application instance ID
The deployment environment ID of this application instance
The deployment environment name of this application instance
The fleet ID of this application instance
The fleet name of this application instance
The application instance is host on this server.
0 if this instance runs on a bare metal server, 1 if it runs on a VM
The application ID of this application instance
The application name of this application instance
The type of the application, the different types can be found in: GET /v3/application/type
The application build ID of this application instance
The application build name of this application instance
ID of the application install
The datacenter ID of where this application instance is located
The datacenter name of where this application instance is located
The deployment region ID of where this application instance is located
The deployment region name of where this application instance is located
The application instance status, list of application instance status can be found in GET /v3/applicationInstance/status
The Unix timestamp at which this application instance is created
The Unix timestamp at which this application instance is started
The Unix timestamp at which this application instance is stopped
The process ID of the application instance running on the host
The Unix timestamp of the moment the process ID has been changed on the host
The exact startup parameters that were used to start this application instance with all properties resolved to their
respective values. Will be null if the instance has not been started, but will retain its previous value if it was stopped. Once set it will never be
cleared again
The name of the executable that was ran when the application instance started. Will be null if the instance has not been
started, but will retain its previous value if it was stopped. Once set it will never be cleared again
If set to 1, the application instance was manually deployed, instead of automatically deployed through the system
The maximum number of players on the application instance (this only apply to application instances of the type game)
The number of online players on the application instance (this only apply to application instances of the type game)
The live host name of the application instance (this only apply to application instances of the type game)
The live map of an application instance (this only apply to application instances of the type game)
The live game version of an application instance (this only apply to application instances of the type game)
The Unix timestamp at which this application instance is live data is updated (this only apply to application instances of the type game)
The live rules of an application instance (this only apply to application instances of the type game)
If auto restart is 1 then the application instance will auto restart, when 0 the application instance auto restart will be disabled
If an application will be deleted it will be 1, 0 otherwise
1 if Arcus is available & running for this application instance, 0 otherwise.
Note: If your application's managementProtocol is NOT set to Arcus, this value will always be 0, even if your
game server would support the Arcus protocol. The protocol is only tested, and this value potentially be set to 1,
when the managementProtocol is set to Arcus.
OK
Invalid credentials
Invalid hostId or fleetId
Host assigned to a different fleet or host has no hostagent installed
Invalid properties (e.g. similar ports as another application instance, or the fleet is missing deployment profile)
Internal Server Error
The ID of the application instance
OK
Invalid credentials
Invalid applicationInstanceId
Unprocessable Entity
Internal Server Error
The ID of the application instance
Application instance ID
The deployment environment ID of this application instance
The deployment environment name of this application instance
The fleet ID of this application instance
The fleet name of this application instance
The application instance is host on this server.
0 if this instance runs on a bare metal server, 1 if it runs on a VM
The application ID of this application instance
The application name of this application instance
The type of the application, the different types can be found in: GET /v3/application/type
The application build ID of this application instance
The application build name of this application instance
ID of the application install
The datacenter ID of where this application instance is located
The datacenter name of where this application instance is located
The deployment region ID of where this application instance is located
The deployment region name of where this application instance is located
The application instance status, list of application instance status can be found in GET /v3/applicationInstance/status
The Unix timestamp at which this application instance is created
The Unix timestamp at which this application instance is started
The Unix timestamp at which this application instance is stopped
The process ID of the application instance running on the host
The Unix timestamp of the moment the process ID has been changed on the host
The exact startup parameters that were used to start this application instance with all properties resolved to their
respective values. Will be null if the instance has not been started, but will retain its previous value if it was stopped. Once set it will never be
cleared again
The name of the executable that was ran when the application instance started. Will be null if the instance has not been
started, but will retain its previous value if it was stopped. Once set it will never be cleared again
If set to 1, the application instance was manually deployed, instead of automatically deployed through the system
The maximum number of players on the application instance (this only apply to application instances of the type game)
The number of online players on the application instance (this only apply to application instances of the type game)
The live host name of the application instance (this only apply to application instances of the type game)
The live map of an application instance (this only apply to application instances of the type game)
The live game version of an application instance (this only apply to application instances of the type game)
The Unix timestamp at which this application instance is live data is updated (this only apply to application instances of the type game)
The live rules of an application instance (this only apply to application instances of the type game)
If auto restart is 1 then the application instance will auto restart, when 0 the application instance auto restart will be disabled
If an application will be deleted it will be 1, 0 otherwise
1 if Arcus is available & running for this application instance, 0 otherwise.
Note: If your application's managementProtocol is NOT set to Arcus, this value will always be 0, even if your
game server would support the Arcus protocol. The protocol is only tested, and this value potentially be set to 1,
when the managementProtocol is set to Arcus.
OK
Invalid credentials
Invalid applicationInstanceId
Unprocessable Entity
Internal Server Error
The ID of the application instance
Stop method type, list of types can be found in: GET /v3/application/stopMethod
Stop method timeout in seconds, default value is 1800 seconds.
No Content
Invalid credentials
Invalid applicationInstanceId
Internal Server Error
No content
Set the online status of a single application instance. Only possible if the application instance status is at least "offline (2)"
The ID of the application instance
Possible values:
- 3: starting
- 4: online
- 5: allocated (only possible if previous status is online)
OK
Invalid credentials
Invalid applicationInstanceId
Invalid status value
Internal Server Error
The ID of the application instance
OK
Invalid credentials
Invalid applicationInstanceId
Internal Server Error
Stop the application instance given, if no stop method is provided we will use the stop method of the application build or application. The
default is hard kill
The ID of the application instance
Stop method type, list of types can be found in: GET /v3/application/stopMethod
Stop method timeout in seconds, default value is 1800 seconds.
OK
Invalid credentials
Invalid applicationInstanceId
Unprocessable Entity
Internal Server Error
Stop and start a single application instance. Also works if it is already stopped. You can give an stop method in the body, if not given we
will use the stop method defined in the application build or application. Default is hard kill
The ID of the application instance
Stop method type, list of types can be found in: GET /v3/application/stopMethod
Stop method timeout in seconds, default value is 1800 seconds.
OK
Invalid credentials
Invalid applicationInstanceId
Expectation Failed
Unprocessable Entity
Internal Server Error
The ID of the application instance
An application build ID
OK
Invalid credentials
Invalid applicationInstanceId
Expectation Failed
Unprocessable Entity
Internal Server Error
The ID of the application instance
OK
Invalid credentials
Invalid applicationInstanceId
Internal Server Error
The ID of the application
Label expressions can be used to apply more specific search parameters and can be written in standard SQL query language.
E.g. region_id=123 or multiple filters: region_id=123 and fleet_id=456 or host_id=46256 The provided filter query needs to be url encoded. E.g.
region_id%3D123 or multiple filters: region_id%3D123%20and%20fleet_id%3D456%20or%20host_id%3D46256 The total would look like:
/applicationInstance/application/{applicationId}?labels=region_id%3D123%20and%20fleet_id%3D456%20or%20host_id%3D46256
If you want to filter on a non-numeric label such as region_name, you have to wrap the value in double quotes: region_name="Rotterdam"
Warning: the labels query parameter is ignored when passing a PAGE-TOKEN and the original labels string will be used for that request
instead. More information on the use of labels can be found in the
label documentation.
Filter expression can be used to apply more specific search on most parameters in the application instance, it is written like
this E.G. regionId=123 or multiple filters: regionId=123 and fleetId=456, You can only use AND statement You can also search inside nested
objects like metadata.key='testing' and metadata.value='test' You can only search on exact matches.
Warning: the filters query parameter is ignored when passing a PAGE-TOKEN and the original filters string will be used for that request
instead.
Warning: filtering on the following parameters is currently not supported and will give an error:
autoRestart, liveGameVersion, liveHostName, liveMap, liveRules, manuallyDeployed, markedForDeletion, numPlayers, numPlayersMax,
pid, pidChangedAt, startedAt, status, stoppedAt, updatedAt
Sort expression to sort your results in the order that you like E.G. sort=fleetId ASC, applicationId DESC Be aware that all filters
and sorting should be url encoded.
Warning: the sort query parameter is ignored when passing a PAGE-TOKEN and the original sort string will be used for that request instead
Warning: sorting on the following parameters is currently not supported and will give an error:
autoRestart, liveGameVersion, liveHostName, liveMap, liveRules, manuallyDeployed, markedForDeletion, numPlayers, numPlayersMax,
pid, pidChangedAt, startedAt, status, stoppedAt, updatedAt
Example header and default range: RANGED-DATA: start=0,results=25
Warning: the start variable of the RANGED-DATA object has been deprecated for this endpoint. It is not possible to supply a start, see
PAGE-TOKEN header for a replacement
This token will be provided by this endpoint to allow for pagination functionality. By performing a request to this endpoint
without the PAGE-TOKEN you will retrieve the first page of search results. If a PAGE-TOKEN is returned, a next page may be requested by
supplying that token in the next request using the same PAGE-TOKEN key and value in the request header. If no PAGE-TOKEN is returned, the last
page has been reached and no further data can be requested. A returned PAGE-TOKEN is valid until the date specified in the Expires response
header. Example: PAGE-TOKEN: eyJjb25kaXRpb25zIjp7InVzZXJJZCI6NjY2ODI1fSwibGFiZWxz(...) (truncated for readability)
Expires header example: Expires: Fri, 08 Jan 2021 09:10:29 GMT
OK
PAGE-TOKENdid not have an expected structure and is invalid. Please try again by sending a request without aPAGE-TOKENand restarting.- An invalid filter or sort column is provided
Invalid credentials
Invalid applicationId
PAGE-TOKEN is expired. Acquire a new PAGE-TOKEN by sending a request without a PAGE-TOKEN and try again
Labels error
Internal Server Error
Get empty game instances per region for the given applicationId. Currently implies the ONLINE UNALLOCATED game server status.
The ID of the application
Label expressions can be used to apply more specific search parameters and can be written in standard SQL query language.
E.g. region_id=123 or multiple filters: region_id=123 and fleet_id=456 or host_id=46256 The provided filter query needs to be url encoded. E.g.
region_id%3D123 or multiple filters: region_id%3D123%20and%20fleet_id%3D456%20or%20host_id%3D46256 The total would look like:
/applicationInstance/game/{applicationId}/empty/regions?labels=region_id%3D123%20and%20fleet_id%3D456%20or%20host_id%3D46256.
If you want to filter on a non-numeric label such as region_name, you have to wrap the value in double quotes: region_name="Rotterdam".
More information on the use of labels can be found in the
label documentation.
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Invalid applicationInstanceId
Labels error
Internal Server Error
Get empty game instance for the given applicationId. Currently, implies the ONLINE UNALLOCATED game server status.
The ID of the application
Label expressions can be used to apply more specific search parameters and can be written in standard SQL query language.
E.g. region_id=123 or multiple filters: region_id=123 and fleet_id=456 or host_id=46256 The provided filter query needs to be url encoded. E.g.
region_id%3D123 or multiple filters: region_id%3D123%20and%20fleet_id%3D456%20or%20host_id%3D46256 The total would look like:
/applicationInstance/game/{applicationId}/empty?labels=region_id%3D123%20and%20fleet_id%3D456%20or%20host_id%3D46256
If you want to filter on a non-numeric label such as region_name, you have to wrap the value in double quotes: region_name="Rotterdam".
More information on the use of labels can be found in the
label documentation.
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Invalid applicationInstanceId
Labels error
Internal Server Error
Allocate an ONLINE application instance and return errors if there are no application instances to allocate
Fetches an empty ONLINE application instance with the given labels or filters, for the given application ID and changes its status to ALLOCATED.
You may pass metadata to this request to pass information to the application instance during allocation.
This v3 endpoint returns various errors if allocation failed instead of an empty array to help you pinpoint why allocation may have failed
The ID of the application
Label expressions can be used to apply more specific search parameters and can be written in standard SQL query language.
E.g. region_id=123 or multiple filters: region_id=123 and fleet_id=456 or host_id=46256 The provided filter query needs to be url encoded.
E.g.
region_id%3D123 or multiple filters: region_id%3D123%20and%20fleet_id%3D456%20or%20host_id%3D46256 The total would look like:
/applicationInstance/game/{applicationId}/empty/allocate?labels=region_id%3D123%20and%20fleet_id%3D456%20or%20host_id%3D46256
If you want to filter on a non-numeric label such as region_name, you have to wrap the value in double quotes: region_name="Rotterdam"
More information on the use of labels can be found here.
Filter expression can be used to apply more specific search on most parameters in the application instance, it is written like
this E.G. regionId=123 or multiple filters: regionId=123 and fleetId=456, only the AND statement is supported at this time. You can only search on exact matches.
Warning: filtering on the following parameters is currently not supported and will give an error:
autoRestart, liveGameVersion, liveHostName, liveMap, liveRules, manuallyDeployed, markedForDeletion, numPlayers, numPlayersMax,
properties, ipAddress, labelReadOnly, labelPublic, metadata, pid, pidChangedAt, startedAt, status, stoppedAt, updatedAt
OK
An invalid filter column is provided
Invalid credentials
Invalid applicationId, or if any of the following filters contain a value that cannot be resolved to their respective entity (labels and
nested objects not supported):
- 1:
deploymentEnvironmentId - 2:
deploymentEnvironmentName - 3:
fleetId - 4:
fleetName - 5:
regionId - 6:
regionName - 7:
dcLocationId - 8:
dcLocationNameIf no application instances can be allocated and if your application is configured to use the Arcus protocol, and there is a connection problem with Arcus or Arcus is not implemented properly in your application build, a separate error may be thrown. Alternatively, if yourfilterscontain one (or more) of the following properties but they filter out application instances that would be available for allocation, a404error can be thrown detailing which filter caused no application instances to be found: - 1:
deploymentEnvironmentId - 2:
fleetId - 3:
regionId - 4:
dcLocationId
Internal Server Error
The host agent could not be reached
The ID of the application instance
OK
Invalid credentials
Invalid applicationInstanceId
Internal Server Error
The ID of the application instance
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Invalid applicationInstanceId
Internal Server Error
Task template ID, as seen in GET /applicationInstance/task/template
Array of application instance IDs to create the tasks for
If > 0, we gather all game server IDs for this fleet and add those to the gameServerIds property
If > 0, we gather all game server IDs for this region and add those to the gameServerIds property
A unix timestamp indicating the time at which to execute the task (to schedule tasks for future execution)
OK
Invalid credentials
Unprocessable Entity
Internal Server Error
The Id of the task
OK
Invalid credentials
Invalid taskId
Task cannot be pause
Internal Server Error
The Id of the task
OK
Invalid credentials
Invalid taskId
Task cannot be cancelled
Internal Server Error
The Id of the task batch
OK
Invalid credentials
Invalid taskBatchId
Internal Server Error
The Id of the assignable file
OK
Invalid credentials
Invalid fileId
Internal Server Error
The application's ID this application install is coupled to
ID of the assignableFile. Can be obtained from GET /applicationInstall/assignable
Operating system group ID (1 = windows, 2 = linux)
Application install name
Application install version
Game install release notes
Does the archive contain the game instance executable?
OK
Invalid credentials
Unprocessable Entity
Internal Server Error
The Id of the application install to fetch
OK
Invalid credentials
Invalid installId
Internal Server Error
The Id of the application install to update
Application install ID
Application install assigned to applicationId
The list of Application types can be found in: GET /application/type
Application install created at timestamp
Application install name
Application install version
Operating system group ID (1 = windows, 2 = linux)
Application install active
Application install release notes
Path of the file on the file server
File size in bytes
Archive file SHA-256 hash
SHA-256 hash of the executable in the archive
Status of application install.
Does the archive contain the game instance executable?
OK
Invalid credentials
Invalid installId
Unprocessable Entity
Internal Server Error
The Id of the application install you want to remove
No Content
Invalid credentials
Invalid installId
Application install is in use, cannot delete
Internal Server Error
No content
Cloud provider ID. For a list of cloud providers see GET /v3/cloud/provider
OK
Invalid credentials
Internal Server Error
i3D.net or cloud data center location ID. For a list of all data center locations see GET /v3/cloud/dcLocation
OK
Invalid credentials
Internal Server Error
Comma separated array of data center location Ids, example: id1,id2. For a list of all data center locations see GET /v3/cloud/dcLocation
OK
Invalid credentials
Internal Server Error
The Id of the data center location. For a list of all data center locations see GET /v3/cloud/dcLocation
OK
Invalid credentials
Invalid dcLocationId
Internal Server Error
The Id of the data center location. For a list of all data center locations see GET /v3/cloud/dcLocation
OK
Invalid credentials
Invalid dcLocationId
Internal Server Error
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Internal Server Error
Ubisoft Cloud network setting id
Ubisoft Cloud project id
Ubisoft Cloud region name
Ubisoft Cloud public network UUID id e.g: (b091a99e-abdd-11ea-bb37-0242ac130002)
Ubisoft Cloud private network UUID id e.g: (d80e2d7e-aa38-490e-915c-bb56222911c3)
Ubisoft Cloud security group id e.g: (0ec61726-405c-4919-b9a1-9dcd6ae56077)
UnixTimestamp
UnixTimestamp
OK
Invalid credentials
Unprocessable Entity
Internal Server Error
The Id of the Ubisoft cloud setting
OK
Invalid credentials
Invalid ucSettingId
Internal Server Error
The Id of the Ubisoft cloud setting
Ubisoft Cloud network setting id
Ubisoft Cloud project id
Ubisoft Cloud region name
Ubisoft Cloud public network UUID id e.g: (b091a99e-abdd-11ea-bb37-0242ac130002)
Ubisoft Cloud private network UUID id e.g: (d80e2d7e-aa38-490e-915c-bb56222911c3)
Ubisoft Cloud security group id e.g: (0ec61726-405c-4919-b9a1-9dcd6ae56077)
UnixTimestamp
UnixTimestamp
OK
Invalid credentials
Invalid ucSettingId
Internal Server Error
The Id of the Ubisoft cloud setting
No Content
Invalid credentials
Invalid ucSettingId
Internal Server Error
No content
For a list of cloud providers see GET /v3/cloud/provider)
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Internal Server Error
For a list of cloud providers see GET /v3/cloud/provider)
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Internal Server Error
For a list of cloud providers see GET /v3/cloud/provider
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Internal Server Error
For a list of cloud providers see GET /v3/cloud/provider
OK
Invalid credentials
Internal Server Error
For a list of cloud providers see GET /v3/cloud/provider.
In order to use your account for ODP you need to have permissions access, create and control instance templates and instances.
If you are not sure which permissions you need, please contact [email protected].
Cloud provider ID. For a list of cloud providers see GET /v3/cloud/provider
User defined name for the cloud credential
Cloud provider specific authentication params, in json format. API examples
Unix timestamp of when credentials were first stored (informative only)
Unix timestamp of credential last verification time (informative only)
Status of cloud credential
- 0: valid
- 1: invalid
Unix timestamp of invalidation
The reason for invalidation of the cloud credential
Status of a currently in use cloud credential
- 0: inactive
- 1: active
OK
Invalid credentials
Conflict
Unprocessable Entity
Internal Server Error
For a list of cloud providers see GET /v3/cloud/provider
The user defined name for cloud credentials
OK
Invalid credentials
Invalid credentialName
Internal Server Error
The user defined name for cloud credentials.
User defined name for the cloud credential
Status of a cloud credential
- 0: inactive
- 1: active
OK
Invalid credentials
Invalid credentialName
Name already exists
Unprocessable Entity
Internal Server Error
For a list of cloud providers see GET /v3/cloud/provider
The user defined name for cloud credentials.
No Content
Invalid credentials
Invalid credentialName
Internal Server Error
No content
For a list of cloud providers see GET /v3/cloud/provider.
In order to use your account for the One Platform you need to have permissions to access, create and control instance templates and instances.
If you are not sure which permissions you need, please contact [email protected]. This endpoint only validates provided cloud credentials, this action won't create new
cloud credentials for your user (to do so please refer to POST /cloud/configuration/credential)
Cloud provider ID. For a list of cloud providers see GET /v3/cloud/provider
Cloud provider specific authentication params, in json format. API examples
No Content
Invalid credentials
Conflict
Unprocessable Entity
Internal Server Error
No content
Example header and default range: RANGED-DATA:start=0,results=25
OK
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
Invalid credentials
Unprocessable Entity
Internal Server Error
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Internal Server Error
The Id of the deployment profile
OK
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
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)
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)
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
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
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
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)
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)
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
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
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)
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)
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
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)
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)
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
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
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
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
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
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
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
You can filter based on following parameters
- deploymentEnvironmentId
- fleetId
- hostId
- applicationId
- applicationBuildId
- applicationInstanceId
Example header and default range: RANGED-DATA:start=0,results=25
OK
Bad Request
Invalid credentials
Internal Server Error
You can filter based on following parameters
- deploymentEnvironmentId
- fleetId
- deploymentRegionId
- dcLocationId
OK
Bad Request
Invalid credentials
Internal Server Error
You can filter based on following parameters
- deploymentEnvironmentId
- fleetId
- deploymentRegionId
- dcLocationId
Unix timestamp. Filter from time, default value is -1 day
Unix timestamp. Filter to time, default value is now
OK
Bad Request
Invalid credentials
Internal Server Error
Start unix timestamp
End unix timestamp
OK
Error Host not found
Internal Server Error
Start unix timestamp
End unix timestamp
OK
Error Host not found
Internal Server Error
Start unix timestamp
End unix timestamp
OK
Error Host not found
Internal Server Error
Start unix timestamp
End unix timestamp
OK
Error Host not found
Internal Server Error
You can filter based on following parameters
- deploymentEnvironmentId
- fleetId
- deploymentRegionId
- dcLocationId
OK
Bad Request
Invalid credentials
Internal Server Error
You can filter based on following parameters
- deploymentEnvironmentId
- fleetId
- deploymentRegionId
- dcLocationId
Unix timestamp. Filter from time, default value is -1 day
Unix timestamp. Filter to time, default value is now
OK
Bad Request
Invalid credentials
Internal Server Error
You can filter based on following parameters
- deploymentEnvironmentId
- fleetId
Unix timestamp. Filter from time, default value is -1 day
Unix timestamp. Filter to time, default value is now
OK
Invalid credentials
Internal Server Error
You can filter based on following parameters
- deploymentEnvironmentId
- fleetId
OK
Invalid credentials
Internal Server Error
Unix timestamp. Filter from time, default value is -1 day
Unix timestamp. Filter to time, default value is now
OK
Invalid credentials
Internal Server Error
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Internal Server Error
Start unix timestamp
End unix timestamp
OK
Error Application instance not found
Internal Server Error
Start unix timestamp
End unix timestamp
OK
Error Application instance not found
Internal Server Error
You can filter based on following parameters
- deploymentEnvironmentId
- fleetId
- deploymentRegionId
- dcLocationId
OK
Bad Request
Invalid credentials
Internal Server Error
Get the aggregated list of application instance status, according to give date range system will calculate the interval, possible interval options are as follows
- minute
- hour
- day
- month
- 0: Both game and utilities
- 1: Only game (default)
- 2: Only utilities
You can filter based on following parameters
- deploymentEnvironmentId
- fleetId
- deploymentRegionId
- dcLocationId
Unix timestamp. Filter from time, default value is -1 day
Unix timestamp. Filter to time, default value is now
OK
Bad Request
Invalid credentials
Internal Server Error
- 0: Both game and utilities
- 1: Only game (default)
- 2: Only utilities
You can filter based on the following parameters
- deploymentProfileId
OK
Bad Request
Invalid credentials
Internal Server Error
- 0: Both game and utilities
- 1: Only game (default)
- 2: Only utilities
You can filter based on the following parameters
- deploymentEnvironmentId
- fleetId
- deploymentRegionId
- dcLocationId
OK
Bad Request
Invalid credentials
Internal Server Error
Get the aggregated list of application instance status, according to give date range system will calculate the interval, possible interval options are as follows
- minute
- hour
- day
- month
- 0: Both game and utilities
- 1: Only game (default)
- 2: Only utilities
You can filter based on following parameters
- deploymentEnvironmentId
- fleetId
- regionId
- dcLocationId
Unix timestamp. Filter from time, default value is -1 day
Unix timestamp. Filter to time, default value is now
OK
Bad Request
Invalid credentials
Internal Server Error
Get the current distribution of application instances (of type Game) for bare metal, flex metal and cloud
OK
Bad Request
Invalid credentials
Internal Server Error
Get the historic distribution of application instances (of type Game) for bare metal, flex metal and cloud
Get the aggregated list of application instance status, according to give date range system will calculate the interval, possible interval options are as follows
- minute
- hour
- day
Unix timestamp. Filter from time, default value is -1 day
Unix timestamp. Filter to time, default value is now
OK
Bad Request
Invalid credentials
Internal Server Error
Get the aggregated list of application instances (of type Game) for bare metal, flex metal and cloud
OK
Bad Request
Invalid credentials
Internal Server Error
Unix timestamp. Filter from time, default value is -1 day
Unix timestamp. Filter to time, default value is now
OK
Invalid credentials
Internal Server Error
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Internal Server Error
The ID of the build provisioning storage registration for which to fetch the information
OK
Invalid credentials
Invalid id
Internal Server Error
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Internal Server Error
The ID of the build provisioning file for which to fetch the information
OK
Invalid credentials
Invalid id
Internal Server Error
The ID of the build provisioning registration where you want the files of
Example header and default range: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Internal Server Error
Last updated
Was this helpful?