---
title: "Restore From Snapshot"
method: POST
path: "/v1/namespaces/{namespace_identifier}/snapshots/{snapshot_id}/restore"
tags: ["Namespace Snapshots"]
---

# Restore From Snapshot

`POST /v1/namespaces/{namespace_identifier}/snapshots/{snapshot_id}/restore`

## Request

- Base URL: `https://api.mixpeek.com`
- URL: `https://api.mixpeek.com/v1/namespaces/{namespace_identifier}/snapshots/{snapshot_id}/restore`
- Auth: HTTP bearer

Restore a namespace from a snapshot. If target_namespace_name is provided, creates a new namespace with the restored data. Otherwise, restores in-place (replaces current namespace data).

## Path parameters

- `namespace_identifier` string, required: Namespace name or ID
- `snapshot_id` string, required: Snapshot ID to restore from

## Request body

- RestoreSnapshotRequest
  - `target_namespace_name` string, nullable: Name for the restored namespace. If omitted, restores in-place (deletes current data and replaces with snapshot data), which requires confirm_in_place.
  - `confirm_in_place` boolean: Required to restore in place (no target_namespace_name): the namespace's current data is deleted and replaced by the snapshot's. While the restore runs the namespace is read-only; writes are refused with a 409 to retry after it completes.
  - `restore_point` union: Restore the namespace as it was at this point: an RFC 3339 instant (e.g. 2026-10-01T18:00:00Z) or a vector-store WAL seq. Requires target_namespace_name. The snapshot supplies the configuration (collections, retrievers, buckets) and must have been taken at or before the point; the vectors and payloads are the shard's state at the point, replayed from its retained WAL. A restore can reach any point from the vector store's most recent checkpoint up to its newest durable write. A point outside that range is refused, and the error names the oldest and newest instants you can restore to now. Omit to restore the snapshot as taken.
    - string
    - integer
  - `isolated` boolean: Restore beside the source onto a temporary vector shard of its own instead of the plane's shared one. Requires target_namespace_name. The copy is for checking or measuring a restore: its shard stops after six hours, and deleting the copy's namespace stops it sooner. One isolated copy runs at a time; a second request while one is up is refused naming the namespace that holds it.

## Response `200`

Successful Response

- RestoreSnapshotResponse
  - `task_id` string, required
  - `snapshot_id` string, required
  - `target_namespace_id` string, required
  - `message` string, required
  - `restore_point` string, nullable: The restore_point requested, normalized
  - `fork_id` string, nullable: Identifies the point-in-time replica this restore reads from; the task's restore_report carries the same id
  - `resolved_seq` integer, nullable: The WAL seq the restore targets. Known here when restore_point is a seq; for an instant the shard resolves it during the restore, and the task's restore_report records it.
  - `isolated` boolean: True when the copy goes onto a temporary shard of its own; the task creates the namespace once that shard is up

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `422`: Unprocessable Entity
- `429`: Too Many Requests
- `500`: Internal Server Error
- `503`: Service Unavailable

## Changes

- **2026-10-09** `61a175e8eb9a`: 1 warning, 5 info
  - removed the optional property `detail` from the response with the `422` status
  - added the non-success response with the status `429`
  - added the non-success response with the status `503`
  - added the optional property `success` to the response with the `422` status
  - …2 more
- **2026-10-04** `38e0822db900`: 7 info
  - added the new optional request property `confirm_in_place`
  - added the new optional request property `isolated`
  - added the new optional request property `restore_point`
  - added the optional property `fork_id` to the response with the `200` status
  - …3 more
- **2026-08-09** `5d4c905106b4`: 1 info
  - the endpoint scheme security `BearerAuth` was added to the API

[Operation history](https://skmtc.dev/mixpeek/apis/mixpeek-api/changes/v1/namespaces/:namespace_identifier/snapshots/:snapshot_id/restore/post.md)

---

[API](https://skmtc.dev/mixpeek/apis/mixpeek-api.md) - [All operations](https://skmtc.dev/mixpeek/apis/mixpeek-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mixpeek/apis/mixpeek-api/revisions/790bc16455f6?raw)