Skip to main content
PARIXDocs
Getting started

Getting started

Create or import a Parix database, issue an API key, and verify the first gateway request.

Use this guide to take an organization from its database list to a ready Parix database with a verified, authenticated TigerBeetle read. The normal first-run path is entirely available in the dashboard.

Before you begin

You need:

  • a Parix account with a verified email
  • an active organization in which you are a member
  • an organization owner or administrator if Stripe billing or API-key management is required
  • a secure place to store an API-key secret

Choose the database path that matches your source data:

GoalPathAvailability
Start with an empty shared database for learning or integration workNew database > DeveloperOne complimentary Developer database per verified user, for life; later Developer databases require billing and available shared-cell capacity.
Start with an empty isolated databaseNew database > Dedicated or ProductionRequires an organization with usable Stripe billing. The create catalog controls the providers, regions, storage, and sizes currently available.
Move an existing TigerBeetle replica set into ParixNew database > Import databaseRequires usable Stripe billing and one readable .tigerbeetle file for every replica in the selected topology. Import is not a Developer shared-plan workflow.

Developer databases use a shared Parix-operated cell. Dedicated and Production databases use isolated deployments. Every plan is gateway-only: applications never connect directly to TigerBeetle replica addresses.

Complete the first-run workflow

  1. Open the organization database list at /{organizationSlug}.
  2. Open the New database menu.
  3. Choose New database to provision an empty database, or Import database to upload an existing replica set.
  4. Complete the selected workflow:
  5. Open the new database and wait until its dashboard reports Ready. A Dedicated or Production database normally passes through Provisioning first; a Developer placement can become active immediately.
  6. Generate a key at /settings/api-keys/generate. Choose Specific database for an application that needs only this database.
  7. On the database dashboard, select Connect and follow Connect to a database.
  8. Run the read-only query_accounts verification request. An empty result is a successful check for a new database.

The Recent databases page with the New database menu

The organization route lists recent databases and provides both create and import entries. Select the image to open it at full size.

Expected result

At the end of the workflow:

  • the database dashboard reports Ready
  • you have copied an active px_... API key into a secret manager or local environment
  • a request to /api/v1/databases/{databaseId}/tb/query_accounts returns HTTP 200
  • the response identifies the database and includes a responsePayload array, which may be empty

The dashboard URL and API URL use different identifiers:

/{organizationSlug}/databases/{databaseName}
/api/v1/databases/{databaseId}

Copy Database ID from the database dashboard for API calls. Cluster ID identifies the TigerBeetle cluster and is mainly relevant to replica files and import metadata.

Plan-specific dashboard access

SurfaceDeveloper sharedDedicated and Production
Dashboard, Connect, Query, SettingsAvailableAvailable
MetricsProject/request metricsInfrastructure and request metrics
Logs, Cluster, Backups, Webhooks, diagnostics, upgradesNot exposed as self-service surfacesAvailable when the database profile and provider support them

Do not treat a missing shared-plan navigation item as a provisioning failure. Parix intentionally hides surfaces that the Developer plan does not expose.

If you get stuck

Next steps

Compatibility and support boundaries

Check the current Parix access, plan, provider, topology, storage, recovery, and API boundaries.

Create a database

Provision an empty Developer, Dedicated, or Production database from the Parix dashboard.