# Hathora Cloud API API

> Hathora Cloud API API on Apizie: 45 endpoints (Returns an unsorted list of your organization’s…, Create a new [application](https://hathora.dev/docs/concepts/hathora-entities#application)., Update data for an existing [application](https://hathora.dev/docs/concepts/hathora-entities#application)…, Get details for an [application](https://hathora.dev/docs/concepts/hathora-entities#application) using…, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:hathora/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:hathora`
- Category: Cloud
- Status: byok
- Source: https://hathora.dev
- Page: https://apizie.tech/api/cloud/hathora
- OpenAPI: https://apizie.tech/api/cloud/hathora/openapi.json

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

## Endpoints

### Returns an unsorted list of your organization’s…
`GET https://apizie.tech/v1/cloud:hathora/app-v1-get-app-list` (byok)

### Create a new [application](https://hathora.dev/docs/concepts/hathora-entities#application).
`POST https://apizie.tech/v1/cloud:hathora/app-v1-create-new-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Update data for an existing [application](https://hathora.dev/docs/concepts/hathora-entities#application)…
`POST https://apizie.tech/v1/cloud:hathora/app-v1-update-application-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |
| body | object | yes | JSON request body |

### Get details for an [application](https://hathora.dev/docs/concepts/hathora-entities#application) using…
`GET https://apizie.tech/v1/cloud:hathora/app-v1-get-app-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |

### Delete an [application](https://hathora.dev/docs/concepts/hathora-entities#application) using `appId`. Your…
`POST https://apizie.tech/v1/cloud:hathora/app-v1-delete-application-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |

### Returns a unique player token for an anonymous user.
`POST https://apizie.tech/v1/cloud:hathora/auth-v1-generate-player-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |

### Returns a unique player token with a specified nickname for a user.
`POST https://apizie.tech/v1/cloud:hathora/auth-v1-generate-unique-player-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |
| body | object | yes | JSON request body |

### Returns a unique player token using a Google-signed OIDC `idToken`.
`POST https://apizie.tech/v1/cloud:hathora/auth-v1-get-unique-player-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |
| body | object | yes | JSON request body |

### GET /billing/v1/balance
`GET https://apizie.tech/v1/cloud:hathora/billing-v1-get-balance` (byok)

### GET /billing/v1/paymentmethod
`GET https://apizie.tech/v1/cloud:hathora/billing-v1-get-payment-method` (byok)

### POST /billing/v1/customerportalurl
`POST https://apizie.tech/v1/cloud:hathora/billing-v1-create-customer-portal-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### GET /billing/v1/invoices
`GET https://apizie.tech/v1/cloud:hathora/billing-v1-list-invoices` (byok)

### Returns an array of [builds](https://hathora.dev/docs/concepts/hathora-entities#build) for an…
`GET https://apizie.tech/v1/cloud:hathora/build-v1-get-application-builds` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |

### Get details for a [build](https://hathora.dev/docs/concepts/hathora-entities#build).
`GET https://apizie.tech/v1/cloud:hathora/build-v1-get-application-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |
| buildId | integer | yes | System generated id for a build. Increments by 1. |

### Creates a new [build](https://hathora.dev/docs/concepts/hathora-entities#build). Responds with a `buildId`…
`POST https://apizie.tech/v1/cloud:hathora/build-v1-create-build` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |
| body | object | yes | JSON request body |

### Builds a game server artifact from a tarball you provide. Pass in the `buildId` generated from…
`POST https://apizie.tech/v1/cloud:hathora/build-v1-build-server-artifact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |
| buildId | integer | yes | System generated id for a build. Increments by 1. |
| body | object | yes | Form fields as a JSON object |

### Delete a [build](https://hathora.dev/docs/concepts/hathora-entities#build). All associated metadata is…
`POST https://apizie.tech/v1/cloud:hathora/build-v1-delete-build-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |
| buildId | integer | yes | System generated id for a build. Increments by 1. |

### Returns an array of [deployments](https://hathora.dev/docs/concepts/hathora-entities#deployment) for an…
`GET https://apizie.tech/v1/cloud:hathora/deployment-v2-get-app-deployments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |

### Get the latest [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment) for an…
`GET https://apizie.tech/v1/cloud:hathora/deployment-v2-get-latest-deployment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |

### Get details for a [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment).
`GET https://apizie.tech/v1/cloud:hathora/deployment-v2-get-deployment-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |
| deploymentId | integer | yes | System generated id for a deployment. Increments by 1. |

### Create a new [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment). Creating a new…
`POST https://apizie.tech/v1/cloud:hathora/deployment-v2-create-deployment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |
| buildId | integer | yes | System generated id for a build. Increments by 1. |
| body | object | yes | JSON request body |

### Returns an array of all regions with a host and port that a client can directly ping. Open a websocket…
`GET https://apizie.tech/v1/cloud:hathora/discovery-v1-get-endpoints` (byok)

### Create a new lobby for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). A…
`POST https://apizie.tech/v1/cloud:hathora/lobby-v3-create-new-lobby` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |
| shortCode | string | no | User-defined identifier for a lobby. |
| roomId | string | no | Unique identifier to a game session or match. Use the default system generated ID or overwrite it with your own. Note: error will be… |
| body | object | yes | JSON request body |

### Get all active lobbies for a given…
`GET https://apizie.tech/v1/cloud:hathora/lobby-v3-list-public-lobbies` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |
| region | string | no | If omitted, active public lobbies in all regions will be returned. |

### Get details for a lobby.
`GET https://apizie.tech/v1/cloud:hathora/lobby-v3-get-lobby-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |
| roomId | string | yes | Unique identifier to a game session or match. Use the default system generated ID or overwrite it with your own. Note: error will be… |

### Get details for a lobby. If 2 or more lobbies have the same `shortCode`, then the most recently created…
`GET https://apizie.tech/v1/cloud:hathora/lobby-v3-get-info-by-short-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |
| shortCode | string | yes | User-defined identifier for a lobby. |

### Returns a stream of logs for a [process](https://hathora.dev/docs/concepts/hathora-entities#process) using…
`GET https://apizie.tech/v1/cloud:hathora/log-v1-stream-logs-for-process` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |
| processId | string | yes | System generated unique identifier to a runtime instance of your game server. |
| follow | boolean | no | Stream logs in realtime. |
| tailLines | integer | no | Number of lines to return from most recent logs history. |

### Download entire log file for a stopped process.
`GET https://apizie.tech/v1/cloud:hathora/log-v1-download-log-for-process` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |
| processId | string | yes | System generated unique identifier to a runtime instance of your game server. |

### POST /management/v1/sendverificationemail
`POST https://apizie.tech/v1/cloud:hathora/management-v1-send-verification-email` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get metrics for a [process](https://hathora.dev/docs/concepts/hathora-entities#process) using `appId` and…
`GET https://apizie.tech/v1/cloud:hathora/metrics-v1-get-process-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |
| processId | string | yes | System generated unique identifier to a runtime instance of your game server. |
| metrics | array | no | Available metrics to query over time. |
| end | number | no | Unix timestamp. Default is current time. |
| start | number | no | Unix timestamp. Default is -1 hour from `end`. |
| step | integer | no | Width of time in seconds to group data. |

### Get details for a [process](https://hathora.dev/docs/concepts/hathora-entities#process).
`GET https://apizie.tech/v1/cloud:hathora/processes-v2-get-process-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |
| processId | string | yes | System generated unique identifier to a runtime instance of your game server. |

### Retrieve the 10 most recent [processes](https://hathora.dev/docs/concepts/hathora-entities#process) objects…
`GET https://apizie.tech/v1/cloud:hathora/processes-v2-get-latest-processes-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |
| status | array | no |  |
| region | array | no |  |

### Stops a [process](https://hathora.dev/docs/concepts/hathora-entities#process) immediately.
`POST https://apizie.tech/v1/cloud:hathora/processes-v2-stop-process-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |
| processId | string | yes | System generated unique identifier to a runtime instance of your game server. |

### Creates a [process](https://hathora.dev/docs/concepts/hathora-entities#process) without a room. Use this to…
`POST https://apizie.tech/v1/cloud:hathora/processes-v2-create-process-without-room` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |
| region | string | yes |  |

### Create a new [room](https://hathora.dev/docs/concepts/hathora-entities#room) for an existing…
`POST https://apizie.tech/v1/cloud:hathora/room-v2-create-room` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |
| roomId | string | no | Unique identifier to a game session or match. Use the default system generated ID or overwrite it with your own. Note: error will be… |
| body | object | yes | JSON request body |

### Retreive current and historical allocation data for a…
`GET https://apizie.tech/v1/cloud:hathora/room-v2-get-allocation-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |
| roomId | string | yes | Unique identifier to a game session or match. Use the default system generated ID or overwrite it with your own. Note: error will be… |

### Get all active [rooms](https://hathora.dev/docs/concepts/hathora-entities#room) for a given…
`GET https://apizie.tech/v1/cloud:hathora/room-v2-list-active-rooms` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |
| processId | string | yes | System generated unique identifier to a runtime instance of your game server. |

### Get all inactive [rooms](https://hathora.dev/docs/concepts/hathora-entities#room) for a given…
`GET https://apizie.tech/v1/cloud:hathora/room-v2-list-inactive-rooms` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |
| processId | string | yes | System generated unique identifier to a runtime instance of your game server. |

### Destroy a [room](https://hathora.dev/docs/concepts/hathora-entities#room). All associated metadata is deleted.
`POST https://apizie.tech/v1/cloud:hathora/room-v2-destroy-room-allocation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |
| roomId | string | yes | Unique identifier to a game session or match. Use the default system generated ID or overwrite it with your own. Note: error will be… |

### Suspend a [room](https://hathora.dev/docs/concepts/hathora-entities#room). The room is unallocated from the…
`POST https://apizie.tech/v1/cloud:hathora/room-v2-suspend-room-allocation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |
| roomId | string | yes | Unique identifier to a game session or match. Use the default system generated ID or overwrite it with your own. Note: error will be… |

### Poll this endpoint to get connection details to a…
`GET https://apizie.tech/v1/cloud:hathora/room-v2-get-connection-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |
| roomId | string | yes | Unique identifier to a game session or match. Use the default system generated ID or overwrite it with your own. Note: error will be… |

### POST /rooms/v2/{appId}/update/{roomId}
`POST https://apizie.tech/v1/cloud:hathora/room-v2-update-room-allocation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| appId | string | yes | System generated unique identifier for an application. |
| roomId | string | yes | Unique identifier to a game session or match. Use the default system generated ID or overwrite it with your own. Note: error will be… |
| body | object | yes | JSON request body |

### List all organization tokens for a given org.
`GET https://apizie.tech/v1/cloud:hathora/org-tokens-v1-list-org-tokens` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| orgId | string | yes | System generated unique identifier for an organization. Not guaranteed to have a specific format. |

### Create a new organization token.
`POST https://apizie.tech/v1/cloud:hathora/org-tokens-v1-create-new-org-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| orgId | string | yes | System generated unique identifier for an organization. Not guaranteed to have a specific format. |
| body | object | yes | JSON request body |

### Revoke an organization token.
`POST https://apizie.tech/v1/cloud:hathora/org-tokens-v1-revoke-org-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| orgId | string | yes | System generated unique identifier for an organization. Not guaranteed to have a specific format. |
| orgTokenId | string | yes | System generated unique identifier for an organization. Not guaranteed to have a specific format. |

## Example
```
curl "https://apizie.tech/v1/cloud:hathora/app-v1-get-app-list" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Hathora Cloud API API?
Create a free Apizie key, then send GET https://apizie.tech/v1/cloud:hathora/app-v1-get-app-list with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Hathora Cloud API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Hathora Cloud API itself also needs your own key from api.hathora.dev.

### Can AI agents use the Hathora Cloud API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:hathora.

### What is the status of the Hathora Cloud API API?
Needs your own provider key (bring your own key)