Overview

Parix is a managed TigerBeetle platform. The implementation exposes a Cloudflare-hosted control plane, provider-hosted TigerBeetle data planes, and a dashboard that drives provisioning, connection, observability, backups, and configuration workflows.

This is the onboarding tutorial. By the end of this path, you should have a ready database, an API key, and a verified read operation.

First path through the product

Use this sequence when onboarding a new developer:

1. Open the organization dashboard, for example /acme2.
2. Create a database from /new, or import existing TigerBeetle replica files from /new?mode=import.
3. Wait for the database profile to become READY.
4. Generate an API key from /settings/api-keys/generate.
5. Open the database Connect page and run the read-only verification command.
6. Use Query, Metrics, Logs, Backups, Cluster, Webhooks, and Settings from the database navigation as needed.

The live dashboard currently shows organization-level navigation for Databases, Settings, Documentation, Policy, and Terms. Database-level navigation includes Dashboard, Query, Logs, Metrics, Cluster, Backups, Webhooks, and Settings.

Core identifiers

The dashboard route uses the database name:

/{organizationSlug}/databases/{databaseName}

The API uses the database ID:

/api/v1/databases/{databaseId}

The database dashboard shows both the database ID and the TigerBeetle cluster ID. Use the database ID for Parix API calls. Use the cluster ID when you are reasoning about TigerBeetle replica files or import metadata.

What ready means

A ready database profile has completed provisioning and can serve operations through the gateway. The dashboard shows gateway state, TigerBeetle version, node count, CPU, memory, storage, provider, region, estimated monthly price, database ID, and cluster ID.

Where to go next

• Create a new empty database in Create a database.
• Bring existing TigerBeetle files into Parix in Import a database.
• Generate credentials in API keys.
• Connect from code in Connecting.