Database

Create a database.

Creates a ScalixNova database in the project on the requested PostgreSQL major version (16 default, 17, or 18). The version is fixed at creation; branches and point-in-time restores keep it.

post/v1/databases

Request

  • Base URL: https://api.scalix.world
  • URL: https://api.scalix.world/v1/databases
  • Auth: HTTP bearer

Request body

namestring required

Display name, unique within the org.

pg_versionstring nullable

PostgreSQL major version: "16" (default), "17", or "18". Accepts a string or number. Fixed for the life of the database — branches and point-in-time restores keep this major. Unsupported values return 400 listing the supported set.

isolationstring nullable

Isolation tier: "shared" (default) or "dedicated" (Firecracker microVM; PostgreSQL 16 only, returns 501 where the tier isn't provisioned).

Example request

{
  "name": "prod",
  "pg_version": "18",
  "isolation": "shared"
}

Response

Database created

idstring required
namestring required
pg_databasestring required
tenant_idstring required
connection_stringstring required

Postgres connection string (replace YOUR_API_KEY with an API key).

statusstring required
isolationstring required
pg_versionstring required

PostgreSQL major version the database was created on.

Example response

{
  "pg_version": "18"
}

Changes

No recorded changes to this operation across all 1 revision of this API.