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 DeploymentsV3 API

Versioned runtime configuration for a build.

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

Tagged areas include DeploymentsV3. 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 3 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 3 schemas 3 GET1 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 DeploymentsV3 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 — 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

DeploymentsV3 4

Versioned runtime configuration for a build.

GET
/deployments/v3/{appId}/list
Returns an array of deployments for an application.
GetDeployments 1 param → 200
POST
/deployments/v3/{appId}/create/{buildId}
Create a new deployment. All new processes for the app will use the latest deployment configuration.
CreateDeployment 2 params body → 201
GET
/deployments/v3/{appId}/latest
Get the latest deployment for an application.
GetLatestDeployment 1 param → 200
GET
/deployments/v3/{appId}/info/{deploymentId}
Get details for a deployment.
GetDeployment 2 params → 200404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Deployment (11 properties), DeploymentConfig (8 properties), ApiError (1 property). Each schema is shown below with its type and property counts.

Deployment
object
11 properties
ApiError
object
1 property
DeploymentConfig
object
8 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hathora-deploymentsv3-api-openapi.yml Raw ↑

Other APIs Hathora publishes across the network.

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