Sign in

v1

latestOpenAPI 3.0.32026-07-17485661.9 KB

Create a database

Creates a new database in a space.

post/spaces/{space_id}/databases

Path parameters

space_idstring required

Ghost space ID.

Request body

namestring

Name for the new database. Auto-generated if omitted.

type'standard' | 'dedicated'

Database deployment model.

  • standard — shared-resource databases subject to the space's compute and storage limits.
  • dedicated — per-instance paid databases with guaranteed resources, exempt from space-level auto-pause.
size'1x' | '2x' | '4x' | '8x'

Compute size for dedicated databases. Each step up allocates proportionally more vCPU and RAM.

share_tokenstring

Share token from a database share (begins with gs_). When provided, creates the new database from the shared snapshot.

Response

Database created

idstring required

Database ID.

namestring required

Database name. Unique within the space.

type'standard' | 'dedicated' required

Database deployment model.

  • standard — shared-resource databases subject to the space's compute and storage limits.
  • dedicated — per-instance paid databases with guaranteed resources, exempt from space-level auto-pause.
size'1x' | '2x' | '4x' | '8x'

Compute size for dedicated databases. Each step up allocates proportionally more vCPU and RAM.

status'queued' | 'configuring' | 'running' | 'pausing' | 'paused' | 'resuming' | 'deleting' | 'deleted' | 'upgrading' | 'unstable' | 'unknown' required

Current lifecycle status of the database.

hoststring required

PostgreSQL hostname for connections.

portinteger required

PostgreSQL port for connections.

passwordstring nullable

PostgreSQL password for the default user. Returned on every GET for authorized callers.

storage_mibinteger nullable

Current disk usage in MiB. Null if not yet available.