Sign in

v1

latestSwagger 2.02026-07-172964242.9 KB
Database

Create database

Creates a new database in the cluster.

post/v1/databases

Request body

idstring

Unique identifier for the database.

tenant_idstring

Unique identifier for the database's owner.

Example request

{
  "id": "storefront",
  "spec": {
    "database_name": "storefront",
    "database_users": [
      {
        "attributes": [
          "LOGIN",
          "SUPERUSER"
        ],
        "db_owner": true,
        "password": "password",
        "username": "admin"
      }
    ],
    "nodes": [
      {
        "host_ids": [
          "us-east-1"
        ],
        "name": "n1"
      },
      {
        "host_ids": [
          "ap-south-1"
        ],
        "name": "n2"
      },
      {
        "host_ids": [
          "eu-central-1"
        ],
        "name": "n3"
      }
    ],
    "port": 5432,
    "postgresql_conf": {
      "max_connections": 5000
    }
  }
}

Response

OK response.

Example response

{
  "database": {
    "created_at": "2025-06-18T16:52:05Z",
    "id": "storefront",
    "spec": {
      "database_name": "storefront",
      "database_users": [
        {
          "attributes": [
            "SUPERUSER",
            "LOGIN"
          ],
          "db_owner": true,
          "username": "admin"
        }
      ],
      "nodes": [
        {
          "host_ids": [
            "us-east-1"
          ],
          "name": "n1"
        },
        {
          "host_ids": [
            "ap-south-1"
          ],
          "name": "n2"
        },
        {
          "host_ids": [
            "eu-central-1"
          ],
          "name": "n3"
        }
      ],
      "port": 5432,
      "postgres_version": "17.6",
      "spock_version": "5"
    },
    "state": "creating",
    "updated_at": "2025-06-18T16:52:05Z"
  },
  "task": {
    "created_at": "2025-06-18T16:52:05Z",
    "database_id": "storefront",
    "status": "pending",
    "task_id": "019783f4-75f4-71e7-85a3-c9b96b345d77",
    "type": "create"
  }
}