Skip to main content
POST
Restore From 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 to restore from

Body

application/json
target_namespace_name
string | null

Name for the restored namespace. If omitted, restores in-place (deletes current data and replaces with snapshot data).

Response

Successful Response

task_id
string
required
snapshot_id
string
required
target_namespace_id
string
required
message
string
required