Create a database
Dashboard and API behavior for creating a new Parix database.
The new-database flow is implemented in the /new route and the POST /api/v1/databases API route. Both paths resolve the requested provider, region, topology, storage tier, storage size, and cluster size from the create catalog before provisioning.
Use this guide when you want Parix to create an empty hosted TigerBeetle database.
Dashboard flow
Open the organization dashboard and choose New database. The current form collects:
- mode:
New DatabaseorImport Database - organization
- database name
- region, such as Google Cloud Iowa
us-central1 - cluster configuration: single node, HA 3 replicas, or HA 6 replicas
- storage type and storage size
- cluster size, such as PX-5 through PX-160
The summary panel shows the selected provider, region, topology, storage, node sizing, and estimated monthly price before the create action runs.
Click Create Database to queue provisioning. The database page becomes useful after the profile reaches READY.
API flow
Create a database with an organization-wide API key:
curl -X POST "https://dev.parix.io/api/v1/databases" \
-H "content-type: application/json" \
-H "x-api-key: $PARIX_API_KEY" \
-d '{
"name": "wallet-demo",
"provider": "gcp",
"region": "us-central1",
"selectedStorageGb": 10
}'If optional catalog fields are omitted, the API resolves current defaults. Use GET /api/v1/catalog/create to inspect provider, region, cluster configuration, cluster size, storage tier, and storage capability choices before creating.
Provisioning behavior
When the request passes validation, Parix:
- checks that the organization can provision databases
- creates the database and active profile records
- enqueues audit and notification events
- starts the provisioning workflow when the selected provider supports it
The response includes database, profile, job, and provisioning data when provisioning is queued. If billing setup is required, the response can include a billing checkout URL instead of starting the workflow.
Common creation failures
- The database name must be unique in the organization.
- The organization must be allowed to provision from the billing guard.
- The requested provider, region, topology, storage, and size must exist in the create catalog.
- A local NVMe option can be unavailable for the selected topology.
Next, generate credentials in API keys or connect from code in Connecting quickstart.