Skip to main content
GET
Get Snapshot

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

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,
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
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

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.

download
SnapshotDownload · object | null

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