Summary

Hathora Cloud API: Welcome to the Hathora Cloud API documentation! Learn how to use the Hathora Cloud APIs to build and scale your game servers globally.

Table of Contents

* SDK Installation
* SDK Example Usage
* Available Resources and Operations
* Error Handling
* Server Selection
* Custom HTTP Client
* Authentication
* Standalone functions
* Global Parameters
* Requirements
* Retries
* Debugging

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

$3

``bash
npm add @hathora/cloud-sdk-typescript
`

$3

`bash
pnpm add @hathora/cloud-sdk-typescript
`

$3

`bash
bun add @hathora/cloud-sdk-typescript
`

$3

`bash
yarn add @hathora/cloud-sdk-typescript
`





SDK Example Usage

$3

`typescript
import { HathoraCloud } from "@hathora/cloud-sdk-typescript";

const hathoraCloud = new HathoraCloud({
hathoraDevToken: "",
});

async function run() {
const result = await hathoraCloud.tokensV1.getOrgTokens(
"org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
);

console.log(result);
}

run();

`





Available Resources and Operations

Available methods

$3

* ~~getAppsV1Deprecated~~ - GetAppsV1Deprecated :warning: Deprecated
* ~~createAppV1Deprecated~~ - CreateAppV1Deprecated :warning: Deprecated
* ~~updateAppV1Deprecated~~ - UpdateAppV1Deprecated :warning: Deprecated
* ~~getAppInfoV1Deprecated~~ - GetAppInfoV1Deprecated :warning: Deprecated
* ~~deleteAppV1Deprecated~~ - DeleteAppV1Deprecated :warning: Deprecated

$3

* getApps - GetApps
* createApp - CreateApp
* updateApp - UpdateApp
* patchApp - PatchApp
* getApp - GetApp
* deleteApp - DeleteApp

$3

* loginAnonymous - LoginAnonymous
* loginNickname - LoginNickname
* loginGoogle - LoginGoogle

$3

* ~~getBalance~~ - GetBalance :warning: Deprecated
* getUpcomingInvoiceItems - GetUpcomingInvoiceItems
* getUpcomingInvoiceTotal - GetUpcomingInvoiceTotal
* getPaymentMethod - GetPaymentMethod
* initStripeCustomerPortalUrl - InitStripeCustomerPortalUrl
* getInvoices - GetInvoices

$3

* ~~getBuildsDeprecated~~ - GetBuildsDeprecated :warning: Deprecated
* ~~getBuildInfoDeprecated~~ - GetBuildInfoDeprecated :warning: Deprecated
* ~~createBuildDeprecated~~ - CreateBuildDeprecated :warning: Deprecated
* ~~deleteBuildDeprecated~~ - DeleteBuildDeprecated :warning: Deprecated
* ~~runBuildDeprecated~~ - RunBuildDeprecated :warning: Deprecated

$3

* ~~getBuildsV2Deprecated~~ - GetBuildsV2Deprecated :warning: Deprecated
* ~~getBuildInfoV2Deprecated~~ - GetBuildInfoV2Deprecated :warning: Deprecated
* ~~createBuildV2Deprecated~~ - CreateBuildV2Deprecated :warning: Deprecated
* ~~createBuildWithUploadUrlV2Deprecated~~ - CreateBuildWithUploadUrlV2Deprecated :warning: Deprecated
* ~~createWithMultipartUploadsV2Deprecated~~ - CreateWithMultipartUploadsV2Deprecated :warning: Deprecated
* ~~deleteBuildV2Deprecated~~ - DeleteBuildV2Deprecated :warning: Deprecated
* ~~runBuildV2Deprecated~~ - RunBuildV2Deprecated :warning: Deprecated

$3

* getBuilds - GetBuilds
* createBuild - CreateBuild
* getBuild - GetBuild
* deleteBuild - DeleteBuild
* createBuildRegistry - CreateBuildRegistry
* runBuild - RunBuild
* runBuildRegistry - RunBuildRegistry

$3

* ~~getDeploymentsV1Deprecated~~ - GetDeploymentsV1Deprecated :warning: Deprecated
* ~~getLatestDeploymentV1Deprecated~~ - GetLatestDeploymentV1Deprecated :warning: Deprecated
* ~~getDeploymentInfoV1Deprecated~~ - GetDeploymentInfoV1Deprecated :warning: Deprecated
* ~~createDeploymentV1Deprecated~~ - CreateDeploymentV1Deprecated :warning: Deprecated

$3

* ~~getDeploymentsV2Deprecated~~ - GetDeploymentsV2Deprecated :warning: Deprecated
* ~~getLatestDeploymentV2Deprecated~~ - GetLatestDeploymentV2Deprecated :warning: Deprecated
* ~~getDeploymentInfoV2Deprecated~~ - GetDeploymentInfoV2Deprecated :warning: Deprecated
* ~~createDeploymentV2Deprecated~~ - CreateDeploymentV2Deprecated :warning: Deprecated

$3

* getDeployments - GetDeployments
* createDeployment - CreateDeployment
* getLatestDeployment - GetLatestDeployment
* getDeployment - GetDeployment

$3

* ~~getPingServiceEndpointsDeprecated~~ - GetPingServiceEndpointsDeprecated :warning: Deprecated

$3

* getPingServiceEndpoints - GetPingServiceEndpoints

$3

* getFleetsDeprecated - GetFleetsDeprecated
* createFleetDeprecated - CreateFleetDeprecated
* getFleetDeprecated - GetFleetDeprecated
* updateFleetDeprecated - UpdateFleetDeprecated
* getFleetRegionDeprecated - GetFleetRegionDeprecated
* updateFleetRegionDeprecated - UpdateFleetRegionDeprecated
* getFleetMetricsDeprecated - GetFleetMetricsDeprecated
* getFleetRegionMetricsDeprecated - GetFleetRegionMetricsDeprecated

$3

* getNodeShapes - GetNodeShapes
* getFleets - GetFleets
* createFleet - CreateFleet
* getFleet - GetFleet
* updateFleet - UpdateFleet
* getFleetRegion - GetFleetRegion
* ~~deprecatedUpdateFleetRegionV2~~ - DeprecatedUpdateFleetRegionV2 :warning: Deprecated
* updateFleetRegion - UpdateFleetRegion
* getFleetMetrics - GetFleetMetrics
* getFleetRegionMetrics - GetFleetRegionMetrics

$3

* ~~createPrivateLobbyDeprecated~~ - CreatePrivateLobbyDeprecated :warning: Deprecated
* ~~createPublicLobbyDeprecated~~ - CreatePublicLobbyDeprecated :warning: Deprecated
* ~~listActivePublicLobbiesDeprecatedV1~~ - ListActivePublicLobbiesDeprecatedV1 :warning: Deprecated

$3

* ~~createPrivateLobby~~ - CreatePrivateLobby :warning: Deprecated
* ~~createPublicLobby~~ - CreatePublicLobby :warning: Deprecated
* ~~createLocalLobby~~ - CreateLocalLobby :warning: Deprecated
* ~~createLobbyDeprecated~~ - CreateLobbyDeprecated :warning: Deprecated
* ~~listActivePublicLobbiesDeprecatedV2~~ - ListActivePublicLobbiesDeprecatedV2 :warning: Deprecated
* ~~getLobbyInfo~~ - GetLobbyInfo :warning: Deprecated
* ~~setLobbyState~~ - SetLobbyState :warning: Deprecated

$3

* createLobby - CreateLobby
* listActivePublicLobbies - ListActivePublicLobbies
* getLobbyInfoByRoomId - GetLobbyInfoByRoomId
* getLobbyInfoByShortCode - GetLobbyInfoByShortCode

$3

* getLogsForProcess - GetLogsForProcess
* downloadLogForProcess - DownloadLogForProcess

$3

* sendVerificationEmail - SendVerificationEmail

$3

* ~~getMetricsDeprecated~~ - GetMetricsDeprecated :warning: Deprecated

$3

* getNode - GetNode
* listProvisionedNodes - ListProvisionedNodes

$3

* getOrgs - GetOrgs
* getUserPendingInvites - GetUserPendingInvites
* getOrgMembers - GetOrgMembers
* inviteUser - InviteUser
* updateUserInvite - UpdateUserInvite
* rescindInvite - RescindInvite
* getOrgPendingInvites - GetOrgPendingInvites
* acceptInvite - AcceptInvite
* rejectInvite - RejectInvite
* getUsageLimits - GetUsageLimits

$3

* ~~getRunningProcesses~~ - GetRunningProcesses :warning: Deprecated
* ~~getStoppedProcesses~~ - GetStoppedProcesses :warning: Deprecated
* ~~getProcessInfoDeprecated~~ - GetProcessInfoDeprecated :warning: Deprecated

$3

* ~~getProcessInfoV2Deprecated~~ - GetProcessInfoV2Deprecated :warning: Deprecated
* ~~getLatestProcessesV2Deprecated~~ - GetLatestProcessesV2Deprecated :warning: Deprecated
* ~~getProcessesCountExperimentalV2Deprecated~~ - GetProcessesCountExperimentalV2Deprecated :warning: Deprecated
* ~~stopProcessV2Deprecated~~ - StopProcessV2Deprecated :warning: Deprecated
* ~~createProcessV2Deprecated~~ - CreateProcessV2Deprecated :warning: Deprecated

$3

* getLatestProcesses - GetLatestProcesses
* getProcessesCountExperimental - GetProcessesCountExperimental
* createProcess - CreateProcess
* getProcess - GetProcess
* stopProcess - StopProcess
* getProcessMetrics - GetProcessMetrics

$3

* ~~createRoomDeprecated~~ - CreateRoomDeprecated :warning: Deprecated
* ~~getRoomInfoDeprecated~~ - GetRoomInfoDeprecated :warning: Deprecated
* ~~getActiveRoomsForProcessDeprecated~~ - GetActiveRoomsForProcessDeprecated :warning: Deprecated
* ~~getInactiveRoomsForProcessDeprecated~~ - GetInactiveRoomsForProcessDeprecated :warning: Deprecated
* ~~destroyRoomDeprecated~~ - DestroyRoomDeprecated :warning: Deprecated
* ~~suspendRoomDeprecated~~ - SuspendRoomDeprecated :warning: Deprecated
* ~~getConnectionInfoDeprecated~~ - GetConnectionInfoDeprecated :warning: Deprecated

$3

* createRoom - CreateRoom
* getRoomInfo - GetRoomInfo
* getActiveRoomsForProcess - GetActiveRoomsForProcess
* getInactiveRoomsForProcess - GetInactiveRoomsForProcess
* destroyRoom - DestroyRoom
* ~~suspendRoomV2Deprecated~~ - SuspendRoomV2Deprecated :warning: Deprecated
* getConnectionInfo - GetConnectionInfo
* updateRoomConfig - UpdateRoomConfig
* resumeRoom - ResumeRoom

$3

* getOrgTokens - GetOrgTokens
* createOrgToken - CreateOrgToken
* revokeOrgToken - RevokeOrgToken

Error Handling

HathoraCloudError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description |
| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
| error.message | string | Error message |
| error.statusCode | number | HTTP response status code eg 404 |
| error.headers | Headers | HTTP response headers |
| error.body | string | HTTP body. Can be empty string if no body is returned. |
| error.rawResponse | Response | Raw HTTP response |
| error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |

$3


`typescript
import { HathoraCloud } from "@hathora/cloud-sdk-typescript";
import * as errors from "@hathora/cloud-sdk-typescript/models/errors";

const hathoraCloud = new HathoraCloud({
hathoraDevToken: "",
});

async function run() {
try {
const result = await hathoraCloud.tokensV1.getOrgTokens(
"org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
);

console.log(result);
} catch (error) {
// The base class for HTTP error responses
if (error instanceof errors.HathoraCloudError) {
console.log(error.message);
console.log(error.statusCode);
console.log(error.body);
console.log(error.headers);

// Depending on the method different errors may be thrown
if (error instanceof errors.ApiError) {
console.log(error.data$.message); // string
}
}
}
}

run();

`

$3


Primary errors:
* HathoraCloudError: The base class for HTTP error responses.
ApiError: .

Less common errors (6)




Network errors:
* ConnectionError: HTTP client was unable to make a request to a server.
* RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.
* RequestAbortedError: HTTP request was aborted by the client.
* InvalidRequestError: Any input used to create a request is invalid.
* UnexpectedClientError: Unrecognised or unexpected error.


Inherit from HathoraCloudError:
* ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

\* Check the method documentation to see if the error is applicable.





Server Selection

$3

You can override the default server globally by passing a server index to the serverIdx: number optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

| # | Server | Description |
| --- | ------------------------- | ----------- |
| 0 | https://api.hathora.dev | |
| 1 | / | |

#### Example

`typescript
import { HathoraCloud } from "@hathora/cloud-sdk-typescript";

const hathoraCloud = new HathoraCloud({
serverIdx: 0,
hathoraDevToken: "",
});

async function run() {
const result = await hathoraCloud.tokensV1.getOrgTokens(
"org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
);

console.log(result);
}

run();

`

$3

The default server can also be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:
`typescript
import { HathoraCloud } from "@hathora/cloud-sdk-typescript";

const hathoraCloud = new HathoraCloud({
serverURL: "https://api.hathora.dev",
hathoraDevToken: "",
});

async function run() {
const result = await hathoraCloud.tokensV1.getOrgTokens(
"org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
);

console.log(result);
}

run();

`





Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native
Fetch API. This
client is a thin wrapper around fetch and provides the ability to attach hooks
around the request lifecycle that can be used to modify the request or handle
errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be
used to integrate a third-party HTTP client or when writing tests to mock out
the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a
custom header and a timeout to requests and how to use the "requestError" hook
to log errors:

`typescript
import { HathoraCloud } from "@hathora/cloud-sdk-typescript";
import { HTTPClient } from "@hathora/cloud-sdk-typescript/lib/http";

const httpClient = new HTTPClient({
// fetcher takes a function that has the same signature as native fetch.
fetcher: (request) => {
return fetch(request);
}
});

httpClient.addHook("beforeRequest", (request) => {
const nextRequest = new Request(request, {
signal: request.signal || AbortSignal.timeout(5000)
});

nextRequest.headers.set("x-custom-header", "custom value");

return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
console.group("Request Error");
console.log("Reason:", ${error});
console.log("Endpoint:", ${request.method} ${request.url});
console.groupEnd();
});

const sdk = new HathoraCloud({ httpClient: httpClient });
`





Authentication

$3

This SDK supports the following security scheme globally:

| Name | Type | Scheme |
| ----------------- | ---- | ----------- |
| hathoraDevToken | http | HTTP Bearer |

To authenticate with the API the hathoraDevToken parameter must be set when initializing the SDK client instance. For example:
`typescript
import { HathoraCloud } from "@hathora/cloud-sdk-typescript";

const hathoraCloud = new HathoraCloud({
hathoraDevToken: "",
});

async function run() {
const result = await hathoraCloud.tokensV1.getOrgTokens(
"org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
);

console.log(result);
}

run();

`

$3

Some operations in this SDK require the security scheme to be specified at the request level. For example:
`typescript
import { HathoraCloud } from "@hathora/cloud-sdk-typescript";

const hathoraCloud = new HathoraCloud({
appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});

async function run() {
const result = await hathoraCloud.lobbiesV3.createLobby(
{
playerAuth: "",
},
{
visibility: "private",
roomConfig: "{\"name\":\"my-room\"}",
region: "Dubai",
},
undefined,
"LFG4",
"2swovpy1fnunu",
);

console.log(result);
}

run();

`





Standalone functions

All the methods listed above are available as standalone functions. These
functions are ideal for use in applications running in the browser, serverless
runtimes or other environments where application bundle size is a primary
concern. When using a bundler to build your application, all unused
functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Available standalone functions

- appsV2CreateApp - CreateApp
- appsV2DeleteApp - DeleteApp
- appsV2GetApp - GetApp
- appsV2GetApps - GetApps
- appsV2PatchApp - PatchApp
- appsV2UpdateApp - UpdateApp
- authV1LoginAnonymous - LoginAnonymous
- authV1LoginGoogle - LoginGoogle
- authV1LoginNickname - LoginNickname
- billingV1GetInvoices - GetInvoices
- billingV1GetPaymentMethod - GetPaymentMethod
- billingV1GetUpcomingInvoiceItems - GetUpcomingInvoiceItems
- billingV1GetUpcomingInvoiceTotal - GetUpcomingInvoiceTotal
- billingV1InitStripeCustomerPortalUrl - InitStripeCustomerPortalUrl
- buildsV3CreateBuild - CreateBuild
- buildsV3CreateBuildRegistry - CreateBuildRegistry
- buildsV3DeleteBuild - DeleteBuild
- buildsV3GetBuild - GetBuild
- buildsV3GetBuilds - GetBuilds
- buildsV3RunBuild - RunBuild
- buildsV3RunBuildRegistry - RunBuildRegistry
- deploymentsV3CreateDeployment - CreateDeployment
- deploymentsV3GetDeployment - GetDeployment
- deploymentsV3GetDeployments - GetDeployments
- deploymentsV3GetLatestDeployment - GetLatestDeployment
- discoveryV2GetPingServiceEndpoints - GetPingServiceEndpoints
- fleetsV1CreateFleetDeprecated - CreateFleetDeprecated
- fleetsV1GetFleetDeprecated - GetFleetDeprecated
- fleetsV1GetFleetMetricsDeprecated - GetFleetMetricsDeprecated
- fleetsV1GetFleetRegionDeprecated - GetFleetRegionDeprecated
- fleetsV1GetFleetRegionMetricsDeprecated - GetFleetRegionMetricsDeprecated
- fleetsV1GetFleetsDeprecated - GetFleetsDeprecated
- fleetsV1UpdateFleetDeprecated - UpdateFleetDeprecated
- fleetsV1UpdateFleetRegionDeprecated - UpdateFleetRegionDeprecated
- fleetsV2CreateFleet - CreateFleet
- fleetsV2GetFleet - GetFleet
- fleetsV2GetFleetMetrics - GetFleetMetrics
- fleetsV2GetFleetRegion - GetFleetRegion
- fleetsV2GetFleetRegionMetrics - GetFleetRegionMetrics
- fleetsV2GetFleets - GetFleets
- fleetsV2GetNodeShapes - GetNodeShapes
- fleetsV2UpdateFleet - UpdateFleet
- fleetsV2UpdateFleetRegion - UpdateFleetRegion
- lobbiesV3CreateLobby - CreateLobby
- lobbiesV3GetLobbyInfoByRoomId - GetLobbyInfoByRoomId
- lobbiesV3GetLobbyInfoByShortCode - GetLobbyInfoByShortCode
- lobbiesV3ListActivePublicLobbies - ListActivePublicLobbies
- logsV1DownloadLogForProcess - DownloadLogForProcess
- logsV1GetLogsForProcess - GetLogsForProcess
- managementV1SendVerificationEmail - SendVerificationEmail
- nodesV1GetNode - GetNode
- nodesV1ListProvisionedNodes - ListProvisionedNodes
- organizationsV1AcceptInvite - AcceptInvite
- organizationsV1GetOrgMembers - GetOrgMembers
- organizationsV1GetOrgPendingInvites - GetOrgPendingInvites
- organizationsV1GetOrgs - GetOrgs
- organizationsV1GetUsageLimits - GetUsageLimits
- organizationsV1GetUserPendingInvites - GetUserPendingInvites
- organizationsV1InviteUser - InviteUser
- organizationsV1RejectInvite - RejectInvite
- organizationsV1RescindInvite - RescindInvite
- organizationsV1UpdateUserInvite - UpdateUserInvite
- processesV3CreateProcess - CreateProcess
- processesV3GetLatestProcesses - GetLatestProcesses
- processesV3GetProcess - GetProcess
- processesV3GetProcessesCountExperimental - GetProcessesCountExperimental
- processesV3GetProcessMetrics - GetProcessMetrics
- processesV3StopProcess - StopProcess
- roomsV2CreateRoom - CreateRoom
- roomsV2DestroyRoom - DestroyRoom
- roomsV2GetActiveRoomsForProcess - GetActiveRoomsForProcess
- roomsV2GetConnectionInfo - GetConnectionInfo
- roomsV2GetInactiveRoomsForProcess - GetInactiveRoomsForProcess
- roomsV2GetRoomInfo - GetRoomInfo
- roomsV2ResumeRoom - ResumeRoom
- roomsV2UpdateRoomConfig - UpdateRoomConfig
- tokensV1CreateOrgToken - CreateOrgToken
- tokensV1GetOrgTokens - GetOrgTokens
- tokensV1RevokeOrgToken - RevokeOrgToken
- ~~appsV1CreateAppV1Deprecated~~ - CreateAppV1Deprecated :warning: Deprecated
- ~~appsV1DeleteAppV1Deprecated~~ - DeleteAppV1Deprecated :warning: Deprecated
- ~~appsV1GetAppInfoV1Deprecated~~ - GetAppInfoV1Deprecated :warning: Deprecated
- ~~appsV1GetAppsV1Deprecated~~ - GetAppsV1Deprecated :warning: Deprecated
- ~~appsV1UpdateAppV1Deprecated~~ - UpdateAppV1Deprecated :warning: Deprecated
- ~~billingV1GetBalance~~ - GetBalance :warning: Deprecated
- ~~buildsV1CreateBuildDeprecated~~ - CreateBuildDeprecated :warning: Deprecated
- ~~buildsV1DeleteBuildDeprecated~~ - DeleteBuildDeprecated :warning: Deprecated
- ~~buildsV1GetBuildInfoDeprecated~~ - GetBuildInfoDeprecated :warning: Deprecated
- ~~buildsV1GetBuildsDeprecated~~ - GetBuildsDeprecated :warning: Deprecated
- ~~buildsV1RunBuildDeprecated~~ - RunBuildDeprecated :warning: Deprecated
- ~~buildsV2CreateBuildV2Deprecated~~ - CreateBuildV2Deprecated :warning: Deprecated
- ~~buildsV2CreateBuildWithUploadUrlV2Deprecated~~ - CreateBuildWithUploadUrlV2Deprecated :warning: Deprecated
- ~~buildsV2CreateWithMultipartUploadsV2Deprecated~~ - CreateWithMultipartUploadsV2Deprecated :warning: Deprecated
- ~~buildsV2DeleteBuildV2Deprecated~~ - DeleteBuildV2Deprecated :warning: Deprecated
- ~~buildsV2GetBuildInfoV2Deprecated~~ - GetBuildInfoV2Deprecated :warning: Deprecated
- ~~buildsV2GetBuildsV2Deprecated~~ - GetBuildsV2Deprecated :warning: Deprecated
- ~~buildsV2RunBuildV2Deprecated~~ - RunBuildV2Deprecated :warning: Deprecated
- ~~deploymentsV1CreateDeploymentV1Deprecated~~ - CreateDeploymentV1Deprecated :warning: Deprecated
- ~~deploymentsV1GetDeploymentInfoV1Deprecated~~ - GetDeploymentInfoV1Deprecated :warning: Deprecated
- ~~deploymentsV1GetDeploymentsV1Deprecated~~ - GetDeploymentsV1Deprecated :warning: Deprecated
- ~~deploymentsV1GetLatestDeploymentV1Deprecated~~ - GetLatestDeploymentV1Deprecated :warning: Deprecated
- ~~deploymentsV2CreateDeploymentV2Deprecated~~ - CreateDeploymentV2Deprecated :warning: Deprecated
- ~~deploymentsV2GetDeploymentInfoV2Deprecated~~ - GetDeploymentInfoV2Deprecated :warning: Deprecated
- ~~deploymentsV2GetDeploymentsV2Deprecated~~ - GetDeploymentsV2Deprecated :warning: Deprecated
- ~~deploymentsV2GetLatestDeploymentV2Deprecated~~ - GetLatestDeploymentV2Deprecated :warning: Deprecated
- ~~discoveryV1GetPingServiceEndpointsDeprecated~~ - GetPingServiceEndpointsDeprecated :warning: Deprecated
- ~~fleetsV2DeprecatedUpdateFleetRegionV2~~ - DeprecatedUpdateFleetRegionV2 :warning: Deprecated
- ~~lobbiesV1CreatePrivateLobbyDeprecated~~ - CreatePrivateLobbyDeprecated :warning: Deprecated
- ~~lobbiesV1CreatePublicLobbyDeprecated~~ - CreatePublicLobbyDeprecated :warning: Deprecated
- ~~lobbiesV1ListActivePublicLobbiesDeprecatedV1~~ - ListActivePublicLobbiesDeprecatedV1 :warning: Deprecated
- ~~lobbiesV2CreateLobbyDeprecated~~ - CreateLobbyDeprecated :warning: Deprecated
- ~~lobbiesV2CreateLocalLobby~~ - CreateLocalLobby :warning: Deprecated
- ~~lobbiesV2CreatePrivateLobby~~ - CreatePrivateLobby :warning: Deprecated
- ~~lobbiesV2CreatePublicLobby~~ - CreatePublicLobby :warning: Deprecated
- ~~lobbiesV2GetLobbyInfo~~ - GetLobbyInfo :warning: Deprecated
- ~~lobbiesV2ListActivePublicLobbiesDeprecatedV2~~ - ListActivePublicLobbiesDeprecatedV2 :warning: Deprecated
- ~~lobbiesV2SetLobbyState~~ - SetLobbyState :warning: Deprecated
- ~~metricsV1GetMetricsDeprecated~~ - GetMetricsDeprecated :warning: Deprecated
- ~~processesV1GetProcessInfoDeprecated~~ - GetProcessInfoDeprecated :warning: Deprecated
- ~~processesV1GetRunningProcesses~~ - GetRunningProcesses :warning: Deprecated
- ~~processesV1GetStoppedProcesses~~ - GetStoppedProcesses :warning: Deprecated
- ~~processesV2CreateProcessV2Deprecated~~ - CreateProcessV2Deprecated :warning: Deprecated
- ~~processesV2GetLatestProcessesV2Deprecated~~ - GetLatestProcessesV2Deprecated :warning: Deprecated
- ~~processesV2GetProcessesCountExperimentalV2Deprecated~~ - GetProcessesCountExperimentalV2Deprecated :warning: Deprecated
- ~~processesV2GetProcessInfoV2Deprecated~~ - GetProcessInfoV2Deprecated :warning: Deprecated
- ~~processesV2StopProcessV2Deprecated~~ - StopProcessV2Deprecated :warning: Deprecated
- ~~roomsV1CreateRoomDeprecated~~ - CreateRoomDeprecated :warning: Deprecated
- ~~roomsV1DestroyRoomDeprecated~~ - DestroyRoomDeprecated :warning: Deprecated
- ~~roomsV1GetActiveRoomsForProcessDeprecated~~ - GetActiveRoomsForProcessDeprecated :warning: Deprecated
- ~~roomsV1GetConnectionInfoDeprecated~~ - GetConnectionInfoDeprecated :warning: Deprecated
- ~~roomsV1GetInactiveRoomsForProcessDeprecated~~ - GetInactiveRoomsForProcessDeprecated :warning: Deprecated
- ~~roomsV1GetRoomInfoDeprecated~~ - GetRoomInfoDeprecated :warning: Deprecated
- ~~roomsV1SuspendRoomDeprecated~~ - SuspendRoomDeprecated :warning: Deprecated
- ~~roomsV2SuspendRoomV2Deprecated~~ - SuspendRoomV2Deprecated :warning: Deprecated

Global Parameters

Certain parameters are configured globally. These parameters may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, These global values will be used as defaults on the operations that use them. When such operations are called, there is a place in each to override the global value, if needed.

For example, you can set orgId to "org-6f706e83-0ec1-437a-9a46-7d4281eb2f39" at SDK initialization and then you do not have to pass the same value on calls to operations like getOrgTokens. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.




$3

The following global parameters are available.

| Name | Type | Description |
| ----- | ------ | -------------------- |
| orgId | string | The orgId parameter. |
| appId | string | The appId parameter. |

$3

`typescript
import { HathoraCloud } from "@hathora/cloud-sdk-typescript";

const hathoraCloud = new HathoraCloud({
orgId: "org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
hathoraDevToken: "",
});

async function run() {
const result = await hathoraCloud.tokensV1.getOrgTokens(
"org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
);

console.log(result);
}

run();

`





Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.





Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
`typescript
import { HathoraCloud } from "@hathora/cloud-sdk-typescript";

const hathoraCloud = new HathoraCloud({
hathoraDevToken: "",
});

async function run() {
const result = await hathoraCloud.tokensV1.getOrgTokens(
"org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
{
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
},
);

console.log(result);
}

run();

`

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
`typescript
import { HathoraCloud } from "@hathora/cloud-sdk-typescript";

const hathoraCloud = new HathoraCloud({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
hathoraDevToken: "",
});

async function run() {
const result = await hathoraCloud.tokensV1.getOrgTokens(
"org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
);

console.log(result);
}

run();

`





Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

> [!WARNING]
> Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

`typescript
import { HathoraCloud } from "@hathora/cloud-sdk-typescript";

const sdk = new HathoraCloud({ debugLogger: console });
``

$3

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
looking for the latest version.

$3

While we value open-source contributions to this SDK, this library is generated programmatically.
Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release !

$3