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 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 (e.g. snap_xxxxxxxxxxxx)

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
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 metadata-only daily snapshots whose vectors are covered by the shard representative's export.

vector_shard_key
string | null
last_restore
RestoreReport · object | null

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