Sign in

Fork a database

Forks an existing database.

post/spaces/{space_id}/databases/{database_ref}/fork

Path parameters

space_idstring required

Ghost space ID.

database_refstring required

Database ID or name.

Request body

namestring

Name for the forked database. Auto-generated from the source name 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.

Response

Database forked

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.

Changes