Get Snapshot

Get details of a specific snapshot. With download=true the response also carries a signed URL and the sha256 for every artifact (configuration, Mongo dumps, vector export, object manifest), valid for one hour, so you can download the namespace.

GET /v1/namespaces/{namespace_identifier}/snapshots/{snapshot_id}

Get Snapshot

cURL

curl --request GET \
  --url https://api.mixpeek.com/v1/namespaces/{namespace_identifier}/snapshots/{snapshot_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "namespace_id": "<string>",
  "namespace_name": "<string>",
  "internal_id": "<string>",
  "snapshot_type": "daily",
  "snapshot_id": "<string>",
  "status": "pending",
  "created_at": "2023-11-07T05:31:56Z",
  "dispatch_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "schema_version": 1,
  "s3_prefix": "",
  "s3_objects_copied": false,
  "manifest": {
    "snapshot_id": "<string>",
    "namespace_id": "<string>",
    "namespace_name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "snapshot_type": "<string>",
    "schema_version": 1,
    "mongo_collections": {},
    "vector_point_count": 0,
    "s3_object_count": 0,
    "s3_total_bytes": 0,
    "s3_objects_copied": false,
    "include_vectors": true,
    "vector_shard_key": "<string>",
    "frontier": {
      "consistency": "bracketed",
      "mongo": {
        "read_concern": "snapshot",
        "cluster_time_start": {
          "t": 123,
          "i": 123
        },
        "cluster_time_end": {
          "t": 123,
          "i": 123
        },
        "error": "<string>"
      },
      "vectors": {
        "capture_mode": "scroll_bracketed",
        "shards_start": {},
        "shards_end": {},
        "error": "<string>"
      },
      "objects": {
        "generation_cutoff": 123,
        "last_modified_cutoff": "<string>",
        "objects_listed": 0
      },
      "config_yaml": "<string>",
      "config_yaml_error": "<string>",
      "digests": {},
      "schema_versions": {},
      "secrets": [
        {
          "name": "<string>",
          "version": "<string>"
        }
      ]
    }
  },
  "error": "<string>",
  "task_id": "<string>",
  "include_vectors": true,
  "vector_shard_key": "<string>",
  "copy_out": {
    "status": "<string>",
    "bucket": "<string>",
    "objects": 0,
    "bytes": 0,
    "mismatched": [
      "<string>"
    ],
    "error": "<string>"
  },
  "imported_from": {},
  "last_restore": {
    "snapshot_id": "<string>",
    "target_namespace_id": "<string>",
    "complete": true,
    "collections": [
      {
        "collection": "<string>",
        "expected": 123,
        "restored": 123,
        "status": "<string>",
        "reason": "<string>"
      }
    ],
    "vector_expected": 0,
    "vector_restored": 0,
    "vector_source": "<string>",
    "vector_status": "none",
    "skipped_summary": [
      "<string>"
    ],
    "retriever_parity": [
      {
        "retriever_name": "<string>",
        "status": "<string>",
        "reason": "<string>",
        "probe_inputs": {},
        "source_top_k": [
          "<string>"
        ],
        "target_top_k": [
          "<string>"
        ],
        "overlap": 123
      }
    ],
    "restore_point": "<string>",
    "resolved_seq": 123,
    "fork_id": "<string>",
    "write_gap": {}
  },
  "download": {
    "expires_at": "2023-11-07T05:31:56Z",
    "artifacts": [
      {
        "path": "<string>",
        "url": "<string>",
        "sha256": "<string>",
        "size": 123
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing, malformed, unknown, revoked, inactive or expired key returns 401; a key without the permission, scope or plan an operation needs returns 403.

Path Parameters

namespace_identifier · string · required

Namespace name or ID

snapshot_id · string · required

Snapshot ID (e.g. snap_xxxxxxxxxxxx)

Query Parameters

download · boolean · default: false

Return signed download URLs and sha256 digests for every artifact. Only a completed snapshot can be downloaded.

Response

200

application/json

Successful Response

namespace_id · string · required

namespace_name · string · required

internal_id · string · required

snapshot_type · enum<string> · required

Available options: daily, pre_delete, manual

snapshot_id · string

status · enum<string> · default: pending

Available options: pending, in_progress, completed, partial, failed, expired

created_at · string<date-time> | null

dispatch_at · string<date-time> | null

When the snapshot's work was due to start (created_at plus any dispatch stagger)

completed_at · string<date-time> | null

expires_at · string<date-time> | null

schema_version · integer · default: 1

s3_prefix · string · default: ""

s3_objects_copied · boolean · default: false

manifest · SnapshotManifest · object | null

Show child attributes

error · string | null

task_id · string | null

include_vectors · boolean · default: true

False for a metadata-only snapshot, which holds the namespace's records but no vector points; restoring it writes no vectors.

vector_shard_key · string | null

copy_out · SnapshotCopyOut · object | null

The copy of this snapshot in the plane's backup bucket

Show child attributes

imported_from · Imported From · object | null

For an imported snapshot, the bucket and prefix it was copied from and the source snapshot's id

last_restore · RestoreReport · object | null

Outcome of the most recent restore FROM this snapshot (what was restored vs skipped); null if never restored.

Show child attributes

download · SnapshotDownload · object | null

Signed URLs for every artifact, with each one's sha256. Present only when the request sets download=true.

Show child attributes