# Models

## The Application object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"Application":{"type":"object","required":["id","type","managementProtocol","name","createdAt","inUse"],"properties":{"id":{"type":"string","format":"","description":"Application ID","readOnly":true},"type":{"type":"integer","format":"integer","description":"The list of application type can be found in: GET /application/type"},"managementProtocol":{"type":"integer","format":"integer","description":"The protocol used to manage the application (defaults to None when not set):\n* 0: None\n* 1: A2S\n* 2: ARCUS"},"name":{"type":"string","format":"","description":"The public name of your application"},"websiteUrl":{"type":"string","format":"","description":"The url to your application's website"},"description":{"type":"string","format":"","description":"A short description of your application"},"developerName":{"type":"string","format":"","description":"The name of the application's developer"},"publisherName":{"type":"string","format":"","description":"The name of the application's publisher"},"stopDefaultOsGroup":{"type":"integer","format":"integer","description":"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:\n* 1: Windows\n* 2: Linux (default)"},"stopMethod":{"type":"integer","format":"integer","description":"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](game-publisher#/Application/getApplicationStopMethods)"},"stopTimeout":{"type":"integer","format":"integer","description":"The timeout that will be used on restart or destroy of an application instance, in seconds. The default is 0 (no timeout)"},"createdAt":{"type":"integer","format":"integer","description":"UnixTimestamp","readOnly":true},"inUse":{"type":"integer","format":"integer","description":"If the application currently in use or not","readOnly":true}},"additionalProperties":false}}}}
```

## The ApplicationBuild object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationBuild":{"type":"object","required":["id","name","applicationId","type","executable","osId","createdAt","runAsRoot"],"properties":{"id":{"type":"string","format":"","description":"Application build ID","readOnly":true},"name":{"type":"string","format":"","description":"The name of the application build"},"applicationId":{"type":"string","format":"","description":"The ID of the application. May be null if buildProvisioningStorageType is LegacyFTP","nullable":true},"hostCapacityTemplateId":{"type":"string","format":"","description":"The ID of the host capacity template"},"type":{"type":"integer","format":"integer","description":"The application build, list of types can be found in: [GET /application/type](#/Application/get_v3_application_type)","readOnly":true},"executable":{"type":"string","format":"","description":"The executable name including the path originating from the root directory of the software structure"},"startupParameters":{"type":"string","format":"","description":"The startup parameters required for an executable"},"instanceDoesReadyCallback":{"type":"integer","format":"integer","description":"Set to 1 if a deployed application instance will inform the platform it's done with initializing and is ready to\naccept players. Defaults to 0 if not set, which means an instance's status will go directly to ONLINE (4) after starting"},"installId":{"type":"integer","format":"integer","description":"ID of the application install (legacy FTP, will be removed, may not be updated)","deprecated":true},"osId":{"type":"integer","format":"integer","description":"ID of the operating system, list of operating systems can be found in: [GET\n/v3/operatingsystem](all#/OperatingSystem/get_v3_operatingsystem)"},"stopMethod":{"type":"integer","format":"integer","description":"The stop method that will be used on restart or destroy of an application instance. The default is taken from the value of\n[GET /v3/application/stopMethod](game-publisher#/Application/getApplicationStopMethods) - any value submitted here overrides that Application default","nullable":true},"stopTimeout":{"type":"integer","format":"integer","description":"The timeout that will be used on restart or destroy of an application instance. The default is taken from the value of\n`Application.stopTimeout` - any value submitted here overrides that Application default","nullable":true},"createdAt":{"type":"integer","format":"integer","description":"When the application build was created (unix timestamp)","readOnly":true},"label":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"description":"Custom key/value pairs that can be used for application build selection / identification"},"applicationBuildFile":{"allOf":[{"$ref":"#/components/schemas/ApplicationBuildFile"}],"description":"The application build file to be used for the application instance","nullable":true},"buildProvisioningStorageType":{"type":"integer","format":"integer","description":"Type of storage being used [GET\n/v3/buildProvisioning/storage/registration/types](#/BuildProvisioning/getBuildProvisioningStorageRegistrationTypes). Default: 0"},"runAsRoot":{"type":"integer","format":"integer","description":"Controls whether to run this build as root or as a non-privileged user.\nWarning: This currently only works for builds deployed onto a Linux operating system. Windows builds will always run as administrator\n* 0: run as non-privileged user\n* 1: run as root user (default)"}},"additionalProperties":false},"Label":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","format":"","description":"Label key, only hyphens (-), underscores (_), lowercase characters and numbers are allowed. Keys must start with a lowercase character."},"value":{"type":"string","format":"","description":"Label value, maximum length is 150 characters"}},"additionalProperties":false},"ApplicationBuildFile":{"type":"object","required":["id","buildProvisioningFileId","buildProvisioningRegistrationId","fileName","fileSize","version","md5CheckSum","createdAt","changedAt","availableOnCDN"],"properties":{"id":{"type":"string","format":"","description":"Application build file ID","readOnly":true},"buildProvisioningFileId":{"type":"string","format":"","description":"ID of the uploaded file to the i3D.net storage. Cannot be updated once set"},"buildProvisioningRegistrationId":{"type":"string","format":"","description":"ID of the build provisioning registration. Cannot be updated once set"},"fileName":{"type":"string","format":"","description":"Name of the file"},"fileSize":{"type":"integer","format":"integer","description":"Size of the file","readOnly":true},"version":{"type":"string","format":"","description":"Version of the file"},"md5CheckSum":{"type":"string","format":"","description":"MD5 checksum of the file","readOnly":true},"path":{"type":"string","format":"","description":"location of the file"},"domain":{"type":"string","format":"","description":"The domain where the files are stored"},"dockerRepository":{"type":"string","format":"","description":"The docker repository that needs to be used","deprecated":true},"createdAt":{"type":"integer","format":"integer","description":"UNIX timestamp when the application build file has been created","readOnly":true},"changedAt":{"type":"integer","format":"integer","description":"UNIX timestamp when the application build file last has been changed","readOnly":true},"availableOnCDN":{"type":"integer","format":"integer","description":"the file is on the CDN when is 1.","readOnly":true}},"additionalProperties":false,"nullable":true}}}}
```

## The ApplicationBuildConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationBuildConfiguration":{"type":"object","required":["id","configPath","configName","configContent","createdAt"],"properties":{"id":{"type":"string","format":"","description":"Application build configuration ID","readOnly":true},"configPath":{"type":"string","format":"","description":"Configuration file path"},"configName":{"type":"string","format":"","description":"Configuration file name"},"configContent":{"type":"string","format":"","description":"Configuration file contents"},"createdAt":{"type":"integer","format":"integer","description":"UnixTimestamp","readOnly":true}},"additionalProperties":false}}}}
```

## The ApplicationBuildFile object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationBuildFile":{"type":"object","required":["id","buildProvisioningFileId","buildProvisioningRegistrationId","fileName","fileSize","version","md5CheckSum","createdAt","changedAt","availableOnCDN"],"properties":{"id":{"type":"string","format":"","description":"Application build file ID","readOnly":true},"buildProvisioningFileId":{"type":"string","format":"","description":"ID of the uploaded file to the i3D.net storage. Cannot be updated once set"},"buildProvisioningRegistrationId":{"type":"string","format":"","description":"ID of the build provisioning registration. Cannot be updated once set"},"fileName":{"type":"string","format":"","description":"Name of the file"},"fileSize":{"type":"integer","format":"integer","description":"Size of the file","readOnly":true},"version":{"type":"string","format":"","description":"Version of the file"},"md5CheckSum":{"type":"string","format":"","description":"MD5 checksum of the file","readOnly":true},"path":{"type":"string","format":"","description":"location of the file"},"domain":{"type":"string","format":"","description":"The domain where the files are stored"},"dockerRepository":{"type":"string","format":"","description":"The docker repository that needs to be used","deprecated":true},"createdAt":{"type":"integer","format":"integer","description":"UNIX timestamp when the application build file has been created","readOnly":true},"changedAt":{"type":"integer","format":"integer","description":"UNIX timestamp when the application build file last has been changed","readOnly":true},"availableOnCDN":{"type":"integer","format":"integer","description":"the file is on the CDN when is 1.","readOnly":true}},"additionalProperties":false,"nullable":true}}}}
```

## The ApplicationBuildId object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationBuildId":{"type":"object","required":["applicationBuildId"],"properties":{"applicationBuildId":{"type":"string","format":"","description":"An application build ID"}},"additionalProperties":false}}}}
```

## The ApplicationBuildProperty object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationBuildProperty":{"type":"object","required":["id","propertyType","propertyKey","propertyValue"],"properties":{"id":{"type":"string","format":"","description":"The application build property ID","readOnly":true},"propertyType":{"type":"integer","format":"integer","description":"The application build property type. For a list of application property types see\n[`GET /v3/application/property/type`](#/Application/get_v3_application_property_type)","readOnly":true},"propertyKey":{"type":"string","format":"","description":"The application build property key. Only hyphens (-), underscores (_), lowercase characters and numbers are allowed.\nKeys must start with a lowercase character","readOnly":true},"propertyValue":{"type":"string","format":"","description":"The application build property value"}},"additionalProperties":false}}}}
```

## The ApplicationBuildTelemetryHistoryDataModel object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationBuildTelemetryHistoryDataModel":{"type":"object","required":["timestamp","hosts","instances","players"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"Unix timestamp of data","readOnly":true},"hosts":{"type":"integer","format":"integer","description":"The number of hosts"},"instances":{"type":"integer","format":"integer","description":"The number of instances"},"players":{"type":"integer","format":"integer","description":"The number of players"}},"additionalProperties":false}}}}
```

## The ApplicationBuildTelemetryHistoryModel object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationBuildTelemetryHistoryModel":{"type":"object","required":["unit","data"],"properties":{"unit":{"type":"string","format":"","description":"Unit of data frequency,  possible interval options are as follows\n- minute\n- hour\n- day\n- month","readOnly":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationBuildTelemetryHistoryDataModel"},"description":"Average aggregated data of application instances","readOnly":true}},"additionalProperties":false},"ApplicationBuildTelemetryHistoryDataModel":{"type":"object","required":["timestamp","hosts","instances","players"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"Unix timestamp of data","readOnly":true},"hosts":{"type":"integer","format":"integer","description":"The number of hosts"},"instances":{"type":"integer","format":"integer","description":"The number of instances"},"players":{"type":"integer","format":"integer","description":"The number of players"}},"additionalProperties":false}}}}
```

## The ApplicationBuildTelemetryModel object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationBuildTelemetryModel":{"type":"object","required":["hosts","instances","players"],"properties":{"hosts":{"type":"integer","format":"integer","description":"The number of hosts"},"instances":{"type":"integer","format":"integer","description":"The number of instances"},"players":{"type":"integer","format":"integer","description":"The number of players"}},"additionalProperties":false}}}}
```

## The ApplicationInstall object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationInstall":{"type":"object","required":["id","applicationId","applicationType","createdAt","name","version","osGroupId","active","filePath","fileSize","fileSHA256","executableSHA256","status","installHasExe"],"properties":{"id":{"type":"integer","format":"integer","description":"Application install ID","readOnly":true},"applicationId":{"type":"string","format":"","description":"Application install assigned to applicationId"},"applicationType":{"type":"integer","format":"integer","description":"The list of Application types can be found in: GET /application/type","nullable":true},"createdAt":{"type":"integer","format":"integer","description":"Application install created at timestamp","readOnly":true},"name":{"type":"string","format":"","description":"Application install name"},"version":{"type":"string","format":"","description":"Application install version"},"osGroupId":{"type":"integer","format":"integer","description":"Operating system group ID (1 = windows, 2 = linux)"},"active":{"type":"integer","format":"integer","description":"Application install active"},"releaseNotes":{"type":"string","format":"","description":"Application install release notes","nullable":true},"filePath":{"type":"string","format":"","description":"Path of the file on the file server","readOnly":true},"fileSize":{"type":"integer","format":"integer","description":"File size in bytes","readOnly":true},"fileSHA256":{"type":"string","format":"","description":"Archive file SHA-256 hash","readOnly":true},"executableSHA256":{"type":"string","format":"","description":"SHA-256 hash of the executable in the archive","readOnly":true},"status":{"type":"integer","format":"integer","description":"Status of application install.","readOnly":true},"installHasExe":{"type":"integer","format":"integer","description":"Does the archive contain the game instance executable?"}},"additionalProperties":false}}}}
```

## The ApplicationInstance object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationInstance":{"type":"object","required":["id","deploymentEnvironmentId","deploymentEnvironmentName","fleetId","fleetName","hostId","isVirtual","applicationId","applicationName","applicationType","applicationBuildId","applicationBuildName","dcLocationId","dcLocationName","regionId","regionName","status","createdAt","startedAt","stoppedAt","pid","pidChangedAt","startupParams","executable","manuallyDeployed","properties","ipAddress","labelReadOnly","numPlayersMax","numPlayers","liveHostName","liveMap","liveGameVersion","updatedAt","liveRules","autoRestart","markedForDeletion","arcusAvailable"],"properties":{"id":{"type":"string","format":"","description":"Application instance ID","readOnly":true},"deploymentEnvironmentId":{"type":"string","format":"","description":"The deployment environment ID of this application instance","readOnly":true},"deploymentEnvironmentName":{"type":"string","format":"","description":"The deployment environment name of this application instance","readOnly":true},"fleetId":{"type":"string","format":"","description":"The fleet ID of this application instance","readOnly":true},"fleetName":{"type":"string","format":"","description":"The fleet name of this application instance","readOnly":true},"hostId":{"type":"integer","format":"integer","description":"The application instance is host on this server.","readOnly":true},"isVirtual":{"type":"integer","format":"integer","description":"0 if this instance runs on a bare metal server, 1 if it runs on a VM","readOnly":true},"applicationId":{"type":"string","format":"","description":"The application ID of this application instance","readOnly":true},"applicationName":{"type":"string","format":"","description":"The application name of this application instance","readOnly":true},"applicationType":{"type":"integer","format":"integer","description":"The type of the application, the different types can be found in:\n[GET /v3/application/type](game-publisher#/Application/getApplicationTypes)","readOnly":true},"applicationBuildId":{"type":"string","format":"","description":"The application build ID of this application instance","readOnly":true},"applicationBuildName":{"type":"string","format":"","description":"The application build name of this application instance","readOnly":true},"installId":{"type":"string","format":"","description":"ID of the application install","nullable":true,"deprecated":true},"dcLocationId":{"type":"integer","format":"integer","description":"The datacenter ID of where this application instance is located","readOnly":true},"dcLocationName":{"type":"string","format":"","description":"The datacenter name of where this application instance is located","readOnly":true},"regionId":{"type":"string","format":"","description":"The deployment region ID of where this application instance is located","readOnly":true},"regionName":{"type":"string","format":"","description":"The deployment region name of where this application instance is located","readOnly":true},"status":{"type":"integer","format":"integer","description":"The application instance status, list of application instance status can be found in\n[GET /v3/applicationInstance/status](game-publisher#/ApplicationInstance/getApplicationInstanceStatuses)","readOnly":true},"createdAt":{"type":"integer","format":"integer","description":"The Unix timestamp at which this application instance is created","readOnly":true},"startedAt":{"type":"integer","format":"integer","description":"The Unix timestamp at which this application instance is started","readOnly":true},"stoppedAt":{"type":"integer","format":"integer","description":"The Unix timestamp at which this application instance is stopped","readOnly":true},"pid":{"type":"integer","format":"integer","description":"The process ID of the application instance running on the host","readOnly":true},"pidChangedAt":{"type":"integer","format":"integer","description":"The Unix timestamp of the moment the process ID has been changed on the host","readOnly":true},"startupParams":{"type":"string","format":"","description":"The exact startup parameters that were used to start this application instance with all properties resolved to their\nrespective 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\ncleared again","nullable":true,"readOnly":true},"executable":{"type":"string","format":"","description":"The name of the executable that was ran when the application instance started. Will be `null` if the instance has not been\nstarted, but will retain its previous value if it was stopped. Once set it will never be cleared again","nullable":true,"readOnly":true},"manuallyDeployed":{"type":"integer","format":"integer","description":"If set to `1`, the application instance was manually deployed, instead of automatically deployed through the system","readOnly":true},"properties":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationInstanceProperty"},"description":"Properties of application instance","readOnly":true},"ipAddress":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationInstanceIP"},"description":"List of IP addresses for an application instance","readOnly":true},"labelReadOnly":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"description":"Pre-defined key/value pairs that can be used for application selection / identification.\nAvailable labelReadOnly keys are:\n* application_id\n* fleet_id\n* host_id\n* dc_location_id\n* region_id\n* application_build_id","readOnly":true},"labelPublic":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"description":"Custom key/value pairs that can be used for application instance selection / identification"},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/Metadata"},"description":"Custom key/value pairs to be set or adjusted by the allocation call or the application instance itself. This metadata\nwill be passed to the application instance when starting it [needs more clarification]"},"numPlayersMax":{"type":"integer","format":"integer","description":"The maximum number of players on the application instance (this only apply to application instances of the type game)","readOnly":true},"numPlayers":{"type":"integer","format":"integer","description":"The number of online players on the application instance (this only apply to application instances of the type game)","readOnly":true},"liveHostName":{"type":"string","format":"","description":"The live host name of the application instance (this only apply to application instances of the type game)","readOnly":true},"liveMap":{"type":"string","format":"","description":"The live map of an application instance (this only apply to application instances of the type game)","readOnly":true},"liveGameVersion":{"type":"string","format":"","description":"The live game version of an application instance (this only apply to application instances of the type game)","readOnly":true},"updatedAt":{"type":"integer","format":"integer","description":"The Unix timestamp at which this application instance is live data is updated (this only apply to application instances of the type game)","readOnly":true},"liveRules":{"type":"string","format":"","description":"The live rules of an application instance (this only apply to application instances of the type game)","readOnly":true},"autoRestart":{"type":"integer","format":"integer","description":"If auto restart is `1` then the application instance will auto restart, when `0` the application instance auto restart will be disabled","readOnly":true},"markedForDeletion":{"type":"integer","format":"integer","description":"If an application will be deleted it will be `1`, `0` otherwise","readOnly":true},"arcusAvailable":{"type":"integer","format":"integer","description":"`1` if Arcus is available & running for this application instance, `0` otherwise.\nNote: If your application's `managementProtocol` is NOT set to Arcus, this value will always be `0`, even if your\ngame server would support the Arcus protocol. The protocol is only tested, and this value potentially be set to `1`,\nwhen the `managementProtocol` is set to Arcus.","readOnly":true}},"additionalProperties":false},"ApplicationInstanceProperty":{"type":"object","required":["id","propertyType","propertyKey","propertyValue"],"properties":{"id":{"type":"string","format":"","description":"The application instance property ID","readOnly":true},"propertyType":{"type":"integer","format":"integer","description":"The application instance property type. For a list of application property types see\n[`GET /v3/application/property/type`](#/Application/get_v3_application_property_type)","readOnly":true},"propertyKey":{"type":"string","format":"","description":"The application instance property key. Only hyphens (-), underscores (_), lowercase characters and numbers are allowed.\nKeys must start with a lowercase character"},"propertyValue":{"type":"string","format":"","description":"The application instance property value"}},"additionalProperties":false},"ApplicationInstanceIP":{"type":"object","required":["ipAddress","ipVersion","private"],"properties":{"ipAddress":{"type":"string","format":"","description":"Application instance IP address"},"ipVersion":{"type":"integer","format":"integer","description":"Application instance IP version","readOnly":true},"private":{"type":"integer","format":"integer","description":"If application instance has private ip address.","readOnly":true}},"additionalProperties":false},"Label":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","format":"","description":"Label key, only hyphens (-), underscores (_), lowercase characters and numbers are allowed. Keys must start with a lowercase character."},"value":{"type":"string","format":"","description":"Label value, maximum length is 150 characters"}},"additionalProperties":false},"Metadata":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","format":"","description":"Metadata key. Max length 50 characters"},"value":{"type":"string","format":"","description":"Metadata value. Max length 2048 bytes"}},"additionalProperties":false}}}}
```

## The ApplicationInstanceByRegion object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationInstanceByRegion":{"type":"object","required":["regionId","allocatableInstances","applicationInstances"],"properties":{"regionId":{"type":"string","format":"","description":"The ID of the deployment region","readOnly":true},"allocatableInstances":{"type":"integer","format":"integer","description":"Amount of allocatable instances for the deployment region","readOnly":true},"applicationInstances":{"type":"array","items":{"type":"string","format":""},"description":"List of application instances ID's","readOnly":true}},"additionalProperties":false}}}}
```

## The ApplicationInstanceConfiguration object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationInstanceConfiguration":{"type":"object","required":["id","applicationInstanceId","applicationBuildConfigurationId","configPath","configName","configContent","updatedAt","active"],"properties":{"id":{"type":"string","format":"","description":"The ID of the application instance configuration","readOnly":true},"applicationInstanceId":{"type":"string","format":"","description":"The ID of the application instance","readOnly":true},"applicationBuildConfigurationId":{"type":"string","format":"","description":"The ID of the application build configuration","readOnly":true},"configPath":{"type":"string","format":"","description":"Path of the configuration","readOnly":true},"configName":{"type":"string","format":"","description":"Name of the configuration","readOnly":true},"configContent":{"type":"string","format":"","description":"Content of the configuration","readOnly":true},"updatedAt":{"type":"integer","format":"integer","description":"UnixTimestamp","readOnly":true},"active":{"type":"integer","format":"integer","description":"Status of the application instance configuration","readOnly":true}},"additionalProperties":false}}}}
```

## The ApplicationInstanceCpuDataTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationInstanceCpuDataTelemetry":{"type":"object","required":["timestamp","cpu"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The time at which the last update occurred","readOnly":true},"cpu":{"type":"integer","format":"integer","description":"Percentage of cpu used across all cores","readOnly":true}},"additionalProperties":false}}}}
```

## The ApplicationInstanceCpuTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationInstanceCpuTelemetry":{"type":"object","required":["unit","data"],"properties":{"unit":{"type":"string","format":"","description":"Unit of data frequency, which is always `null` in this endpoint. This property is there\nfor consistency across all telemetry endpoints. It's `null` because the data is not aggregated","readOnly":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationInstanceCpuDataTelemetry"},"description":"Contains the data object","readOnly":true}},"additionalProperties":false},"ApplicationInstanceCpuDataTelemetry":{"type":"object","required":["timestamp","cpu"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The time at which the last update occurred","readOnly":true},"cpu":{"type":"integer","format":"integer","description":"Percentage of cpu used across all cores","readOnly":true}},"additionalProperties":false}}}}
```

## The ApplicationInstanceCrashDataTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationInstanceCrashDataTelemetry":{"type":"object","required":["timestamp","crashes"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"Timestamp of the data","readOnly":true},"crashes":{"type":"integer","format":"integer","description":"The number of crashes of application instances","readOnly":true}},"additionalProperties":false}}}}
```

## The ApplicationInstanceCrashTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationInstanceCrashTelemetry":{"type":"object","required":["unit","data"],"properties":{"unit":{"type":"string","format":"","description":"Unit of data frequency","readOnly":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationInstanceCrashDataTelemetry"},"description":"Contains the data object by host type","readOnly":true}},"additionalProperties":false},"ApplicationInstanceCrashDataTelemetry":{"type":"object","required":["timestamp","crashes"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"Timestamp of the data","readOnly":true},"crashes":{"type":"integer","format":"integer","description":"The number of crashes of application instances","readOnly":true}},"additionalProperties":false}}}}
```

## The ApplicationInstanceDeploymentProfileStatusDataTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationInstanceDeploymentProfileStatusDataTelemetry":{"type":"object","required":["timestamp","deploymentProfiles"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"Unix timestamp of the data","readOnly":true},"deploymentProfiles":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationInstanceDeploymentProfileStatusDeploymentProfileTelemetry"},"description":"Contains the deployment profiles","readOnly":true}},"additionalProperties":false},"ApplicationInstanceDeploymentProfileStatusDeploymentProfileTelemetry":{"type":"object","required":["deploymentProfileId","setup","offline","starting","online","allocated","deploymentRegions"],"properties":{"deploymentProfileId":{"type":"string","format":"","description":"The ID of the deployment profile","readOnly":true},"setup":{"type":"integer","format":"integer","description":"Average number of application instances with setup status","readOnly":true},"offline":{"type":"integer","format":"integer","description":"Average number of application instances with offline status","readOnly":true},"starting":{"type":"integer","format":"integer","description":"Average number of application instances with starting status","readOnly":true},"online":{"type":"integer","format":"integer","description":"Average number of application instances with online status","readOnly":true},"allocated":{"type":"integer","format":"integer","description":"Average number of application instances with allocated status","readOnly":true},"deploymentRegions":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationInstanceDeploymentProfileStatusDeploymentRegionTelemetry"},"description":"Contains the deployment regions","readOnly":true}},"additionalProperties":false},"ApplicationInstanceDeploymentProfileStatusDeploymentRegionTelemetry":{"type":"object","required":["deploymentRegionId","setup","offline","starting","online","allocated"],"properties":{"deploymentRegionId":{"type":"string","format":"","description":"The ID of the deployment region","readOnly":true},"setup":{"type":"integer","format":"integer","description":"Average number of application instances with setup status","readOnly":true},"offline":{"type":"integer","format":"integer","description":"Average number of application instances with offline status","readOnly":true},"starting":{"type":"integer","format":"integer","description":"Average number of application instances with starting status","readOnly":true},"online":{"type":"integer","format":"integer","description":"Average number of application instances with online status","readOnly":true},"allocated":{"type":"integer","format":"integer","description":"Average number of application instances with allocated status","readOnly":true}},"additionalProperties":false}}}}
```

## The ApplicationInstanceDeploymentProfileStatusDeploymentProfileTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationInstanceDeploymentProfileStatusDeploymentProfileTelemetry":{"type":"object","required":["deploymentProfileId","setup","offline","starting","online","allocated","deploymentRegions"],"properties":{"deploymentProfileId":{"type":"string","format":"","description":"The ID of the deployment profile","readOnly":true},"setup":{"type":"integer","format":"integer","description":"Average number of application instances with setup status","readOnly":true},"offline":{"type":"integer","format":"integer","description":"Average number of application instances with offline status","readOnly":true},"starting":{"type":"integer","format":"integer","description":"Average number of application instances with starting status","readOnly":true},"online":{"type":"integer","format":"integer","description":"Average number of application instances with online status","readOnly":true},"allocated":{"type":"integer","format":"integer","description":"Average number of application instances with allocated status","readOnly":true},"deploymentRegions":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationInstanceDeploymentProfileStatusDeploymentRegionTelemetry"},"description":"Contains the deployment regions","readOnly":true}},"additionalProperties":false},"ApplicationInstanceDeploymentProfileStatusDeploymentRegionTelemetry":{"type":"object","required":["deploymentRegionId","setup","offline","starting","online","allocated"],"properties":{"deploymentRegionId":{"type":"string","format":"","description":"The ID of the deployment region","readOnly":true},"setup":{"type":"integer","format":"integer","description":"Average number of application instances with setup status","readOnly":true},"offline":{"type":"integer","format":"integer","description":"Average number of application instances with offline status","readOnly":true},"starting":{"type":"integer","format":"integer","description":"Average number of application instances with starting status","readOnly":true},"online":{"type":"integer","format":"integer","description":"Average number of application instances with online status","readOnly":true},"allocated":{"type":"integer","format":"integer","description":"Average number of application instances with allocated status","readOnly":true}},"additionalProperties":false}}}}
```

## The ApplicationInstanceDeploymentProfileStatusDeploymentRegionTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationInstanceDeploymentProfileStatusDeploymentRegionTelemetry":{"type":"object","required":["deploymentRegionId","setup","offline","starting","online","allocated"],"properties":{"deploymentRegionId":{"type":"string","format":"","description":"The ID of the deployment region","readOnly":true},"setup":{"type":"integer","format":"integer","description":"Average number of application instances with setup status","readOnly":true},"offline":{"type":"integer","format":"integer","description":"Average number of application instances with offline status","readOnly":true},"starting":{"type":"integer","format":"integer","description":"Average number of application instances with starting status","readOnly":true},"online":{"type":"integer","format":"integer","description":"Average number of application instances with online status","readOnly":true},"allocated":{"type":"integer","format":"integer","description":"Average number of application instances with allocated status","readOnly":true}},"additionalProperties":false}}}}
```

## The ApplicationInstanceDeploymentProfileStatusTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationInstanceDeploymentProfileStatusTelemetry":{"type":"object","required":["unit","data"],"properties":{"unit":{"type":"string","format":"","description":"Unit of data frequency, which is always `null` in this endpoint. This property is there\nfor consistency across all telemetry endpoints. It's `null` because the data is not aggregated","nullable":true,"readOnly":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationInstanceDeploymentProfileStatusDataTelemetry"},"description":"Contains the data object by host type","readOnly":true}},"additionalProperties":false},"ApplicationInstanceDeploymentProfileStatusDataTelemetry":{"type":"object","required":["timestamp","deploymentProfiles"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"Unix timestamp of the data","readOnly":true},"deploymentProfiles":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationInstanceDeploymentProfileStatusDeploymentProfileTelemetry"},"description":"Contains the deployment profiles","readOnly":true}},"additionalProperties":false},"ApplicationInstanceDeploymentProfileStatusDeploymentProfileTelemetry":{"type":"object","required":["deploymentProfileId","setup","offline","starting","online","allocated","deploymentRegions"],"properties":{"deploymentProfileId":{"type":"string","format":"","description":"The ID of the deployment profile","readOnly":true},"setup":{"type":"integer","format":"integer","description":"Average number of application instances with setup status","readOnly":true},"offline":{"type":"integer","format":"integer","description":"Average number of application instances with offline status","readOnly":true},"starting":{"type":"integer","format":"integer","description":"Average number of application instances with starting status","readOnly":true},"online":{"type":"integer","format":"integer","description":"Average number of application instances with online status","readOnly":true},"allocated":{"type":"integer","format":"integer","description":"Average number of application instances with allocated status","readOnly":true},"deploymentRegions":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationInstanceDeploymentProfileStatusDeploymentRegionTelemetry"},"description":"Contains the deployment regions","readOnly":true}},"additionalProperties":false},"ApplicationInstanceDeploymentProfileStatusDeploymentRegionTelemetry":{"type":"object","required":["deploymentRegionId","setup","offline","starting","online","allocated"],"properties":{"deploymentRegionId":{"type":"string","format":"","description":"The ID of the deployment region","readOnly":true},"setup":{"type":"integer","format":"integer","description":"Average number of application instances with setup status","readOnly":true},"offline":{"type":"integer","format":"integer","description":"Average number of application instances with offline status","readOnly":true},"starting":{"type":"integer","format":"integer","description":"Average number of application instances with starting status","readOnly":true},"online":{"type":"integer","format":"integer","description":"Average number of application instances with online status","readOnly":true},"allocated":{"type":"integer","format":"integer","description":"Average number of application instances with allocated status","readOnly":true}},"additionalProperties":false}}}}
```

## The ApplicationInstanceHostCapacityTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationInstanceHostCapacityTelemetry":{"type":"object","required":["bareMetal","flexMetal","cloud"],"properties":{"bareMetal":{"type":"integer","format":"integer","description":"Percentage of game instances on the bare metal, based on the amount set in the host capacity template","readOnly":true},"flexMetal":{"type":"integer","format":"integer","description":"Percentage of game instances on the flex metal, based on the amount set in the host capacity template","readOnly":true},"cloud":{"type":"integer","format":"integer","description":"Percentage of game instances in the cloud, based on the amount set in the host capacity template","readOnly":true}},"additionalProperties":false}}}}
```

## The ApplicationInstanceIP object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationInstanceIP":{"type":"object","required":["ipAddress","ipVersion","private"],"properties":{"ipAddress":{"type":"string","format":"","description":"Application instance IP address"},"ipVersion":{"type":"integer","format":"integer","description":"Application instance IP version","readOnly":true},"private":{"type":"integer","format":"integer","description":"If application instance has private ip address.","readOnly":true}},"additionalProperties":false}}}}
```

## The ApplicationInstanceLogModel object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationInstanceLogModel":{"type":"object","required":["applicationInstanceId","fleetId","exitCode","stdOutLog","createdAt"],"properties":{"applicationInstanceId":{"type":"string","format":"","description":"ID of Application instance","readOnly":true},"fleetId":{"type":"string","format":"","description":"The application instance's fleet ID","readOnly":true},"exitCode":{"type":"integer","format":"integer","description":"The code given back by the server when the application instance was killed","readOnly":true},"stdOutLog":{"type":"string","format":"","description":"Log output from the application instances from the server","readOnly":true},"createdAt":{"type":"integer","format":"integer","description":"Timestamp when the log was created","readOnly":true}},"additionalProperties":false}}}}
```

## The ApplicationInstanceMemoryDataTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationInstanceMemoryDataTelemetry":{"type":"object","required":["timestamp","memUsed"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The time at which the last update occurred","readOnly":true},"memUsed":{"type":"integer","format":"integer","description":"The amount of memory that is used by the ApplicationInstance (in megabytes)","readOnly":true}},"additionalProperties":false}}}}
```

## The ApplicationInstanceMemoryTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationInstanceMemoryTelemetry":{"type":"object","required":["unit","data"],"properties":{"unit":{"type":"string","format":"","description":"Unit of data frequency, which is always `null` in this endpoint. This property is there\nfor consistency across all telemetry endpoints. It's `null` because the data is not aggregated","readOnly":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationInstanceMemoryDataTelemetry"},"description":"Contains the data object","readOnly":true}},"additionalProperties":false},"ApplicationInstanceMemoryDataTelemetry":{"type":"object","required":["timestamp","memUsed"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The time at which the last update occurred","readOnly":true},"memUsed":{"type":"integer","format":"integer","description":"The amount of memory that is used by the ApplicationInstance (in megabytes)","readOnly":true}},"additionalProperties":false}}}}
```

## The ApplicationInstanceProperty object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationInstanceProperty":{"type":"object","required":["id","propertyType","propertyKey","propertyValue"],"properties":{"id":{"type":"string","format":"","description":"The application instance property ID","readOnly":true},"propertyType":{"type":"integer","format":"integer","description":"The application instance property type. For a list of application property types see\n[`GET /v3/application/property/type`](#/Application/get_v3_application_property_type)","readOnly":true},"propertyKey":{"type":"string","format":"","description":"The application instance property key. Only hyphens (-), underscores (_), lowercase characters and numbers are allowed.\nKeys must start with a lowercase character"},"propertyValue":{"type":"string","format":"","description":"The application instance property value"}},"additionalProperties":false}}}}
```

## The ApplicationInstanceStatus object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationInstanceStatus":{"type":"object","required":["statusId","statusDescription","description","isDependency"],"properties":{"statusId":{"type":"integer","format":"integer","description":"Status code of an application instance","readOnly":true},"statusDescription":{"type":"string","format":"","description":"Application instance status name","readOnly":true},"description":{"type":"string","format":"","description":"Application instance status description","readOnly":true},"isDependency":{"type":"integer","format":"integer","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","readOnly":true}},"additionalProperties":false}}}}
```

## The ApplicationInstanceStatusDataTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationInstanceStatusDataTelemetry":{"type":"object","required":["timestamp","setup","offline","starting","online","allocated"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The timestamp on which data is calculated","readOnly":true},"setup":{"type":"integer","format":"integer","description":"Average number of application instances with setup status","readOnly":true},"offline":{"type":"integer","format":"integer","description":"Average number of application instances with offline status","readOnly":true},"starting":{"type":"integer","format":"integer","description":"Average number of application instances with starting status","readOnly":true},"online":{"type":"integer","format":"integer","description":"Average number of application instances with online status","readOnly":true},"allocated":{"type":"integer","format":"integer","description":"Average number of application instances with allocated status","readOnly":true}},"additionalProperties":false}}}}
```

## The ApplicationInstanceStatusTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationInstanceStatusTelemetry":{"type":"object","required":["unit","data"],"properties":{"unit":{"type":"string","format":"","description":"Unit of data frequency, possible interval options are as follows\n- minute\n- hour\n- day\n- week","readOnly":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationInstanceStatusDataTelemetry"},"description":"Average aggregated data of application status","readOnly":true}},"additionalProperties":false},"ApplicationInstanceStatusDataTelemetry":{"type":"object","required":["timestamp","setup","offline","starting","online","allocated"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The timestamp on which data is calculated","readOnly":true},"setup":{"type":"integer","format":"integer","description":"Average number of application instances with setup status","readOnly":true},"offline":{"type":"integer","format":"integer","description":"Average number of application instances with offline status","readOnly":true},"starting":{"type":"integer","format":"integer","description":"Average number of application instances with starting status","readOnly":true},"online":{"type":"integer","format":"integer","description":"Average number of application instances with online status","readOnly":true},"allocated":{"type":"integer","format":"integer","description":"Average number of application instances with allocated status","readOnly":true}},"additionalProperties":false}}}}
```

## The ApplicationInstanceStopMethod object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationInstanceStopMethod":{"type":"object","properties":{"methodId":{"type":"integer","format":"integer","description":"Stop method type, list of types can be found in: [GET /v3/application/stopMethod](game-publisher#/Application/getApplicationStopMethods)"},"timeout":{"type":"integer","format":"integer","description":"Stop method timeout in seconds, default value is 1800 seconds."}},"additionalProperties":false}}}}
```

## The ApplicationInstanceSummary object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationInstanceSummary":{"type":"object","required":["id","deploymentEnvironmentId","deploymentEnvironmentName","fleetId","fleetName","hostId","isVirtual","applicationId","applicationName","applicationType","applicationBuildId","applicationBuildName","dcLocationId","dcLocationName","regionId","regionName","status","createdAt","startedAt","stoppedAt","pid","pidChangedAt","manuallyDeployed","autoRestart","markedForDeletion","arcusAvailable"],"properties":{"id":{"type":"string","format":"","description":"Application instance ID","readOnly":true},"deploymentEnvironmentId":{"type":"string","format":"","description":"The deployment environment ID of this application instance","readOnly":true},"deploymentEnvironmentName":{"type":"string","format":"","description":"The deployment environment name of this application instance","readOnly":true},"fleetId":{"type":"string","format":"","description":"The fleet ID of this application instance","readOnly":true},"fleetName":{"type":"string","format":"","description":"The fleet name of this application instance","readOnly":true},"hostId":{"type":"integer","format":"integer","description":"The application instance is host on this server.","readOnly":true},"isVirtual":{"type":"integer","format":"integer","description":"0 if this instance runs on a bare metal server, 1 if it runs on a VM","readOnly":true},"applicationId":{"type":"string","format":"","description":"The application ID of this application instance","readOnly":true},"applicationName":{"type":"string","format":"","description":"The application name of this application instance","readOnly":true},"applicationType":{"type":"integer","format":"integer","description":"The type of the application, the different types can be found in:  GET /application/type","readOnly":true},"applicationBuildId":{"type":"string","format":"","description":"The application build ID of this application instance","readOnly":true},"applicationBuildName":{"type":"string","format":"","description":"The application build name of this application instance","readOnly":true},"installId":{"type":"string","format":"","description":"ID of the application install","nullable":true,"deprecated":true},"dcLocationId":{"type":"integer","format":"integer","description":"The datacenter ID of where this application instance is located","readOnly":true},"dcLocationName":{"type":"string","format":"","description":"The datacenter name of where this application instance is located","readOnly":true},"regionId":{"type":"string","format":"","description":"The deployment region ID of where this application instance is located","readOnly":true},"regionName":{"type":"string","format":"","description":"The deployment region name of where this application instance is located","readOnly":true},"status":{"type":"integer","format":"integer","description":"The application instance status, list of application instance status can be found in [`GET /v3/applicationInstance/status`](game-publisher#/ApplicationInstance/get_v3_applicationInstance_status)","readOnly":true},"createdAt":{"type":"integer","format":"integer","description":"The Unix timestamp at which this application instance is created","readOnly":true},"startedAt":{"type":"integer","format":"integer","description":"The Unix timestamp at which this application instance is started","readOnly":true},"stoppedAt":{"type":"integer","format":"integer","description":"The Unix timestamp at which this application instance is stopped","readOnly":true},"pid":{"type":"integer","format":"integer","description":"The process ID of the application instance running on the host","readOnly":true},"pidChangedAt":{"type":"integer","format":"integer","description":"The Unix timestamp of the moment the process ID has been changed on the host","readOnly":true},"manuallyDeployed":{"type":"integer","format":"integer","description":"If set to 1, the application instance was manually deployed.","readOnly":true},"autoRestart":{"type":"integer","format":"integer","description":"If auto restart is 1 than the application instance will auto restart, when 0 the application instance auto restart will be disabled","readOnly":true},"markedForDeletion":{"type":"integer","format":"integer","description":"if an application will be deleted it will be 1 else 0","readOnly":true},"arcusAvailable":{"type":"integer","format":"integer","description":"`1` if Arcus is available & running for this application instance, `0` otherwise.\nNote: If your application's `managementProtocol` is NOT set to Arcus, this value will always be `0`, even if your\ngame server would support the Arcus protocol. The protocol is only tested, and this value potentially be set to `1`,\nwhen the `managementProtocol` is set to Arcus.","readOnly":true}},"additionalProperties":false}}}}
```

## The ApplicationInstanceTaskCreate object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationInstanceTaskCreate":{"type":"object","required":["taskTemplateId"],"properties":{"taskTemplateId":{"type":"string","format":"","description":"Task template ID, as seen in GET /applicationInstance/task/template"},"applicationInstanceIds":{"type":"array","items":{"type":"string","format":""},"description":"Array of application instance IDs to create the tasks for"},"fleetId":{"type":"string","format":"","description":"If > 0, we gather all game server IDs for this fleet and add those to the gameServerIds property"},"regionId":{"type":"string","format":"","description":"If > 0, we gather all game server IDs for this region and add those to the gameServerIds property"},"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"description":"Optionally select game servers by label key/value pairs."},"executeAt":{"type":"integer","format":"integer","description":"A unix timestamp indicating the time at which to execute the task (to schedule tasks for future execution)"},"taskActionParam":{"type":"array","items":{"$ref":"#/components/schemas/TaskTemplateActionParameters"},"description":"The list of required action parameters for a template. See the task templates (/applicationInstance/task/template) end point for more information."}},"additionalProperties":false},"Label":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","format":"","description":"Label key, only hyphens (-), underscores (_), lowercase characters and numbers are allowed. Keys must start with a lowercase character."},"value":{"type":"string","format":"","description":"Label value, maximum length is 150 characters"}},"additionalProperties":false},"TaskTemplateActionParameters":{"type":"object","required":["paramName","paramValue"],"properties":{"paramName":{"type":"string","format":"","description":"Name of required parameters by task template."},"paramValue":{"type":"string","format":"","description":"Value of required parameters."}},"additionalProperties":false}}}}
```

## The ApplicationInstancesDataProviderTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationInstancesDataProviderTelemetry":{"type":"object","required":["providerId","applicationInstanceCount"],"properties":{"providerId":{"type":"integer","format":"integer","description":"Cloud provider ID. For a list of cloud providers see [`GET /v3/cloud/provider`](#/Cloud/get_v3_cloud_provider)","readOnly":true},"applicationInstanceCount":{"type":"integer","format":"integer","description":"Number of application instances","readOnly":true}},"additionalProperties":false}}}}
```

## The ApplicationInstancesDataTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationInstancesDataTelemetry":{"type":"object","required":["timestamp","applicationInstances"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The timestamp on which data is calculated","readOnly":true},"applicationInstances":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationInstancesDataProviderTelemetry"},"description":"List of application instances","readOnly":true}},"additionalProperties":false},"ApplicationInstancesDataProviderTelemetry":{"type":"object","required":["providerId","applicationInstanceCount"],"properties":{"providerId":{"type":"integer","format":"integer","description":"Cloud provider ID. For a list of cloud providers see [`GET /v3/cloud/provider`](#/Cloud/get_v3_cloud_provider)","readOnly":true},"applicationInstanceCount":{"type":"integer","format":"integer","description":"Number of application instances","readOnly":true}},"additionalProperties":false}}}}
```

## The ApplicationInstancesTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationInstancesTelemetry":{"type":"object","required":["unit","data"],"properties":{"unit":{"type":"string","format":"","description":"Unit of data frequency,  possible interval options are as follows\n- minute\n- hour\n- day\n- week","readOnly":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationInstancesDataTelemetry"},"description":"Average aggregated data of application instances","readOnly":true}},"additionalProperties":false},"ApplicationInstancesDataTelemetry":{"type":"object","required":["timestamp","applicationInstances"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The timestamp on which data is calculated","readOnly":true},"applicationInstances":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationInstancesDataProviderTelemetry"},"description":"List of application instances","readOnly":true}},"additionalProperties":false},"ApplicationInstancesDataProviderTelemetry":{"type":"object","required":["providerId","applicationInstanceCount"],"properties":{"providerId":{"type":"integer","format":"integer","description":"Cloud provider ID. For a list of cloud providers see [`GET /v3/cloud/provider`](#/Cloud/get_v3_cloud_provider)","readOnly":true},"applicationInstanceCount":{"type":"integer","format":"integer","description":"Number of application instances","readOnly":true}},"additionalProperties":false}}}}
```

## The ApplicationOSStopMethods object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationOSStopMethods":{"type":"object","required":["linux","windows"],"properties":{"linux":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationStopMethod"},"description":"Stop methods for Linux.","readOnly":true},"windows":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationStopMethod"},"description":"Stop methods for Windows.","readOnly":true}},"additionalProperties":false},"ApplicationStopMethod":{"type":"object","required":["id","description"],"properties":{"id":{"type":"integer","format":"integer","description":"Stop method identifier","readOnly":true},"description":{"type":"string","format":"","description":"Stop method identifier","readOnly":true}},"additionalProperties":false}}}}
```

## The ApplicationProperty object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationProperty":{"type":"object","required":["id","propertyType","propertyKey"],"properties":{"id":{"type":"string","format":"","description":"The application property ID","readOnly":true},"propertyType":{"type":"integer","format":"integer","description":"The application property type. For a list of application property types see\n[`GET /v3/application/property/type`](#/Application/get_v3_application_property_type)"},"propertyKey":{"type":"string","format":"","description":"The application property key. Only hyphens (-), underscores (_), lowercase characters and numbers are allowed.\nKeys must start with a lowercase character"},"propertyValue":{"type":"string","format":"","description":"The application property value"}},"additionalProperties":false}}}}
```

## The ApplicationPropertyType object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationPropertyType":{"type":"object","required":["typeId","typeDescription"],"properties":{"typeId":{"type":"integer","format":"integer","description":"Application type ID","readOnly":true},"typeDescription":{"type":"string","format":"","description":"Application type description","readOnly":true}},"additionalProperties":false}}}}
```

## The ApplicationStopMethod object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationStopMethod":{"type":"object","required":["id","description"],"properties":{"id":{"type":"integer","format":"integer","description":"Stop method identifier","readOnly":true},"description":{"type":"string","format":"","description":"Stop method identifier","readOnly":true}},"additionalProperties":false}}}}
```

## The ApplicationTelemetryHistoryDataModel object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationTelemetryHistoryDataModel":{"type":"object","required":["timestamp","hosts","instances","players"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"Unix timestamp of data","readOnly":true},"hosts":{"type":"integer","format":"integer","description":"The number of hosts"},"instances":{"type":"integer","format":"integer","description":"The number of instances"},"players":{"type":"integer","format":"integer","description":"The number of players"}},"additionalProperties":false}}}}
```

## The ApplicationTelemetryHistoryModel object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationTelemetryHistoryModel":{"type":"object","required":["unit","data"],"properties":{"unit":{"type":"string","format":"","description":"Unit of data frequency,  possible interval options are as follows\n- minute\n- hour\n- day\n- month","readOnly":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationTelemetryHistoryDataModel"},"description":"Average aggregated data of application instances","readOnly":true}},"additionalProperties":false},"ApplicationTelemetryHistoryDataModel":{"type":"object","required":["timestamp","hosts","instances","players"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"Unix timestamp of data","readOnly":true},"hosts":{"type":"integer","format":"integer","description":"The number of hosts"},"instances":{"type":"integer","format":"integer","description":"The number of instances"},"players":{"type":"integer","format":"integer","description":"The number of players"}},"additionalProperties":false}}}}
```

## The ApplicationTelemetryModel object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationTelemetryModel":{"type":"object","required":["hosts","instances","players"],"properties":{"hosts":{"type":"integer","format":"integer","description":"The number of hosts"},"instances":{"type":"integer","format":"integer","description":"The number of instances"},"players":{"type":"integer","format":"integer","description":"The number of players"}},"additionalProperties":false}}}}
```

## The ApplicationType object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ApplicationType":{"type":"object","required":["typeId","typeDescription"],"properties":{"typeId":{"type":"integer","format":"integer","description":"Application type ID","readOnly":true},"typeDescription":{"type":"string","format":"","description":"Application type description","readOnly":true}},"additionalProperties":false}}}}
```

## The AssignableFile object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"AssignableFile":{"type":"object","required":["id","fileName","fileSize","fileSHA256","status","statusText"],"properties":{"id":{"type":"integer","format":"integer","description":"ID of the file","readOnly":true},"fileName":{"type":"string","format":"","description":"Name of the file","readOnly":true},"fileSize":{"type":"integer","format":"integer","description":"Size in bytes of the file","readOnly":true},"fileSHA256":{"type":"string","format":"","description":"Archive file SHA-256 hash","readOnly":true},"status":{"type":"integer","format":"integer","description":"Status of this file, options:\n- 0: no status.\n- 1: new file discovered on FTP account.\n- 2: new file on FTP account has been scanned and added to collection.\n- 3: application install details have been provided.\n- 4: transferring the original archive to the main file server.\n- 5: finished transferring the original archive to the main file server.\n- 6: re-packing the original archive.\n- 7: finished re-packing the original archive.\n- 10: creating a hash of the new archive.\n- 11: deploying the final archive to all relevant file servers.\n- 12: deploying the final archive to all relevant file servers\n- 13: finished deploying the final archive to all relevant file servers.\n- 14: activated the game install.\n- 125: cancelled.\n- 126: cancelled and cleaned up.\n- 127: the application install creation process has finished.\n- 128: a permanent error has been encountered.","readOnly":true},"statusText":{"type":"string","format":"","description":"Status in text of this file","readOnly":true}},"additionalProperties":false}}}}
```

## The BuildProvisioningFile object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"BuildProvisioningFile":{"type":"object","required":["id","buildProvisionRegistrationId","fileName","fileSize","md5CheckSum","createdAt","changedAt"],"properties":{"id":{"type":"string","format":"","description":"Build provisioning file ID","readOnly":true},"buildProvisionRegistrationId":{"type":"string","format":"","description":"ID of the build provisioning storage registration","readOnly":true},"fileName":{"type":"string","format":"","description":"Name of the file","readOnly":true},"fileSize":{"type":"integer","format":"integer","description":"Size of the file","readOnly":true},"md5CheckSum":{"type":"string","format":"","description":"MD5 checksum of the file","readOnly":true},"createdAt":{"type":"integer","format":"integer","description":"UNIX timestamp when the file has been created","readOnly":true},"changedAt":{"type":"integer","format":"integer","description":"UNIX timestamp when the file last has been changed","readOnly":true}},"additionalProperties":false}}}}
```

## The BuildProvisioningHeaders object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"BuildProvisioningHeaders":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string","format":"","description":"The name of the header property"},"value":{"type":"string","format":"","description":"The value for the header"}},"additionalProperties":false}}}}
```

## The BuildProvisioningRegistration object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"BuildProvisioningRegistration":{"type":"object","required":["id","username","port","name","originDomainName","cdnDomainName","headers","contractStart","contractEnd","type","createdAt","changedAt"],"properties":{"id":{"type":"string","format":"","description":"ID of the build provisioning registration","readOnly":true},"username":{"type":"string","format":"","description":"Username the login name for the build provisioning registration (can be i3D.net docker or i3D.net storage)","readOnly":true},"port":{"type":"integer","format":"integer","description":"Port for the login to the build provisioning registration","readOnly":true},"name":{"type":"string","format":"","description":"Unique name of the build provisioning registration","readOnly":true},"originDomainName":{"type":"string","format":"","description":"Origin domain name of the build provisioning registration","readOnly":true},"cdnDomainName":{"type":"string","format":"","description":"CDN domain name of the build provisioning registration, where the application instance will be downloaded by the hostagent","readOnly":true},"headers":{"type":"array","items":{"$ref":"#/components/schemas/BuildProvisioningHeaders"},"description":"Array of headers used to download the file from the storage or get access to the docker repository","readOnly":true},"contractStart":{"type":"integer","format":"integer","description":"Start UNIX timestamp when the registration starts for the customer","readOnly":true},"contractEnd":{"type":"integer","format":"integer","description":"End UNIX timestamp when the registration ends for the customer","readOnly":true},"type":{"type":"integer","format":"integer","description":"The type of build provisioning registration storage that is being used [GET /v3/buildProvisioning/storage/registration/types](game-publisher#/BuildProvisioningRegistration/get_v3_buildProvisioning_storage_registration_types)","readOnly":true},"createdAt":{"type":"integer","format":"integer","description":"UNIX timestamp when the build provisioning registration is created","readOnly":true},"changedAt":{"type":"integer","format":"integer","description":"UNIX timestamp when the build provisioning registration is changed","readOnly":true}},"additionalProperties":false},"BuildProvisioningHeaders":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string","format":"","description":"The name of the header property"},"value":{"type":"string","format":"","description":"The value for the header"}},"additionalProperties":false}}}}
```

## The BuildProvisioningRegistrationType object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"BuildProvisioningRegistrationType":{"type":"object","required":["id","description"],"properties":{"id":{"type":"integer","format":"integer","description":"ID of the build provisioning registration type","readOnly":true},"description":{"type":"string","format":"","description":"Description of the build provisioning registration type","readOnly":true}},"additionalProperties":false}}}}
```

## The BuildProvisioningStorageTypes object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"BuildProvisioningStorageTypes":{"type":"object","required":["id","description"],"properties":{"id":{"type":"integer","format":"integer","description":"ID of the build provisioning storage type","readOnly":true},"description":{"type":"string","format":"","description":"Description of the  build provisioning storage type","readOnly":true}},"additionalProperties":false}}}}
```

## The BulkReserveHostByFleet object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"BulkReserveHostByFleet":{"type":"object","required":["fleetId","hosts"],"properties":{"fleetId":{"type":"string","format":"","description":"Fleet ID"},"hosts":{"type":"array","items":{"type":"integer","format":"integer"},"description":"List of host ID's"},"methodId":{"type":"integer","format":"integer","description":"Stop method type, list of types can be found in: [GET /v3/application/stopMethod](game-publisher#/Application/getApplicationStopMethods)"},"timeout":{"type":"integer","format":"integer","description":"Stop method timeout in seconds, default value is 1800 seconds"}},"additionalProperties":false}}}}
```

## The BulkReserveHostByFleetStatus object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"BulkReserveHostByFleetStatus":{"type":"object","required":["oldFleetId","newFleetId","hostId","inProgress"],"properties":{"oldFleetId":{"type":"string","format":"","description":"Fleet ID that was assigned to the host prior to bulk reservation."},"newFleetId":{"type":"string","format":"","description":"Fleet ID that will be assigned to the host after completion of bulk reservation."},"hostId":{"type":"integer","format":"integer","description":"ID of the host."},"inProgress":{"type":"integer","format":"integer","description":"When the value is 1 then the host is not changed to the new fleet ID, when value is 0 than the host is changed to the new fleet ID."}},"additionalProperties":false}}}}
```

## The CCUApplicationTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"CCUApplicationTelemetry":{"type":"object","required":["applicationId","applicationName","playerCount","maxPlayers"],"properties":{"applicationId":{"type":"string","format":"","description":"Application ID","readOnly":true},"applicationName":{"type":"string","format":"","description":"The public name of your application"},"playerCount":{"type":"integer","format":"integer","description":"Number of players currently playing on the hosts","readOnly":true},"maxPlayers":{"type":"integer","format":"integer","description":"Maximum number of players the hosts can support","readOnly":true}},"additionalProperties":false}}}}
```

## The CCUStatusAggregateDataContainerTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"CCUStatusAggregateDataContainerTelemetry":{"type":"object","required":["timestamp","ccus"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"Unix time in which the data was saved","readOnly":true},"ccus":{"type":"array","items":{"$ref":"#/components/schemas/CCUStatusAggregateDataTelemetry"},"description":"List containing the telemetry data grouped by providerId","readOnly":true}},"additionalProperties":false},"CCUStatusAggregateDataTelemetry":{"type":"object","required":["providerId","maxPlayers","currentPlayers"],"properties":{"providerId":{"type":"integer","format":"integer","description":"Cloud provider ID. For a list of cloud providers see [`GET /v3/cloud/provider`](#/Cloud/get_v3_cloud_provider)","readOnly":true},"maxPlayers":{"type":"integer","format":"integer","description":"Maximum number of players the hosts can support","readOnly":true},"currentPlayers":{"type":"integer","format":"integer","description":"Number of players currently playing on the hosts","readOnly":true}},"additionalProperties":false}}}}
```

## The CCUStatusAggregateDataTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"CCUStatusAggregateDataTelemetry":{"type":"object","required":["providerId","maxPlayers","currentPlayers"],"properties":{"providerId":{"type":"integer","format":"integer","description":"Cloud provider ID. For a list of cloud providers see [`GET /v3/cloud/provider`](#/Cloud/get_v3_cloud_provider)","readOnly":true},"maxPlayers":{"type":"integer","format":"integer","description":"Maximum number of players the hosts can support","readOnly":true},"currentPlayers":{"type":"integer","format":"integer","description":"Number of players currently playing on the hosts","readOnly":true}},"additionalProperties":false}}}}
```

## The CCUStatusAggregateTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"CCUStatusAggregateTelemetry":{"type":"object","required":["unit","data"],"properties":{"unit":{"type":"string","format":"","description":"Unit of data frequency, possible interval options are as follows\n- minute\n- hour\n- day\n- month","readOnly":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/CCUStatusAggregateDataContainerTelemetry"},"description":"Object containing the data object grouped by timestamp and providerId","readOnly":true}},"additionalProperties":false},"CCUStatusAggregateDataContainerTelemetry":{"type":"object","required":["timestamp","ccus"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"Unix time in which the data was saved","readOnly":true},"ccus":{"type":"array","items":{"$ref":"#/components/schemas/CCUStatusAggregateDataTelemetry"},"description":"List containing the telemetry data grouped by providerId","readOnly":true}},"additionalProperties":false},"CCUStatusAggregateDataTelemetry":{"type":"object","required":["providerId","maxPlayers","currentPlayers"],"properties":{"providerId":{"type":"integer","format":"integer","description":"Cloud provider ID. For a list of cloud providers see [`GET /v3/cloud/provider`](#/Cloud/get_v3_cloud_provider)","readOnly":true},"maxPlayers":{"type":"integer","format":"integer","description":"Maximum number of players the hosts can support","readOnly":true},"currentPlayers":{"type":"integer","format":"integer","description":"Number of players currently playing on the hosts","readOnly":true}},"additionalProperties":false}}}}
```

## The CCUStatusDataTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"CCUStatusDataTelemetry":{"type":"object","required":["timestamp","maxPlayers","currentPlayers"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The time at which the last update occurred","readOnly":true},"maxPlayers":{"type":"integer","format":"integer","description":"Maximum number of players the hosts can support","readOnly":true},"currentPlayers":{"type":"integer","format":"integer","description":"Number of players currently playing on the hosts","readOnly":true}},"additionalProperties":false}}}}
```

## The CCUStatusTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"CCUStatusTelemetry":{"type":"object","required":["unit","data"],"properties":{"unit":{"type":"string","format":"","description":"Unit of data frequency, which is always '1m' in this endpoint","readOnly":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/CCUStatusDataTelemetry"},"description":"Contains the data object","readOnly":true}},"additionalProperties":false},"CCUStatusDataTelemetry":{"type":"object","required":["timestamp","maxPlayers","currentPlayers"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The time at which the last update occurred","readOnly":true},"maxPlayers":{"type":"integer","format":"integer","description":"Maximum number of players the hosts can support","readOnly":true},"currentPlayers":{"type":"integer","format":"integer","description":"Number of players currently playing on the hosts","readOnly":true}},"additionalProperties":false}}}}
```

## The CloudCredentials object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"CloudCredentials":{"type":"object","required":["providerId","name","params","createdAt","verifiedAt","credentialStatus","invalidateAt","invalidateReason","status"],"properties":{"providerId":{"type":"integer","format":"integer","description":"Cloud provider ID. For a list of cloud providers see [`GET /v3/cloud/provider`](#/Cloud/get_v3_cloud_provider)"},"name":{"type":"string","format":"","description":"User defined name for the cloud credential"},"params":{"anyOf":[{"$ref":"#/components/schemas/CloudCredentialsParamsAws"},{"$ref":"#/components/schemas/CloudCredentialsParamsAzure"},{"$ref":"#/components/schemas/CloudCredentialsParamsGcp"},{"$ref":"#/components/schemas/CloudCredentialsParamsUc"}],"description":"Cloud provider specific authentication params, in json format. [API examples](https://www.i3d.net/docs/one/odp/Cloud-Usage/Cloud-Credentials/#api-examples)"},"createdAt":{"type":"integer","format":"integer","description":"Unix timestamp of when credentials were first stored (informative only)","readOnly":true},"verifiedAt":{"type":"integer","format":"integer","description":"Unix timestamp of credential last verification time (informative only)","readOnly":true},"credentialStatus":{"type":"integer","format":"integer","description":"Status of cloud credential\n* 0: valid\n* 1: invalid","readOnly":true},"invalidateAt":{"type":"integer","format":"integer","description":"Unix timestamp of invalidation","readOnly":true},"invalidateReason":{"type":"string","format":"","description":"The reason for invalidation of the cloud credential","readOnly":true},"status":{"type":"integer","format":"integer","description":"Status of a currently in use cloud credential\n* 0: inactive\n* 1: active"}},"additionalProperties":false},"CloudCredentialsParamsAws":{"type":"object","required":["accessKeyId","secretAccessKey","defaultRegion","keyPair","securityGroup","isGameLift"],"properties":{"accessKeyId":{"type":"string","format":""},"secretAccessKey":{"type":"string","format":""},"defaultRegion":{"type":"string","format":"","description":"(regionName from [`GET /v3/cloud/provider/27/dcLocation`](#/Cloud/get_v3_cloud_provider__providerId__dcLocation))"},"keyPair":{"type":"string","format":"","nullable":true},"securityGroup":{"type":"string","format":"","nullable":true},"isGameLift":{"type":"boolean"}},"additionalProperties":false},"CloudCredentialsParamsAzure":{"type":"object","required":["tenantId","subscriptionId","clientId","clientSecretKey","resourceName","defaultRegion"],"properties":{"tenantId":{"type":"string","format":""},"subscriptionId":{"type":"string","format":""},"clientId":{"type":"string","format":""},"clientSecretKey":{"type":"string","format":""},"resourceName":{"type":"string","format":""},"defaultRegion":{"type":"string","format":"","description":"(regionName from [`GET /v3/cloud/provider/28/dcLocation`](#/Cloud/get_v3_cloud_provider__providerId__dcLocation))"}},"additionalProperties":false},"CloudCredentialsParamsGcp":{"type":"object","required":["projectName","network","authJson"],"properties":{"projectName":{"type":"string","format":""},"network":{"type":"string","format":""},"authJson":{"$ref":"#/components/schemas/CloudCredentialsParamsGcpAuthJson"}},"additionalProperties":false},"CloudCredentialsParamsGcpAuthJson":{"type":"object","required":["type","project_id","private_key_id","private_key","client_email","client_id","auth_uri","token_uri","auth_provider_x509_cert_url","client_x509_cert_url"],"properties":{"type":{"type":"string","format":""},"project_id":{"type":"string","format":""},"private_key_id":{"type":"string","format":""},"private_key":{"type":"string","format":""},"client_email":{"type":"string","format":""},"client_id":{"type":"string","format":""},"auth_uri":{"type":"string","format":""},"token_uri":{"type":"string","format":""},"auth_provider_x509_cert_url":{"type":"string","format":""},"client_x509_cert_url":{"type":"string","format":""}},"additionalProperties":false},"CloudCredentialsParamsUc":{"type":"object","required":["username","password","projectId","defaultRegion"],"properties":{"username":{"type":"string","format":""},"password":{"type":"string","format":""},"projectId":{"type":"string","format":""},"defaultRegion":{"type":"string","format":""},"keyPair":{"type":"string","format":""},"securityGroup":{"type":"string","format":""},"network":{"type":"string","format":""}},"additionalProperties":false}}}}
```

## The CloudCredentialsMetaData object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"CloudCredentialsMetaData":{"type":"object","required":["name","status"],"properties":{"name":{"type":"string","format":"","description":"User defined name for the cloud credential"},"status":{"type":"integer","format":"integer","description":"Status of a cloud credential\n* 0: inactive\n* 1: active"}},"additionalProperties":false}}}}
```

## The CloudCredentialsParamsAws object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"CloudCredentialsParamsAws":{"type":"object","required":["accessKeyId","secretAccessKey","defaultRegion","keyPair","securityGroup","isGameLift"],"properties":{"accessKeyId":{"type":"string","format":""},"secretAccessKey":{"type":"string","format":""},"defaultRegion":{"type":"string","format":"","description":"(regionName from [`GET /v3/cloud/provider/27/dcLocation`](#/Cloud/get_v3_cloud_provider__providerId__dcLocation))"},"keyPair":{"type":"string","format":"","nullable":true},"securityGroup":{"type":"string","format":"","nullable":true},"isGameLift":{"type":"boolean"}},"additionalProperties":false}}}}
```

## The CloudCredentialsParamsAzure object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"CloudCredentialsParamsAzure":{"type":"object","required":["tenantId","subscriptionId","clientId","clientSecretKey","resourceName","defaultRegion"],"properties":{"tenantId":{"type":"string","format":""},"subscriptionId":{"type":"string","format":""},"clientId":{"type":"string","format":""},"clientSecretKey":{"type":"string","format":""},"resourceName":{"type":"string","format":""},"defaultRegion":{"type":"string","format":"","description":"(regionName from [`GET /v3/cloud/provider/28/dcLocation`](#/Cloud/get_v3_cloud_provider__providerId__dcLocation))"}},"additionalProperties":false}}}}
```

## The CloudCredentialsParamsGcp object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"CloudCredentialsParamsGcp":{"type":"object","required":["projectName","network","authJson"],"properties":{"projectName":{"type":"string","format":""},"network":{"type":"string","format":""},"authJson":{"$ref":"#/components/schemas/CloudCredentialsParamsGcpAuthJson"}},"additionalProperties":false},"CloudCredentialsParamsGcpAuthJson":{"type":"object","required":["type","project_id","private_key_id","private_key","client_email","client_id","auth_uri","token_uri","auth_provider_x509_cert_url","client_x509_cert_url"],"properties":{"type":{"type":"string","format":""},"project_id":{"type":"string","format":""},"private_key_id":{"type":"string","format":""},"private_key":{"type":"string","format":""},"client_email":{"type":"string","format":""},"client_id":{"type":"string","format":""},"auth_uri":{"type":"string","format":""},"token_uri":{"type":"string","format":""},"auth_provider_x509_cert_url":{"type":"string","format":""},"client_x509_cert_url":{"type":"string","format":""}},"additionalProperties":false}}}}
```

## The CloudCredentialsParamsGcpAuthJson object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"CloudCredentialsParamsGcpAuthJson":{"type":"object","required":["type","project_id","private_key_id","private_key","client_email","client_id","auth_uri","token_uri","auth_provider_x509_cert_url","client_x509_cert_url"],"properties":{"type":{"type":"string","format":""},"project_id":{"type":"string","format":""},"private_key_id":{"type":"string","format":""},"private_key":{"type":"string","format":""},"client_email":{"type":"string","format":""},"client_id":{"type":"string","format":""},"auth_uri":{"type":"string","format":""},"token_uri":{"type":"string","format":""},"auth_provider_x509_cert_url":{"type":"string","format":""},"client_x509_cert_url":{"type":"string","format":""}},"additionalProperties":false}}}}
```

## The CloudCredentialsParamsUc object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"CloudCredentialsParamsUc":{"type":"object","required":["username","password","projectId","defaultRegion"],"properties":{"username":{"type":"string","format":""},"password":{"type":"string","format":""},"projectId":{"type":"string","format":""},"defaultRegion":{"type":"string","format":""},"keyPair":{"type":"string","format":""},"securityGroup":{"type":"string","format":""},"network":{"type":"string","format":""}},"additionalProperties":false}}}}
```

## The CloudCredentialsValidation object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"CloudCredentialsValidation":{"type":"object","required":["providerId","params"],"properties":{"providerId":{"type":"integer","format":"integer","description":"Cloud provider ID. For a list of cloud providers see [`GET /v3/cloud/provider`](#/Cloud/get_v3_cloud_provider)"},"params":{"anyOf":[{"$ref":"#/components/schemas/CloudCredentialsParamsAws"},{"$ref":"#/components/schemas/CloudCredentialsParamsAzure"},{"$ref":"#/components/schemas/CloudCredentialsParamsGcp"},{"$ref":"#/components/schemas/CloudCredentialsParamsUc"}],"description":"Cloud provider specific authentication params, in json format. [API examples](https://www.i3d.net/docs/one/odp/Cloud-Usage/Cloud-Credentials/#api-examples)"}},"additionalProperties":false},"CloudCredentialsParamsAws":{"type":"object","required":["accessKeyId","secretAccessKey","defaultRegion","keyPair","securityGroup","isGameLift"],"properties":{"accessKeyId":{"type":"string","format":""},"secretAccessKey":{"type":"string","format":""},"defaultRegion":{"type":"string","format":"","description":"(regionName from [`GET /v3/cloud/provider/27/dcLocation`](#/Cloud/get_v3_cloud_provider__providerId__dcLocation))"},"keyPair":{"type":"string","format":"","nullable":true},"securityGroup":{"type":"string","format":"","nullable":true},"isGameLift":{"type":"boolean"}},"additionalProperties":false},"CloudCredentialsParamsAzure":{"type":"object","required":["tenantId","subscriptionId","clientId","clientSecretKey","resourceName","defaultRegion"],"properties":{"tenantId":{"type":"string","format":""},"subscriptionId":{"type":"string","format":""},"clientId":{"type":"string","format":""},"clientSecretKey":{"type":"string","format":""},"resourceName":{"type":"string","format":""},"defaultRegion":{"type":"string","format":"","description":"(regionName from [`GET /v3/cloud/provider/28/dcLocation`](#/Cloud/get_v3_cloud_provider__providerId__dcLocation))"}},"additionalProperties":false},"CloudCredentialsParamsGcp":{"type":"object","required":["projectName","network","authJson"],"properties":{"projectName":{"type":"string","format":""},"network":{"type":"string","format":""},"authJson":{"$ref":"#/components/schemas/CloudCredentialsParamsGcpAuthJson"}},"additionalProperties":false},"CloudCredentialsParamsGcpAuthJson":{"type":"object","required":["type","project_id","private_key_id","private_key","client_email","client_id","auth_uri","token_uri","auth_provider_x509_cert_url","client_x509_cert_url"],"properties":{"type":{"type":"string","format":""},"project_id":{"type":"string","format":""},"private_key_id":{"type":"string","format":""},"private_key":{"type":"string","format":""},"client_email":{"type":"string","format":""},"client_id":{"type":"string","format":""},"auth_uri":{"type":"string","format":""},"token_uri":{"type":"string","format":""},"auth_provider_x509_cert_url":{"type":"string","format":""},"client_x509_cert_url":{"type":"string","format":""}},"additionalProperties":false},"CloudCredentialsParamsUc":{"type":"object","required":["username","password","projectId","defaultRegion"],"properties":{"username":{"type":"string","format":""},"password":{"type":"string","format":""},"projectId":{"type":"string","format":""},"defaultRegion":{"type":"string","format":""},"keyPair":{"type":"string","format":""},"securityGroup":{"type":"string","format":""},"network":{"type":"string","format":""}},"additionalProperties":false}}}}
```

## The CloudInstance object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"CloudInstance":{"type":"object","required":["id","providerInstanceId","providerImageId","providerId","dediServerId","applicationId","fleetId","regionId","dcLocationId","instanceTypeId","availabilityZone","name","tag","publicIpAddress","status","createdAt"],"properties":{"id":{"type":"integer","format":"integer","readOnly":true},"providerInstanceId":{"type":"string","format":"","readOnly":true},"providerImageId":{"type":"string","format":"","readOnly":true},"providerId":{"type":"integer","format":"integer","description":"Cloud Provider ID. For a list of cloud providers see [`GET /v3/cloud/provider`](#/Cloud/get_v3_cloud_provider)","readOnly":true},"dediServerId":{"type":"integer","format":"integer","readOnly":true},"applicationId":{"type":"integer","format":"integer","readOnly":true},"fleetId":{"type":"integer","format":"integer","readOnly":true},"regionId":{"type":"integer","format":"integer","readOnly":true},"dcLocationId":{"type":"integer","format":"integer","readOnly":true},"instanceTypeId":{"type":"integer","format":"integer","readOnly":true},"availabilityZone":{"type":"string","format":"","readOnly":true},"name":{"type":"string","format":"","readOnly":true},"tag":{"type":"string","format":"","readOnly":true},"publicIpAddress":{"type":"string","format":"","readOnly":true},"status":{"type":"integer","format":"integer","readOnly":true},"createdAt":{"type":"integer","format":"integer","description":"Unix timestamp","readOnly":true}},"additionalProperties":false}}}}
```

## The CloudProvider object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"CloudProvider":{"type":"object","required":["id","name","shortName","active"],"properties":{"id":{"type":"integer","format":"integer","description":"Cloud provider ID","readOnly":true},"name":{"type":"string","format":"","description":"Cloud provider's name","readOnly":true},"shortName":{"type":"string","format":"","description":"Cloud provider's short name (abbreviation)","readOnly":true},"active":{"type":"integer","format":"integer","description":"Cloud provider's status","readOnly":true}},"additionalProperties":false}}}}
```

## The CpuPlatform object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"CpuPlatform":{"type":"object","required":["providerId","dcLocationId","cpuPlatform"],"properties":{"providerId":{"type":"integer","format":"integer","description":"Cloud provider ID. For a list of cloud providers see [`GET /v3/cloud/provider`](#/Cloud/get_v3_cloud_provider)"},"dcLocationId":{"type":"integer","format":"integer"},"cpuPlatform":{"type":"string","format":"","nullable":true}},"additionalProperties":false}}}}
```

## The CrashEvent object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"CrashEvent":{"type":"object","required":["id","hostId","deploymentEnvironmentId","fleetId","applicationBuildId","applicationBuildExecutable","applicationBuildStartParams","applicationId","exitCode","deploymentEnvironment","fleet","applicationInstance","applicationInstanceConfiguration","applicationInstanceMetadata","createdAt"],"properties":{"id":{"type":"string","format":"","description":"Crash event ID","readOnly":true},"hostId":{"type":"integer","format":"integer","description":"Host ID (Dedicated Server ID)","readOnly":true},"deploymentEnvironmentId":{"type":"string","format":"","description":"Deployment environment ID to which the fleet is assigned","readOnly":true},"fleetId":{"type":"integer","format":"integer","description":"ID of the fleet","readOnly":true},"applicationId":{"type":"string","format":"","description":"Application install assigned to applicationId","readOnly":true},"applicationBuildId":{"type":"string","format":"","description":"ID of the application build","readOnly":true},"applicationBuildExecutable":{"type":"string","format":"","description":"Executable of the application build","readOnly":true},"applicationBuildStartParams":{"type":"string","format":"","description":"Start parameters of the application build","readOnly":true},"exitCode":{"type":"integer","format":"integer","description":"Exit code of the application instance","readOnly":true},"deploymentEnvironment":{"allOf":[{"$ref":"#/components/schemas/DeploymentEnvironment"}],"description":"Snapshot of deployment environment","readOnly":true},"fleet":{"allOf":[{"$ref":"#/components/schemas/Fleet"}],"description":"Snapshot of fleet","readOnly":true},"applicationInstance":{"allOf":[{"$ref":"#/components/schemas/ApplicationInstance"}],"description":"Snapshot of an application instance","readOnly":true},"applicationInstanceConfiguration":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationInstanceConfiguration"},"description":"Snapshot of an application instance","readOnly":true},"applicationInstanceMetadata":{"type":"array","items":{"$ref":"#/components/schemas/Metadata"},"description":"Snapshot of an application instance metadata","readOnly":true},"createdAt":{"type":"integer","format":"integer","description":"Application install created at timestamp","readOnly":true}},"additionalProperties":false},"DeploymentEnvironment":{"type":"object","required":["id","name","createdAt"],"properties":{"id":{"type":"string","format":"","description":"Deployment environment ID","readOnly":true},"name":{"type":"string","format":"","description":"The public name of your deployment environment"},"createdAt":{"type":"integer","format":"integer","description":"UnixTimestamp","readOnly":true}},"additionalProperties":false},"Fleet":{"type":"object","required":["id","name","deploymentEnvironmentId","operationalStatus","isGameLift"],"properties":{"id":{"type":"string","format":"","description":"Fleet ID","readOnly":true},"name":{"type":"string","format":"","description":"The name of the fleet"},"deploymentEnvironmentId":{"type":"string","format":"","description":"Deployment environment ID to which the fleet is assigned"},"deploymentProfileId":{"type":"string","format":"","description":"The `DeploymentProfileTemplate`'s ID, used for scaling, that is attached to this `Fleet`"},"gameDeploymentTemplateId":{"type":"string","format":"","description":"The `GameDeploymentTemplate`'s ID that is attached to this `Fleet`"},"utilityDeploymentTemplateId":{"type":"string","format":"","description":"The `UtilityDeploymentTemplate`'s ID that is attached to this `Fleet`"},"dependencyDeploymentTemplateId":{"type":"string","format":"","description":"The `DependencyDeploymentTemplate`'s ID that is attached to this `Fleet`"},"hostCapacityTemplateId":{"type":"string","format":"","description":"The `HostCapacityTemplate`'s ID that is attached to this `Fleet`"},"operationalStatus":{"type":"integer","format":"integer","description":"0: Manual, 1: Automatic deployment enabled, 2: Automatic scaling enabled (implies automatic deployment)","readOnly":true},"isGameLift":{"type":"boolean","description":"When it is active it cannot be disabled anymore"}},"additionalProperties":false},"ApplicationInstance":{"type":"object","required":["id","deploymentEnvironmentId","deploymentEnvironmentName","fleetId","fleetName","hostId","isVirtual","applicationId","applicationName","applicationType","applicationBuildId","applicationBuildName","dcLocationId","dcLocationName","regionId","regionName","status","createdAt","startedAt","stoppedAt","pid","pidChangedAt","startupParams","executable","manuallyDeployed","properties","ipAddress","labelReadOnly","numPlayersMax","numPlayers","liveHostName","liveMap","liveGameVersion","updatedAt","liveRules","autoRestart","markedForDeletion","arcusAvailable"],"properties":{"id":{"type":"string","format":"","description":"Application instance ID","readOnly":true},"deploymentEnvironmentId":{"type":"string","format":"","description":"The deployment environment ID of this application instance","readOnly":true},"deploymentEnvironmentName":{"type":"string","format":"","description":"The deployment environment name of this application instance","readOnly":true},"fleetId":{"type":"string","format":"","description":"The fleet ID of this application instance","readOnly":true},"fleetName":{"type":"string","format":"","description":"The fleet name of this application instance","readOnly":true},"hostId":{"type":"integer","format":"integer","description":"The application instance is host on this server.","readOnly":true},"isVirtual":{"type":"integer","format":"integer","description":"0 if this instance runs on a bare metal server, 1 if it runs on a VM","readOnly":true},"applicationId":{"type":"string","format":"","description":"The application ID of this application instance","readOnly":true},"applicationName":{"type":"string","format":"","description":"The application name of this application instance","readOnly":true},"applicationType":{"type":"integer","format":"integer","description":"The type of the application, the different types can be found in:\n[GET /v3/application/type](game-publisher#/Application/getApplicationTypes)","readOnly":true},"applicationBuildId":{"type":"string","format":"","description":"The application build ID of this application instance","readOnly":true},"applicationBuildName":{"type":"string","format":"","description":"The application build name of this application instance","readOnly":true},"installId":{"type":"string","format":"","description":"ID of the application install","nullable":true,"deprecated":true},"dcLocationId":{"type":"integer","format":"integer","description":"The datacenter ID of where this application instance is located","readOnly":true},"dcLocationName":{"type":"string","format":"","description":"The datacenter name of where this application instance is located","readOnly":true},"regionId":{"type":"string","format":"","description":"The deployment region ID of where this application instance is located","readOnly":true},"regionName":{"type":"string","format":"","description":"The deployment region name of where this application instance is located","readOnly":true},"status":{"type":"integer","format":"integer","description":"The application instance status, list of application instance status can be found in\n[GET /v3/applicationInstance/status](game-publisher#/ApplicationInstance/getApplicationInstanceStatuses)","readOnly":true},"createdAt":{"type":"integer","format":"integer","description":"The Unix timestamp at which this application instance is created","readOnly":true},"startedAt":{"type":"integer","format":"integer","description":"The Unix timestamp at which this application instance is started","readOnly":true},"stoppedAt":{"type":"integer","format":"integer","description":"The Unix timestamp at which this application instance is stopped","readOnly":true},"pid":{"type":"integer","format":"integer","description":"The process ID of the application instance running on the host","readOnly":true},"pidChangedAt":{"type":"integer","format":"integer","description":"The Unix timestamp of the moment the process ID has been changed on the host","readOnly":true},"startupParams":{"type":"string","format":"","description":"The exact startup parameters that were used to start this application instance with all properties resolved to their\nrespective 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\ncleared again","nullable":true,"readOnly":true},"executable":{"type":"string","format":"","description":"The name of the executable that was ran when the application instance started. Will be `null` if the instance has not been\nstarted, but will retain its previous value if it was stopped. Once set it will never be cleared again","nullable":true,"readOnly":true},"manuallyDeployed":{"type":"integer","format":"integer","description":"If set to `1`, the application instance was manually deployed, instead of automatically deployed through the system","readOnly":true},"properties":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationInstanceProperty"},"description":"Properties of application instance","readOnly":true},"ipAddress":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationInstanceIP"},"description":"List of IP addresses for an application instance","readOnly":true},"labelReadOnly":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"description":"Pre-defined key/value pairs that can be used for application selection / identification.\nAvailable labelReadOnly keys are:\n* application_id\n* fleet_id\n* host_id\n* dc_location_id\n* region_id\n* application_build_id","readOnly":true},"labelPublic":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"description":"Custom key/value pairs that can be used for application instance selection / identification"},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/Metadata"},"description":"Custom key/value pairs to be set or adjusted by the allocation call or the application instance itself. This metadata\nwill be passed to the application instance when starting it [needs more clarification]"},"numPlayersMax":{"type":"integer","format":"integer","description":"The maximum number of players on the application instance (this only apply to application instances of the type game)","readOnly":true},"numPlayers":{"type":"integer","format":"integer","description":"The number of online players on the application instance (this only apply to application instances of the type game)","readOnly":true},"liveHostName":{"type":"string","format":"","description":"The live host name of the application instance (this only apply to application instances of the type game)","readOnly":true},"liveMap":{"type":"string","format":"","description":"The live map of an application instance (this only apply to application instances of the type game)","readOnly":true},"liveGameVersion":{"type":"string","format":"","description":"The live game version of an application instance (this only apply to application instances of the type game)","readOnly":true},"updatedAt":{"type":"integer","format":"integer","description":"The Unix timestamp at which this application instance is live data is updated (this only apply to application instances of the type game)","readOnly":true},"liveRules":{"type":"string","format":"","description":"The live rules of an application instance (this only apply to application instances of the type game)","readOnly":true},"autoRestart":{"type":"integer","format":"integer","description":"If auto restart is `1` then the application instance will auto restart, when `0` the application instance auto restart will be disabled","readOnly":true},"markedForDeletion":{"type":"integer","format":"integer","description":"If an application will be deleted it will be `1`, `0` otherwise","readOnly":true},"arcusAvailable":{"type":"integer","format":"integer","description":"`1` if Arcus is available & running for this application instance, `0` otherwise.\nNote: If your application's `managementProtocol` is NOT set to Arcus, this value will always be `0`, even if your\ngame server would support the Arcus protocol. The protocol is only tested, and this value potentially be set to `1`,\nwhen the `managementProtocol` is set to Arcus.","readOnly":true}},"additionalProperties":false},"ApplicationInstanceProperty":{"type":"object","required":["id","propertyType","propertyKey","propertyValue"],"properties":{"id":{"type":"string","format":"","description":"The application instance property ID","readOnly":true},"propertyType":{"type":"integer","format":"integer","description":"The application instance property type. For a list of application property types see\n[`GET /v3/application/property/type`](#/Application/get_v3_application_property_type)","readOnly":true},"propertyKey":{"type":"string","format":"","description":"The application instance property key. Only hyphens (-), underscores (_), lowercase characters and numbers are allowed.\nKeys must start with a lowercase character"},"propertyValue":{"type":"string","format":"","description":"The application instance property value"}},"additionalProperties":false},"ApplicationInstanceIP":{"type":"object","required":["ipAddress","ipVersion","private"],"properties":{"ipAddress":{"type":"string","format":"","description":"Application instance IP address"},"ipVersion":{"type":"integer","format":"integer","description":"Application instance IP version","readOnly":true},"private":{"type":"integer","format":"integer","description":"If application instance has private ip address.","readOnly":true}},"additionalProperties":false},"Label":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","format":"","description":"Label key, only hyphens (-), underscores (_), lowercase characters and numbers are allowed. Keys must start with a lowercase character."},"value":{"type":"string","format":"","description":"Label value, maximum length is 150 characters"}},"additionalProperties":false},"Metadata":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","format":"","description":"Metadata key. Max length 50 characters"},"value":{"type":"string","format":"","description":"Metadata value. Max length 2048 bytes"}},"additionalProperties":false},"ApplicationInstanceConfiguration":{"type":"object","required":["id","applicationInstanceId","applicationBuildConfigurationId","configPath","configName","configContent","updatedAt","active"],"properties":{"id":{"type":"string","format":"","description":"The ID of the application instance configuration","readOnly":true},"applicationInstanceId":{"type":"string","format":"","description":"The ID of the application instance","readOnly":true},"applicationBuildConfigurationId":{"type":"string","format":"","description":"The ID of the application build configuration","readOnly":true},"configPath":{"type":"string","format":"","description":"Path of the configuration","readOnly":true},"configName":{"type":"string","format":"","description":"Name of the configuration","readOnly":true},"configContent":{"type":"string","format":"","description":"Content of the configuration","readOnly":true},"updatedAt":{"type":"integer","format":"integer","description":"UnixTimestamp","readOnly":true},"active":{"type":"integer","format":"integer","description":"Status of the application instance configuration","readOnly":true}},"additionalProperties":false}}}}
```

## The CreateApplicationInstall object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"CreateApplicationInstall":{"type":"object","required":["id","fileId","fileName","fileSize","fileSHA256","status","statusText","mirrorState"],"properties":{"id":{"type":"integer","format":"integer","description":"Install ID","readOnly":true},"fileId":{"type":"integer","format":"integer","description":"ID of the file"},"fileName":{"type":"string","format":"","description":"Name of the file"},"fileSize":{"type":"integer","format":"integer","description":"Size in bytes of the file"},"fileSHA256":{"type":"string","format":"","description":"Archive file SHA-256 hash"},"status":{"type":"integer","format":"integer","description":"Status of this file<br />\n**1**: File has been seen on your FTP account<br />\n**2**: Your file has stopped - regarding the upload as finished<br />\n**3**: File details have been stored<br />\n**5**: File has been moved to our main file server for further processing<br />\n**6**: Re-packing your original archive<br />\n**7**: Re-packing is done<br />\n**10**: Creating an SHA-256 hash of the archive<br />\n**11**: Hashing done<br />\n**12**: Mirroring the archive to global file servers<br />\n**13**: Mirroring is done<br />\n**14**: ApplicationInstall has been activated<br />\n**125**: Cancelled 1<br />\n**126**: Cancelled 2<br />\n**127**: ApplicationInstall creation is done<br />\n**128**: A permanent error has occurred"},"statusText":{"type":"string","format":"","description":"Status in text of this file"},"mirrorState":{"type":"array","items":{"$ref":"#/components/schemas/MirrorState"},"description":"An array with the status of the mirroring to all locations process"}},"additionalProperties":false},"MirrorState":{"type":"object","required":["locationId","locationName","fileServerIds","transfers"],"properties":{"locationId":{"type":"integer","format":"integer","description":"ID of the location"},"locationName":{"type":"string","format":"","description":"Name of the location"},"fileServerIds":{"type":"array","items":{"type":"integer","format":"integer"},"description":"An array with the file server IDs that are used for this mirroring process"},"transfers":{"type":"array","items":{"$ref":"#/components/schemas/Transfer"},"description":"An array with the file transfer progress per file server"}},"additionalProperties":false},"Transfer":{"type":"object","required":["fileServerId","progress","errorCount","retries"],"properties":{"fileServerId":{"type":"integer","format":"integer","description":"ID of the file server"},"progress":{"type":"integer","format":"integer","description":"The transfer progress in percentage"},"errorCount":{"type":"integer","format":"integer","description":"The amount of errors that occurred during this process"},"retries":{"type":"integer","format":"integer","description":"The amount of retries in the process"}},"additionalProperties":false}}}}
```

## The CustomCommandCollection object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"CustomCommandCollection":{"type":"object","properties":{"customCommand":{"type":"array","items":{"$ref":"#/components/schemas/CustomCommandKeyValue"},"description":"A collection of custom command entities"}},"additionalProperties":false},"CustomCommandKeyValue":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","format":"","description":"Custom command key that will be send. Max length 50 characters"},"value":{"type":"string","format":"","description":"Custom Command value that will be send. Max length 512 characters"}},"additionalProperties":false}}}}
```

## The CustomCommandKeyValue object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"CustomCommandKeyValue":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","format":"","description":"Custom command key that will be send. Max length 50 characters"},"value":{"type":"string","format":"","description":"Custom Command value that will be send. Max length 512 characters"}},"additionalProperties":false}}}}
```

## The DcLocation object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"DcLocation":{"type":"object","required":["id","continentId","country","displayName","providerId","availabilityZones","regionName","pingSiteIds"],"properties":{"id":{"type":"integer","format":"integer","description":"Datacenter location ID","readOnly":true},"continentId":{"type":"integer","format":"integer","description":"Continent ID\n* 1: Africa\n* 2: Antarctica\n* 3: Asia\n* 4: Australia\n* 5: Europe\n* 6: Middle East\n* 7: North America\n* 8: South America","readOnly":true},"country":{"type":"string","format":"","description":"Country name","readOnly":true},"displayName":{"type":"string","format":"","description":"The datacenter location's name","readOnly":true},"providerId":{"type":"integer","format":"integer","description":"Cloud provider ID. For a list of cloud providers see [`GET /v3/cloud/provider`](#/Cloud/get_v3_cloud_provider)","readOnly":true},"availabilityZones":{"type":"array","items":{"type":"string","format":""},"description":"Data center availability zones (only applies to cloud data centers)","readOnly":true},"regionName":{"type":"string","format":"","description":"Data center region name (only applies to cloud data centers)","readOnly":true},"pingSiteIds":{"type":"array","items":{"type":"string","format":""},"description":"Host name for the corresponding data center location."}},"additionalProperties":false}}}}
```

## The DcLocationVicinityMapping object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"DcLocationVicinityMapping":{"type":"object","required":["i3dDcLocationId","cloudDcLocationId"],"properties":{"i3dDcLocationId":{"type":"integer","format":"integer","description":"An i3D.net dcLocationId","readOnly":true},"cloudDcLocationId":{"type":"integer","format":"integer","description":"A cloud dcLocationId","readOnly":true}},"additionalProperties":false}}}}
```

## The DependencyDeploymentTemplate object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"DependencyDeploymentTemplate":{"type":"object","required":["id","name","dependencyInstallerBuildId","dependencyUninstallerBuildId","fleetIds","inUse","createdAt"],"properties":{"id":{"type":"string","format":"","description":"dependency Deployment template ID","readOnly":true},"name":{"type":"string","format":"","description":"Name of the dependency deployment template"},"dependencyInstallerBuildId":{"type":"string","format":"","description":"Dependency installer build ID"},"dependencyUninstallerBuildId":{"type":"string","format":"","description":"Dependency uninstaller build ID"},"fleetIds":{"type":"array","items":{"type":"string","format":""},"description":"IDs of the fleets that use this template","readOnly":true},"inUse":{"type":"integer","format":"integer","description":"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.","readOnly":true},"createdAt":{"type":"integer","format":"integer","description":"UnixTimestamp","readOnly":true}},"additionalProperties":false}}}}
```

## The DeploymentContainer object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"DeploymentContainer":{"type":"object","required":["id","markedForDeletion","containerLocations"],"properties":{"id":{"type":"string","format":"","description":"This deployment container's ID","readOnly":true},"markedForDeletion":{"type":"integer","format":"integer","description":"If set to 1, all application instances will be gracefully removed inside the container. Afterwards this container will be set to inactive","readOnly":true},"containerLocations":{"type":"array","items":{"$ref":"#/components/schemas/DeploymentContainerLocation"}}},"additionalProperties":false},"DeploymentContainerLocation":{"type":"object","required":["id","cloudProviderId","dcLocationId","primaryInstanceTypeName","primaryInstanceTypeStatus","secondaryInstanceTypeStatus","markedForDeletion"],"properties":{"id":{"type":"string","format":"","description":"This deploymentContainerLocation's ID","readOnly":true},"cloudProviderId":{"type":"integer","format":"integer","description":"The cloud provider ID of this location. For a list of cloud providers see [`GET /v3/cloud/provider`](#/Cloud/get_v3_cloud_provider)"},"dcLocationId":{"type":"integer","format":"integer","description":"The ID of the data center. Find all possible values from [`GET /v3/cloud/dcLocation`](#/Cloud/get_v3_cloud_dcLocation)"},"primaryInstanceTypeName":{"type":"string","format":"","description":"The primary instance type to use. Find all possible values from [`GET /v3/cloud/instanceType`](#/Cloud/get_v3_cloud_instanceType)","nullable":true},"primaryInstanceTypeStatus":{"type":"integer","format":"integer","description":"It will show either primary instance type is available or not","readOnly":true},"secondaryInstanceTypeName":{"type":"string","format":"","description":"The secondary instance type to use. Find all possible values from [`GET /v3/cloud/instanceType`](#/Cloud/get_v3_cloud_instanceType)","nullable":true},"secondaryInstanceTypeStatus":{"type":"integer","format":"integer","description":"It will show either secondary instance type is available or not","readOnly":true},"cpuPlatform":{"type":"string","format":"","description":"The CPU platform to use for the given `cloudProviderId`. Find all possible values from [`GET /v3/cloud/cpuPlatform`](#/Cloud/get_v3_cloud_cpuPlatform).\nNull value means that a CPU platform is chosen automatically by the cloud provider.\nNote that this selector is not available on all cloud platforms","nullable":true,"deprecated":true},"markedForDeletion":{"type":"integer","format":"integer","description":"If set to 1, all application instances will be gracefully removed in this cloud location. After all application instances are removed this object will also be deleted","readOnly":true}},"additionalProperties":false}}}}
```

## The DeploymentContainerLocation object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"DeploymentContainerLocation":{"type":"object","required":["id","cloudProviderId","dcLocationId","primaryInstanceTypeName","primaryInstanceTypeStatus","secondaryInstanceTypeStatus","markedForDeletion"],"properties":{"id":{"type":"string","format":"","description":"This deploymentContainerLocation's ID","readOnly":true},"cloudProviderId":{"type":"integer","format":"integer","description":"The cloud provider ID of this location. For a list of cloud providers see [`GET /v3/cloud/provider`](#/Cloud/get_v3_cloud_provider)"},"dcLocationId":{"type":"integer","format":"integer","description":"The ID of the data center. Find all possible values from [`GET /v3/cloud/dcLocation`](#/Cloud/get_v3_cloud_dcLocation)"},"primaryInstanceTypeName":{"type":"string","format":"","description":"The primary instance type to use. Find all possible values from [`GET /v3/cloud/instanceType`](#/Cloud/get_v3_cloud_instanceType)","nullable":true},"primaryInstanceTypeStatus":{"type":"integer","format":"integer","description":"It will show either primary instance type is available or not","readOnly":true},"secondaryInstanceTypeName":{"type":"string","format":"","description":"The secondary instance type to use. Find all possible values from [`GET /v3/cloud/instanceType`](#/Cloud/get_v3_cloud_instanceType)","nullable":true},"secondaryInstanceTypeStatus":{"type":"integer","format":"integer","description":"It will show either secondary instance type is available or not","readOnly":true},"cpuPlatform":{"type":"string","format":"","description":"The CPU platform to use for the given `cloudProviderId`. Find all possible values from [`GET /v3/cloud/cpuPlatform`](#/Cloud/get_v3_cloud_cpuPlatform).\nNull value means that a CPU platform is chosen automatically by the cloud provider.\nNote that this selector is not available on all cloud platforms","nullable":true,"deprecated":true},"markedForDeletion":{"type":"integer","format":"integer","description":"If set to 1, all application instances will be gracefully removed in this cloud location. After all application instances are removed this object will also be deleted","readOnly":true}},"additionalProperties":false}}}}
```

## The DeploymentEnvironment object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"DeploymentEnvironment":{"type":"object","required":["id","name","createdAt"],"properties":{"id":{"type":"string","format":"","description":"Deployment environment ID","readOnly":true},"name":{"type":"string","format":"","description":"The public name of your deployment environment"},"createdAt":{"type":"integer","format":"integer","description":"UnixTimestamp","readOnly":true}},"additionalProperties":false}}}}
```

## The DeploymentEnvironmentTelemetryModel object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"DeploymentEnvironmentTelemetryModel":{"type":"object","required":["hosts","instances","players"],"properties":{"hosts":{"type":"integer","format":"integer","description":"The number of hosts"},"instances":{"type":"integer","format":"integer","description":"The number of instances"},"players":{"type":"integer","format":"integer","description":"The number of players"}},"additionalProperties":false}}}}
```

## The DeploymentProfile object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"DeploymentProfile":{"type":"object","required":["id","fleetIds","name","strategyType","minimumCapacity","bufferValue","bufferValueType","markedForDeletion","inUse","deploymentRegions","createdAt"],"properties":{"id":{"type":"string","format":"","description":"The deployment profile ID","readOnly":true},"fleetIds":{"type":"array","items":{"type":"string","format":""},"description":"IDs of the fleets in which this deployment profile is being used","readOnly":true},"name":{"type":"string","format":"","description":"This deployment profile's name"},"description":{"type":"string","format":"","description":"This deployment profile's description"},"strategyType":{"type":"integer","format":"integer","description":"Possible values:\n- 1: Round robin"},"minimumCapacity":{"type":"integer","format":"integer","description":"The minimum amount of game instances that should always be deployed for each deployment region in this deployment profile.\nCan be overridden per deployment region"},"maximumCapacity":{"type":"integer","format":"integer","description":"The maximum amount of game instances that can be deployed in each region. Can be overridden per region.\n`Null` value means that there is no `maximumCapacity`","nullable":true},"bufferValue":{"type":"integer","format":"integer","description":"Global buffer value, to be applied to individual deployment regions. Can be overridden per region"},"bufferValueType":{"type":"integer","format":"integer","description":"Possible values:\n- 0: Absolute value\n- 1: Percentage value (must be accompanied by `bufferValueMin` and `bufferValueMax`)"},"bufferValueMin":{"type":"integer","format":"integer","description":"The minimum absolute `bufferValue` when using a percentage, to prevent `bufferValue` from going too low","nullable":true},"bufferValueMax":{"type":"integer","format":"integer","description":"The maximum absolute `bufferValue` when using a percentage, to prevent `bufferValue` from going too high","nullable":true},"markedForDeletion":{"type":"integer","format":"integer","description":"When `1`, `markedForDeletion` will propagate to all deployment regions of this deployment profile.\nScaling down will happen slowly as application instances get removed naturally.\nAfter all application instances are removed, the deployment profile is set to inactive","readOnly":true},"inUse":{"type":"integer","format":"integer","description":"Possible values:\n- 0: Deployment profile has no active application instances\n- 1: Deployment profile has active application instance(s)","readOnly":true},"deploymentRegions":{"type":"array","items":{"$ref":"#/components/schemas/DeploymentRegion"},"description":"All deployment regions of this deployment profile","readOnly":true},"createdAt":{"type":"integer","format":"integer","description":"Unix timestamp of creation time","readOnly":true}},"additionalProperties":false},"DeploymentRegion":{"type":"object","required":["id","name","i3dDcLocationIds","markedForDeletion","inUse"],"properties":{"id":{"type":"string","format":"","description":"This deployment region's ID","readOnly":true},"name":{"type":"string","format":"","description":"The name of the deployment region"},"i3dDcLocationIds":{"type":"array","items":{"type":"integer","format":"integer"},"description":"All the i3D.net DC location IDs configured for this deployment region. You can get available IDs via `GET /cloud/dcLocation`"},"i3dDcLocationIdsToBeRemoved":{"type":"array","items":{"type":"integer","format":"integer"},"description":"i3D.net data center location IDs scheduled for removal from this region"},"minimumCapacity":{"type":"integer","format":"integer","description":"The minimum amount of game instances that should always be deployed in this region.\n`Null` value means that the `minimumCapacity` provided in the deployment profile will persist","nullable":true},"maximumCapacity":{"type":"integer","format":"integer","description":"The maximum amount of game instances that can be deployed in this region.\n`Null` value means that the `maximumCapacity` provided in the deployment profile will persist","nullable":true},"bufferValue":{"type":"integer","format":"integer","description":"Override for `DeploymentProfile.bufferValue`, to be applied only to this deployment region.\n`Null` value means that the `bufferValue` provided in the deployment profile will persist","nullable":true},"bufferValueType":{"type":"integer","format":"integer","description":"Override for `DeploymentProfile.bufferValueType`. Possible values:\n- 0: Absolute value\n- 1: Percentage value (must be accompanied by `bufferValueMin` and `bufferValueMax`)\n`Null` value means that the `bufferValueType` provided in the deployment profile will persist","nullable":true},"bufferValueMin":{"type":"integer","format":"integer","description":"Override for `DeploymentProfile.bufferValueMin`. The minimum absolute `bufferValue` when using a percentage, to prevent `bufferValue` from going too low.\n`Null` value means that the `bufferValueMin` provided in the deployment profile will persist.\nNote: if this value is supplied (not `null`) with your request, `bufferValue` and `bufferValueType` become required parameters.\nSee `POST /deploymentProfile/{deploymentProfileId}` for more information","nullable":true},"bufferValueMax":{"type":"integer","format":"integer","description":"Override for `DeploymentProfile.bufferValueMax`. The maximum absolute `bufferValue` when using a percentage, to prevent `bufferValue` from going too high.\n`Null` value means that the `bufferValueMax` provided in the deployment profile will persist.\nNote: if this value is supplied (not `null`) with your request, `bufferValue` and `bufferValueType` become required parameters.\nSee `POST /deploymentProfile/{deploymentProfileId}` for more information","nullable":true},"strategyType":{"type":"integer","format":"integer","description":"Override value for `DeploymentProfile.strategyType`. Possible values:\n- `0`: Use default\n- `1`: Round robin\n- `null`: The `strategyType` provided in the deployment profile will persist","nullable":true},"markedForDeletion":{"type":"integer","format":"integer","description":"If set to `1`, all application instances will be gracefully removed inside the deployment region. Afterwards this deployment region will be set to inactive","readOnly":true},"containers":{"type":"array","items":{"$ref":"#/components/schemas/DeploymentContainer"}},"inUse":{"type":"integer","format":"integer","description":"Possible values:\n- 0: Deployment region has no active application instances\n- 1: Deployment region has active application instance(s)","readOnly":true}},"additionalProperties":false},"DeploymentContainer":{"type":"object","required":["id","markedForDeletion","containerLocations"],"properties":{"id":{"type":"string","format":"","description":"This deployment container's ID","readOnly":true},"markedForDeletion":{"type":"integer","format":"integer","description":"If set to 1, all application instances will be gracefully removed inside the container. Afterwards this container will be set to inactive","readOnly":true},"containerLocations":{"type":"array","items":{"$ref":"#/components/schemas/DeploymentContainerLocation"}}},"additionalProperties":false},"DeploymentContainerLocation":{"type":"object","required":["id","cloudProviderId","dcLocationId","primaryInstanceTypeName","primaryInstanceTypeStatus","secondaryInstanceTypeStatus","markedForDeletion"],"properties":{"id":{"type":"string","format":"","description":"This deploymentContainerLocation's ID","readOnly":true},"cloudProviderId":{"type":"integer","format":"integer","description":"The cloud provider ID of this location. For a list of cloud providers see [`GET /v3/cloud/provider`](#/Cloud/get_v3_cloud_provider)"},"dcLocationId":{"type":"integer","format":"integer","description":"The ID of the data center. Find all possible values from [`GET /v3/cloud/dcLocation`](#/Cloud/get_v3_cloud_dcLocation)"},"primaryInstanceTypeName":{"type":"string","format":"","description":"The primary instance type to use. Find all possible values from [`GET /v3/cloud/instanceType`](#/Cloud/get_v3_cloud_instanceType)","nullable":true},"primaryInstanceTypeStatus":{"type":"integer","format":"integer","description":"It will show either primary instance type is available or not","readOnly":true},"secondaryInstanceTypeName":{"type":"string","format":"","description":"The secondary instance type to use. Find all possible values from [`GET /v3/cloud/instanceType`](#/Cloud/get_v3_cloud_instanceType)","nullable":true},"secondaryInstanceTypeStatus":{"type":"integer","format":"integer","description":"It will show either secondary instance type is available or not","readOnly":true},"cpuPlatform":{"type":"string","format":"","description":"The CPU platform to use for the given `cloudProviderId`. Find all possible values from [`GET /v3/cloud/cpuPlatform`](#/Cloud/get_v3_cloud_cpuPlatform).\nNull value means that a CPU platform is chosen automatically by the cloud provider.\nNote that this selector is not available on all cloud platforms","nullable":true,"deprecated":true},"markedForDeletion":{"type":"integer","format":"integer","description":"If set to 1, all application instances will be gracefully removed in this cloud location. After all application instances are removed this object will also be deleted","readOnly":true}},"additionalProperties":false}}}}
```

## The DeploymentProfileSummary object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"DeploymentProfileSummary":{"type":"object","required":["id","fleetIds","name","strategyType","minimumCapacity","bufferValue","bufferValueType","markedForDeletion","inUse","createdAt"],"properties":{"id":{"type":"string","format":"","description":"The deployment profile ID","readOnly":true},"fleetIds":{"type":"array","items":{"type":"string","format":""},"description":"IDs of the fleets in which this deployment profile is being used","readOnly":true},"name":{"type":"string","format":"","description":"This deployment profile's name"},"description":{"type":"string","format":"","description":"This deployment profile's description"},"strategyType":{"type":"integer","format":"integer","description":"Possible values:\n- 1: Round robin"},"minimumCapacity":{"type":"integer","format":"integer","description":"The minimum amount of game instances that should always be deployed for each deployment region in this deployment profile.\nCan be overridden per deployment region"},"maximumCapacity":{"type":"integer","format":"integer","description":"The maximum amount of game instances that can be deployed in each region. Can be overridden per region.\n`Null` value means that there is no `maximumCapacity`","nullable":true},"bufferValue":{"type":"integer","format":"integer","description":"Global buffer value, to be applied to individual deployment regions. Can be overridden per region"},"bufferValueType":{"type":"integer","format":"integer","description":"Possible values:\n- 0: Absolute value\n- 1: Percentage value (must be accompanied by `bufferValueMin` and `bufferValueMax`)"},"bufferValueMin":{"type":"integer","format":"integer","description":"The minimum absolute `bufferValue` when using a percentage, to prevent `bufferValue` from going too low","nullable":true},"bufferValueMax":{"type":"integer","format":"integer","description":"The maximum absolute `bufferValue` when using a percentage, to prevent `bufferValue` from going too high","nullable":true},"markedForDeletion":{"type":"integer","format":"integer","description":"When `1`, `markedForDeletion` will propagate to all deployment regions of this deployment profile.\nScaling down will happen slowly as application instances get removed naturally.\nAfter all application instances are removed, the deployment profile is set to inactive","readOnly":true},"inUse":{"type":"integer","format":"integer","description":"Possible values:\n- 0: Deployment profile has no active application instances\n- 1: Deployment profile has active application instance(s)","readOnly":true},"createdAt":{"type":"integer","format":"integer","description":"Unix timestamp of creation time","readOnly":true}},"additionalProperties":false}}}}
```

## The DeploymentRegion object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"DeploymentRegion":{"type":"object","required":["id","name","i3dDcLocationIds","markedForDeletion","inUse"],"properties":{"id":{"type":"string","format":"","description":"This deployment region's ID","readOnly":true},"name":{"type":"string","format":"","description":"The name of the deployment region"},"i3dDcLocationIds":{"type":"array","items":{"type":"integer","format":"integer"},"description":"All the i3D.net DC location IDs configured for this deployment region. You can get available IDs via `GET /cloud/dcLocation`"},"i3dDcLocationIdsToBeRemoved":{"type":"array","items":{"type":"integer","format":"integer"},"description":"i3D.net data center location IDs scheduled for removal from this region"},"minimumCapacity":{"type":"integer","format":"integer","description":"The minimum amount of game instances that should always be deployed in this region.\n`Null` value means that the `minimumCapacity` provided in the deployment profile will persist","nullable":true},"maximumCapacity":{"type":"integer","format":"integer","description":"The maximum amount of game instances that can be deployed in this region.\n`Null` value means that the `maximumCapacity` provided in the deployment profile will persist","nullable":true},"bufferValue":{"type":"integer","format":"integer","description":"Override for `DeploymentProfile.bufferValue`, to be applied only to this deployment region.\n`Null` value means that the `bufferValue` provided in the deployment profile will persist","nullable":true},"bufferValueType":{"type":"integer","format":"integer","description":"Override for `DeploymentProfile.bufferValueType`. Possible values:\n- 0: Absolute value\n- 1: Percentage value (must be accompanied by `bufferValueMin` and `bufferValueMax`)\n`Null` value means that the `bufferValueType` provided in the deployment profile will persist","nullable":true},"bufferValueMin":{"type":"integer","format":"integer","description":"Override for `DeploymentProfile.bufferValueMin`. The minimum absolute `bufferValue` when using a percentage, to prevent `bufferValue` from going too low.\n`Null` value means that the `bufferValueMin` provided in the deployment profile will persist.\nNote: if this value is supplied (not `null`) with your request, `bufferValue` and `bufferValueType` become required parameters.\nSee `POST /deploymentProfile/{deploymentProfileId}` for more information","nullable":true},"bufferValueMax":{"type":"integer","format":"integer","description":"Override for `DeploymentProfile.bufferValueMax`. The maximum absolute `bufferValue` when using a percentage, to prevent `bufferValue` from going too high.\n`Null` value means that the `bufferValueMax` provided in the deployment profile will persist.\nNote: if this value is supplied (not `null`) with your request, `bufferValue` and `bufferValueType` become required parameters.\nSee `POST /deploymentProfile/{deploymentProfileId}` for more information","nullable":true},"strategyType":{"type":"integer","format":"integer","description":"Override value for `DeploymentProfile.strategyType`. Possible values:\n- `0`: Use default\n- `1`: Round robin\n- `null`: The `strategyType` provided in the deployment profile will persist","nullable":true},"markedForDeletion":{"type":"integer","format":"integer","description":"If set to `1`, all application instances will be gracefully removed inside the deployment region. Afterwards this deployment region will be set to inactive","readOnly":true},"containers":{"type":"array","items":{"$ref":"#/components/schemas/DeploymentContainer"}},"inUse":{"type":"integer","format":"integer","description":"Possible values:\n- 0: Deployment region has no active application instances\n- 1: Deployment region has active application instance(s)","readOnly":true}},"additionalProperties":false},"DeploymentContainer":{"type":"object","required":["id","markedForDeletion","containerLocations"],"properties":{"id":{"type":"string","format":"","description":"This deployment container's ID","readOnly":true},"markedForDeletion":{"type":"integer","format":"integer","description":"If set to 1, all application instances will be gracefully removed inside the container. Afterwards this container will be set to inactive","readOnly":true},"containerLocations":{"type":"array","items":{"$ref":"#/components/schemas/DeploymentContainerLocation"}}},"additionalProperties":false},"DeploymentContainerLocation":{"type":"object","required":["id","cloudProviderId","dcLocationId","primaryInstanceTypeName","primaryInstanceTypeStatus","secondaryInstanceTypeStatus","markedForDeletion"],"properties":{"id":{"type":"string","format":"","description":"This deploymentContainerLocation's ID","readOnly":true},"cloudProviderId":{"type":"integer","format":"integer","description":"The cloud provider ID of this location. For a list of cloud providers see [`GET /v3/cloud/provider`](#/Cloud/get_v3_cloud_provider)"},"dcLocationId":{"type":"integer","format":"integer","description":"The ID of the data center. Find all possible values from [`GET /v3/cloud/dcLocation`](#/Cloud/get_v3_cloud_dcLocation)"},"primaryInstanceTypeName":{"type":"string","format":"","description":"The primary instance type to use. Find all possible values from [`GET /v3/cloud/instanceType`](#/Cloud/get_v3_cloud_instanceType)","nullable":true},"primaryInstanceTypeStatus":{"type":"integer","format":"integer","description":"It will show either primary instance type is available or not","readOnly":true},"secondaryInstanceTypeName":{"type":"string","format":"","description":"The secondary instance type to use. Find all possible values from [`GET /v3/cloud/instanceType`](#/Cloud/get_v3_cloud_instanceType)","nullable":true},"secondaryInstanceTypeStatus":{"type":"integer","format":"integer","description":"It will show either secondary instance type is available or not","readOnly":true},"cpuPlatform":{"type":"string","format":"","description":"The CPU platform to use for the given `cloudProviderId`. Find all possible values from [`GET /v3/cloud/cpuPlatform`](#/Cloud/get_v3_cloud_cpuPlatform).\nNull value means that a CPU platform is chosen automatically by the cloud provider.\nNote that this selector is not available on all cloud platforms","nullable":true,"deprecated":true},"markedForDeletion":{"type":"integer","format":"integer","description":"If set to 1, all application instances will be gracefully removed in this cloud location. After all application instances are removed this object will also be deleted","readOnly":true}},"additionalProperties":false}}}}
```

## The DeploymentRegionProperty object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"DeploymentRegionProperty":{"type":"object","required":["id","applicationPropertyId","propertyValue"],"properties":{"id":{"type":"string","format":"","description":"Deployment region property ID","readOnly":true},"applicationPropertyId":{"type":"string","format":"","description":"The application property ID that this regional property overrides"},"propertyValue":{"type":"string","format":"","description":"The overridden value of the application property"}},"additionalProperties":false}}}}
```

## The Error object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"Error":{"type":"object","required":["errorCode","errorMessage","errors"],"properties":{"errorCode":{"type":"integer","format":"integer","description":"Error code"},"errorMessage":{"type":"string","format":"","description":"Error message"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetails"},"description":"Error details"}},"additionalProperties":false},"ErrorDetails":{"type":"object","required":["property","message"],"properties":{"property":{"type":"string","format":"","description":"Property in which there is an error"},"message":{"type":"string","format":"","description":"Error message"}},"additionalProperties":false}}}}
```

## The ErrorDetails object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ErrorDetails":{"type":"object","required":["property","message"],"properties":{"property":{"type":"string","format":"","description":"Property in which there is an error"},"message":{"type":"string","format":"","description":"Error message"}},"additionalProperties":false}}}}
```

## The Fleet object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"Fleet":{"type":"object","required":["id","name","deploymentEnvironmentId","operationalStatus","isGameLift"],"properties":{"id":{"type":"string","format":"","description":"Fleet ID","readOnly":true},"name":{"type":"string","format":"","description":"The name of the fleet"},"deploymentEnvironmentId":{"type":"string","format":"","description":"Deployment environment ID to which the fleet is assigned"},"deploymentProfileId":{"type":"string","format":"","description":"The `DeploymentProfileTemplate`'s ID, used for scaling, that is attached to this `Fleet`"},"gameDeploymentTemplateId":{"type":"string","format":"","description":"The `GameDeploymentTemplate`'s ID that is attached to this `Fleet`"},"utilityDeploymentTemplateId":{"type":"string","format":"","description":"The `UtilityDeploymentTemplate`'s ID that is attached to this `Fleet`"},"dependencyDeploymentTemplateId":{"type":"string","format":"","description":"The `DependencyDeploymentTemplate`'s ID that is attached to this `Fleet`"},"hostCapacityTemplateId":{"type":"string","format":"","description":"The `HostCapacityTemplate`'s ID that is attached to this `Fleet`"},"operationalStatus":{"type":"integer","format":"integer","description":"0: Manual, 1: Automatic deployment enabled, 2: Automatic scaling enabled (implies automatic deployment)","readOnly":true},"isGameLift":{"type":"boolean","description":"When it is active it cannot be disabled anymore"}},"additionalProperties":false}}}}
```

## The FleetTelemetryModel object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"FleetTelemetryModel":{"type":"object","required":["hosts","instances","players"],"properties":{"hosts":{"type":"integer","format":"integer","description":"The number of hosts"},"instances":{"type":"integer","format":"integer","description":"The number of instances"},"players":{"type":"integer","format":"integer","description":"The number of players"}},"additionalProperties":false}}}}
```

## The GameDeploymentTemplate object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"GameDeploymentTemplate":{"type":"object","required":["id","fleetIds","name","inUse","createdAt","gameDeploymentTemplateBuild"],"properties":{"id":{"type":"string","format":"","description":"Game deployment template ID","readOnly":true},"fleetIds":{"type":"array","items":{"type":"string","format":""},"description":"IDs of the fleets that use this template","readOnly":true},"name":{"type":"string","format":"","description":"The public name of your game deployment template"},"inUse":{"type":"integer","format":"integer","description":"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.","readOnly":true},"createdAt":{"type":"integer","format":"integer","description":"UnixTimestamp","readOnly":true},"gameDeploymentTemplateBuild":{"type":"array","items":{"$ref":"#/components/schemas/GameDeploymentTemplateBuild"},"description":"Application build assigned to the template (can only be one build)"}},"additionalProperties":false},"GameDeploymentTemplateBuild":{"type":"object","required":["applicationBuildId"],"properties":{"applicationBuildId":{"type":"string","format":"","description":"The Application Build ID"}},"additionalProperties":false}}}}
```

## The GameDeploymentTemplateBuild object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"GameDeploymentTemplateBuild":{"type":"object","required":["applicationBuildId"],"properties":{"applicationBuildId":{"type":"string","format":"","description":"The Application Build ID"}},"additionalProperties":false}}}}
```

## The GameLiftEnvironmentVariables object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"GameLiftEnvironmentVariables":{"type":"object","required":["id","type","name"],"properties":{"id":{"type":"string","format":"","description":"of game lift environment variable","nullable":true},"type":{"type":"string","format":"","description":"of game lift environment variable:\n- awsgl_endpoint\n- awsgl_region\n- awsgl_token\n- awsgl_hostname\n- awsgl_fleetid\n- raw_value"},"name":{"type":"string","format":"","description":"of game lift environment variable, e.g. \"AWS_TOKEN_ID\"","nullable":true}},"additionalProperties":false}}}}
```

## The GenericIntModel object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"GenericIntModel":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","format":"integer","description":"The ID of the object"},"name":{"type":"string","format":"","description":"The name of the object"}},"additionalProperties":false}}}}
```

## The GenericModel object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"GenericModel":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","format":"","description":"The ID of the object"},"name":{"type":"string","format":"","description":"The name of the object"}},"additionalProperties":false}}}}
```

## The Host object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"Host":{"type":"object","required":["id","userId","serverId","serverName","serverType","liveHostName","isVirtual","category","osId","locationId","dcLocationId","instanceType","fleetId","newFleetId","fleetAssociatedSince","rackName","dateStart","dateEnd","dateCancelled","dateEndContract","contractPeriod","extendPeriod","cancellationPeriod","purchaseOrder","paymentTerm","pricePerMonth","pricePerTbOveruse","currencyId","bandwidthBillingType","bandwidthContractual","ipAddress","brand","model","numCpu","cpuInfo","cpuType","cpuLoad","cpu","memUsed","memMax","memFree","disk","memory","isReserve","serviceTag","isODP","fmOrderId","installStatus","status","trafficSum","uplinks","freeIncomingTraffic","outgoingTrafficSum","incomingTrafficSum"],"properties":{"id":{"type":"integer","format":"integer","description":"The ID of this host","readOnly":true},"userId":{"type":"integer","format":"integer","description":"The ID of the user who owns this server","readOnly":true},"serverId":{"type":"integer","format":"integer","description":"The ID of the physical machine","readOnly":true},"serverName":{"type":"string","format":"","description":"The name of the physical machine","readOnly":true},"serverType":{"type":"integer","format":"integer","description":"The type of the server:\n* 1: Bare metal server\n* 2: Flex metal server\n* 3: Virtual machine","readOnly":true},"projectName":{"type":"string","format":"","description":"The name of the project for the host"},"clientServerName":{"type":"string","format":"","description":"The name of the server defined by client"},"clientState":{"type":"string","format":"","description":"Client statement for the host"},"liveHostName":{"type":"string","format":"","description":"The host name","readOnly":true},"isVirtual":{"type":"integer","format":"integer","description":"0 if this is a bare metal server, 1 if it's a VM. Use `serverType` instead","readOnly":true,"deprecated":true},"category":{"type":"string","format":"","description":"Host category. Normally \"Dedicated Game Servers\" or \"Dedicated Servers\", but can be \"Broken\" if the server is in a degraded state","readOnly":true},"osId":{"type":"integer","format":"integer","description":"Operating system ID, must be one of [`GET /v3/operatingsystem`](all#/OperatingSystem/getOperatingsystems)","readOnly":true},"locationId":{"type":"integer","format":"integer","description":"Legacy location ID (not used for ODP)","readOnly":true},"dcLocationId":{"type":"integer","format":"integer","description":"Datacenter location ID. Points to one of [`GET /v3/cloud/dcLocation`](#/Cloud/getCloudDcLocations)","readOnly":true},"instanceType":{"type":"string","format":"","description":"The instance type of this server, which is one of [`GET /v3/host/instanceType`](#/Host/getHostInstanceTypes) for a bare metal, or one of\n[`GET /v3/cloud/instanceType`](#/Cloud/getCloudInstanceTypes) for a virtual machine","readOnly":true},"fleetId":{"type":"string","format":"","description":"The fleet ID, if this host has been assigned to a fleet\nIf `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.","readOnly":true},"newFleetId":{"type":"string","format":"","description":"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`](#/Fleet/createFleetHostBulkReserve)","nullable":true,"readOnly":true},"fleetAssociatedSince":{"type":"integer","format":"integer","description":"Unix timestamp when fleet assigned to the host","readOnly":true},"rackName":{"type":"string","format":"","description":"The name of the rack the host is located","readOnly":true},"dateStart":{"type":"string","format":"","description":"The date at which this host became active","readOnly":true},"dateEnd":{"type":"string","format":"","description":"The date at which this host will expire","readOnly":true},"dateCancelled":{"type":"string","format":"","description":"The date at which this host was cancelled","readOnly":true},"dateEndContract":{"type":"string","format":"","description":"The date at which the contract ends (if applicable)","readOnly":true},"contractPeriod":{"type":"integer","format":"integer","description":"The contract period in months","readOnly":true},"extendPeriod":{"type":"integer","format":"integer","description":"The service extend period in months","readOnly":true},"cancellationPeriod":{"type":"integer","format":"integer","description":"The cancellation period in months","readOnly":true},"purchaseOrder":{"type":"string","format":"","description":"Purchase order, if one has been supplied via our billing department","readOnly":true},"paymentTerm":{"type":"integer","format":"integer","description":"The payment term in days (how many days are invoices generated before dateEnd)","readOnly":true},"pricePerMonth":{"type":"string","format":"","description":"The price of this host per month in cents (see `currencyId` for currency)","readOnly":true},"pricePerTbOveruse":{"type":"string","format":"","description":"The price of traffic overuse in cents (per TB) (see `currencyId` for currency)","readOnly":true},"currencyId":{"type":"integer","format":"integer","description":"The currency of the `pricePerMonth` field:\n* 0: EURO\n* 1: USD\n* 9: YEN","readOnly":true},"bandwidthBillingType":{"type":"integer","format":"integer","description":"The bandwidth billing method for this service:\n* 1: unmetered connection\n* 2: measured in TB per month\n* 3: measured in mbit 95th percentile","readOnly":true},"bandwidthContractual":{"type":"integer","format":"integer","description":"The contractual maximum bandwidth usage value. In GB if bandwidthBillingType equals `2`, in mbit otherwise","readOnly":true},"ipAddress":{"type":"array","items":{"$ref":"#/components/schemas/HostIP"},"description":"All IP addresses assigned to this host","readOnly":true},"brand":{"type":"string","format":"","description":"The server manufacturer brand name","readOnly":true},"model":{"type":"string","format":"","description":"The model of the server","readOnly":true},"numCpu":{"type":"integer","format":"integer","description":"Number of CPUs in this host","readOnly":true},"cpuInfo":{"type":"string","format":"","readOnly":true},"cpuType":{"type":"string","format":"","readOnly":true},"cpuLoad":{"type":"number","format":"float","description":"Percentage of cpu used across all cores","readOnly":true},"cpu":{"allOf":[{"$ref":"#/components/schemas/HostCpu"}],"readOnly":true},"memUsed":{"type":"integer","format":"integer","description":"The amount of memory that is used by the host (in megabytes)","readOnly":true},"memMax":{"type":"integer","format":"integer","description":"The amount of memory that is available on the host (in megabytes)","readOnly":true},"memFree":{"type":"integer","format":"integer","description":"The amount of free memory that is available on the host (in megabytes)","readOnly":true},"disk":{"type":"array","items":{"$ref":"#/components/schemas/HostDisk"},"readOnly":true},"memory":{"type":"array","items":{"$ref":"#/components/schemas/HostMemory"},"readOnly":true},"isReserve":{"type":"integer","format":"integer","description":"If the host is reserved for a fleet isReserve set to 1","readOnly":true},"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"description":"Custom key/value pairs that can be used for host"},"serviceTag":{"type":"string","format":"","description":"The service tag of the host","readOnly":true},"isODP":{"type":"integer","format":"integer","description":"If the host is available for game hosting platform isODP set to 1","readOnly":true},"fmOrderId":{"type":"string","format":"","description":"ID of Flex Metal order if this is a flex metal server","nullable":true,"readOnly":true},"installStatus":{"type":"string","format":"","description":"Status of server auto install if it was started by one. (created / installing / finished / failed)","nullable":true,"readOnly":true},"status":{"type":"string","format":"","description":"Whether the host is running or not","readOnly":true},"uptime":{"type":"integer","format":"integer","description":"The uptime of the host. Read-only. Only provided if the server checked-in recently"},"trafficSum":{"type":"integer","format":"integer","description":"Monthly traffic of all incoming and outgoing bandwidth in GB or Mbit depending on host configuration","readOnly":true},"uplinks":{"type":"array","items":{"$ref":"#/components/schemas/HostUplink"},"description":"A list of uplinks attached to this host","readOnly":true},"freeIncomingTraffic":{"type":"boolean","description":"Whether the host has free incoming traffic or not","readOnly":true},"outgoingTrafficSum":{"type":"integer","format":"integer","description":"The outgoing traffic (Mbit or GB)","readOnly":true},"incomingTrafficSum":{"type":"integer","format":"integer","description":"The incoming traffic (Mbit or GB)","readOnly":true}},"additionalProperties":false},"HostIP":{"type":"object","required":["ipAddress","version","type","private","interface","macAddress","rDns","vlanId","gateway","netmask","prefix"],"properties":{"ipAddress":{"type":"string","format":"","description":"Host IP address","readOnly":true},"version":{"type":"integer","format":"integer","description":"IP version, possible values can be 4 or 6","readOnly":true},"type":{"type":"integer","format":"integer","description":"IP type:\n1) normal,\n2) KVM,\n253) VRRP1,\n254) VRRP2,\n255) gateway","readOnly":true},"private":{"type":"integer","format":"integer","description":"Private IP (1) or public IP (0)","readOnly":true},"interface":{"type":"integer","format":"integer","description":"ID of the interface (0-7)","readOnly":true},"macAddress":{"type":"string","format":"","description":"MAC address of the interface","readOnly":true},"rDns":{"type":"string","format":"","description":"RDNS of the interface","readOnly":true},"vlanId":{"type":"integer","format":"integer","description":"ID for the VLAN","nullable":true,"readOnly":true},"gateway":{"type":"string","format":"","description":"Interface gateway","nullable":true,"readOnly":true},"netmask":{"type":"string","format":"","description":"Interface netmask","nullable":true,"readOnly":true},"prefix":{"type":"integer","format":"integer","description":"Interface prefix","nullable":true,"readOnly":true}},"additionalProperties":false},"HostCpu":{"type":"object","required":["socket","cores","threads","info","type"],"properties":{"socket":{"type":"integer","format":"integer","description":"Number of populated CPU sockets","readOnly":true},"cores":{"type":"integer","format":"integer","description":"Total number of cores (sum of all CPU cores)","readOnly":true},"threads":{"type":"integer","format":"integer","description":"Total number of threads (sum of all CPU threads).","readOnly":true},"info":{"type":"string","format":"","description":"CPU information","readOnly":true},"type":{"type":"string","format":"","description":"CPU type","readOnly":true}},"additionalProperties":false},"HostDisk":{"type":"object","required":["diskType","diskMedium","model","product","diskSerial","firmwareVersion","rotationRate","sectorSizeLogical","sectorSizePhysical","size"],"properties":{"diskType":{"type":"string","format":"","description":"The type of disk","readOnly":true},"diskMedium":{"type":"string","format":"","description":"The medium of this disk","readOnly":true},"model":{"type":"string","format":"","description":"The model name of this disk","readOnly":true},"product":{"type":"string","format":"","description":"The product string of this disk","readOnly":true},"diskSerial":{"type":"string","format":"","description":"The serial number of this disk","readOnly":true},"firmwareVersion":{"type":"string","format":"","description":"Firmware version","readOnly":true},"rotationRate":{"type":"integer","format":"integer","description":"Rotation rate (does not apply to SSD)","readOnly":true},"sectorSizeLogical":{"type":"integer","format":"integer","description":"Logical sector size","readOnly":true},"sectorSizePhysical":{"type":"integer","format":"integer","description":"Physical sector size","readOnly":true},"size":{"type":"integer","format":"integer","description":"In bytes","readOnly":true}},"additionalProperties":false},"HostMemory":{"type":"object","required":["brand","model","size","speed","ecc","memoryBank","memoryType","memorySlot","memorySerial"],"properties":{"brand":{"type":"string","format":"","description":"The brand name","readOnly":true},"model":{"type":"string","format":"","description":"The model name","readOnly":true},"size":{"type":"integer","format":"integer","description":"In bytes","readOnly":true},"speed":{"type":"integer","format":"integer","description":"The speed this memory module runs at","readOnly":true},"ecc":{"type":"integer","format":"integer","description":"Set to 1 if ecc is supported and enabled","readOnly":true},"memoryBank":{"type":"integer","format":"integer","description":"The bank this module sits in","readOnly":true},"memoryType":{"type":"string","format":"","description":"The type of memory module","readOnly":true},"memorySlot":{"type":"string","format":"","description":"The slot this module sits in","readOnly":true},"memorySerial":{"type":"string","format":"","description":"The serial number of this module","readOnly":true}},"additionalProperties":false},"Label":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","format":"","description":"Label key, only hyphens (-), underscores (_), lowercase characters and numbers are allowed. Keys must start with a lowercase character."},"value":{"type":"string","format":"","description":"Label value, maximum length is 150 characters"}},"additionalProperties":false},"HostUplink":{"type":"object","required":["uplinkId","aggregate"],"properties":{"uplinkId":{"type":"integer","format":"integer","description":"The cacti ID of the uplink","readOnly":true},"aggregate":{"type":"boolean","description":"True if the uplink is an aggregated uplink, false if it is not aggregated","readOnly":true}},"additionalProperties":false}}}}
```

## The HostActionResponse object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostActionResponse":{"type":"object","required":["result","timestamp"],"properties":{"result":{"type":"string","format":"","description":"The incoming data usage"},"timestamp":{"type":"integer","format":"integer","description":"The corresponding date"}},"additionalProperties":false}}}}
```

## The HostAlert object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostAlert":{"type":"object","required":["id","percentage","sendMail","sendTicket","triggered","createdAt"],"properties":{"id":{"type":"integer","format":"integer","description":"Host alert ID","readOnly":true},"percentage":{"type":"integer","format":"integer","description":"At what percentage of bandwidth usage to trigger the alert"},"sendMail":{"type":"integer","format":"integer","description":"Will send an email notification when alert is triggered"},"sendTicket":{"type":"integer","format":"integer","description":"WIll create a ticket notification when alert is triggered"},"triggered":{"type":"integer","format":"integer","description":"UNIX timestamp of the last time the alert was triggered","readOnly":true},"createdAt":{"type":"integer","format":"integer","description":"UNIX timestamp of the time the alert was created","readOnly":true}},"additionalProperties":false}}}}
```

## The HostCapacityTemplate object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostCapacityTemplate":{"type":"object","required":["id","fleetIds","applicationBuildIds","name","inUse","createdAt"],"properties":{"id":{"type":"string","format":"","description":"The ID of the Host Capacity Template","readOnly":true},"fleetIds":{"type":"array","items":{"type":"string","format":""},"description":"IDs of the Fleets that use this Host Capacity Template","readOnly":true},"applicationBuildIds":{"type":"array","items":{"type":"string","format":""},"description":"IDs of the Application Builds that use this Host Capacity Template","readOnly":true},"name":{"type":"string","format":"","description":"The public name of your Host Capacity Template"},"inUse":{"type":"integer","format":"integer","description":"1 if the Host Capacity Template is in use by a Fleet or Application Build, 0 if it is not."},"createdAt":{"type":"integer","format":"integer","description":"The Unix timestamp at which this element is created","readOnly":true}},"additionalProperties":false}}}}
```

## The HostCpu object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostCpu":{"type":"object","required":["socket","cores","threads","info","type"],"properties":{"socket":{"type":"integer","format":"integer","description":"Number of populated CPU sockets","readOnly":true},"cores":{"type":"integer","format":"integer","description":"Total number of cores (sum of all CPU cores)","readOnly":true},"threads":{"type":"integer","format":"integer","description":"Total number of threads (sum of all CPU threads).","readOnly":true},"info":{"type":"string","format":"","description":"CPU information","readOnly":true},"type":{"type":"string","format":"","description":"CPU type","readOnly":true}},"additionalProperties":false}}}}
```

## The HostCpuDataTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostCpuDataTelemetry":{"type":"object","required":["timestamp","cpu"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The time at which the last update occurred","readOnly":true},"cpu":{"type":"integer","format":"integer","description":"Percentage of cpu used across all cores","readOnly":true}},"additionalProperties":false}}}}
```

## The HostCpuTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostCpuTelemetry":{"type":"object","required":["unit","data"],"properties":{"unit":{"type":"string","format":"","description":"Unit of data frequency, which is always '1m' in this endpoint","readOnly":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/HostCpuDataTelemetry"},"description":"Contains the data object","readOnly":true}},"additionalProperties":false},"HostCpuDataTelemetry":{"type":"object","required":["timestamp","cpu"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The time at which the last update occurred","readOnly":true},"cpu":{"type":"integer","format":"integer","description":"Percentage of cpu used across all cores","readOnly":true}},"additionalProperties":false}}}}
```

## The HostDisk object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostDisk":{"type":"object","required":["diskType","diskMedium","model","product","diskSerial","firmwareVersion","rotationRate","sectorSizeLogical","sectorSizePhysical","size"],"properties":{"diskType":{"type":"string","format":"","description":"The type of disk","readOnly":true},"diskMedium":{"type":"string","format":"","description":"The medium of this disk","readOnly":true},"model":{"type":"string","format":"","description":"The model name of this disk","readOnly":true},"product":{"type":"string","format":"","description":"The product string of this disk","readOnly":true},"diskSerial":{"type":"string","format":"","description":"The serial number of this disk","readOnly":true},"firmwareVersion":{"type":"string","format":"","description":"Firmware version","readOnly":true},"rotationRate":{"type":"integer","format":"integer","description":"Rotation rate (does not apply to SSD)","readOnly":true},"sectorSizeLogical":{"type":"integer","format":"integer","description":"Logical sector size","readOnly":true},"sectorSizePhysical":{"type":"integer","format":"integer","description":"Physical sector size","readOnly":true},"size":{"type":"integer","format":"integer","description":"In bytes","readOnly":true}},"additionalProperties":false}}}}
```

## The HostFormatDisks object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostFormatDisks":{"type":"object","required":["method"],"properties":{"method":{"type":"string","format":"","description":"Can be quick format or a full secure disk wipe. Available options: quick | fullwipe"}},"additionalProperties":false}}}}
```

## The HostHardwareCapacityDataTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostHardwareCapacityDataTelemetry":{"type":"object","required":["timestamp","value"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The time at which the last update occurred","readOnly":true},"value":{"allOf":[{"$ref":"#/components/schemas/HostHardwareCapacityDataValueTelemetry"}],"description":"The value of data at this timestamp","readOnly":true}},"additionalProperties":false},"HostHardwareCapacityDataValueTelemetry":{"type":"object","required":["cpuPercentage","ramPercentage","diskPercentage"],"properties":{"cpuPercentage":{"type":"number","format":"float","description":"The amount of used CPU power as a percentage of the total amount of CPU power","readOnly":true},"ramPercentage":{"type":"number","format":"float","description":"The amount of used RAM space as a percentage of the total amount of RAM","readOnly":true},"diskPercentage":{"type":"number","format":"float","description":"The amount of used disk space as a percentage of the total amount of space","readOnly":true}},"additionalProperties":false}}}}
```

## The HostHardwareCapacityDataValueTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostHardwareCapacityDataValueTelemetry":{"type":"object","required":["cpuPercentage","ramPercentage","diskPercentage"],"properties":{"cpuPercentage":{"type":"number","format":"float","description":"The amount of used CPU power as a percentage of the total amount of CPU power","readOnly":true},"ramPercentage":{"type":"number","format":"float","description":"The amount of used RAM space as a percentage of the total amount of RAM","readOnly":true},"diskPercentage":{"type":"number","format":"float","description":"The amount of used disk space as a percentage of the total amount of space","readOnly":true}},"additionalProperties":false}}}}
```

## The HostHardwareCapacityTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostHardwareCapacityTelemetry":{"type":"object","required":["unit","data"],"properties":{"unit":{"type":"string","format":"","description":"Unit of data frequency","readOnly":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/HostHardwareCapacityDataTelemetry"},"description":"Contains the data object","readOnly":true}},"additionalProperties":false},"HostHardwareCapacityDataTelemetry":{"type":"object","required":["timestamp","value"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The time at which the last update occurred","readOnly":true},"value":{"allOf":[{"$ref":"#/components/schemas/HostHardwareCapacityDataValueTelemetry"}],"description":"The value of data at this timestamp","readOnly":true}},"additionalProperties":false},"HostHardwareCapacityDataValueTelemetry":{"type":"object","required":["cpuPercentage","ramPercentage","diskPercentage"],"properties":{"cpuPercentage":{"type":"number","format":"float","description":"The amount of used CPU power as a percentage of the total amount of CPU power","readOnly":true},"ramPercentage":{"type":"number","format":"float","description":"The amount of used RAM space as a percentage of the total amount of RAM","readOnly":true},"diskPercentage":{"type":"number","format":"float","description":"The amount of used disk space as a percentage of the total amount of space","readOnly":true}},"additionalProperties":false}}}}
```

## The HostHddDataTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostHddDataTelemetry":{"type":"object","required":["timestamp","hardDisk0Free","hardDisk1Free","hardDisk2Free","hardDisk3Free"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The time at which the last update occurred","readOnly":true},"hardDisk0Free":{"type":"integer","format":"integer","description":"The first hard disk's free space in bytes","readOnly":true},"hardDisk1Free":{"type":"integer","format":"integer","description":"The second hard disk's free space in bytes","readOnly":true},"hardDisk2Free":{"type":"integer","format":"integer","description":"The third hard disk's free space in bytes","readOnly":true},"hardDisk3Free":{"type":"integer","format":"integer","description":"The fourth hard disk's free space in bytes","readOnly":true}},"additionalProperties":false}}}}
```

## The HostHddTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostHddTelemetry":{"type":"object","required":["unit","data"],"properties":{"unit":{"type":"string","format":"","description":"Unit of data frequency, which is always '1m' in this endpoint","readOnly":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/HostHddDataTelemetry"},"description":"Contains the data object","readOnly":true}},"additionalProperties":false},"HostHddDataTelemetry":{"type":"object","required":["timestamp","hardDisk0Free","hardDisk1Free","hardDisk2Free","hardDisk3Free"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The time at which the last update occurred","readOnly":true},"hardDisk0Free":{"type":"integer","format":"integer","description":"The first hard disk's free space in bytes","readOnly":true},"hardDisk1Free":{"type":"integer","format":"integer","description":"The second hard disk's free space in bytes","readOnly":true},"hardDisk2Free":{"type":"integer","format":"integer","description":"The third hard disk's free space in bytes","readOnly":true},"hardDisk3Free":{"type":"integer","format":"integer","description":"The fourth hard disk's free space in bytes","readOnly":true}},"additionalProperties":false}}}}
```

## The HostIP object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostIP":{"type":"object","required":["ipAddress","version","type","private","interface","macAddress","rDns","vlanId","gateway","netmask","prefix"],"properties":{"ipAddress":{"type":"string","format":"","description":"Host IP address","readOnly":true},"version":{"type":"integer","format":"integer","description":"IP version, possible values can be 4 or 6","readOnly":true},"type":{"type":"integer","format":"integer","description":"IP type:\n1) normal,\n2) KVM,\n253) VRRP1,\n254) VRRP2,\n255) gateway","readOnly":true},"private":{"type":"integer","format":"integer","description":"Private IP (1) or public IP (0)","readOnly":true},"interface":{"type":"integer","format":"integer","description":"ID of the interface (0-7)","readOnly":true},"macAddress":{"type":"string","format":"","description":"MAC address of the interface","readOnly":true},"rDns":{"type":"string","format":"","description":"RDNS of the interface","readOnly":true},"vlanId":{"type":"integer","format":"integer","description":"ID for the VLAN","nullable":true,"readOnly":true},"gateway":{"type":"string","format":"","description":"Interface gateway","nullable":true,"readOnly":true},"netmask":{"type":"string","format":"","description":"Interface netmask","nullable":true,"readOnly":true},"prefix":{"type":"integer","format":"integer","description":"Interface prefix","nullable":true,"readOnly":true}},"additionalProperties":false}}}}
```

## The HostLiveState object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostLiveState":{"type":"object","required":["id","serverId","cpuLoad","memMax","memUsed","memFree"],"properties":{"id":{"type":"integer","format":"integer","description":"The ID of this host","readOnly":true},"serverId":{"type":"integer","format":"integer","description":"The ID of the physical machine","readOnly":true},"cpuLoad":{"type":"number","format":"float","description":"Percentage of cpu used across all cores","readOnly":true},"memMax":{"type":"integer","format":"integer","description":"The amount of memory that is available on the host (in megabytes)","readOnly":true},"memUsed":{"type":"integer","format":"integer","description":"The amount of memory that is used by the host (in megabytes)","readOnly":true},"memFree":{"type":"integer","format":"integer","description":"The amount of free memory that is available on the host (in megabytes)","readOnly":true}},"additionalProperties":false}}}}
```

## The HostMemory object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostMemory":{"type":"object","required":["brand","model","size","speed","ecc","memoryBank","memoryType","memorySlot","memorySerial"],"properties":{"brand":{"type":"string","format":"","description":"The brand name","readOnly":true},"model":{"type":"string","format":"","description":"The model name","readOnly":true},"size":{"type":"integer","format":"integer","description":"In bytes","readOnly":true},"speed":{"type":"integer","format":"integer","description":"The speed this memory module runs at","readOnly":true},"ecc":{"type":"integer","format":"integer","description":"Set to 1 if ecc is supported and enabled","readOnly":true},"memoryBank":{"type":"integer","format":"integer","description":"The bank this module sits in","readOnly":true},"memoryType":{"type":"string","format":"","description":"The type of memory module","readOnly":true},"memorySlot":{"type":"string","format":"","description":"The slot this module sits in","readOnly":true},"memorySerial":{"type":"string","format":"","description":"The serial number of this module","readOnly":true}},"additionalProperties":false}}}}
```

## The HostMemoryDataTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostMemoryDataTelemetry":{"type":"object","required":["timestamp","memUsed"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The time at which the last update occurred","readOnly":true},"memUsed":{"type":"integer","format":"integer","description":"The amount of memory that is used by the host (in megabytes)","readOnly":true}},"additionalProperties":false}}}}
```

## The HostMemoryTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostMemoryTelemetry":{"type":"object","required":["unit","memMax","data"],"properties":{"unit":{"type":"string","format":"","description":"Unit of data frequency, which is always '1m' in this endpoint","readOnly":true},"memMax":{"type":"integer","format":"integer","description":"The amount of memory that is available on the host (in megabytes)","readOnly":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/HostMemoryDataTelemetry"},"description":"Contains the data object","readOnly":true}},"additionalProperties":false},"HostMemoryDataTelemetry":{"type":"object","required":["timestamp","memUsed"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The time at which the last update occurred","readOnly":true},"memUsed":{"type":"integer","format":"integer","description":"The amount of memory that is used by the host (in megabytes)","readOnly":true}},"additionalProperties":false}}}}
```

## The HostNetworkDataTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostNetworkDataTelemetry":{"type":"object","required":["timestamp","networkIngress","networkEgress"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The time at which the last update occurred","readOnly":true},"networkIngress":{"type":"integer","format":"integer","description":"The network's ingress in bytes","readOnly":true},"networkEgress":{"type":"integer","format":"integer","description":"The network's egress in bytes","readOnly":true}},"additionalProperties":false}}}}
```

## The HostNetworkTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostNetworkTelemetry":{"type":"object","required":["unit","data"],"properties":{"unit":{"type":"string","format":"","description":"Unit of data frequency, which is always '1m' in this endpoint","readOnly":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/HostNetworkDataTelemetry"},"description":"Contains the data object","readOnly":true}},"additionalProperties":false},"HostNetworkDataTelemetry":{"type":"object","required":["timestamp","networkIngress","networkEgress"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The time at which the last update occurred","readOnly":true},"networkIngress":{"type":"integer","format":"integer","description":"The network's ingress in bytes","readOnly":true},"networkEgress":{"type":"integer","format":"integer","description":"The network's egress in bytes","readOnly":true}},"additionalProperties":false}}}}
```

## The HostOnlineStatusHistoryDataTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostOnlineStatusHistoryDataTelemetry":{"type":"object","required":["hostType","online","install","offline","unknown"],"properties":{"hostType":{"type":"integer","format":"integer","description":"Type of the host e.g 1: Bare metal, 2: Flex metal, 3: Cloud","readOnly":true},"online":{"type":"integer","format":"integer","description":"The number of host with status online","readOnly":true},"install":{"type":"integer","format":"integer","description":"The number of host with status installing","readOnly":true},"offline":{"type":"integer","format":"integer","description":"The number of host with status offline","readOnly":true},"unknown":{"type":"integer","format":"integer","description":"The number of host with status unknow","readOnly":true}},"additionalProperties":false}}}}
```

## The HostOnlineStatusHistoryHostTypeTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostOnlineStatusHistoryHostTypeTelemetry":{"type":"object","required":["timestamp","data"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The time at which the last update occurred","readOnly":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/HostOnlineStatusHistoryDataTelemetry"},"description":"Contains the data object","readOnly":true}},"additionalProperties":false},"HostOnlineStatusHistoryDataTelemetry":{"type":"object","required":["hostType","online","install","offline","unknown"],"properties":{"hostType":{"type":"integer","format":"integer","description":"Type of the host e.g 1: Bare metal, 2: Flex metal, 3: Cloud","readOnly":true},"online":{"type":"integer","format":"integer","description":"The number of host with status online","readOnly":true},"install":{"type":"integer","format":"integer","description":"The number of host with status installing","readOnly":true},"offline":{"type":"integer","format":"integer","description":"The number of host with status offline","readOnly":true},"unknown":{"type":"integer","format":"integer","description":"The number of host with status unknow","readOnly":true}},"additionalProperties":false}}}}
```

## The HostOnlineStatusHistoryTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostOnlineStatusHistoryTelemetry":{"type":"object","required":["unit","host"],"properties":{"unit":{"type":"string","format":"","description":"Unit of data frequency","readOnly":true},"host":{"type":"array","items":{"$ref":"#/components/schemas/HostOnlineStatusHistoryHostTypeTelemetry"},"description":"Contains the data object by host type","readOnly":true}},"additionalProperties":false},"HostOnlineStatusHistoryHostTypeTelemetry":{"type":"object","required":["timestamp","data"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The time at which the last update occurred","readOnly":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/HostOnlineStatusHistoryDataTelemetry"},"description":"Contains the data object","readOnly":true}},"additionalProperties":false},"HostOnlineStatusHistoryDataTelemetry":{"type":"object","required":["hostType","online","install","offline","unknown"],"properties":{"hostType":{"type":"integer","format":"integer","description":"Type of the host e.g 1: Bare metal, 2: Flex metal, 3: Cloud","readOnly":true},"online":{"type":"integer","format":"integer","description":"The number of host with status online","readOnly":true},"install":{"type":"integer","format":"integer","description":"The number of host with status installing","readOnly":true},"offline":{"type":"integer","format":"integer","description":"The number of host with status offline","readOnly":true},"unknown":{"type":"integer","format":"integer","description":"The number of host with status unknow","readOnly":true}},"additionalProperties":false}}}}
```

## The HostOnlineStatusTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostOnlineStatusTelemetry":{"type":"object","required":["timestamp","hostType","online","onlinePercentage","install","installPercentage","offline","offlinePercentage","unknown","unknownPercentage","total"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The unix time stamp","readOnly":true},"hostType":{"type":"integer","format":"integer","description":"Type of the host e.g\n* 1: Bare metal\n* 2: Flex metal\n* 3: Cloud","readOnly":true},"online":{"type":"integer","format":"integer","description":"The number of hosts with status online","readOnly":true},"onlinePercentage":{"type":"integer","format":"integer","description":"The percentage of hosts with status online","readOnly":true},"install":{"type":"integer","format":"integer","description":"The number of hosts with status installing","readOnly":true},"installPercentage":{"type":"integer","format":"integer","description":"The percentage of hosts with status installing","readOnly":true},"offline":{"type":"integer","format":"integer","description":"The number of hosts with status offline","readOnly":true},"offlinePercentage":{"type":"integer","format":"integer","description":"The percentage of hosts with status offline","readOnly":true},"unknown":{"type":"integer","format":"integer","description":"The number of hosts with status unknown","readOnly":true},"unknownPercentage":{"type":"integer","format":"integer","description":"The percentage of hosts with status unknown","readOnly":true},"total":{"type":"integer","format":"integer","description":"The total number of hosts","readOnly":true}},"additionalProperties":false}}}}
```

## The HostOsInstall object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostOsInstall":{"type":"object","required":["os"],"properties":{"hostname":{"type":"string","format":""},"os":{"$ref":"#/components/schemas/OperatingSystemPartial"},"postInstallScript":{"type":"string","format":""},"quickFormat":{"type":"boolean","description":"Perform a quick format of all drives. Default: true"},"sshKeyUuid":{"type":"string","format":"","description":"For an overview of available SSH keys, see /v3/sshKey. Only required for Linux OSs, except Talos."}},"additionalProperties":false},"OperatingSystemPartial":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","format":"integer","description":"For an overview of available Operating Systems, see /v3/operatingsystem."},"kernelParams":{"type":"array","items":{"$ref":"#/components/schemas/KernelParamPartial"}}},"additionalProperties":false},"KernelParamPartial":{"type":"object","required":["key"],"properties":{"key":{"type":"string","format":""},"value":{"type":"string","format":""}},"additionalProperties":false}}}}
```

## The HostOveruseTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostOveruseTelemetry":{"type":"object","required":["hostId","hostName","orderedBandwidth","usedBandwidth"],"properties":{"hostId":{"type":"integer","format":"integer","description":"The ID of the host","readOnly":true},"hostName":{"type":"string","format":"","description":"The name of the physical machine","readOnly":true},"orderedBandwidth":{"type":"number","format":"float","description":"Allowed bandwidth of the host","readOnly":true},"usedBandwidth":{"type":"number","format":"float","description":"Used bandwidth of the host","readOnly":true}},"additionalProperties":false}}}}
```

## The HostSummary object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostSummary":{"type":"object","required":["id","serverId","serverName","serverType","liveHostName","isVirtual","category","osId","locationId","dcLocationId","instanceType","fleetId","newFleetId","fleetAssociatedSince","rackName","dateStart","dateEnd","dateCancelled","dateEndContract","contractPeriod","extendPeriod","cancellationPeriod","purchaseOrder","paymentTerm","pricePerMonth","pricePerTbOveruse","currencyId","bandwidthBillingType","bandwidthContractual","brand","model","isReserve","serviceTag","isODP","fmOrderId","installStatus","status","trafficSum","freeIncomingTraffic","outgoingTrafficSum","incomingTrafficSum"],"properties":{"id":{"type":"integer","format":"integer","description":"The ID of this host","readOnly":true},"serverId":{"type":"integer","format":"integer","description":"The ID of the physical machine","readOnly":true},"serverName":{"type":"string","format":"","description":"The name of the physical machine","readOnly":true},"serverType":{"type":"integer","format":"integer","description":"The type of the server:\n* 1: Bare metal server\n* 2: Flex metal server\n* 3: Virtual machine","readOnly":true},"projectName":{"type":"string","format":"","description":"The name of the project for the host"},"clientServerName":{"type":"string","format":"","description":"The name of the server defined by client"},"clientState":{"type":"string","format":"","description":"Client statement for the host"},"liveHostName":{"type":"string","format":"","description":"The host name","readOnly":true},"isVirtual":{"type":"integer","format":"integer","description":"0 if this is a bare metal server, 1 if it's a VM. Use `serverType` instead","readOnly":true,"deprecated":true},"category":{"type":"string","format":"","description":"Host category. Normally \"Dedicated Game Servers\" or \"Dedicated Servers\", but can be \"Broken\" if the server is in a degraded state","readOnly":true},"osId":{"type":"integer","format":"integer","description":"Operating system ID, must be one of [`GET /v3/operatingsystem`](all#/OperatingSystem/getOperatingsystems)","readOnly":true},"locationId":{"type":"integer","format":"integer","description":"Legacy location ID (not used for ODP)","readOnly":true},"dcLocationId":{"type":"integer","format":"integer","description":"Datacenter location ID. Points to one of [`GET /v3/cloud/dcLocation`](#/Cloud/getCloudDcLocations)","readOnly":true},"instanceType":{"type":"string","format":"","description":"The instance type of this server, which is one of [`GET /v3/host/instanceType`](#/Host/getHostInstanceTypes) for a bare metal, or one of\n[`GET /v3/cloud/instanceType`](#/Cloud/getCloudInstanceTypes) for a virtual machine","readOnly":true},"fleetId":{"type":"string","format":"","description":"The fleet ID, if this host has been assigned to a fleet\nIf `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.","readOnly":true},"newFleetId":{"type":"string","format":"","description":"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`](#/Fleet/createFleetHostBulkReserve)","nullable":true,"readOnly":true},"fleetAssociatedSince":{"type":"integer","format":"integer","description":"Unix timestamp when fleet assigned to the host","readOnly":true},"rackName":{"type":"string","format":"","description":"The name of the rack the host is located","readOnly":true},"dateStart":{"type":"string","format":"","description":"The date at which this host became active","readOnly":true},"dateEnd":{"type":"string","format":"","description":"The date at which this host will expire","readOnly":true},"dateCancelled":{"type":"string","format":"","description":"The date at which this host was cancelled","readOnly":true},"dateEndContract":{"type":"string","format":"","description":"The date at which the contract ends (if applicable)","readOnly":true},"contractPeriod":{"type":"integer","format":"integer","description":"The contract period in months","readOnly":true},"extendPeriod":{"type":"integer","format":"integer","description":"The service extend period in months","readOnly":true},"cancellationPeriod":{"type":"integer","format":"integer","description":"The cancellation period in months","readOnly":true},"purchaseOrder":{"type":"string","format":"","description":"Purchase order, if one has been supplied via our billing department","readOnly":true},"paymentTerm":{"type":"integer","format":"integer","description":"The payment term in days (how many days are invoices generated before dateEnd)","readOnly":true},"pricePerMonth":{"type":"string","format":"","description":"The price of this host per month in cents (see `currencyId` for currency)","readOnly":true},"pricePerTbOveruse":{"type":"string","format":"","description":"The price of traffic overuse in cents (per TB) (see `currencyId` for currency)","readOnly":true},"currencyId":{"type":"integer","format":"integer","description":"The currency of the `pricePerMonth` field:\n* 0: EURO\n* 1: USD\n* 9: YEN","readOnly":true},"bandwidthBillingType":{"type":"integer","format":"integer","description":"The bandwidth billing method for this service:\n* 1: unmetered connection\n* 2: measured in TB per month\n* 3: measured in mbit 95th percentile","readOnly":true},"bandwidthContractual":{"type":"integer","format":"integer","description":"The contractual maximum bandwidth usage value. In GB if bandwidthBillingType equals `2`, in mbit otherwise","readOnly":true},"brand":{"type":"string","format":"","description":"The server manufacturer brand name","readOnly":true},"model":{"type":"string","format":"","description":"The model of the server","readOnly":true},"isReserve":{"type":"integer","format":"integer","description":"If the host is reserved for a fleet isReserve set to 1","readOnly":true},"serviceTag":{"type":"string","format":"","description":"The service tag of the host","readOnly":true},"isODP":{"type":"integer","format":"integer","description":"If the host is available for game hosting platform isODP set to 1","readOnly":true},"fmOrderId":{"type":"string","format":"","description":"ID of Flex Metal order if this is a flex metal server","nullable":true,"readOnly":true},"installStatus":{"type":"string","format":"","description":"Status of server auto install if it was started by one. (created / installing / finished / failed)","nullable":true,"readOnly":true},"status":{"type":"string","format":"","description":"Whether the host is running or not","readOnly":true},"uptime":{"type":"integer","format":"integer","description":"The uptime of the host. Read-only. Only provided if the server checked-in recently"},"trafficSum":{"type":"integer","format":"integer","description":"Monthly traffic of all incoming and outgoing bandwidth in GB or Mbit depending on host configuration","readOnly":true},"freeIncomingTraffic":{"type":"boolean","description":"Whether the host has free incoming traffic or not","readOnly":true},"outgoingTrafficSum":{"type":"integer","format":"integer","description":"The outgoing traffic (Mbit or GB)","readOnly":true},"incomingTrafficSum":{"type":"integer","format":"integer","description":"The incoming traffic (Mbit or GB)","readOnly":true}},"additionalProperties":false}}}}
```

## The HostUplink object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostUplink":{"type":"object","required":["uplinkId","aggregate"],"properties":{"uplinkId":{"type":"integer","format":"integer","description":"The cacti ID of the uplink","readOnly":true},"aggregate":{"type":"boolean","description":"True if the uplink is an aggregated uplink, false if it is not aggregated","readOnly":true}},"additionalProperties":false}}}}
```

## The HostUtilizationAggregateDataContainerTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostUtilizationAggregateDataContainerTelemetry":{"type":"object","required":["timestamp","hosts"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"Unix time in which the data was saved","readOnly":true},"hosts":{"type":"array","items":{"$ref":"#/components/schemas/HostUtilizationAggregateDataTelemetry"},"description":"List containing the telemetry data grouped by providerId","readOnly":true}},"additionalProperties":false},"HostUtilizationAggregateDataTelemetry":{"type":"object","required":["providerId","hostsOccupied","hostsFree","hostsFull","hostsTotal","launched","destroyed"],"properties":{"providerId":{"type":"integer","format":"integer","description":"Cloud provider ID. For a list of cloud providers see [`GET /v3/cloud/provider`](#/Cloud/get_v3_cloud_provider)","readOnly":true},"hostsOccupied":{"type":"integer","format":"integer","description":"Number of hosts that are occupied (one or more (but not the maximum amount of) application instances on them)","readOnly":true},"hostsFree":{"type":"integer","format":"integer","description":"Number of host that are free (no application instances on them)","readOnly":true},"hostsFull":{"type":"integer","format":"integer","description":"Number of host that are full (the maximum amount of application instances on them)\nSee also [`GET /v3/hostCapacityTemplate`](#/HostCapacityTemplate/getHostCapacityTemplates) and\n[`GET /v3/hostCapacityTemplate/{hostCapacityTemplateId}/instanceTypeCapacity`](#/InstanceTypeCapacity/getHostCapacityTemplateInstanceTypeCapacities)","readOnly":true},"hostsTotal":{"type":"integer","format":"integer","description":"Number of hosts in total","readOnly":true},"launched":{"type":"integer","format":"integer","description":"Number of launched instances since the previous entry","readOnly":true},"destroyed":{"type":"integer","format":"integer","description":"Number of destroyed instances since the previous entry","readOnly":true}},"additionalProperties":false}}}}
```

## The HostUtilizationAggregateDataTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostUtilizationAggregateDataTelemetry":{"type":"object","required":["providerId","hostsOccupied","hostsFree","hostsFull","hostsTotal","launched","destroyed"],"properties":{"providerId":{"type":"integer","format":"integer","description":"Cloud provider ID. For a list of cloud providers see [`GET /v3/cloud/provider`](#/Cloud/get_v3_cloud_provider)","readOnly":true},"hostsOccupied":{"type":"integer","format":"integer","description":"Number of hosts that are occupied (one or more (but not the maximum amount of) application instances on them)","readOnly":true},"hostsFree":{"type":"integer","format":"integer","description":"Number of host that are free (no application instances on them)","readOnly":true},"hostsFull":{"type":"integer","format":"integer","description":"Number of host that are full (the maximum amount of application instances on them)\nSee also [`GET /v3/hostCapacityTemplate`](#/HostCapacityTemplate/getHostCapacityTemplates) and\n[`GET /v3/hostCapacityTemplate/{hostCapacityTemplateId}/instanceTypeCapacity`](#/InstanceTypeCapacity/getHostCapacityTemplateInstanceTypeCapacities)","readOnly":true},"hostsTotal":{"type":"integer","format":"integer","description":"Number of hosts in total","readOnly":true},"launched":{"type":"integer","format":"integer","description":"Number of launched instances since the previous entry","readOnly":true},"destroyed":{"type":"integer","format":"integer","description":"Number of destroyed instances since the previous entry","readOnly":true}},"additionalProperties":false}}}}
```

## The HostUtilizationAggregateTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostUtilizationAggregateTelemetry":{"type":"object","required":["unit","data"],"properties":{"unit":{"type":"string","format":"","description":"Unit of data frequency, possible interval options are as follows\n- minute\n- hour\n- day\n- month","readOnly":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/HostUtilizationAggregateDataContainerTelemetry"},"description":"Object containing the data object grouped by timestamp and providerId","readOnly":true}},"additionalProperties":false},"HostUtilizationAggregateDataContainerTelemetry":{"type":"object","required":["timestamp","hosts"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"Unix time in which the data was saved","readOnly":true},"hosts":{"type":"array","items":{"$ref":"#/components/schemas/HostUtilizationAggregateDataTelemetry"},"description":"List containing the telemetry data grouped by providerId","readOnly":true}},"additionalProperties":false},"HostUtilizationAggregateDataTelemetry":{"type":"object","required":["providerId","hostsOccupied","hostsFree","hostsFull","hostsTotal","launched","destroyed"],"properties":{"providerId":{"type":"integer","format":"integer","description":"Cloud provider ID. For a list of cloud providers see [`GET /v3/cloud/provider`](#/Cloud/get_v3_cloud_provider)","readOnly":true},"hostsOccupied":{"type":"integer","format":"integer","description":"Number of hosts that are occupied (one or more (but not the maximum amount of) application instances on them)","readOnly":true},"hostsFree":{"type":"integer","format":"integer","description":"Number of host that are free (no application instances on them)","readOnly":true},"hostsFull":{"type":"integer","format":"integer","description":"Number of host that are full (the maximum amount of application instances on them)\nSee also [`GET /v3/hostCapacityTemplate`](#/HostCapacityTemplate/getHostCapacityTemplates) and\n[`GET /v3/hostCapacityTemplate/{hostCapacityTemplateId}/instanceTypeCapacity`](#/InstanceTypeCapacity/getHostCapacityTemplateInstanceTypeCapacities)","readOnly":true},"hostsTotal":{"type":"integer","format":"integer","description":"Number of hosts in total","readOnly":true},"launched":{"type":"integer","format":"integer","description":"Number of launched instances since the previous entry","readOnly":true},"destroyed":{"type":"integer","format":"integer","description":"Number of destroyed instances since the previous entry","readOnly":true}},"additionalProperties":false}}}}
```

## The HostUtilizationDataTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostUtilizationDataTelemetry":{"type":"object","required":["timestamp","hostsOccupied","hostsFree","hostsFull","hostsTotal","launched","destroyed"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The time at which the last update occurred","readOnly":true},"hostsOccupied":{"type":"integer","format":"integer","description":"Number of hosts that are occupied (one or more (but not the maximum amount of) application instances on them)","readOnly":true},"hostsFree":{"type":"integer","format":"integer","description":"Number of host that are free (no application instances on them)","readOnly":true},"hostsFull":{"type":"integer","format":"integer","description":"Number of host that are full (the maximum amount of application instances on them)\nSee also GET /v3/hostCapacityTemplate and GET /v3/hostCapacityTemplate/{hostCapacityTemplateId}/instanceTypeCapacity","readOnly":true},"hostsTotal":{"type":"integer","format":"integer","description":"Number of hosts in total","readOnly":true},"launched":{"type":"integer","format":"integer","description":"Number of launched instances since the previous entry","readOnly":true},"destroyed":{"type":"integer","format":"integer","description":"Number of destroyed instances since the previous entry","readOnly":true}},"additionalProperties":false}}}}
```

## The HostUtilizationTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"HostUtilizationTelemetry":{"type":"object","required":["unit","data"],"properties":{"unit":{"type":"string","format":"","description":"Unit of data frequency, which is always '1m' in this endpoint","readOnly":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/HostUtilizationDataTelemetry"},"description":"Contains the data object","readOnly":true}},"additionalProperties":false},"HostUtilizationDataTelemetry":{"type":"object","required":["timestamp","hostsOccupied","hostsFree","hostsFull","hostsTotal","launched","destroyed"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The time at which the last update occurred","readOnly":true},"hostsOccupied":{"type":"integer","format":"integer","description":"Number of hosts that are occupied (one or more (but not the maximum amount of) application instances on them)","readOnly":true},"hostsFree":{"type":"integer","format":"integer","description":"Number of host that are free (no application instances on them)","readOnly":true},"hostsFull":{"type":"integer","format":"integer","description":"Number of host that are full (the maximum amount of application instances on them)\nSee also GET /v3/hostCapacityTemplate and GET /v3/hostCapacityTemplate/{hostCapacityTemplateId}/instanceTypeCapacity","readOnly":true},"hostsTotal":{"type":"integer","format":"integer","description":"Number of hosts in total","readOnly":true},"launched":{"type":"integer","format":"integer","description":"Number of launched instances since the previous entry","readOnly":true},"destroyed":{"type":"integer","format":"integer","description":"Number of destroyed instances since the previous entry","readOnly":true}},"additionalProperties":false}}}}
```

## The InstanceDistribution object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"InstanceDistribution":{"type":"object","required":["bareMetal","bareMetalPercentage","flexMetal","flexMetalPercentage","cloud","cloudPercentage","total"],"properties":{"bareMetal":{"type":"integer","format":"integer","description":"Amount of game instances on the bare metal","readOnly":true},"bareMetalPercentage":{"type":"integer","format":"integer","description":"Percentage of game instances on the bare metal","readOnly":true},"flexMetal":{"type":"integer","format":"integer","description":"Amount of game instances on the flex metal","readOnly":true},"flexMetalPercentage":{"type":"integer","format":"integer","description":"Percentage of game instances on the flex metal","readOnly":true},"cloud":{"type":"integer","format":"integer","description":"Amount of game instances in the cloud","readOnly":true},"cloudPercentage":{"type":"integer","format":"integer","description":"Percentage of game instances in the cloud","readOnly":true},"total":{"type":"integer","format":"integer","description":"Total amount of game instances","readOnly":true}},"additionalProperties":false}}}}
```

## The InstanceDistributionDataTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"InstanceDistributionDataTelemetry":{"type":"object","required":["timestamp","bareMetal","bareMetalPercentage","flexMetal","flexMetalPercentage","cloud","cloudPercentage","total"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"Unix timestamp of data","readOnly":true},"bareMetal":{"type":"integer","format":"integer","description":"Amount of game instances on the bare metal","readOnly":true},"bareMetalPercentage":{"type":"integer","format":"integer","description":"Percentage of game instances on the bare metal","readOnly":true},"flexMetal":{"type":"integer","format":"integer","description":"Amount of game instances on the flex metal","readOnly":true},"flexMetalPercentage":{"type":"integer","format":"integer","description":"Percentage of game instances on the flex metal","readOnly":true},"cloud":{"type":"integer","format":"integer","description":"Amount of game instances in the cloud","readOnly":true},"cloudPercentage":{"type":"integer","format":"integer","description":"Percentage of game instances in the cloud","readOnly":true},"total":{"type":"integer","format":"integer","description":"Total amount of game instances","readOnly":true}},"additionalProperties":false}}}}
```

## The InstanceDistributionTelemetry object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"InstanceDistributionTelemetry":{"type":"object","required":["unit","data"],"properties":{"unit":{"type":"string","format":"","description":"Unit of data frequency,  possible interval options are as follows\n- minute\n- hour\n- day\n- month","readOnly":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/InstanceDistributionDataTelemetry"},"description":"Average aggregated data of application instances","readOnly":true}},"additionalProperties":false},"InstanceDistributionDataTelemetry":{"type":"object","required":["timestamp","bareMetal","bareMetalPercentage","flexMetal","flexMetalPercentage","cloud","cloudPercentage","total"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"Unix timestamp of data","readOnly":true},"bareMetal":{"type":"integer","format":"integer","description":"Amount of game instances on the bare metal","readOnly":true},"bareMetalPercentage":{"type":"integer","format":"integer","description":"Percentage of game instances on the bare metal","readOnly":true},"flexMetal":{"type":"integer","format":"integer","description":"Amount of game instances on the flex metal","readOnly":true},"flexMetalPercentage":{"type":"integer","format":"integer","description":"Percentage of game instances on the flex metal","readOnly":true},"cloud":{"type":"integer","format":"integer","description":"Amount of game instances in the cloud","readOnly":true},"cloudPercentage":{"type":"integer","format":"integer","description":"Percentage of game instances in the cloud","readOnly":true},"total":{"type":"integer","format":"integer","description":"Total amount of game instances","readOnly":true}},"additionalProperties":false}}}}
```

## The InstanceType object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"InstanceType":{"type":"object","required":["instanceTypeId","cloudProviderId","dcLocationId","instanceType","numCores","memory","storage","status"],"properties":{"instanceTypeId":{"type":"integer","format":"integer","readOnly":true},"cloudProviderId":{"type":"integer","format":"integer","description":"The cloud provider ID. For a list of cloud providers see [`GET /v3/cloud/provider`](#/Cloud/get_v3_cloud_provider))","readOnly":true},"dcLocationId":{"type":"integer","format":"integer","readOnly":true},"instanceType":{"type":"string","format":"","readOnly":true},"numCores":{"type":"integer","format":"integer","readOnly":true},"memory":{"type":"integer","format":"integer","readOnly":true},"storage":{"type":"string","format":"","readOnly":true},"status":{"type":"integer","format":"integer","description":"It will show either instance type is available or not","readOnly":true}},"additionalProperties":false}}}}
```

## The InstanceTypeBM object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"InstanceTypeBM":{"type":"object","required":["id","instanceType","cpuType","cpuSpeed","numCpu","numCoresPerCpu","memoryType","memorySpeed","memorySize"],"properties":{"id":{"type":"string","format":"","description":"The ID of the instance type","readOnly":true},"instanceType":{"type":"string","format":"","description":"The name of the instance type","readOnly":true},"cpuType":{"type":"string","format":"","description":"The type of CPU of the instance type","readOnly":true},"cpuSpeed":{"type":"integer","format":"integer","description":"The speed of CPU of the instance type","readOnly":true},"numCpu":{"type":"integer","format":"integer","description":"The number of CPUs of the instance type","readOnly":true},"numCoresPerCpu":{"type":"integer","format":"integer","description":"The number of cores per CPUs of the instance type","readOnly":true},"memoryType":{"type":"string","format":"","description":"The type of memory of the instance type","readOnly":true},"memorySpeed":{"type":"integer","format":"integer","description":"The memory speed of the instance type","readOnly":true},"memorySize":{"type":"integer","format":"integer","description":"The amount of memory of the instance type in MB","readOnly":true}},"additionalProperties":false}}}}
```

## The InstanceTypeCapacity object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"InstanceTypeCapacity":{"type":"object","required":["id","hostCapacityTemplateId","providerId","instanceType","isVirtual","capacity","createdAt"],"properties":{"id":{"type":"string","format":"","description":"The ID of the Instance Type Capacity","readOnly":true},"hostCapacityTemplateId":{"type":"string","format":"","description":"The ID of the Host Capacity Template to which this element is linked","readOnly":true},"providerId":{"type":"integer","format":"integer","description":"Cloud provider ID. For a list of cloud providers see [`GET /v3/cloud/provider`](#/Cloud/get_v3_cloud_provider)"},"instanceType":{"type":"string","format":"","description":"The instance type to which the `capacity` applies. This is the name of instance types found at various cloud providers.\nSee GET /cloud/instanceType (for virtual servers) and GET /host/instanceType (for bare metal servers)"},"isVirtual":{"type":"integer","format":"integer","description":"`1` if the instance type is a virtual server, `0` if it is a bare metal server","readOnly":true},"capacity":{"type":"integer","format":"integer","description":"The capacity of the instance type"},"createdAt":{"type":"integer","format":"integer","description":"The Unix timestamp at which this element is created","readOnly":true}},"additionalProperties":false}}}}
```

## The Invoice object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"Invoice":{"type":"object","required":["id","creationDate","dueDate","invoiceNumber","invoiceHash","description","currency","currencySign","amountIncVAT","amountExclVAT","paymentStatus","paymentDate","isCredit","remainingAmount","totalPaidAmount"],"properties":{"id":{"type":"string","format":"","description":"The ID of the invoice","readOnly":true},"creationDate":{"type":"integer","format":"integer","description":"The date the invoice was created","readOnly":true},"dueDate":{"type":"integer","format":"integer","description":"The due date of the invoice","readOnly":true},"invoiceNumber":{"type":"string","format":"","description":"The number of the invoice","readOnly":true},"invoiceHash":{"type":"string","format":"","description":"A unique hash for this invoice","readOnly":true},"description":{"type":"string","format":"","description":"The description of the invoice"},"currency":{"type":"string","format":"","description":"The currency that is being used"},"currencySign":{"type":"string","format":"","description":"The currency sign that is being used"},"amountIncVAT":{"type":"string","format":"","description":"The amount of the invoice with VAT in cents"},"amountExclVAT":{"type":"string","format":"","description":"The amount of the invoice without VAT in cents"},"paymentStatus":{"type":"integer","format":"integer","description":"The payment status"},"paymentDate":{"type":"integer","format":"integer","description":"The timestamp that the invoice was paid, if paid"},"isCredit":{"type":"integer","format":"integer","description":"If this field is 1 it means that invoice is a credit invoice"},"remainingAmount":{"type":"string","format":"","description":"The remaining amount of invoice"},"totalPaidAmount":{"type":"string","format":"","description":"The total paid amount of invoice"}},"additionalProperties":false}}}}
```

## The KernelParamPartial object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"KernelParamPartial":{"type":"object","required":["key"],"properties":{"key":{"type":"string","format":""},"value":{"type":"string","format":""}},"additionalProperties":false}}}}
```

## The Label object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"Label":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","format":"","description":"Label key, only hyphens (-), underscores (_), lowercase characters and numbers are allowed. Keys must start with a lowercase character."},"value":{"type":"string","format":"","description":"Label value, maximum length is 150 characters"}},"additionalProperties":false}}}}
```

## The Metadata object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"Metadata":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","format":"","description":"Metadata key. Max length 50 characters"},"value":{"type":"string","format":"","description":"Metadata value. Max length 2048 bytes"}},"additionalProperties":false}}}}
```

## The MetadataCollection object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"MetadataCollection":{"type":"object","properties":{"metadata":{"type":"array","items":{"$ref":"#/components/schemas/Metadata"},"description":"A collection of Metadata entities"}},"additionalProperties":false},"Metadata":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","format":"","description":"Metadata key. Max length 50 characters"},"value":{"type":"string","format":"","description":"Metadata value. Max length 2048 bytes"}},"additionalProperties":false}}}}
```

## The MirrorState object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"MirrorState":{"type":"object","required":["locationId","locationName","fileServerIds","transfers"],"properties":{"locationId":{"type":"integer","format":"integer","description":"ID of the location"},"locationName":{"type":"string","format":"","description":"Name of the location"},"fileServerIds":{"type":"array","items":{"type":"integer","format":"integer"},"description":"An array with the file server IDs that are used for this mirroring process"},"transfers":{"type":"array","items":{"$ref":"#/components/schemas/Transfer"},"description":"An array with the file transfer progress per file server"}},"additionalProperties":false},"Transfer":{"type":"object","required":["fileServerId","progress","errorCount","retries"],"properties":{"fileServerId":{"type":"integer","format":"integer","description":"ID of the file server"},"progress":{"type":"integer","format":"integer","description":"The transfer progress in percentage"},"errorCount":{"type":"integer","format":"integer","description":"The amount of errors that occurred during this process"},"retries":{"type":"integer","format":"integer","description":"The amount of retries in the process"}},"additionalProperties":false}}}}
```

## The NewCreateApplicationInstall object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"NewCreateApplicationInstall":{"type":"object","required":["applicationId","fileId","osGroupId","name","version","installHasExe"],"properties":{"applicationId":{"type":"string","format":"","description":"The application's ID this application install is coupled to"},"fileId":{"type":"integer","format":"integer","description":"ID of the assignableFile. Can be obtained from [`GET /applicationInstall/assignable`](#/ApplicationAssignableFile/get_applicationInstall_assignable)"},"osGroupId":{"type":"integer","format":"integer","description":"Operating system group ID (1 = windows, 2 = linux)"},"name":{"type":"string","format":"","description":"Application install name"},"version":{"type":"string","format":"","description":"Application install version"},"releaseNotes":{"type":"string","format":"","description":"Game install release notes","nullable":true},"installHasExe":{"type":"integer","format":"integer","description":"Does the archive contain the game instance executable?"}},"additionalProperties":false}}}}
```

## The OperatingSystemPartial object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"OperatingSystemPartial":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","format":"integer","description":"For an overview of available Operating Systems, see /v3/operatingsystem."},"kernelParams":{"type":"array","items":{"$ref":"#/components/schemas/KernelParamPartial"}}},"additionalProperties":false},"KernelParamPartial":{"type":"object","required":["key"],"properties":{"key":{"type":"string","format":""},"value":{"type":"string","format":""}},"additionalProperties":false}}}}
```

## The OperationalStatus object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"OperationalStatus":{"type":"object","required":["operationalStatus"],"properties":{"operationalStatus":{"type":"integer","format":"integer","description":"The operational status for the fleet"}},"additionalProperties":false}}}}
```

## The PatchJob object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"PatchJob":{"type":"object","required":["id","deploymentEnvironmentId","applicationId","patchJobMethodId","patchJobMethod","patchJobName","status","stopMethodId","stopMethodName","patchJobStartTime","patchJobOverallProgress","applicationBuild","fleet","createdAt","changedAt","finishedAt","isRevertable","revertsPatchJobId","revertedByPatchJobId"],"properties":{"id":{"type":"string","format":"","description":"Patch job ID","readOnly":true},"deploymentEnvironmentId":{"type":"string","format":"","description":"Deployment environment ID"},"applicationId":{"type":"string","format":"","description":"Application ID"},"patchJobMethodId":{"type":"integer","format":"integer","description":"Patch job type, you can find the list available patch job type [`GET /v3/patchJob/type`](game-publisher#/PatchJob/get_v3_patchJob_type)"},"patchJobMethod":{"type":"string","format":"","description":"Name of the patch job method","readOnly":true},"patchJobName":{"type":"string","format":"","description":"Name of the patch job (unique)"},"status":{"type":"integer","format":"integer","description":"Status of the patch job, you can find the list available patch job type [`GET /v3/patchJob/status`](game-publisher#/PatchJob/get_v3_patchJob_status)","readOnly":true},"stopMethodId":{"type":"integer","format":"integer","description":"Stop method of an application instance, you can find the list available application instance stop methods [`GET /v3/application/stopMethod`](game-publisher#/Application/get_v3_application_stopMethod)"},"stopMethodName":{"type":"string","format":"","description":"Name of the stop method","readOnly":true},"stopMethodTimeout":{"type":"integer","format":"integer","description":"Stop method timeout of an application instance in seconds"},"comments":{"type":"string","format":"","description":"Comments for patch job"},"schedulerStartTime":{"type":"integer","format":"integer","description":"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"},"patchJobStartTime":{"type":"integer","format":"integer","description":"Timestamp when the patch job has been started in UTC","readOnly":true},"patchJobOverallProgress":{"allOf":[{"$ref":"#/components/schemas/PatchJobReportProgress"}],"description":"How many application instances are being patched","nullable":true,"readOnly":true},"applicationBuild":{"type":"array","items":{"$ref":"#/components/schemas/PatchJobApplicationBuild"},"description":"Array of old and new application build needs to be patched"},"fleet":{"type":"array","items":{"$ref":"#/components/schemas/PatchJobFleet"},"description":"Array of fleet that needs to be patched"},"email":{"type":"array","items":{"$ref":"#/components/schemas/PatchJobEmail"},"description":"Array of email address for reporting purposes"},"createdAt":{"type":"integer","format":"integer","description":"Timestamp when the patch job has been created","readOnly":true},"changedAt":{"type":"integer","format":"integer","description":"Timestamp when the patch job last has been changed","readOnly":true},"finishedAt":{"type":"integer","format":"integer","description":"Timestamp when the patch job has been finished in UTC","readOnly":true},"isRevertable":{"type":"integer","format":"integer","description":"If the patch job can be cancelled, when is 1 you can cancel the patch job else not","readOnly":true},"revertsPatchJobId":{"type":"integer","format":"integer","description":"If filled in, this ID points to the patch job that has been reverted by this patch job","nullable":true,"readOnly":true},"revertedByPatchJobId":{"type":"integer","format":"integer","description":"If filled in, this ID points to the PatchJob that has reverted this patch job","nullable":true,"readOnly":true}},"additionalProperties":false},"PatchJobReportProgress":{"type":"object","required":["total","downloaded","stopped","success","failed","started","canceled","remaining"],"properties":{"total":{"type":"integer","format":"integer","description":"The total amount of application instances affected by the patch job","readOnly":true},"downloaded":{"type":"integer","format":"integer","description":"The amount of downloaded application instances","readOnly":true},"stopped":{"type":"integer","format":"integer","description":"The amount of stopped application instances","readOnly":true},"success":{"type":"integer","format":"integer","description":"The amount of successfully patched application instances","readOnly":true},"failed":{"type":"integer","format":"integer","description":"The amount of failed application instances","readOnly":true},"started":{"type":"integer","format":"integer","description":"The amount of started application instances","readOnly":true},"canceled":{"type":"integer","format":"integer","description":"The amount of canceled application instances","readOnly":true},"remaining":{"type":"integer","format":"integer","description":"The amount of remaining application instances","readOnly":true}},"additionalProperties":false,"nullable":true},"PatchJobApplicationBuild":{"type":"object","required":["id","oldApplicationBuildId","newApplicationBuildId"],"properties":{"id":{"type":"string","format":"","description":"ID of a patch job application build","readOnly":true},"oldApplicationBuildId":{"type":"string","format":"","description":"ID of an old application build"},"newApplicationBuildId":{"type":"string","format":"","description":"ID of a new application build"}},"additionalProperties":false},"PatchJobFleet":{"type":"object","required":["id","fleetId"],"properties":{"id":{"type":"string","format":"","description":"ID of a patch job fleet","readOnly":true},"fleetId":{"type":"string","format":"","description":"ID of fleet"}},"additionalProperties":false},"PatchJobEmail":{"type":"object","required":["id","email","progressReport","resultReport","createdAt","changedAt"],"properties":{"id":{"type":"string","format":"","description":"ID of a patch job email","readOnly":true},"email":{"type":"string","format":"","description":"Email address for reporting (unique)"},"progressReport":{"type":"integer","format":"integer","description":"If 1 progress report will be send, if 0 no progress report will be send"},"resultReport":{"type":"integer","format":"integer","description":"If 1 result report will be send, if 0 no result report will be send"},"createdAt":{"type":"integer","format":"integer","description":"Timestamp when the patch job email has been created","readOnly":true},"changedAt":{"type":"integer","format":"integer","description":"Timestamp when the patch job email last has been changed","readOnly":true}},"additionalProperties":false}}}}
```

## The PatchJobApplicationBuild object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"PatchJobApplicationBuild":{"type":"object","required":["id","oldApplicationBuildId","newApplicationBuildId"],"properties":{"id":{"type":"string","format":"","description":"ID of a patch job application build","readOnly":true},"oldApplicationBuildId":{"type":"string","format":"","description":"ID of an old application build"},"newApplicationBuildId":{"type":"string","format":"","description":"ID of a new application build"}},"additionalProperties":false}}}}
```

## The PatchJobApplicationInstanceCount object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"PatchJobApplicationInstanceCount":{"type":"object","required":["region","dataCenter","buildVersion","numberOfInstances"],"properties":{"region":{"type":"string","format":"","description":"Region name of application instances","readOnly":true},"dataCenter":{"type":"string","format":"","description":"Data center location name","readOnly":true},"buildVersion":{"type":"string","format":"","description":"Application build version number","readOnly":true},"numberOfInstances":{"type":"integer","format":"integer","description":"Number of application instances","readOnly":true}},"additionalProperties":false}}}}
```

## The PatchJobApplicationInstancePreview object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"PatchJobApplicationInstancePreview":{"type":"object","required":["deploymentEnvironmentId","applicationId","fleet","applicationBuild"],"properties":{"deploymentEnvironmentId":{"type":"string","format":"","description":"Deployment environment ID"},"applicationId":{"type":"string","format":"","description":"Application ID"},"fleet":{"type":"array","items":{"type":"string","format":""},"description":"List of fleet ID"},"applicationBuild":{"type":"array","items":{"type":"string","format":""},"description":"List of application build ID"}},"additionalProperties":false}}}}
```

## The PatchJobEmail object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"PatchJobEmail":{"type":"object","required":["id","email","progressReport","resultReport","createdAt","changedAt"],"properties":{"id":{"type":"string","format":"","description":"ID of a patch job email","readOnly":true},"email":{"type":"string","format":"","description":"Email address for reporting (unique)"},"progressReport":{"type":"integer","format":"integer","description":"If 1 progress report will be send, if 0 no progress report will be send"},"resultReport":{"type":"integer","format":"integer","description":"If 1 result report will be send, if 0 no result report will be send"},"createdAt":{"type":"integer","format":"integer","description":"Timestamp when the patch job email has been created","readOnly":true},"changedAt":{"type":"integer","format":"integer","description":"Timestamp when the patch job email last has been changed","readOnly":true}},"additionalProperties":false}}}}
```

## The PatchJobEmailBulk object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"PatchJobEmailBulk":{"type":"object","required":["patchJobEmail"],"properties":{"patchJobEmail":{"type":"array","items":{"$ref":"#/components/schemas/PatchJobEmail"},"description":"Array of patch job email address for reporting purposes"}},"additionalProperties":false},"PatchJobEmail":{"type":"object","required":["id","email","progressReport","resultReport","createdAt","changedAt"],"properties":{"id":{"type":"string","format":"","description":"ID of a patch job email","readOnly":true},"email":{"type":"string","format":"","description":"Email address for reporting (unique)"},"progressReport":{"type":"integer","format":"integer","description":"If 1 progress report will be send, if 0 no progress report will be send"},"resultReport":{"type":"integer","format":"integer","description":"If 1 result report will be send, if 0 no result report will be send"},"createdAt":{"type":"integer","format":"integer","description":"Timestamp when the patch job email has been created","readOnly":true},"changedAt":{"type":"integer","format":"integer","description":"Timestamp when the patch job email last has been changed","readOnly":true}},"additionalProperties":false}}}}
```

## The PatchJobFailedApplicationInstance object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"PatchJobFailedApplicationInstance":{"type":"object","required":["id","fleetId","fleetName","hostId","isVirtual","applicationId","applicationName","applicationType","applicationBuildId","applicationBuildName","dcLocationId","dcLocationName","regionId","regionName","status","createdAt","startedAt","stoppedAt","pid","pidChangedAt","manuallyDeployed","properties","ipAddress","labelReadOnly","numPlayersMax","numPlayers","liveHostName","liveMap","liveGameVersion","liveRules","autoRestart","markedForDeletion","exitCode","failingReason","startParameters"],"properties":{"id":{"type":"string","format":"","description":"Application instance ID","readOnly":true},"fleetId":{"type":"string","format":"","description":"The application's fleet ID","readOnly":true},"fleetName":{"type":"string","format":"","description":"The application's fleet name","readOnly":true},"hostId":{"type":"integer","format":"integer","description":"The application instance is host on this server.","readOnly":true},"isVirtual":{"type":"integer","format":"integer","description":"0 if this instance runs on a bare metal server, 1 if it runs on a VM","readOnly":true},"applicationId":{"type":"string","format":"","description":"The ID of the application","readOnly":true},"applicationName":{"type":"string","format":"","description":"The application's application name","readOnly":true},"applicationType":{"type":"integer","format":"integer","description":"The type of the application, the different types can be found in:  [GET\n/v3/application/type](game-publisher#/Application/getApplicationTypes)]","readOnly":true},"applicationBuildId":{"type":"string","format":"","description":"The ID of the application build","readOnly":true},"applicationBuildName":{"type":"string","format":"","description":"The application's application build name","readOnly":true},"installId":{"type":"integer","format":"integer","description":"ID of the application install","deprecated":true},"dcLocationId":{"type":"integer","format":"integer","description":"The datacenter ID of where this application instance is located","readOnly":true},"dcLocationName":{"type":"string","format":"","description":"The application's dc location name","readOnly":true},"regionId":{"type":"string","format":"","description":"The deployment region ID of where this application instance is located","readOnly":true},"regionName":{"type":"string","format":"","description":"The application's region name","readOnly":true},"status":{"type":"integer","format":"integer","description":"The application instance status, list of application instance status can be found in [`GET\n/v3/applicationInstance/status`](game-publisher#/ApplicationInstance/get_v3_applicationInstance_status)","readOnly":true},"createdAt":{"type":"integer","format":"integer","description":"The Unix timestamp at which this application instance is created","readOnly":true},"startedAt":{"type":"integer","format":"integer","description":"The Unix timestamp at which this application instance is started","readOnly":true},"stoppedAt":{"type":"integer","format":"integer","description":"The Unix timestamp at which this application instance is stopped","readOnly":true},"pid":{"type":"integer","format":"integer","description":"The process ID of the application instance running on the host","readOnly":true},"pidChangedAt":{"type":"integer","format":"integer","description":"The Unix timestamp of the moment the process ID has been changed on the host","readOnly":true},"manuallyDeployed":{"type":"integer","format":"integer","description":"If set to 1, the application instance was manually deployed.","readOnly":true},"properties":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationInstanceProperty"},"description":"Properties of application instance","readOnly":true},"ipAddress":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationInstanceIP"},"description":"List of IP addresses for an application instance.","readOnly":true},"labelReadOnly":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"description":"Pre-defined key/value pairs that can be used for application selection / identification.\nList of available labelReadOnly keys (application_id, fleet_id, host_id, dc_location_id, region_id, application_build_id)","readOnly":true},"labelPublic":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"description":"Custom key/value pairs that can be used for application instance selection / identification"},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/Metadata"},"description":"Custom key/value pairs to be set or adjusted by the allocation call or the application instance itself. This metadata\nwill be passed to the application instance when starting it [needs more clarification]."},"numPlayersMax":{"type":"integer","format":"integer","description":"The maximum number of players on the application instance (this only apply to application instances of the type game)","readOnly":true},"numPlayers":{"type":"integer","format":"integer","description":"The number of online players on the application instance (this only apply to application instances of the type game)","readOnly":true},"liveHostName":{"type":"string","format":"","description":"The live host name of the application instance (this only apply to application instances of the type game)","readOnly":true},"liveMap":{"type":"string","format":"","description":"The live map of an application instance (this only apply to application instances of the type game)","readOnly":true},"liveGameVersion":{"type":"string","format":"","description":"The live game version of an application instance (this only apply to application instances of the type game)","readOnly":true},"liveRules":{"type":"string","format":"","description":"The live rules of an application instance (this only apply to application instances of the type game)","readOnly":true},"autoRestart":{"type":"integer","format":"integer","description":"If auto restart is 1 than the application instance will auto restart, when 0 the application instance auto restart will be disabled","readOnly":true},"markedForDeletion":{"type":"integer","format":"integer","description":"if an application will be deleted it will be 1 else 0","readOnly":true},"exitCode":{"type":"integer","format":"integer","description":"The exit code of the application, if it has crashed during patching else it will be 0","readOnly":true},"failingReason":{"type":"string","format":"","description":"The reason why the application instance failed to patch","readOnly":true},"startParameters":{"type":"string","format":"","description":"The start parameters that were used to start the application","readOnly":true}},"additionalProperties":false},"ApplicationInstanceProperty":{"type":"object","required":["id","propertyType","propertyKey","propertyValue"],"properties":{"id":{"type":"string","format":"","description":"The application instance property ID","readOnly":true},"propertyType":{"type":"integer","format":"integer","description":"The application instance property type. For a list of application property types see\n[`GET /v3/application/property/type`](#/Application/get_v3_application_property_type)","readOnly":true},"propertyKey":{"type":"string","format":"","description":"The application instance property key. Only hyphens (-), underscores (_), lowercase characters and numbers are allowed.\nKeys must start with a lowercase character"},"propertyValue":{"type":"string","format":"","description":"The application instance property value"}},"additionalProperties":false},"ApplicationInstanceIP":{"type":"object","required":["ipAddress","ipVersion","private"],"properties":{"ipAddress":{"type":"string","format":"","description":"Application instance IP address"},"ipVersion":{"type":"integer","format":"integer","description":"Application instance IP version","readOnly":true},"private":{"type":"integer","format":"integer","description":"If application instance has private ip address.","readOnly":true}},"additionalProperties":false},"Label":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","format":"","description":"Label key, only hyphens (-), underscores (_), lowercase characters and numbers are allowed. Keys must start with a lowercase character."},"value":{"type":"string","format":"","description":"Label value, maximum length is 150 characters"}},"additionalProperties":false},"Metadata":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","format":"","description":"Metadata key. Max length 50 characters"},"value":{"type":"string","format":"","description":"Metadata value. Max length 2048 bytes"}},"additionalProperties":false}}}}
```

## The PatchJobFleet object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"PatchJobFleet":{"type":"object","required":["id","fleetId"],"properties":{"id":{"type":"string","format":"","description":"ID of a patch job fleet","readOnly":true},"fleetId":{"type":"string","format":"","description":"ID of fleet"}},"additionalProperties":false}}}}
```

## The PatchJobFleetApplicationBuild object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"PatchJobFleetApplicationBuild":{"type":"object","required":["id","name","applicationBuild"],"properties":{"id":{"type":"string","format":"","description":"ID of the fleet","readOnly":true},"name":{"type":"string","format":"","description":"Name of the fleet","readOnly":true},"applicationBuild":{"type":"array","items":{"$ref":"#/components/schemas/PatchJobFleetApplicationBuildDetail"},"description":"Array of the application build belonging to the fleet","readOnly":true}},"additionalProperties":false},"PatchJobFleetApplicationBuildDetail":{"type":"object","required":["id","name","osId"],"properties":{"id":{"type":"string","format":"","description":"ID of the application build","readOnly":true},"name":{"type":"string","format":"","description":"Name of the application build","readOnly":true},"osId":{"type":"integer","format":"integer","description":"ID of the operating system","readOnly":true}},"additionalProperties":false}}}}
```

## The PatchJobFleetApplicationBuildDetail object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"PatchJobFleetApplicationBuildDetail":{"type":"object","required":["id","name","osId"],"properties":{"id":{"type":"string","format":"","description":"ID of the application build","readOnly":true},"name":{"type":"string","format":"","description":"Name of the application build","readOnly":true},"osId":{"type":"integer","format":"integer","description":"ID of the operating system","readOnly":true}},"additionalProperties":false}}}}
```

## The PatchJobReport object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"PatchJobReport":{"type":"object","required":["patchJobId","patchJobName","changedAt","finishedAt","startedAt","patchJobMethodName","patchJobStatus","deploymentEnvironment","oldApplicationBuilds","newApplicationBuild","progress","fleetData"],"properties":{"patchJobId":{"type":"string","format":"","description":"Patch job ID","readOnly":true},"patchJobName":{"type":"string","format":"","description":"Name of the patch job","readOnly":true},"changedAt":{"type":"integer","format":"integer","description":"Unix timestamp when the status of the patch job has been changed","readOnly":true},"finishedAt":{"type":"integer","format":"integer","description":"Unix timestamp when the patch job finished (if `0` then the patch job is still running)","readOnly":true},"startedAt":{"type":"integer","format":"integer","description":"Unix timestamp when the patch job started","readOnly":true},"patchJobMethodName":{"type":"string","format":"","description":"Name of the patch job method (strategy)","readOnly":true},"patchJobStatus":{"type":"integer","format":"integer","description":"Status of the patch job","readOnly":true},"deploymentEnvironment":{"allOf":[{"$ref":"#/components/schemas/GenericModel"}],"description":"The deployment environment","readOnly":true},"oldApplicationBuilds":{"type":"array","items":{"$ref":"#/components/schemas/PatchJobReportApplicationBuild"},"description":"List of old application builds","readOnly":true},"newApplicationBuild":{"allOf":[{"$ref":"#/components/schemas/PatchJobReportApplicationBuild"}],"description":"The new application build","readOnly":true},"progress":{"allOf":[{"$ref":"#/components/schemas/PatchJobReportProgress"}],"description":"Progress across all fleets - total for the entire patch job","readOnly":true},"fleetData":{"type":"array","items":{"$ref":"#/components/schemas/PatchJobReportFleet"},"description":"Patch job report data based on fleet","readOnly":true}},"additionalProperties":false},"GenericModel":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","format":"","description":"The ID of the object"},"name":{"type":"string","format":"","description":"The name of the object"}},"additionalProperties":false},"PatchJobReportApplicationBuild":{"type":"object","required":["id","name","version"],"properties":{"id":{"type":"string","format":"","description":"Application build ID","readOnly":true},"name":{"type":"string","format":"","description":"The name of the application build"},"version":{"type":"string","format":"","description":"The version of the application install or build provisioning file linked to this application build"}},"additionalProperties":false},"PatchJobReportProgress":{"type":"object","required":["total","downloaded","stopped","success","failed","started","canceled","remaining"],"properties":{"total":{"type":"integer","format":"integer","description":"The total amount of application instances affected by the patch job","readOnly":true},"downloaded":{"type":"integer","format":"integer","description":"The amount of downloaded application instances","readOnly":true},"stopped":{"type":"integer","format":"integer","description":"The amount of stopped application instances","readOnly":true},"success":{"type":"integer","format":"integer","description":"The amount of successfully patched application instances","readOnly":true},"failed":{"type":"integer","format":"integer","description":"The amount of failed application instances","readOnly":true},"started":{"type":"integer","format":"integer","description":"The amount of started application instances","readOnly":true},"canceled":{"type":"integer","format":"integer","description":"The amount of canceled application instances","readOnly":true},"remaining":{"type":"integer","format":"integer","description":"The amount of remaining application instances","readOnly":true}},"additionalProperties":false,"nullable":true},"PatchJobReportFleet":{"type":"object","required":["fleet","progress","deploymentRegionData"],"properties":{"fleet":{"allOf":[{"$ref":"#/components/schemas/GenericModel"}],"description":"The Fleet details","readOnly":true},"progress":{"allOf":[{"$ref":"#/components/schemas/PatchJobReportProgress"}],"description":"Progress for just this fleet","readOnly":true},"deploymentRegionData":{"type":"array","items":{"$ref":"#/components/schemas/PatchJobReportDeploymentRegion"},"description":"Patch job report data based on deployment region","readOnly":true}},"additionalProperties":false},"PatchJobReportDeploymentRegion":{"type":"object","required":["deploymentRegion","progress","dcLocationData"],"properties":{"deploymentRegion":{"allOf":[{"$ref":"#/components/schemas/GenericModel"}],"description":"The Deployment Region's details","readOnly":true},"progress":{"allOf":[{"$ref":"#/components/schemas/PatchJobReportProgress"}],"description":"Progress for just this Deployment Region","readOnly":true},"dcLocationData":{"type":"array","items":{"$ref":"#/components/schemas/PatchJobReportDcLocation"},"description":"Patch job report data based on DC location","readOnly":true}},"additionalProperties":false},"PatchJobReportDcLocation":{"type":"object","required":["dcLocation","dcLocationRegionName","progress"],"properties":{"dcLocation":{"allOf":[{"$ref":"#/components/schemas/GenericIntModel"}],"description":"The DC Location's details","readOnly":true},"dcLocationRegionName":{"type":"string","format":"","description":"Region name of the DC location","readOnly":true},"progress":{"allOf":[{"$ref":"#/components/schemas/PatchJobReportProgress"}],"description":"Progress for just this DC Location","readOnly":true}},"additionalProperties":false},"GenericIntModel":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","format":"integer","description":"The ID of the object"},"name":{"type":"string","format":"","description":"The name of the object"}},"additionalProperties":false}}}}
```

## The PatchJobReportApplicationBuild object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"PatchJobReportApplicationBuild":{"type":"object","required":["id","name","version"],"properties":{"id":{"type":"string","format":"","description":"Application build ID","readOnly":true},"name":{"type":"string","format":"","description":"The name of the application build"},"version":{"type":"string","format":"","description":"The version of the application install or build provisioning file linked to this application build"}},"additionalProperties":false}}}}
```

## The PatchJobReportDcLocation object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"PatchJobReportDcLocation":{"type":"object","required":["dcLocation","dcLocationRegionName","progress"],"properties":{"dcLocation":{"allOf":[{"$ref":"#/components/schemas/GenericIntModel"}],"description":"The DC Location's details","readOnly":true},"dcLocationRegionName":{"type":"string","format":"","description":"Region name of the DC location","readOnly":true},"progress":{"allOf":[{"$ref":"#/components/schemas/PatchJobReportProgress"}],"description":"Progress for just this DC Location","readOnly":true}},"additionalProperties":false},"GenericIntModel":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","format":"integer","description":"The ID of the object"},"name":{"type":"string","format":"","description":"The name of the object"}},"additionalProperties":false},"PatchJobReportProgress":{"type":"object","required":["total","downloaded","stopped","success","failed","started","canceled","remaining"],"properties":{"total":{"type":"integer","format":"integer","description":"The total amount of application instances affected by the patch job","readOnly":true},"downloaded":{"type":"integer","format":"integer","description":"The amount of downloaded application instances","readOnly":true},"stopped":{"type":"integer","format":"integer","description":"The amount of stopped application instances","readOnly":true},"success":{"type":"integer","format":"integer","description":"The amount of successfully patched application instances","readOnly":true},"failed":{"type":"integer","format":"integer","description":"The amount of failed application instances","readOnly":true},"started":{"type":"integer","format":"integer","description":"The amount of started application instances","readOnly":true},"canceled":{"type":"integer","format":"integer","description":"The amount of canceled application instances","readOnly":true},"remaining":{"type":"integer","format":"integer","description":"The amount of remaining application instances","readOnly":true}},"additionalProperties":false,"nullable":true}}}}
```

## The PatchJobReportDeploymentRegion object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"PatchJobReportDeploymentRegion":{"type":"object","required":["deploymentRegion","progress","dcLocationData"],"properties":{"deploymentRegion":{"allOf":[{"$ref":"#/components/schemas/GenericModel"}],"description":"The Deployment Region's details","readOnly":true},"progress":{"allOf":[{"$ref":"#/components/schemas/PatchJobReportProgress"}],"description":"Progress for just this Deployment Region","readOnly":true},"dcLocationData":{"type":"array","items":{"$ref":"#/components/schemas/PatchJobReportDcLocation"},"description":"Patch job report data based on DC location","readOnly":true}},"additionalProperties":false},"GenericModel":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","format":"","description":"The ID of the object"},"name":{"type":"string","format":"","description":"The name of the object"}},"additionalProperties":false},"PatchJobReportProgress":{"type":"object","required":["total","downloaded","stopped","success","failed","started","canceled","remaining"],"properties":{"total":{"type":"integer","format":"integer","description":"The total amount of application instances affected by the patch job","readOnly":true},"downloaded":{"type":"integer","format":"integer","description":"The amount of downloaded application instances","readOnly":true},"stopped":{"type":"integer","format":"integer","description":"The amount of stopped application instances","readOnly":true},"success":{"type":"integer","format":"integer","description":"The amount of successfully patched application instances","readOnly":true},"failed":{"type":"integer","format":"integer","description":"The amount of failed application instances","readOnly":true},"started":{"type":"integer","format":"integer","description":"The amount of started application instances","readOnly":true},"canceled":{"type":"integer","format":"integer","description":"The amount of canceled application instances","readOnly":true},"remaining":{"type":"integer","format":"integer","description":"The amount of remaining application instances","readOnly":true}},"additionalProperties":false,"nullable":true},"PatchJobReportDcLocation":{"type":"object","required":["dcLocation","dcLocationRegionName","progress"],"properties":{"dcLocation":{"allOf":[{"$ref":"#/components/schemas/GenericIntModel"}],"description":"The DC Location's details","readOnly":true},"dcLocationRegionName":{"type":"string","format":"","description":"Region name of the DC location","readOnly":true},"progress":{"allOf":[{"$ref":"#/components/schemas/PatchJobReportProgress"}],"description":"Progress for just this DC Location","readOnly":true}},"additionalProperties":false},"GenericIntModel":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","format":"integer","description":"The ID of the object"},"name":{"type":"string","format":"","description":"The name of the object"}},"additionalProperties":false}}}}
```

## The PatchJobReportFleet object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"PatchJobReportFleet":{"type":"object","required":["fleet","progress","deploymentRegionData"],"properties":{"fleet":{"allOf":[{"$ref":"#/components/schemas/GenericModel"}],"description":"The Fleet details","readOnly":true},"progress":{"allOf":[{"$ref":"#/components/schemas/PatchJobReportProgress"}],"description":"Progress for just this fleet","readOnly":true},"deploymentRegionData":{"type":"array","items":{"$ref":"#/components/schemas/PatchJobReportDeploymentRegion"},"description":"Patch job report data based on deployment region","readOnly":true}},"additionalProperties":false},"GenericModel":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","format":"","description":"The ID of the object"},"name":{"type":"string","format":"","description":"The name of the object"}},"additionalProperties":false},"PatchJobReportProgress":{"type":"object","required":["total","downloaded","stopped","success","failed","started","canceled","remaining"],"properties":{"total":{"type":"integer","format":"integer","description":"The total amount of application instances affected by the patch job","readOnly":true},"downloaded":{"type":"integer","format":"integer","description":"The amount of downloaded application instances","readOnly":true},"stopped":{"type":"integer","format":"integer","description":"The amount of stopped application instances","readOnly":true},"success":{"type":"integer","format":"integer","description":"The amount of successfully patched application instances","readOnly":true},"failed":{"type":"integer","format":"integer","description":"The amount of failed application instances","readOnly":true},"started":{"type":"integer","format":"integer","description":"The amount of started application instances","readOnly":true},"canceled":{"type":"integer","format":"integer","description":"The amount of canceled application instances","readOnly":true},"remaining":{"type":"integer","format":"integer","description":"The amount of remaining application instances","readOnly":true}},"additionalProperties":false,"nullable":true},"PatchJobReportDeploymentRegion":{"type":"object","required":["deploymentRegion","progress","dcLocationData"],"properties":{"deploymentRegion":{"allOf":[{"$ref":"#/components/schemas/GenericModel"}],"description":"The Deployment Region's details","readOnly":true},"progress":{"allOf":[{"$ref":"#/components/schemas/PatchJobReportProgress"}],"description":"Progress for just this Deployment Region","readOnly":true},"dcLocationData":{"type":"array","items":{"$ref":"#/components/schemas/PatchJobReportDcLocation"},"description":"Patch job report data based on DC location","readOnly":true}},"additionalProperties":false},"PatchJobReportDcLocation":{"type":"object","required":["dcLocation","dcLocationRegionName","progress"],"properties":{"dcLocation":{"allOf":[{"$ref":"#/components/schemas/GenericIntModel"}],"description":"The DC Location's details","readOnly":true},"dcLocationRegionName":{"type":"string","format":"","description":"Region name of the DC location","readOnly":true},"progress":{"allOf":[{"$ref":"#/components/schemas/PatchJobReportProgress"}],"description":"Progress for just this DC Location","readOnly":true}},"additionalProperties":false},"GenericIntModel":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","format":"integer","description":"The ID of the object"},"name":{"type":"string","format":"","description":"The name of the object"}},"additionalProperties":false}}}}
```

## The PatchJobReportProgress object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"PatchJobReportProgress":{"type":"object","required":["total","downloaded","stopped","success","failed","started","canceled","remaining"],"properties":{"total":{"type":"integer","format":"integer","description":"The total amount of application instances affected by the patch job","readOnly":true},"downloaded":{"type":"integer","format":"integer","description":"The amount of downloaded application instances","readOnly":true},"stopped":{"type":"integer","format":"integer","description":"The amount of stopped application instances","readOnly":true},"success":{"type":"integer","format":"integer","description":"The amount of successfully patched application instances","readOnly":true},"failed":{"type":"integer","format":"integer","description":"The amount of failed application instances","readOnly":true},"started":{"type":"integer","format":"integer","description":"The amount of started application instances","readOnly":true},"canceled":{"type":"integer","format":"integer","description":"The amount of canceled application instances","readOnly":true},"remaining":{"type":"integer","format":"integer","description":"The amount of remaining application instances","readOnly":true}},"additionalProperties":false,"nullable":true}}}}
```

## The PatchJobRuntimeType object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"PatchJobRuntimeType":{"type":"object","required":["typeId","typeDescription"],"properties":{"typeId":{"type":"integer","format":"integer","description":"Patch job type ID","readOnly":true},"typeDescription":{"type":"string","format":"","description":"Patch job type description","readOnly":true}},"additionalProperties":false}}}}
```

## The PatchJobStatus object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"PatchJobStatus":{"type":"object","required":["id","description"],"properties":{"id":{"type":"integer","format":"integer","description":"Patch job status ID","readOnly":true},"description":{"type":"string","format":"","description":"Patch job status description","readOnly":true}},"additionalProperties":false}}}}
```

## The PatchJobSummary object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"PatchJobSummary":{"type":"object","required":["id","deploymentEnvironmentId","applicationId","applicationName","newApplicationBuildName","patchJobMethodId","patchJobMethodName","patchJobName","status","comments","schedulerStartTime","patchJobStartTime","finishedAt","isRevertable","patchJobOverallProgress"],"properties":{"id":{"type":"string","format":"","description":"Patch job ID","readOnly":true},"deploymentEnvironmentId":{"type":"string","format":"","description":"Deployment environment ID","readOnly":true},"applicationId":{"type":"string","format":"","description":"Application ID","readOnly":true},"applicationName":{"type":"string","format":"","description":"Name of the application","readOnly":true},"newApplicationBuildName":{"type":"string","format":"","description":"Name of all the application builds that will be patched","readOnly":true},"patchJobMethodId":{"type":"integer","format":"integer","description":"Patch job type, you can find the list available patch job type [`GET /v3/patchJob/type`](game-publisher#/PatchJob/get_v3_patchJob_type)","readOnly":true},"patchJobMethodName":{"type":"string","format":"","description":"Name of the patch job chosen","readOnly":true},"patchJobName":{"type":"string","format":"","description":"Name of the patch job (unique)","readOnly":true},"status":{"type":"integer","format":"integer","description":"Status of the patch job","readOnly":true},"comments":{"type":"string","format":"","description":"Comments for patch job","readOnly":true},"schedulerStartTime":{"type":"integer","format":"integer","description":"When the patch job needs to start, default value is 0 this means it’s start directly after creating the patch job, else there needs to give a timestamp in UTC when the job needs to start","readOnly":true},"patchJobStartTime":{"type":"integer","format":"integer","description":"Timestamp when the patch job has been started in UTC","readOnly":true},"finishedAt":{"type":"integer","format":"integer","description":"Timestamp when the patch job has been finished in UTC","readOnly":true},"isRevertable":{"type":"integer","format":"integer","description":"If the patch job can be cancelled","readOnly":true},"patchJobOverallProgress":{"allOf":[{"$ref":"#/components/schemas/PatchJobReportProgress"}],"description":"How many application instances are being patched","nullable":true,"readOnly":true}},"additionalProperties":false},"PatchJobReportProgress":{"type":"object","required":["total","downloaded","stopped","success","failed","started","canceled","remaining"],"properties":{"total":{"type":"integer","format":"integer","description":"The total amount of application instances affected by the patch job","readOnly":true},"downloaded":{"type":"integer","format":"integer","description":"The amount of downloaded application instances","readOnly":true},"stopped":{"type":"integer","format":"integer","description":"The amount of stopped application instances","readOnly":true},"success":{"type":"integer","format":"integer","description":"The amount of successfully patched application instances","readOnly":true},"failed":{"type":"integer","format":"integer","description":"The amount of failed application instances","readOnly":true},"started":{"type":"integer","format":"integer","description":"The amount of started application instances","readOnly":true},"canceled":{"type":"integer","format":"integer","description":"The amount of canceled application instances","readOnly":true},"remaining":{"type":"integer","format":"integer","description":"The amount of remaining application instances","readOnly":true}},"additionalProperties":false,"nullable":true}}}}
```

## The PatchJobType object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"PatchJobType":{"type":"object","required":["typeId","typeDescription"],"properties":{"typeId":{"type":"integer","format":"integer","description":"Patch job type ID","readOnly":true},"typeDescription":{"type":"string","format":"","description":"Patch job type description","readOnly":true}},"additionalProperties":false}}}}
```

## The RDns object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"RDns":{"type":"object","required":["hostname","ip"],"properties":{"hostname":{"type":"string","format":"","description":"The hostname"},"ip":{"type":"string","format":"","description":"The corresponding ip for the host","readOnly":true}},"additionalProperties":false}}}}
```

## The ServerLog object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"ServerLog":{"type":"object","required":["id","issueOpen","dateStamp","issueCategory","issueDescription","issueResolved","catName"],"properties":{"id":{"type":"integer","format":"integer","description":"The ID of this log"},"issueOpen":{"type":"integer","format":"integer","description":"Does the server log has an open issue"},"dateStamp":{"type":"integer","format":"integer","description":"Time of the log"},"issueCategory":{"type":"string","format":"","description":"Server log issue category"},"issueDescription":{"type":"string","format":"","description":"Server log issue description"},"issueResolved":{"type":"string","format":"","description":"Whether or not server log issue is resolved"},"catName":{"type":"string","format":"","description":"Server log category name"}},"additionalProperties":false}}}}
```

## The TaskBatchStatus object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"TaskBatchStatus":{"type":"object","required":["id","createdAt","executeAt","finishedAt","numTasks","numTasksOk","numTasksFailed","numTasksCancelled","taskIds"],"properties":{"id":{"type":"integer","format":"integer","description":"Task Batch ID","readOnly":true},"createdAt":{"type":"integer","format":"integer","description":"The unix timestamp at which this batch was created","readOnly":true},"executeAt":{"type":"integer","format":"integer","description":"The unix timestamp at which this batch started execution","readOnly":true},"finishedAt":{"type":"integer","format":"integer","description":"The unix timestamp at which this batch was finished","readOnly":true},"numTasks":{"type":"integer","format":"integer","description":"The total number of tasks in this batch","readOnly":true},"numTasksOk":{"type":"integer","format":"integer","description":"The number of successfully executed tasks","readOnly":true},"numTasksFailed":{"type":"integer","format":"integer","description":"The number of failed tasks","readOnly":true},"numTasksCancelled":{"type":"integer","format":"integer","description":"The number of cancelled tasks","readOnly":true},"taskIds":{"type":"array","items":{"type":"integer","format":"integer"},"description":"All the task IDs in this batch","readOnly":true}},"additionalProperties":false}}}}
```

## The TaskStatus object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"TaskStatus":{"type":"object","required":["id","name","batchId","categoryId","entityId","currentActionIdx","executeAt","lastActivityAt","finishedAt","resultCode","resultText"],"properties":{"id":{"type":"integer","format":"integer","description":"Task ID","readOnly":true},"name":{"type":"string","format":"","description":"Task name","readOnly":true},"batchId":{"type":"integer","format":"integer","description":"The ID of the batch the task belongs to","readOnly":true},"categoryId":{"type":"integer","format":"integer","description":"The ID of the task category. Valid values are:\n- 1: game server","readOnly":true},"entityId":{"type":"integer","format":"integer","description":"The ID of the entity the task is being executed for. E.g. a game server ID (categoryId 1)","readOnly":true},"currentActionIdx":{"type":"integer","format":"integer","description":"Currently active action index - relates to the action index as found in the template.","readOnly":true},"executeAt":{"type":"integer","format":"integer","description":"Unix timestamp indicating the start of execution.","readOnly":true},"lastActivityAt":{"type":"integer","format":"integer","description":"Unix timestamp indicating lastest activity.","readOnly":true},"finishedAt":{"type":"integer","format":"integer","description":"Unix timestamp at which the task was finished.","readOnly":true},"resultCode":{"type":"integer","format":"integer","description":"The result of the task. 0: pending, 1: in progress, 2: paused, 125: cancelled, 126: done with error, 127: done","readOnly":true},"resultText":{"type":"string","format":"","description":"The result of the task in message form.","readOnly":true}},"additionalProperties":false}}}}
```

## The TaskTemplate object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"TaskTemplate":{"type":"object","required":["id","name","description","actions"],"properties":{"id":{"type":"integer","format":"integer","description":"Task template ID","readOnly":true},"name":{"type":"string","format":"","description":"Task template name","readOnly":true},"description":{"type":"string","format":"","description":"Task template description","readOnly":true},"actions":{"type":"array","items":{"$ref":"#/components/schemas/TaskTemplateAction"},"description":"Task template actions","readOnly":true}},"additionalProperties":false},"TaskTemplateAction":{"type":"object","required":["idx","actionType","requiredParams"],"properties":{"idx":{"type":"integer","format":"integer","description":"Task template action execution order","readOnly":true},"actionType":{"type":"string","format":"","description":"Task template action type","readOnly":true},"requiredParams":{"type":"array","items":{"type":"string","format":""},"description":"Parameters required by this argument","readOnly":true}},"additionalProperties":false}}}}
```

## The TaskTemplateAction object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"TaskTemplateAction":{"type":"object","required":["idx","actionType","requiredParams"],"properties":{"idx":{"type":"integer","format":"integer","description":"Task template action execution order","readOnly":true},"actionType":{"type":"string","format":"","description":"Task template action type","readOnly":true},"requiredParams":{"type":"array","items":{"type":"string","format":""},"description":"Parameters required by this argument","readOnly":true}},"additionalProperties":false}}}}
```

## The TaskTemplateActionParameters object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"TaskTemplateActionParameters":{"type":"object","required":["paramName","paramValue"],"properties":{"paramName":{"type":"string","format":"","description":"Name of required parameters by task template."},"paramValue":{"type":"string","format":"","description":"Value of required parameters."}},"additionalProperties":false}}}}
```

## The TrafficUsage object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"TrafficUsage":{"type":"object","required":["unit","data"],"properties":{"unit":{"type":"string","format":"","description":"Unit of data frequency,  possible interval options are as follows\n- day","readOnly":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/TrafficUsageData"},"description":"Contains the data object for the usage","readOnly":true}},"additionalProperties":false},"TrafficUsageData":{"type":"object","required":["timestamp","ingress","egress","sum"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The corresponding date","readOnly":true},"ingress":{"type":"string","format":"","description":"The incoming data usage in bytes","readOnly":true},"egress":{"type":"string","format":"","description":"The outgoing data usage in bytes","readOnly":true},"sum":{"type":"string","format":"","description":"The total used data in bytes","readOnly":true}},"additionalProperties":false}}}}
```

## The TrafficUsageData object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"TrafficUsageData":{"type":"object","required":["timestamp","ingress","egress","sum"],"properties":{"timestamp":{"type":"integer","format":"integer","description":"The corresponding date","readOnly":true},"ingress":{"type":"string","format":"","description":"The incoming data usage in bytes","readOnly":true},"egress":{"type":"string","format":"","description":"The outgoing data usage in bytes","readOnly":true},"sum":{"type":"string","format":"","description":"The total used data in bytes","readOnly":true}},"additionalProperties":false}}}}
```

## The Transfer object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"Transfer":{"type":"object","required":["fileServerId","progress","errorCount","retries"],"properties":{"fileServerId":{"type":"integer","format":"integer","description":"ID of the file server"},"progress":{"type":"integer","format":"integer","description":"The transfer progress in percentage"},"errorCount":{"type":"integer","format":"integer","description":"The amount of errors that occurred during this process"},"retries":{"type":"integer","format":"integer","description":"The amount of retries in the process"}},"additionalProperties":false}}}}
```

## The UCSetting object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"UCSetting":{"type":"object","required":["id","projectId","regionName","publicNetworkId","privateNetworkId","securityGroupId","createdAt","changedAt"],"properties":{"id":{"type":"string","format":"","description":"Ubisoft Cloud network setting id","readOnly":true},"projectId":{"type":"string","format":"","description":"Ubisoft Cloud project id"},"regionName":{"type":"string","format":"","description":"Ubisoft Cloud region name"},"publicNetworkId":{"type":"string","format":"","description":"Ubisoft Cloud public network UUID id e.g: (b091a99e-abdd-11ea-bb37-0242ac130002)"},"privateNetworkId":{"type":"string","format":"","description":"Ubisoft Cloud private network UUID id e.g: (d80e2d7e-aa38-490e-915c-bb56222911c3)"},"securityGroupId":{"type":"string","format":"","description":"Ubisoft Cloud security group id e.g: (0ec61726-405c-4919-b9a1-9dcd6ae56077)"},"createdAt":{"type":"integer","format":"integer","description":"UnixTimestamp","readOnly":true},"changedAt":{"type":"integer","format":"integer","description":"UnixTimestamp","readOnly":true}},"additionalProperties":false}}}}
```

## The UtilityDeploymentTemplate object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"UtilityDeploymentTemplate":{"type":"object","required":["id","fleetIds","name","inUse","createdAt","utilityDeploymentTemplateBuild"],"properties":{"id":{"type":"string","format":"","description":"Utility deployment template ID","readOnly":true},"fleetIds":{"type":"array","items":{"type":"string","format":""},"description":"IDs of the fleets that use this template","readOnly":true},"name":{"type":"string","format":"","description":"The name of your utility deployment template"},"inUse":{"type":"integer","format":"integer","description":"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.","readOnly":true},"createdAt":{"type":"integer","format":"integer","description":"UnixTimestamp","readOnly":true},"utilityDeploymentTemplateBuild":{"type":"array","items":{"$ref":"#/components/schemas/UtilityDeploymentTemplateBuild"},"description":"A List of utility deployment template build's"}},"additionalProperties":false},"UtilityDeploymentTemplateBuild":{"type":"object","required":["applicationBuildId"],"properties":{"applicationBuildId":{"type":"string","format":"","description":"The Application Build ID"},"deployOn":{"type":"integer","format":"integer","description":"Indicates on which host types to install the utilities on:\n1) bare metal,\n2) VM,\n3) both (default value when not specified)"},"installsPerLocation":{"type":"integer","format":"integer","description":"If > 0, limit the amount of deploys on hosts to this figure, for each active dcLocation.\nSo if this value is 2, this utility will only be deployed on two hosts per dcLocation. If 0 (default value when not specified), it will be deployed on every host in use."}},"additionalProperties":false}}}}
```

## The UtilityDeploymentTemplateBuild object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"UtilityDeploymentTemplateBuild":{"type":"object","required":["applicationBuildId"],"properties":{"applicationBuildId":{"type":"string","format":"","description":"The Application Build ID"},"deployOn":{"type":"integer","format":"integer","description":"Indicates on which host types to install the utilities on:\n1) bare metal,\n2) VM,\n3) both (default value when not specified)"},"installsPerLocation":{"type":"integer","format":"integer","description":"If > 0, limit the amount of deploys on hosts to this figure, for each active dcLocation.\nSo if this value is 2, this utility will only be deployed on two hosts per dcLocation. If 0 (default value when not specified), it will be deployed on every host in use."}},"additionalProperties":false}}}}
```

## The VmError object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"VmError":{"type":"object","required":["id","hostId","message","arguments","solved","createdAt"],"properties":{"id":{"type":"string","format":"","description":"ID of the virtual machine error","readOnly":true},"hostId":{"type":"integer","format":"integer","description":"ID of the host","readOnly":true},"message":{"type":"string","format":"","description":"Message of error","readOnly":true},"arguments":{"type":"array","items":{"type":"string","format":""},"description":"Arguments generated by the systems","readOnly":true},"solved":{"type":"integer","format":"integer","description":"Status of the error","readOnly":true},"createdAt":{"type":"integer","format":"integer","description":"Unix timestamp","readOnly":true}},"additionalProperties":false}}}}
```

## The VmLog object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"VmLog":{"type":"object","required":["cloudInstanceId","title","log","timestamp"],"properties":{"cloudInstanceId":{"type":"string","format":"","readOnly":true},"title":{"type":"string","format":"","readOnly":true},"log":{"type":"string","format":"","readOnly":true},"timestamp":{"type":"integer","format":"integer","description":"Unix timestamp","readOnly":true}},"additionalProperties":false}}}}
```

## The VmUptime object

```json
{"openapi":"3.0.1","info":{"title":"i3D.net One-Deployment-Platform Endpoints","version":"3.0.0"},"components":{"schemas":{"VmUptime":{"type":"object","required":["cloudInstanceId","providerInstanceId","providerId","hostId","instanceType","dcLocationId","startTime","stopTime","upTime"],"properties":{"cloudInstanceId":{"type":"integer","format":"integer","description":"ID of the VM","readOnly":true},"providerInstanceId":{"type":"string","format":"","description":"The virtual machine ID generated by the cloud provider","readOnly":true},"providerId":{"type":"integer","format":"integer","description":"Cloud provider ID","readOnly":true},"hostId":{"type":"integer","format":"integer","description":"The ID of this host","readOnly":true},"instanceType":{"type":"string","format":"","description":"The name of the instance type","readOnly":true},"dcLocationId":{"type":"integer","format":"integer","description":"Datacenter location ID. Points to one of [`GET /v3/cloud/dcLocation`](game-publisher#/Cloud/get_v3_cloud_dcLocation)","readOnly":true},"startTime":{"type":"integer","format":"integer","description":"Unix timestamp of when the VM was created","readOnly":true},"stopTime":{"type":"integer","format":"integer","description":"Unix timestamp of when the VM was destroyed","readOnly":true},"upTime":{"type":"integer","format":"integer","description":"Uptime in seconds. For a running VM","readOnly":true}},"additionalProperties":false}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.i3d.net/api-references/game/models-1.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.