Namespace Snapshots

Restore From Snapshot

Changed on

Restore a namespace from a snapshot. If target_namespace_name is provided, creates a new namespace with the restored data. Otherwise, restores in-place (replaces current namespace data).

post/v1/namespaces/{namespace_identifier}/snapshots/{snapshot_id}/restore

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/namespaces/{namespace_identifier}/snapshots/{snapshot_id}/restore
  • Auth: HTTP bearer

Path parameters

namespace_identifierstring required

Namespace name or ID

snapshot_idstring required

Snapshot ID to restore from

Request body

target_namespace_namestring nullable

Name for the restored namespace. If omitted, restores in-place (deletes current data and replaces with snapshot data), which requires confirm_in_place.

confirm_in_placeboolean

Required to restore in place (no target_namespace_name): the namespace's current data is deleted and replaced by the snapshot's. While the restore runs the namespace is read-only; writes are refused with a 409 to retry after it completes.

isolatedboolean

Restore beside the source onto a temporary vector shard of its own instead of the plane's shared one. Requires target_namespace_name. The copy is for checking or measuring a restore: its shard stops after six hours, and deleting the copy's namespace stops it sooner. One isolated copy runs at a time; a second request while one is up is refused naming the namespace that holds it.

Response

Successful Response

task_idstring required
snapshot_idstring required
target_namespace_idstring required
messagestring required
restore_pointstring nullable

The restore_point requested, normalized

fork_idstring nullable

Identifies the point-in-time replica this restore reads from; the task's restore_report carries the same id

resolved_seqinteger nullable

The WAL seq the restore targets. Known here when restore_point is a seq; for an instant the shard resolves it during the restore, and the task's restore_report records it.

isolatedboolean

True when the copy goes onto a temporary shard of its own; the task creates the namespace once that shard is up

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 38e0822db900Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • 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