Sign in

Pause a database

Pauses a running database.

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

Path parameters

space_idstring required

Ghost space ID.

database_refstring required

Database ID or name.

Response

Database paused

idstring required

Database ID.

namestring required

Database name. Unique within the space.

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.

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.

storage_mibinteger nullable

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

passwordstring nullable

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

Changes