README.md

DeploymentsV1

(DeploymentsV1)

Overview

Available Operations

• CreateDeploymentV1Deprecated - Create a new deployment. Creating a new deployment means all new rooms created will use the latest deployment configuration, but existing games in progress will not be affected. ⚠️ Deprecated
• GetDeploymentInfoV1Deprecated - Get details for a deployment. ⚠️ Deprecated
• GetDeploymentsV1Deprecated - Returns an array of deployments for an application. ⚠️ Deprecated
• GetLatestDeploymentV1Deprecated - Get the latest deployment for an application. ⚠️ Deprecated

CreateDeploymentV1Deprecated

Create a new deployment. Creating a new deployment means all new rooms created will use the latest deployment configuration, but existing games in progress will not be affected.

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

using HathoraCloud;
using HathoraCloud.Models.Shared;
using HathoraCloud.Models.Operations;
using System.Collections.Generic;

var sdk = new HathoraCloudSDK(
    security: new Security() {
        HathoraDevToken = "<YOUR_BEARER_TOKEN_HERE>",
    },
    appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2");

CreateDeploymentV1DeprecatedRequest req = new CreateDeploymentV1DeprecatedRequest() {
    DeploymentConfig = new DeploymentConfig() {
        AdditionalContainerPorts = new List<ContainerPort>() {
            new ContainerPort() {
                Name = "default",
                Port = 8000,
                TransportType = TransportType.Tcp,
            },
        },
        ContainerPort = 4000,
        Env = new List<Env>() {
            new Env() {
                Name = "EULA",
                Value = "TRUE",
            },
        },
        PlanName = PlanName.Tiny,
        RoomsPerProcess = 3,
        TransportType = TransportType.Tcp,
    },
    BuildId = 1,
};


using(var res = await sdk.DeploymentsV1.CreateDeploymentV1DeprecatedAsync(req))
{
    // handle response
}

Parameters

Parameter	Type	Required	Description
request	CreateDeploymentV1DeprecatedRequest	✔️	The request object to use for the request.

Response

CreateDeploymentV1DeprecatedResponse

Errors

Error Object	Status Code	Content Type
HathoraCloud.Models.Errors.ApiError	400,401,404,422,429,500	application/json
HathoraCloud.Models.Errors.SDKException	4xx-5xx	/

GetDeploymentInfoV1Deprecated

Get details for a deployment.

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

using HathoraCloud;
using HathoraCloud.Models.Shared;
using HathoraCloud.Models.Operations;

var sdk = new HathoraCloudSDK(
    security: new Security() {
        HathoraDevToken = "<YOUR_BEARER_TOKEN_HERE>",
    },
    appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2");

GetDeploymentInfoV1DeprecatedRequest req = new GetDeploymentInfoV1DeprecatedRequest() {
    DeploymentId = 1,
};


using(var res = await sdk.DeploymentsV1.GetDeploymentInfoV1DeprecatedAsync(req))
{
    // handle response
}

Parameters

Parameter	Type	Required	Description
request	GetDeploymentInfoV1DeprecatedRequest	✔️	The request object to use for the request.

Response

GetDeploymentInfoV1DeprecatedResponse

Errors

Error Object	Status Code	Content Type
HathoraCloud.Models.Errors.ApiError	401,404,429	application/json
HathoraCloud.Models.Errors.SDKException	4xx-5xx	/

GetDeploymentsV1Deprecated

Returns an array of deployments for an application.

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

using HathoraCloud;
using HathoraCloud.Models.Shared;
using HathoraCloud.Models.Operations;

var sdk = new HathoraCloudSDK(
    security: new Security() {
        HathoraDevToken = "<YOUR_BEARER_TOKEN_HERE>",
    },
    appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2");

GetDeploymentsV1DeprecatedRequest req = new GetDeploymentsV1DeprecatedRequest() {};


using(var res = await sdk.DeploymentsV1.GetDeploymentsV1DeprecatedAsync(req))
{
    // handle response
}

Parameters

Parameter	Type	Required	Description
request	GetDeploymentsV1DeprecatedRequest	✔️	The request object to use for the request.

Response

GetDeploymentsV1DeprecatedResponse

Errors

Error Object	Status Code	Content Type
HathoraCloud.Models.Errors.ApiError	401,404,429	application/json
HathoraCloud.Models.Errors.SDKException	4xx-5xx	/

GetLatestDeploymentV1Deprecated

Get the latest deployment for an application.

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

using HathoraCloud;
using HathoraCloud.Models.Shared;
using HathoraCloud.Models.Operations;

var sdk = new HathoraCloudSDK(
    security: new Security() {
        HathoraDevToken = "<YOUR_BEARER_TOKEN_HERE>",
    },
    appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2");

GetLatestDeploymentV1DeprecatedRequest req = new GetLatestDeploymentV1DeprecatedRequest() {};


using(var res = await sdk.DeploymentsV1.GetLatestDeploymentV1DeprecatedAsync(req))
{
    // handle response
}

Parameters

Parameter	Type	Required	Description
request	GetLatestDeploymentV1DeprecatedRequest	✔️	The request object to use for the request.

Response

GetLatestDeploymentV1DeprecatedResponse

Errors

Error Object	Status Code	Content Type
HathoraCloud.Models.Errors.ApiError	401,404,422,429	application/json
HathoraCloud.Models.Errors.SDKException	4xx-5xx	/