Namespace Snapshots

Create Namespace Snapshot

Changed on

Create a point-in-time snapshot of the entire namespace. Captures all MongoDB documents and an S3 object manifest. Optionally copies S3 objects to the snapshot prefix for full data preservation (required if you plan to delete the namespace and restore later). With import_from, imports a snapshot taken on another plane instead: its artifacts are copied from an allowed backup bucket, each checked against its recorded sha256, and the snapshot is completed only if verify finds it restorable.

post/v1/namespaces/{namespace_identifier}/snapshots

Request

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

Path parameters

namespace_identifierstring required

Namespace name or ID

Request body

copy_s3_objectsboolean

If true, S3 objects are copied to the snapshot prefix (slower, uses more storage). Required for restoring after namespace deletion.

include_vectorsboolean

If false, creates a metadata-only snapshot: the namespace's records without its vector points. Restoring it writes no vectors, so it is not a backup of the namespace's data.

Response

Successful Response

task_idstring required
snapshot_idstring required
messagestring required

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

  • 8d925c1cf55fRevision changes
    • info

      added the new optional request property