# DeploymentV1

Deployment is a versioned configuration for a build that describes runtime behavior.


## Fields

| Field                                                                                                                                                                                                               | Type                                                                                                                                                                                                                | Required                                                                                                                                                                                                            | Description                                                                                                                                                                                                         | Example                                                                                                                                                                                                             |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `AdditionalContainerPorts`                                                                                                                                                                                          | List<[ContainerPort](../../Models/Shared/ContainerPort.md)>                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                                                                  | Additional ports your server listens on.                                                                                                                                                                            | {<br/>"transportType": "tcp",<br/>"port": 4000,<br/>"name": "debug"<br/>}                                                                                                                                           |
| `AppId`                                                                                                                                                                                                             | *string*                                                                                                                                                                                                            | :heavy_check_mark:                                                                                                                                                                                                  | System generated unique identifier for an application.                                                                                                                                                              | app-af469a92-5b45-4565-b3c4-b79878de67d2                                                                                                                                                                            |
| `BuildId`                                                                                                                                                                                                           | *int*                                                                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                  | System generated id for a build. Increments by 1.                                                                                                                                                                   | 1                                                                                                                                                                                                                   |
| ~~`ContainerPort`~~                                                                                                                                                                                                 | *double*                                                                                                                                                                                                            | :heavy_check_mark:                                                                                                                                                                                                  | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.                                                                                             |                                                                                                                                                                                                                     |
| `CreatedAt`                                                                                                                                                                                                         | [DateTime](https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-5.0)                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                  | When the deployment was created.                                                                                                                                                                                    |                                                                                                                                                                                                                     |
| `CreatedBy`                                                                                                                                                                                                         | *string*                                                                                                                                                                                                            | :heavy_check_mark:                                                                                                                                                                                                  | N/A                                                                                                                                                                                                                 | noreply@hathora.dev                                                                                                                                                                                                 |
| `DefaultContainerPort`                                                                                                                                                                                              | [ContainerPort](../../Models/Shared/ContainerPort.md)                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                  | A container port object represents the transport configruations for how your server will listen.                                                                                                                    |                                                                                                                                                                                                                     |
| `DeploymentId`                                                                                                                                                                                                      | *int*                                                                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                  | System generated id for a deployment. Increments by 1.                                                                                                                                                              | 1                                                                                                                                                                                                                   |
| `Env`                                                                                                                                                                                                               | List<[DeploymentV1Env](../../Models/Shared/DeploymentV1Env.md)>                                                                                                                                                     | :heavy_check_mark:                                                                                                                                                                                                  | The environment variable that our process will have access to at runtime.                                                                                                                                           |                                                                                                                                                                                                                     |
| `IdleTimeoutEnabled`                                                                                                                                                                                                | *bool*                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                  | Option to shut down processes that have had no new connections or rooms<br/>for five minutes.                                                                                                                       |                                                                                                                                                                                                                     |
| `PlanName`                                                                                                                                                                                                          | [PlanName](../../Models/Shared/PlanName.md)                                                                                                                                                                         | :heavy_check_mark:                                                                                                                                                                                                  | A plan defines how much CPU and memory is required to run an instance of your game server.<br/><br/>`tiny`: shared core, 1gb memory<br/><br/>`small`: 1 core, 2gb memory<br/><br/>`medium`: 2 core, 4gb memory<br/><br/>`large`: 4 core, 8gb memory | tiny                                                                                                                                                                                                                |
| `RequestedCPU`                                                                                                                                                                                                      | *double*                                                                                                                                                                                                            | :heavy_check_mark:                                                                                                                                                                                                  | The number of cores allocated to your process.                                                                                                                                                                      | 0.5                                                                                                                                                                                                                 |
| `RequestedMemoryMB`                                                                                                                                                                                                 | *int*                                                                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                  | The amount of memory allocated to your process.                                                                                                                                                                     | 1024                                                                                                                                                                                                                |
| `RoomsPerProcess`                                                                                                                                                                                                   | *int*                                                                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                  | Governs how many [rooms](https://hathora.dev/docs/concepts/hathora-entities#room) can be scheduled in a process.                                                                                                    | 3                                                                                                                                                                                                                   |
| ~~`TransportType`~~                                                                                                                                                                                                 | [DeploymentV1TransportType](../../Models/Shared/DeploymentV1TransportType.md)                                                                                                                                       | :heavy_check_mark:                                                                                                                                                                                                  | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.                                                                                             |                                                                                                                                                                                                                     |