Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hathora RoomsV2 API

Create, inspect, and destroy rooms and get connection info.

Hathora RoomsV2 API is one of 11 APIs that Hathora publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include RoomsV2. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 4 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 3.0.

Requests are made against a single base URL, https://api.hathora.dev.

4 operations 4 paths 5 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
3.0
Base URL
https://api.hathora.dev
Authentication
HTTP Bearer, HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 2

Hathora RoomsV2 API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (hathoraDevToken). It accepts HTTP bearer tokens (JWT) (playerAuth). By default, every request must be authenticated.

  • hathoraDevToken — Organization developer/API token used for management endpoints (apps, builds, deployments, processes, rooms, logs, metrics, billing, tokens).
  • playerAuth — Short-lived player token issued by the AuthV1 login endpoints, used by game clients for room and lobby operations.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

RoomsV2 4

Create, inspect, and destroy rooms and get connection info.

POST
/rooms/v2/{appId}/create
Create a new room for an application.
CreateRoom 1 param body → 201
GET
/rooms/v2/{appId}/info/{roomId}
Get details for a room.
GetRoomInfo 2 params → 200404
GET
/rooms/v2/{appId}/connectioninfo/{roomId}
Poll this endpoint to get connection details for an active room.
GetConnectionInfo 2 params → 200
POST
/rooms/v2/{appId}/destroy/{roomId}
Destroy a room. All associated metadata is deleted.
DestroyRoom 2 params → 204

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Room (4 properties), ConnectionInfo (3 properties), RoomCreated (2 properties), ApiError (1 property). Each schema is shown below with its type and property counts.

Room
object
4 properties
RoomCreated
object
2 properties
Region
string
The region where a process, room, or lobby runs.
ApiError
object
1 property
ConnectionInfo
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hathora-roomsv2-api-openapi.yml Raw ↑

Other APIs Hathora publishes across the network.

Hathora AppsV2 API
Hathora AuthV1 API
Hathora BillingV1 API
Hathora BuildsV3 API
Hathora DeploymentsV3 API
Hathora DiscoveryV2 API
Hathora LogsV1 API
Hathora MetricsV1 API
Hathora ProcessesV3 API
Hathora TokensV1 API