Namespace Snapshots

Get Snapshot

Changed on

Get details of a specific snapshot. With download=true the response also carries a signed URL and the sha256 for every artifact (configuration, Mongo dumps, vector export, object manifest), valid for one hour, so you can download the namespace.

get/v1/namespaces/{namespace_identifier}/snapshots/{snapshot_id}

Request

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

Path parameters

namespace_identifierstring required

Namespace name or ID

snapshot_idstring required

Snapshot ID (e.g. snap_xxxxxxxxxxxx)

Query parameters

downloadboolean

Return signed download URLs and sha256 digests for every artifact. Only a completed snapshot can be downloaded.

Response

Successful Response

snapshot_idstring
namespace_idstring required
namespace_namestring required
internal_idstring required
snapshot_type'daily' | 'pre_delete' | 'manual' required
status'pending' | 'in_progress' | 'completed' | 'partial' | 'failed' | 'expired'
created_atstring date-time nullable
dispatch_atstring date-time nullable

When the snapshot's work was due to start (created_at plus any dispatch stagger)

completed_atstring date-time nullable
expires_atstring date-time nullable
schema_versioninteger
s3_prefixstring
s3_objects_copiedboolean
errorstring nullable
task_idstring nullable
include_vectorsboolean

False for a metadata-only snapshot, which holds the namespace's records but no vector points; restoring it writes no vectors.

vector_shard_keystring nullable
imported_fromobject nullable

For an imported snapshot, the bucket and prefix it was copied from and the source snapshot's id

Changes

  • 927e674bf5dfRevision changes
    • warning

      added the new partial enum value to the response property for the response status

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status