List Namespace Snapshots
curl --request POST \
--url https://api.mixpeek.com/v1/namespaces/{namespace_identifier}/snapshots/list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"skip": 0,
"limit": 20
}
'import requests
url = "https://api.mixpeek.com/v1/namespaces/{namespace_identifier}/snapshots/list"
payload = {
"skip": 0,
"limit": 20
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({skip: 0, limit: 20})
};
fetch('https://api.mixpeek.com/v1/namespaces/{namespace_identifier}/snapshots/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mixpeek.com/v1/namespaces/{namespace_identifier}/snapshots/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'skip' => 0,
'limit' => 20
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.mixpeek.com/v1/namespaces/{namespace_identifier}/snapshots/list"
payload := strings.NewReader("{\n \"skip\": 0,\n \"limit\": 20\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.mixpeek.com/v1/namespaces/{namespace_identifier}/snapshots/list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"skip\": 0,\n \"limit\": 20\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/namespaces/{namespace_identifier}/snapshots/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"skip\": 0,\n \"limit\": 20\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"namespace_id": "<string>",
"namespace_name": "<string>",
"internal_id": "<string>",
"snapshot_type": "daily",
"snapshot_id": "<string>",
"status": "pending",
"created_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"schema_version": 1,
"s3_prefix": "",
"s3_objects_copied": false,
"manifest": {
"snapshot_id": "<string>",
"namespace_id": "<string>",
"namespace_name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"snapshot_type": "<string>",
"schema_version": 1,
"mongo_collections": {},
"vector_point_count": 0,
"s3_object_count": 0,
"s3_total_bytes": 0,
"s3_objects_copied": false,
"include_vectors": true,
"vector_shard_key": "<string>"
},
"error": "<string>",
"task_id": "<string>",
"include_vectors": true,
"vector_shard_key": "<string>",
"last_restore": {
"snapshot_id": "<string>",
"target_namespace_id": "<string>",
"complete": true,
"collections": [
{
"collection": "<string>",
"expected": 123,
"restored": 123,
"status": "<string>",
"reason": "<string>"
}
],
"vector_expected": 0,
"vector_restored": 0,
"vector_source": "<string>",
"vector_status": "none",
"skipped_summary": [
"<string>"
]
}
}
],
"total_count": 123
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}Snapshots
List Namespace Snapshots
List all snapshots for a namespace, newest first.
POST
/
v1
/
namespaces
/
{namespace_identifier}
/
snapshots
/
list
List Namespace Snapshots
curl --request POST \
--url https://api.mixpeek.com/v1/namespaces/{namespace_identifier}/snapshots/list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"skip": 0,
"limit": 20
}
'import requests
url = "https://api.mixpeek.com/v1/namespaces/{namespace_identifier}/snapshots/list"
payload = {
"skip": 0,
"limit": 20
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({skip: 0, limit: 20})
};
fetch('https://api.mixpeek.com/v1/namespaces/{namespace_identifier}/snapshots/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mixpeek.com/v1/namespaces/{namespace_identifier}/snapshots/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'skip' => 0,
'limit' => 20
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.mixpeek.com/v1/namespaces/{namespace_identifier}/snapshots/list"
payload := strings.NewReader("{\n \"skip\": 0,\n \"limit\": 20\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.mixpeek.com/v1/namespaces/{namespace_identifier}/snapshots/list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"skip\": 0,\n \"limit\": 20\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/namespaces/{namespace_identifier}/snapshots/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"skip\": 0,\n \"limit\": 20\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"namespace_id": "<string>",
"namespace_name": "<string>",
"internal_id": "<string>",
"snapshot_type": "daily",
"snapshot_id": "<string>",
"status": "pending",
"created_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"schema_version": 1,
"s3_prefix": "",
"s3_objects_copied": false,
"manifest": {
"snapshot_id": "<string>",
"namespace_id": "<string>",
"namespace_name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"snapshot_type": "<string>",
"schema_version": 1,
"mongo_collections": {},
"vector_point_count": 0,
"s3_object_count": 0,
"s3_total_bytes": 0,
"s3_objects_copied": false,
"include_vectors": true,
"vector_shard_key": "<string>"
},
"error": "<string>",
"task_id": "<string>",
"include_vectors": true,
"vector_shard_key": "<string>",
"last_restore": {
"snapshot_id": "<string>",
"target_namespace_id": "<string>",
"complete": true,
"collections": [
{
"collection": "<string>",
"expected": 123,
"restored": 123,
"status": "<string>",
"reason": "<string>"
}
],
"vector_expected": 0,
"vector_restored": 0,
"vector_source": "<string>",
"vector_status": "none",
"skipped_summary": [
"<string>"
]
}
}
],
"total_count": 123
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}Authorizations
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 name or ID
Body
application/json
Was this page helpful?

