Sign in
Namespace Snapshots

Create Namespace Snapshot

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).

post/v1/namespaces/{namespace_identifier}/snapshots

Path parameters

namespace_identifierstring required

Namespace name or ID

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 (no vector export). Advanced — on restore the vectors are stitched from the shard representative's export (see). Daily sweeps use this to coalesce the full-dataset vector export to one per physical shard.

Response

Successful Response

task_idstring required
snapshot_idstring required
messagestring required

Changes

Changed in 1 of the 33 revisions of this API.1