MAmachines
Postgres Clusters

Fork Cluster to New Cluster

Changed on

Fork a ready Managed Postgres cluster into a new cluster that inherits the source's settings, on the source's plan unless plan is given. The source cluster is left unchanged, and the fork is provisioned asynchronously.

post/v1/postgres/{postgres_cluster_id}/fork

Request

  • Base URL
    https://api.machines.dev
  • URL
    https://api.machines.dev/v1/postgres/{postgres_cluster_id}/fork
  • Auth
    HTTP bearer

Path parameters

postgres_cluster_idstring required

Managed Postgres Cluster ID

Request body

namestring

Name for the forked cluster. Defaults to the source name with a -fork suffix.

plan'basic' | 'starter' | 'launch' | 'scale' | 'Performance'

Plan slug selecting CPU and memory sizing for the fork. Defaults to the source cluster's plan. Matched case-insensitively.

Example request

{
  "plan": "launch"
}

Response

New cluster provisioned from the fork

Example response

{
  "data": {
    "cpu_kind": "shared",
    "cpus": 2,
    "disk_size_gb": 10,
    "memory_mb": 1024,
    "pg_major_version": "17",
    "plan": "basic",
    "region": "iad",
    "replicas": 1,
    "status": "ready",
    "storage_provisioned_bytes": 10737418240,
    "storage_used_bytes": 5368709120
  }
}

Changes

  • dd8f43b54b02Revision changes
    • info

      added the new optional request property

  • ab2c6417040dRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status