@hathora/cloud-sdk-typescript
v2.10.3
Published
<div align="center"> <img src="https://user-images.githubusercontent.com/6267663/235110661-00e586cc-7489-4daf-82e8-7ae3c2c7143e.svg" width="350px"> <h1> Typescript SDK</h1> <p>Serverless cloud hosting for multiplayer games</p> <a href="https
Downloads
627
Keywords
Readme
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
- Requirements
- SDK Example Usage
- Available Resources and Operations
- Standalone functions
- Global Parameters
- Retries
- Error Handling
- Server Selection
- Custom HTTP Client
- Authentication
- Debugging
SDK Installation
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
NPM
npm add @hathora/cloud-sdk-typescript
PNPM
pnpm add @hathora/cloud-sdk-typescript
Bun
bun add @hathora/cloud-sdk-typescript
Yarn
yarn add @hathora/cloud-sdk-typescript zod
# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.
SDK Example Usage
Example
import { HathoraCloud } from "@hathora/cloud-sdk-typescript";
const hathoraCloud = new HathoraCloud({
hathoraDevToken: "<YOUR_BEARER_TOKEN_HERE>",
appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});
async function run() {
const result = await hathoraCloud.tokensV1.getOrgTokens(
"org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
);
// Handle the result
console.log(result);
}
run();
Available Resources and Operations
~~appsV1~~
- ~~getAppsV1Deprecated~~ - Returns an unsorted list of your organization’s applications. An application is uniquely identified by an
appId
. :warning: Deprecated - ~~createAppV1Deprecated~~ - Create a new application. :warning: Deprecated
- ~~updateAppV1Deprecated~~ - Update data for an existing application using
appId
. :warning: Deprecated - ~~getAppInfoV1Deprecated~~ - Get details for an application using
appId
. :warning: Deprecated - ~~deleteAppV1Deprecated~~ - Delete an application using
appId
. Your organization will lose access to this application. :warning: Deprecated
appsV2
- getApps - Returns an unsorted list of your organization’s applications. An application is uniquely identified by an
appId
. - createApp - Create a new application.
- updateApp - Update data for an existing application using
appId
. - getApp - Get details for an application using
appId
. - deleteApp - Delete an application using
appId
. Your organization will lose access to this application.
authV1
- loginAnonymous - Returns a unique player token for an anonymous user.
- loginNickname - Returns a unique player token with a specified nickname for a user.
- loginGoogle - Returns a unique player token using a Google-signed OIDC
idToken
.
billingV1
- getBalance
- getUpcomingInvoiceItems
- getUpcomingInvoiceTotal
- getPaymentMethod
- initStripeCustomerPortalUrl
- getInvoices
~~buildsV1~~
- ~~getBuildsDeprecated~~ - Returns an array of builds for an application. :warning: Deprecated
- ~~getBuildInfoDeprecated~~ - Get details for a build. :warning: Deprecated
- ~~createBuildDeprecated~~ - Creates a new build. Responds with a
buildId
that you must pass toRunBuild()
to build the game server artifact. You can optionally pass in abuildTag
to associate an external version with a build. :warning: Deprecated - ~~deleteBuildDeprecated~~ - Delete a build. All associated metadata is deleted. :warning: Deprecated
- ~~runBuildDeprecated~~ - Builds a game server artifact from a tarball you provide. Pass in the
buildId
generated fromCreateBuild()
. :warning: Deprecated
~~buildsV2~~
- ~~getBuildsV2Deprecated~~ - Returns an array of builds for an application. :warning: Deprecated
- ~~getBuildInfoV2Deprecated~~ - Get details for a build. :warning: Deprecated
- ~~createBuildV2Deprecated~~ - Creates a new build. Responds with a
buildId
that you must pass toRunBuild()
to build the game server artifact. You can optionally pass in abuildTag
to associate an external version with a build. :warning: Deprecated - ~~createBuildWithUploadUrlV2Deprecated~~ - Creates a new build with
uploadUrl
that can be used to upload the build to before callingrunBuild
. Responds with abuildId
that you must pass toRunBuild()
to build the game server artifact. You can optionally pass in abuildTag
to associate an external version with a build. :warning: Deprecated - ~~createWithMultipartUploadsV2Deprecated~~ - Creates a new build with optional
multipartUploadUrls
that can be used to upload larger builds in parts before callingrunBuild
. Responds with abuildId
that you must pass toRunBuild()
to build the game server artifact. You can optionally pass in abuildTag
to associate an external version with a build. :warning: Deprecated - ~~deleteBuildV2Deprecated~~ - Delete a build. All associated metadata is deleted. :warning: Deprecated
- ~~runBuildV2Deprecated~~ - Builds a game server artifact from a tarball you provide. Pass in the
buildId
generated fromCreateBuild()
. :warning: Deprecated
buildsV3
- getBuilds - Returns an array of builds for an application.
- createBuild - Creates a new build with optional
multipartUploadUrls
that can be used to upload larger builds in parts before callingrunBuild
. Responds with abuildId
that you must pass toRunBuild()
to build the game server artifact. You can optionally pass in abuildTag
to associate an external version with a build. - getBuild - Get details for a build.
- deleteBuild - Delete a build. All associated metadata is deleted. Be careful which builds you delete. This endpoint does not prevent you from deleting actively used builds. Deleting a build that is actively build used by an app's deployment will cause failures when creating rooms.
- runBuild - Builds a game server artifact from a tarball you provide. Pass in the
buildId
generated fromCreateBuild()
.
~~deploymentsV1~~
- ~~getDeploymentsV1Deprecated~~ - Returns an array of deployments for an application. :warning: Deprecated
- ~~getLatestDeploymentV1Deprecated~~ - Get the latest deployment for an application. :warning: Deprecated
- ~~getDeploymentInfoV1Deprecated~~ - Get details for a deployment. :warning: 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. :warning: Deprecated
~~deploymentsV2~~
- ~~getDeploymentsV2Deprecated~~ - Returns an array of deployments for an application. :warning: Deprecated
- ~~getLatestDeploymentV2Deprecated~~ - Get the latest deployment for an application. :warning: Deprecated
- ~~getDeploymentInfoV2Deprecated~~ - Get details for a deployment. :warning: Deprecated
- ~~createDeploymentV2Deprecated~~ - 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. :warning: Deprecated
deploymentsV3
- getDeployments - Returns an array of deployments for an application.
- createDeployment - 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.
- getLatestDeployment - Get the latest deployment for an application.
- getDeployment - Get details for a deployment.
~~discoveryV1~~
- ~~getPingServiceEndpointsDeprecated~~ - Returns an array of V1 regions with a host and port that a client can directly ping. Open a websocket connection to
wss://<host>:<port>/ws
and send a packet. To calculate ping, measure the time it takes to get an echo packet back. :warning: Deprecated
discoveryV2
- getPingServiceEndpoints - Returns an array of all regions with a host and port that a client can directly ping. Open a websocket connection to
wss://<host>:<port>/ws
and send a packet. To calculate ping, measure the time it takes to get an echo packet back.
fleetsV1
- getFleets - Returns an array of fleets.
- getFleetRegion - Gets the configuration for a given fleet in a region.
- updateFleetRegion - Updates the configuration for a given fleet in a region.
- getFleetMetrics - Gets metrics for a fleet in a region.
~~lobbiesV1~~
- ~~createPrivateLobbyDeprecated~~ - :warning: Deprecated
- ~~createPublicLobbyDeprecated~~ - :warning: Deprecated
- ~~listActivePublicLobbiesDeprecatedV1~~ - :warning: Deprecated
~~lobbiesV2~~
- ~~createPrivateLobby~~ - :warning: Deprecated
- ~~createPublicLobby~~ - :warning: Deprecated
- ~~createLocalLobby~~ - :warning: Deprecated
- ~~createLobbyDeprecated~~ - Create a new lobby for an application. A lobby object is a wrapper around a room object. With a lobby, you get additional functionality like configuring the visibility of the room, managing the state of a match, and retrieving a list of public lobbies to display to players. :warning: Deprecated
- ~~listActivePublicLobbiesDeprecatedV2~~ - Get all active lobbies for a an application. Filter by optionally passing in a
region
. Use this endpoint to display all public lobbies that a player can join in the game client. :warning: Deprecated - ~~getLobbyInfo~~ - Get details for a lobby. :warning: Deprecated
- ~~setLobbyState~~ - Set the state of a lobby. State is intended to be set by the server and must be smaller than 1MB. Use this endpoint to store match data like live player count to enforce max number of clients or persist end-game data (i.e. winner or final scores). :warning: Deprecated
lobbiesV3
- createLobby - Create a new lobby for an application. A lobby object is a wrapper around a room object. With a lobby, you get additional functionality like configuring the visibility of the room, managing the state of a match, and retrieving a list of public lobbies to display to players.
- listActivePublicLobbies - Get all active lobbies for a given application. Filter the array by optionally passing in a
region
. Use this endpoint to display all public lobbies that a player can join in the game client. - getLobbyInfoByRoomId - Get details for a lobby.
- getLobbyInfoByShortCode - Get details for a lobby. If 2 or more lobbies have the same
shortCode
, then the most recently created lobby will be returned.
logsV1
- ~~getLogsForApp~~ - Returns a stream of logs for an application using
appId
. :warning: Deprecated - getLogsForProcess - Returns a stream of logs for a process using
appId
andprocessId
. - downloadLogForProcess - Download entire log file for a stopped process.
- ~~getLogsForDeployment~~ - Returns a stream of logs for a deployment using
appId
anddeploymentId
. :warning: Deprecated
managementV1
~~metricsV1~~
- ~~getMetricsDeprecated~~ - Get metrics for a process using
appId
andprocessId
. :warning: Deprecated
organizationsV1
- getOrgs - Returns an unsorted list of all organizations that you are a member of (an accepted membership invite). An organization is uniquely identified by an
orgId
. - getUserPendingInvites
- getOrgMembers
- inviteUser
- rescindInvite
- getOrgPendingInvites
- acceptInvite
- rejectInvite
~~processesV1~~
- ~~getRunningProcesses~~ - Retrieve 10 most recently started process objects for an application. Filter the array by optionally passing in a
region
. :warning: Deprecated - ~~getStoppedProcesses~~ - Retrieve 10 most recently stopped process objects for an application. Filter the array by optionally passing in a
region
. :warning: Deprecated - ~~getProcessInfoDeprecated~~ - Get details for a process. :warning: Deprecated
~~processesV2~~
- ~~getProcessInfoV2Deprecated~~ - Get details for a process. :warning: Deprecated
- ~~getLatestProcessesV2Deprecated~~ - Retrieve the 10 most recent processes objects for an application. Filter the array by optionally passing in a
status
orregion
. :warning: Deprecated - ~~getProcessesCountExperimentalV2Deprecated~~ - Count the number of processes objects for an application. Filter by optionally passing in a
status
orregion
. :warning: Deprecated - ~~stopProcessV2Deprecated~~ - Stops a process immediately. :warning: Deprecated
- ~~createProcessV2Deprecated~~ - Creates a process without a room. Use this to pre-allocate processes ahead of time so that subsequent room assignment via CreateRoom() can be instant. :warning: Deprecated
processesV3
- getLatestProcesses - Retrieve the 10 most recent processes objects for an application. Filter the array by optionally passing in a
status
orregion
. - getProcessesCountExperimental - Count the number of processes objects for an application. Filter by optionally passing in a
status
orregion
. - createProcess - Creates a process without a room. Use this to pre-allocate processes ahead of time so that subsequent room assignment via CreateRoom() can be instant.
- getProcess - Get details for a process.
- stopProcess - Stops a process immediately.
- getProcessMetrics
~~roomsV1~~
- ~~createRoomDeprecated~~ - :warning: Deprecated
- ~~getRoomInfoDeprecated~~ - :warning: Deprecated
- ~~getActiveRoomsForProcessDeprecated~~ - :warning: Deprecated
- ~~getInactiveRoomsForProcessDeprecated~~ - :warning: Deprecated
- ~~destroyRoomDeprecated~~ - :warning: Deprecated
- ~~suspendRoomDeprecated~~ - :warning: Deprecated
- ~~getConnectionInfoDeprecated~~ - :warning: Deprecated
roomsV2
- createRoom - Create a new room for an existing application. Poll the
GetConnectionInfo()
endpoint to get connection details for an active room. - getRoomInfo - Retreive current and historical allocation data for a room.
- getActiveRoomsForProcess - Get all active rooms for a given process.
- getInactiveRoomsForProcess - Get all inactive rooms for a given process.
- destroyRoom - Destroy a room. All associated metadata is deleted.
- ~~suspendRoomV2Deprecated~~ - Suspend a room. The room is unallocated from the process but can be rescheduled later using the same
roomId
. :warning: Deprecated - getConnectionInfo - Poll this endpoint to get connection details to a room. Clients can call this endpoint without authentication.
- updateRoomConfig
tokensV1
- getOrgTokens - List all organization tokens for a given org.
- createOrgToken - Create a new organization token.
- revokeOrgToken - Revoke an organization token.
Error Handling
All SDK methods return a response object or throw an error. By default, an API error will throw a errors.SDKError
.
If a HTTP request fails, an operation my also throw an error from the models/errors/httpclienterrors.ts
module:
| HTTP Client Error | Description | | ---------------------------------------------------- | ---------------------------------------------------- | | RequestAbortedError | HTTP request was aborted by the client | | RequestTimeoutError | HTTP request timed out due to an AbortSignal signal | | ConnectionError | HTTP client was unable to make a request to a server | | InvalidRequestError | Any input used to create a request is invalid | | UnexpectedClientError | Unrecognised or unexpected error |
In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation. For example, the getOrgTokens
method may throw the following errors:
| Error Type | Status Code | Content Type | | ---------------- | ---------------- | ---------------- | | errors.ApiError | 401, 404, 429 | application/json | | errors.SDKError | 4XX, 5XX | */* |
import { HathoraCloud } from "@hathora/cloud-sdk-typescript";
import {
ApiError,
SDKValidationError,
} from "@hathora/cloud-sdk-typescript/models/errors";
const hathoraCloud = new HathoraCloud({
hathoraDevToken: "<YOUR_BEARER_TOKEN_HERE>",
appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});
async function run() {
let result;
try {
result = await hathoraCloud.tokensV1.getOrgTokens(
"org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
);
// Handle the result
console.log(result);
} catch (err) {
switch (true) {
case (err instanceof SDKValidationError): {
// Validation errors can be pretty-printed
console.error(err.pretty());
// Raw value may also be inspected
console.error(err.rawValue);
return;
}
case (err instanceof ApiError): {
// Handle err.data$: ApiErrorData
console.error(err);
return;
}
default: {
throw err;
}
}
}
}
run();
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError
that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue
. Additionally, a pretty()
method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
Server Selection
Select Server by Index
You can override the default server globally by passing a server index to the serverIdx
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 | Variables |
| - | ------ | --------- |
| 0 | https://api.hathora.dev
| None |
| 1 | https:///
| None |
import { HathoraCloud } from "@hathora/cloud-sdk-typescript";
const hathoraCloud = new HathoraCloud({
serverIdx: 1,
hathoraDevToken: "<YOUR_BEARER_TOKEN_HERE>",
appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});
async function run() {
const result = await hathoraCloud.tokensV1.getOrgTokens(
"org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
);
// Handle the result
console.log(result);
}
run();
Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the serverURL
optional parameter when initializing the SDK client instance. For example:
import { HathoraCloud } from "@hathora/cloud-sdk-typescript";
const hathoraCloud = new HathoraCloud({
serverURL: "https://api.hathora.dev",
hathoraDevToken: "<YOUR_BEARER_TOKEN_HERE>",
appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});
async function run() {
const result = await hathoraCloud.tokensV1.getOrgTokens(
"org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
);
// Handle the result
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:
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 });
Authentication
Per-Client Security Schemes
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:
import { HathoraCloud } from "@hathora/cloud-sdk-typescript";
const hathoraCloud = new HathoraCloud({
hathoraDevToken: "<YOUR_BEARER_TOKEN_HERE>",
appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});
async function run() {
const result = await hathoraCloud.tokensV1.getOrgTokens(
"org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
);
// Handle the result
console.log(result);
}
run();
Per-Operation Security Schemes
Some operations in this SDK require the security scheme to be specified at the request level. For example:
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: "<YOUR_BEARER_TOKEN_HERE>",
},
{
visibility: "private",
roomConfig: "{\"name\":\"my-room\"}",
region: "Seattle",
},
"app-af469a92-5b45-4565-b3c4-b79878de67d2",
"LFG4",
"2swovpy1fnunu",
);
// Handle the result
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.
appsV2CreateApp
- Create a new application.appsV2DeleteApp
- Delete an application usingappId
. Your organization will lose access to this application.appsV2GetApp
- Get details for an application usingappId
.appsV2GetApps
- Returns an unsorted list of your organization’s applications. An application is uniquely identified by anappId
.appsV2UpdateApp
- Update data for an existing application usingappId
.authV1LoginAnonymous
- Returns a unique player token for an anonymous user.authV1LoginGoogle
- Returns a unique player token using a Google-signed OIDCidToken
.authV1LoginNickname
- Returns a unique player token with a specified nickname for a user.billingV1GetBalance
billingV1GetInvoices
billingV1GetPaymentMethod
billingV1GetUpcomingInvoiceItems
billingV1GetUpcomingInvoiceTotal
billingV1InitStripeCustomerPortalUrl
buildsV3CreateBuild
- Creates a new build with optionalmultipartUploadUrls
that can be used to upload larger builds in parts before callingrunBuild
. Responds with abuildId
that you must pass toRunBuild()
to build the game server artifact. You can optionally pass in abuildTag
to associate an external version with a build.buildsV3DeleteBuild
- Delete a build. All associated metadata is deleted. Be careful which builds you delete. This endpoint does not prevent you from deleting actively used builds. Deleting a build that is actively build used by an app's deployment will cause failures when creating rooms.buildsV3GetBuild
- Get details for a build.buildsV3GetBuilds
- Returns an array of builds for an application.buildsV3RunBuild
- Builds a game server artifact from a tarball you provide. Pass in thebuildId
generated fromCreateBuild()
.deploymentsV3CreateDeployment
- 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.deploymentsV3GetDeployment
- Get details for a deployment.deploymentsV3GetDeployments
- Returns an array of deployments for an application.deploymentsV3GetLatestDeployment
- Get the latest deployment for an application.discoveryV2GetPingServiceEndpoints
- Returns an array of all regions with a host and port that a client can directly ping. Open a websocket connection towss://<host>:<port>/ws
and send a packet. To calculate ping, measure the time it takes to get an echo packet back.fleetsV1GetFleetMetrics
- Gets metrics for a fleet in a region.fleetsV1GetFleetRegion
- Gets the configuration for a given fleet in a region.fleetsV1GetFleets
- Returns an array of fleets.fleetsV1UpdateFleetRegion
- Updates the configuration for a given fleet in a region.lobbiesV3CreateLobby
- Create a new lobby for an application. A lobby object is a wrapper around a room object. With a lobby, you get additional functionality like configuring the visibility of the room, managing the state of a match, and retrieving a list of public lobbies to display to players.lobbiesV3GetLobbyInfoByRoomId
- Get details for a lobby.lobbiesV3GetLobbyInfoByShortCode
- Get details for a lobby. If 2 or more lobbies have the sameshortCode
, then the most recently created lobby will be returned.lobbiesV3ListActivePublicLobbies
- Get all active lobbies for a given application. Filter the array by optionally passing in aregion
. Use this endpoint to display all public lobbies that a player can join in the game client.logsV1DownloadLogForProcess
- Download entire log file for a stopped process.logsV1GetLogsForProcess
- Returns a stream of logs for a process usingappId
andprocessId
.managementV1SendVerificationEmail
organizationsV1AcceptInvite
organizationsV1GetOrgMembers
organizationsV1GetOrgPendingInvites
organizationsV1GetOrgs
- Returns an unsorted list of all organizations that you are a member of (an accepted membership invite). An organization is uniquely identified by anorgId
.organizationsV1GetUserPendingInvites
organizationsV1InviteUser
organizationsV1RejectInvite
organizationsV1RescindInvite
processesV3CreateProcess
- Creates a process without a room. Use this to pre-allocate processes ahead of time so that subsequent room assignment via CreateRoom() can be instant.processesV3GetLatestProcesses
- Retrieve the 10 most recent processes objects for an application. Filter the array by optionally passing in astatus
orregion
.processesV3GetProcess
- Get details for a process.processesV3GetProcessesCountExperimental
- Count the number of processes objects for an application. Filter by optionally passing in astatus
orregion
.processesV3GetProcessMetrics
processesV3StopProcess
- Stops a process immediately.roomsV2CreateRoom
- Create a new room for an existing application. Poll theGetConnectionInfo()
endpoint to get connection details for an active room.roomsV2DestroyRoom
- Destroy a room. All associated metadata is deleted.roomsV2GetActiveRoomsForProcess
- Get all active rooms for a given process.roomsV2GetConnectionInfo
- Poll this endpoint to get connection details to a room. Clients can call this endpoint without authentication.roomsV2GetInactiveRoomsForProcess
- Get all inactive rooms for a given process.roomsV2GetRoomInfo
- Retreive current and historical allocation data for a room.roomsV2UpdateRoomConfig
tokensV1CreateOrgToken
- Create a new organization token.tokensV1GetOrgTokens
- List all organization tokens for a given org.tokensV1RevokeOrgToken
- Revoke an organization token.- ~~
appsV1CreateAppV1Deprecated
~~ - Create a new application. :warning: Deprecated - ~~
appsV1DeleteAppV1Deprecated
~~ - Delete an application usingappId
. Your organization will lose access to this application. :warning: Deprecated - ~~
appsV1GetAppInfoV1Deprecated
~~ - Get details for an application usingappId
. :warning: Deprecated - ~~
appsV1GetAppsV1Deprecated
~~ - Returns an unsorted list of your organization’s applications. An application is uniquely identified by anappId
. :warning: Deprecated - ~~
appsV1UpdateAppV1Deprecated
~~ - Update data for an existing application usingappId
. :warning: Deprecated - ~~
buildsV1CreateBuildDeprecated
~~ - Creates a new build. Responds with abuildId
that you must pass toRunBuild()
to build the game server artifact. You can optionally pass in abuildTag
to associate an external version with a build. :warning: Deprecated - ~~
buildsV1DeleteBuildDeprecated
~~ - Delete a build. All associated metadata is deleted. :warning: Deprecated - ~~
buildsV1GetBuildInfoDeprecated
~~ - Get details for a build. :warning: Deprecated - ~~
buildsV1GetBuildsDeprecated
~~ - Returns an array of builds for an application. :warning: Deprecated - ~~
buildsV1RunBuildDeprecated
~~ - Builds a game server artifact from a tarball you provide. Pass in thebuildId
generated fromCreateBuild()
. :warning: Deprecated - ~~
buildsV2CreateBuildV2Deprecated
~~ - Creates a new build. Responds with abuildId
that you must pass toRunBuild()
to build the game server artifact. You can optionally pass in abuildTag
to associate an external version with a build. :warning: Deprecated - ~~
buildsV2CreateBuildWithUploadUrlV2Deprecated
~~ - Creates a new build withuploadUrl
that can be used to upload the build to before callingrunBuild
. Responds with abuildId
that you must pass toRunBuild()
to build the game server artifact. You can optionally pass in abuildTag
to associate an external version with a build. :warning: Deprecated - ~~
buildsV2CreateWithMultipartUploadsV2Deprecated
~~ - Creates a new build with optionalmultipartUploadUrls
that can be used to upload larger builds in parts before callingrunBuild
. Responds with abuildId
that you must pass toRunBuild()
to build the game server artifact. You can optionally pass in abuildTag
to associate an external version with a build. :warning: Deprecated - ~~
buildsV2DeleteBuildV2Deprecated
~~ - Delete a build. All associated metadata is deleted. :warning: Deprecated - ~~
buildsV2GetBuildInfoV2Deprecated
~~ - Get details for a build. :warning: Deprecated - ~~
buildsV2GetBuildsV2Deprecated
~~ - Returns an array of builds for an application. :warning: Deprecated - ~~
buildsV2RunBuildV2Deprecated
~~ - Builds a game server artifact from a tarball you provide. Pass in thebuildId
generated fromCreateBuild()
. :warning: Deprecated - ~~
deploymentsV1CreateDeploymentV1Deprecated
~~ - 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. :warning: Deprecated - ~~
deploymentsV1GetDeploymentInfoV1Deprecated
~~ - Get details for a deployment. :warning: Deprecated - ~~
deploymentsV1GetDeploymentsV1Deprecated
~~ - Returns an array of deployments for an application. :warning: Deprecated - ~~
deploymentsV1GetLatestDeploymentV1Deprecated
~~ - Get the latest deployment for an application. :warning: Deprecated - ~~
deploymentsV2CreateDeploymentV2Deprecated
~~ - 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. :warning: Deprecated - ~~
deploymentsV2GetDeploymentInfoV2Deprecated
~~ - Get details for a deployment. :warning: Deprecated - ~~
deploymentsV2GetDeploymentsV2Deprecated
~~ - Returns an array of deployments for an application. :warning: Deprecated - ~~
deploymentsV2GetLatestDeploymentV2Deprecated
~~ - Get the latest deployment for an application. :warning: Deprecated - ~~
discoveryV1GetPingServiceEndpointsDeprecated
~~ - Returns an array of V1 regions with a host and port that a client can directly ping. Open a websocket connection towss://<host>:<port>/ws
and send a packet. To calculate ping, measure the time it takes to get an echo packet back. :warning: Deprecated - ~~
lobbiesV1CreatePrivateLobbyDeprecated
~~ - :warning: Deprecated - ~~
lobbiesV1CreatePublicLobbyDeprecated
~~ - :warning: Deprecated - ~~
lobbiesV1ListActivePublicLobbiesDeprecatedV1
~~ - :warning: Deprecated - ~~
lobbiesV2CreateLobbyDeprecated
~~ - Create a new lobby for an application. A lobby object is a wrapper around a room object. With a lobby, you get additional functionality like configuring the visibility of the room, managing the state of a match, and retrieving a list of public lobbies to display to players. :warning: Deprecated - ~~
lobbiesV2CreateLocalLobby
~~ - :warning: Deprecated - ~~
lobbiesV2CreatePrivateLobby
~~ - :warning: Deprecated - ~~
lobbiesV2CreatePublicLobby
~~ - :warning: Deprecated - ~~
lobbiesV2GetLobbyInfo
~~ - Get details for a lobby. :warning: Deprecated - ~~
lobbiesV2ListActivePublicLobbiesDeprecatedV2
~~ - Get all active lobbies for a an application. Filter by optionally passing in aregion
. Use this endpoint to display all public lobbies that a player can join in the game client. :warning: Deprecated - ~~
lobbiesV2SetLobbyState
~~ - Set the state of a lobby. State is intended to be set by the server and must be smaller than 1MB. Use this endpoint to store match data like live player count to enforce max number of clients or persist end-game data (i.e. winner or final scores). :warning: Deprecated - ~~
logsV1GetLogsForApp
~~ - Returns a stream of logs for an application usingappId
. :warning: Deprecated - ~~
logsV1GetLogsForDeployment
~~ - Returns a stream of logs for a deployment usingappId
anddeploymentId
. :warning: Deprecated - ~~
metricsV1GetMetricsDeprecated
~~ - Get metrics for a process usingappId
andprocessId
. :warning: Deprecated - ~~
processesV1GetProcessInfoDeprecated
~~ - Get details for a process. :warning: Deprecated - ~~
processesV1GetRunningProcesses
~~ - Retrieve 10 most recently started process objects for an application. Filter the array by optionally passing in aregion
. :warning: Deprecated - ~~
processesV1GetStoppedProcesses
~~ - Retrieve 10 most recently stopped process objects for an application. Filter the array by optionally passing in aregion
. :warning: Deprecated - ~~
processesV2CreateProcessV2Deprecated
~~ - Creates a process without a room. Use this to pre-allocate processes ahead of time so that subsequent room assignment via CreateRoom() can be instant. :warning: Deprecated - ~~
processesV2GetLatestProcessesV2Deprecated
~~ - Retrieve the 10 most recent processes objects for an application. Filter the array by optionally passing in astatus
orregion
. :warning: Deprecated - ~~
processesV2GetProcessesCountExperimentalV2Deprecated
~~ - Count the number of processes objects for an application. Filter by optionally passing in astatus
orregion
. :warning: Deprecated - ~~
processesV2GetProcessInfoV2Deprecated
~~ - Get details for a process. :warning: Deprecated - ~~
processesV2StopProcessV2Deprecated
~~ - Stops a process immediately. :warning: Deprecated - ~~
roomsV1CreateRoomDeprecated
~~ - :warning: Deprecated - ~~
roomsV1DestroyRoomDeprecated
~~ - :warning: Deprecated - ~~
roomsV1GetActiveRoomsForProcessDeprecated
~~ - :warning: Deprecated - ~~
roomsV1GetConnectionInfoDeprecated
~~ - :warning: Deprecated - ~~
roomsV1GetInactiveRoomsForProcessDeprecated
~~ - :warning: Deprecated - ~~
roomsV1GetRoomInfoDeprecated
~~ - :warning: Deprecated - ~~
roomsV1SuspendRoomDeprecated
~~ - :warning: Deprecated - ~~
roomsV2SuspendRoomV2Deprecated
~~ - Suspend a room. The room is unallocated from the process but can be rescheduled later using the sameroomId
. :warning: Deprecated
Global Parameters
A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
For example, you can set appId
to "app-af469a92-5b45-4565-b3c4-b79878de67d2"
at SDK initialization and then you do not have to pass the same value on calls to operations like createRoom
. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
Available Globals
The following global parameter is available.
| Name | Type | Required | Description | | ---- | ---- |:--------:| ----------- | | appId | string | | The appId parameter. |
Example
import { HathoraCloud } from "@hathora/cloud-sdk-typescript";
const hathoraCloud = new HathoraCloud({
hathoraDevToken: "<YOUR_BEARER_TOKEN_HERE>",
appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});
async function