Skip to main content
Parix
Connecting

Gateway

The current Parix gateway contract, routing path, and operator-visible behavior.

The gateway is the bridge between Parix routing and native TigerBeetle client operations.

Responsibilities

tb-gateway currently handles:

  • provider-routed HTTP requests from Cloudflare-side services
  • request validation and signed-header checks
  • target resolution for TigerBeetle cluster access
  • translation from HTTP operations into TigerBeetle client calls

Private routing path

The request path is:

  1. Cloudflare-side caller sends the request.
  2. app-dispatcher resolves the target provider route.
  3. Workers VPC bindings send traffic through tb-tunnel.
  4. tb-tunnel routes private HTTP traffic to tb-gateway.
  5. tb-gateway performs the TigerBeetle operation.

Current modes

The gateway supports two write modes:

  • stub: validates the request and returns a structured non-persistent success response
  • live: performs real TigerBeetle writes through the Node client module

Current endpoint families

The repository currently documents these gateway endpoints:

  • GET /health
  • POST /v1/ping
  • POST /v1/tenants/:databaseId/accounts
  • POST /v1/tenants/:databaseId/transfers
  • signed internal GET|POST|DELETE /internal/gcp/* routes for narrow provider operations

The internal GCP routes are operator infrastructure, not a general public API surface.

For header and endpoint details, see API reference.

Quickstart

Current connect-flow steps from client install to basic connection verification.

Cluster configurations

Cluster topology, instance sizing, and how Parix applies shape changes through workflows.

On this page

Responsibilities
Private routing path
Current modes
Current endpoint families