ApplicationInstance
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
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.
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
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 /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
If set to 1, the application instance was manually deployed.
If auto restart is 1 than 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 else 0
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.
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
OK
Status code of an application instance
Application instance status name
Application instance status description
If isDependency=1, status code represent for application instance dependency installer and uninstaller, in case of isDependency=0 status code represents application instance game and utility type
Invalid credentials
Unprocessable Entity
Internal Server Error
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
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.
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
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
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.
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
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.
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
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.
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
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.
Invalid credentials
Invalid applicationInstanceId
Invalid status value
Internal Server Error
The ID of the application instance
OK
Task ID
Task name
The ID of the batch the task belongs to
The ID of the task category. Valid values are:
- 1: game server
The ID of the entity the task is being executed for. E.g. a game server ID (categoryId 1)
Currently active action index - relates to the action index as found in the template.
Unix timestamp indicating the start of execution.
Unix timestamp indicating lastest activity.
Unix timestamp at which the task was finished.
The result of the task. 0: pending, 1: in progress, 2: paused, 125: cancelled, 126: done with error, 127: done
The result of the task in message form.
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
Task ID
Task name
The ID of the batch the task belongs to
The ID of the task category. Valid values are:
- 1: game server
The ID of the entity the task is being executed for. E.g. a game server ID (categoryId 1)
Currently active action index - relates to the action index as found in the template.
Unix timestamp indicating the start of execution.
Unix timestamp indicating lastest activity.
Unix timestamp at which the task was finished.
The result of the task. 0: pending, 1: in progress, 2: paused, 125: cancelled, 126: done with error, 127: done
The result of the task in message form.
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
Task ID
Task name
The ID of the batch the task belongs to
The ID of the task category. Valid values are:
- 1: game server
The ID of the entity the task is being executed for. E.g. a game server ID (categoryId 1)
Currently active action index - relates to the action index as found in the template.
Unix timestamp indicating the start of execution.
Unix timestamp indicating lastest activity.
Unix timestamp at which the task was finished.
The result of the task. 0: pending, 1: in progress, 2: paused, 125: cancelled, 126: done with error, 127: done
The result of the task in message form.
Invalid credentials
Invalid applicationInstanceId
Expectation Failed
Unprocessable Entity
Internal Server Error
The ID of the application instance
An application build ID
OK
Task ID
Task name
The ID of the batch the task belongs to
The ID of the task category. Valid values are:
- 1: game server
The ID of the entity the task is being executed for. E.g. a game server ID (categoryId 1)
Currently active action index - relates to the action index as found in the template.
Unix timestamp indicating the start of execution.
Unix timestamp indicating lastest activity.
Unix timestamp at which the task was finished.
The result of the task. 0: pending, 1: in progress, 2: paused, 125: cancelled, 126: done with error, 127: done
The result of the task in message form.
Invalid credentials
Invalid applicationInstanceId
Expectation Failed
Unprocessable Entity
Internal Server Error
The ID of the application instance
OK
Task ID
Task name
The ID of the batch the task belongs to
The ID of the task category. Valid values are:
- 1: game server
The ID of the entity the task is being executed for. E.g. a game server ID (categoryId 1)
Currently active action index - relates to the action index as found in the template.
Unix timestamp indicating the start of execution.
Unix timestamp indicating lastest activity.
Unix timestamp at which the task was finished.
The result of the task. 0: pending, 1: in progress, 2: paused, 125: cancelled, 126: done with error, 127: done
The result of the task in message form.
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
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.
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
The ID of the deployment region
Amount of allocatable instances for the deployment region
List of application instances ID's
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
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.
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
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
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.
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
ID of Application instance
The application instance's fleet ID
The code given back by the server when the application instance was killed
Log output from the application instances from the server
Timestamp when the log was created
Invalid credentials
Invalid applicationInstanceId
Internal Server Error
Last updated
Was this helpful?