API v3 Error Codes
Error group codes
These error group codes define error categories. Within each category there will be codes for specific errors. These are documented further down this page.
| Range Error code | Error Group |
|---|---|
| 10000 | GENERIC_ERROR |
| 11000 | FORM_ERROR |
| 12000 | CALC_QUOTE_ERROR |
| 13000 | CALC_ERROR |
| 15000 | TICKET_ERROR |
| 17000 | GAME_INSTANCE |
| 18000 | CREATE_GAME_INSTALL_ERROR |
| 21000 | ODP_AGENT_ERROR |
| 22000 | LABELS_ERROR |
| 23000 | TASK_ERROR |
| 24000 | CLOUD_ERROR |
| 25000 | DEPLOYMENT_ENVIRONMENT_ERROR |
| 26000 | FLEET_ERROR |
| 27000 | ASSIGNABLE_FILE_ERROR |
| 28000 | APPLICATION_ERROR |
| 29000 | APPLICATION_PROPERTY_ERROR |
| 30000 | APPLICATION_BUILD_ERROR |
| 31000 | APPLICATION_INSTALL_ERROR |
| 32000 | DEPLOYMENT_PROFILE_ERROR |
| 33000 | DEPLOYMENT_TEMPLATE_ERROR |
| 34000 | APPLICATION_INSTANCE_ERROR |
| 35000 | APPLICATION_DEPLOYMENT_ERROR |
| 36000 | OPERATING_SYSTEM_ERROR |
| 37000 | APPLICATION_BUILD_CONFIGURATION_ERROR |
| 38000 | APPLICATION_BUILD_PROPERTY_ERROR |
| 39000 | HOST_ERROR |
| 40000 | API_LOG_ERROR |
Table 1: Error group codes
Generic
| Error Code | Message |
|---|---|
| 10001 | Entity not found |
| 10002 | No (valid) entity ID provided |
| 10003 | No access to entity |
| 10004 | Unauthenticated / invalid credentials for API request |
| 10005 | You are already logged in |
| 10006 | Unknown API version |
| 10007 | Internal server error |
| 10008 | An invalid parameter was provided |
| 10009 | Entity cannot be deleted due to conflict |
Table 2: Generic error codes
Form Errors Codes
| Error Code | Message |
|---|---|
| 11001 | Errors in form |
| 11002 | File upload(s) expected but not found |
Table 3: Form error codes
Calc Quote
| Error Code | Message |
|---|---|
| 12001 | Error in quote properties |
| 12002 | Error in item quote properties |
| 12003 | Failed to save the quote |
| 12004 | Failed to save the item |
| 12005 | Errors in form |
| 12006 | File upload(s) expected but not found |
| 12007 | File is not pdf |
| 12008 | Only one file expected |
| 12009 | No file found |
| 12010 | Price does not match internally calculated |
| 12011 | Item not found |
| 12020 | Unknown configuration |
Table 4: Calc Quote error codes
Calc
| Error Code | Message |
|---|---|
| 13001 | Unknown configuration |
| 13002 | Error in order properties |
| 13003 | Failed to save the order |
Table 5: Calc error codes
Ticket
| Error Code | Message |
|---|---|
| 15005 | Ticket is permanently closed |
Table 6: Ticket error codes
Game Instance
| Error Code | Message |
|---|---|
| 17001 | Invalid game server ID |
| 17002 | Game server is already running |
| 17003 | Game server is already stopped |
| 17004 | Game server's status cannot be manually set if the process is not running |
| 17005 | Game server's status cannot be manually set to allocated if the process is not online |
| 17006 | Invalid filter query parameter |
Table 7: Game Instance error codes
Create Game Install
| Error Code | Message |
|---|---|
| 18001 | Invalid file ID |
| 18002 | The game executable was not found in the archive |
| 18003 | The archive cannot be handled due an unknown error |
| 18004 | The archive has an unhandled extension, do not know how to process it |
| 18005 | No game found |
| 18006 | No files found |
| 18007 | The file Id is already being used in another application install, the same file cannot be used more than once |
Table 8: Create Game Install error codes
Host Agent
| Error Code | Message |
|---|---|
| 21001 | No ODP agent exists for this hostId please select another host |
Table 9: Host Agent error codes
Label
| Error Code | Message |
|---|---|
| 22001 | Invalid character in query, only AND operator is allowed |
| 22002 | Label must have unique key |
Table 10: Label error codes
Task
| Error Code | Message |
|---|---|
| 23001 | Invalid task template ID |
| 23002 | Invalid task ID |
| 23003 | Task creation is missing a required parameter |
| 23004 | Invalid task action parameter |
| 23005 | Task status cannot be changed (anymore) |
| 23006 | Invalid task batch ID |
Table 11: Task error codes
Cloud
| Error Code | Message |
|---|---|
| 24001 | Unknown cloud provider, find the possible cloud provider in: GET /cloud/provider |
| 24002 | You do not have permissions |
Table 12: Cloud error codes
Deployment Environment
| Error Code | Message |
|---|---|
| 25001 | Cannot delete this deployment environment because it is used in a fleet |
Table 13: Deployment Environment error codes
Fleet
| Error Code | Message |
|---|---|
| 26001 | Cannot delete this fleet, it is already in use |
| 26002 | Host is already reserved |
| 26003 | Only reset if there are no active application instances on this host |
| 26004 | The elements of the fleet are not correctly set to start deploying application instances |
| 26005 | Cannot delete this fleet, if there are active application instances on this fleet |
| 26006 | The host selected does not have that fleetId assigned or the hostId is not correct |
Table 14: Fleet error codes
Application
| Error Code | Message |
|---|---|
| 28001 | The application type can not be changed because the given application is already in use in a game deployment template |
| 28002 | The application type can not be changed because the given application is already in use in a utility deployment template |
Table 15: Application error codes
ApplicationProperty
This element only has ErrorDetails listings and no error codes.
ApplicationBuild
| Error Code | Message |
|---|---|
| 30001 | The application used in the body is of type Game. It needs at least one property of type public network port. You can create this property in: POST /application/{applicationId}/property |
| 30002 | The application used in the body has a management protocol bigger than 0, a property called "managementPort" of type network port is needed, you can create this property in POST /application/{applicationId}/property |
Table 16: ApplicationBuild error codes
DeploymentProfile
This element only has ErrorDetails listings and no error codes.
DeploymentTemplate
| Error Code | Message |
|---|---|
| 33001 | BuildId and NewBuildId cannot be same |
| 33002 | Sum of BuildIdPercentage and NewBuildIdPercentage must be equal to 100 |
| 33003 | Cannot delete the deployment template, it is already in use |
| 33004 | The deployment template name already exists, the name must be unique |
Table 18: DeploymentTemplate error codes
ApplicationInstance
| Error Code | Message |
|---|---|
| 34001 | The selected host is assigned to a different fleet that the one provided, please select another host or the fleet the host has assigned |
| 34002 | The application instance status cannot be manually set if the application instance is not running |
| 34003 | The application instance status cannot be manually set to allocated if the application instance is not online |
Table 19: ApplicationInstance error codes
Application Deployment
This element only has ErrorDetails listings and no error codes.
Operating System
This element only has ErrorDetails listings and no error codes.
ApplicationBuildConfiguration
This element only has ErrorDetails listings and no error codes.
ApplicationBuildProperty
This element only has ErrorDetails listings and no error codes.
Host
This element only has ErrorDetails listings and no error codes.
API Log
This element only has ErrorDetails listings and no error codes.