Download one server-local snapshot file
curl --request GET \
--url http://localhost:3000/api/backup/snapshots/{filename} \
--header 'Origin: <api-key>'import requests
url = "http://localhost:3000/api/backup/snapshots/{filename}"
headers = {"Origin": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Origin: '<api-key>'}};
fetch('http://localhost:3000/api/backup/snapshots/{filename}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/backup/snapshots/{filename}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Origin: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/api/backup/snapshots/{filename}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Origin", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/api/backup/snapshots/{filename}")
.header("Origin", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/backup/snapshots/{filename}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Origin"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"version": 1,
"exportedAt": 123,
"apps": [
{
"id": 324684580,
"name": "Spotify - Music and Podcasts",
"url": "https://apps.apple.com/us/app/spotify-music-and-podcasts/id324684580",
"changeCount": 2,
"bundleId": "com.spotify.client",
"developer": "Spotify Ltd.",
"privacyPolicyUrl": "<string>",
"firstSeen": 123
}
]
}{
"error": "Admin token required"
}Backup
Download one server-local snapshot file
GET
/
api
/
backup
/
snapshots
/
{filename}
Download one server-local snapshot file
curl --request GET \
--url http://localhost:3000/api/backup/snapshots/{filename} \
--header 'Origin: <api-key>'import requests
url = "http://localhost:3000/api/backup/snapshots/{filename}"
headers = {"Origin": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Origin: '<api-key>'}};
fetch('http://localhost:3000/api/backup/snapshots/{filename}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/backup/snapshots/{filename}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Origin: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/api/backup/snapshots/{filename}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Origin", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/api/backup/snapshots/{filename}")
.header("Origin", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/backup/snapshots/{filename}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Origin"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"version": 1,
"exportedAt": 123,
"apps": [
{
"id": 324684580,
"name": "Spotify - Music and Podcasts",
"url": "https://apps.apple.com/us/app/spotify-music-and-podcasts/id324684580",
"changeCount": 2,
"bundleId": "com.spotify.client",
"developer": "Spotify Ltd.",
"privacyPolicyUrl": "<string>",
"firstSeen": 123
}
]
}{
"error": "Admin token required"
}Authorizations
sameOriginadminToken
Same-origin CSRF check. The Origin header must match the request host;
enforced for every mutating verb (POST, PUT, PATCH, DELETE).
Path Parameters
Response
JSON bundle.
Versioned export of every app, label, snapshot, annotation, notification, focus state, and feature-flag override. Restorable into any release that understands this bundle format or a later one.
Exported envelopes also carry a signature object (HMAC-SHA256 over
the canonicalised envelope, keyed per install). Restoring a bundle
whose signature doesn't match the target install requires
allowUntrusted — see POST /api/backup/restore.