MAmachines
Postgres Clusters

Restore Backup or Point in Time to New Cluster

Changed on

Restore a backup, or a point in time within the cluster's PITR recovery window, into a new Managed Postgres cluster. The source cluster is left unchanged, and a new cluster is provisioned asynchronously.

post/v1/postgres/{postgres_cluster_id}/restore

Request

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

Path parameters

postgres_cluster_idstring required

Managed Postgres Cluster ID

Request body

backup_idstring

Backup label to restore from, as returned by the backups list. Mutually exclusive with pitr_time.

namestring

Name for the restored cluster. Defaults to a generated name derived from the source cluster and backup/point in time when omitted or blank.

pitr_timestring

Point in time to restore to, as an RFC3339 timestamp with an explicit offset from UTC (e.g. Z or +02:00). Normalized to UTC and must fall within the cluster's PITR recovery window. Mutually exclusive with backup_id.

Response

New cluster provisioned from the backup or point in time

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

  • 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

  • 4a82f51548c8Revision changes
    • info

      the endpoint scheme security FlyBearerAuth was removed from the API