Skip to main content
GET
Verify Snapshot Restore-Readiness

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 header returns 403; an invalid or revoked key returns 401.

Path Parameters

namespace_identifier
string
required

Namespace name or ID

snapshot_id
string
required

Snapshot ID to verify (e.g. snap_xxxxxxxxxxxx)

Query Parameters

deep
boolean
default:false

Also decompress each collection dump to detect truncated artifacts

Response

Successful Response

Result of a read-only pre-flight check that a snapshot can be restored.

Restore itself is LENIENT — a missing collection dump is caught and logged as a warning, so restore reports success while SILENTLY dropping data. This check surfaces exactly what restore would skip BEFORE you depend on it in a recovery, by re-validating the snapshot's object-store artifacts against the manifest it claims to hold (no materialization).

snapshot_id
string
required
status
string
required
restorable
boolean
required

True iff there are no error-severity issues (a clean restore is possible)

issues
SnapshotVerifyIssue · object[]
collections_verified
integer
default:0

Count of expected (non-empty) collection dumps found present

vector_source
string | null

Where vectors would restore from: 'self', the shard-representative prefix (coalesced), 'none', or null if unresolved

vector_capture
string
default:could_not_measure

Deep-verify per-point vector NON-emptiness verdict. 'measured_ok': captured points carry non-empty vectors. 'measured_degraded': a significant fraction carry EMPTY vectors — the Raw-absence signature (a raw-less point scrolls back with vectors=[] yet counts as captured), so a restore would be searchable-degraded even though the point-count guard passed. 'could_not_measure': not deep-verified, metadata-only, or unreadable. Three-valued by design — could_not_measure must never render as ok (a boolean would collapse incapacity into the healthy value).