データベースのスナップショット一覧
GET /v2/databases//snapshots でデータベースのスナップショットを新しい順に一覧表示します。サイズ、日付、ダウンロード URL、復元に使う ID が含まれます。
GET
/
v2
/
databases
/
{database_id}
/
snapshots
データベースのスナップショット一覧
curl --request GET \
--url https://api.squarecloud.app/v2/databases/{database_id}/snapshots \
--header 'Authorization: <authorization>'import requests
url = "https://api.squarecloud.app/v2/databases/{database_id}/snapshots"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.squarecloud.app/v2/databases/{database_id}/snapshots', 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.squarecloud.app/v2/databases/{database_id}/snapshots",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$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 := "https://api.squarecloud.app/v2/databases/{database_id}/snapshots"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.squarecloud.app/v2/databases/{database_id}/snapshots")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.squarecloud.app/v2/databases/{database_id}/snapshots")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"status":"success",
"response":[
{
"name":"a14b8d5e1cb7405a851eb4c075506121_mongo_manual",
"size":10644463,
"modified":"2025-08-13T13:29:11.263Z",
"key":"AWSAccessKeyId=accesskey&Expires=1757683751&Signature=VZ03MSxcNw3%2FtPezXv0IhTs0jq4%3D&versionId=45ec0b49-9af6-445e-a55c-abd7ec5278b2",
"version_id":"45ec0b49-9af6-445e-a55c-abd7ec5278b2",
"url":"https://snapshots.squarecloud.app/databases/<account_id>/<name>.zip?<signed-query-string>",
"runtime":"mongo",
"origin":"manual"
},
{
"name":"a14b8d5e1cb7405a851eb4c075506121_mongo_automatic",
"size":2742383,
"modified":"2025-08-13T00:01:47.010Z",
"key":"AWSAccessKeyId=accesskey&Expires=1757683751&Signature=7zw5apjyaOd1xPZl3gRgp8Y4yEs%3D&versionId=f65e1378-8717-45c5-8aec-bb233eedb5ce",
"version_id":"f65e1378-8717-45c5-8aec-bb233eedb5ce",
"url":"https://snapshots.squarecloud.app/databases/<account_id>/<name>.zip?<signed-query-string>",
"runtime":"mongo",
"origin":"automatic"
}
]
}
snapshots:read スコープを持つ API キーが必要です。
データベースに保存されているすべてのスナップショットを、最新のものから順に、それぞれのサイズと最終更新日とともに一覧表示します。ダッシュボードで復元用のピッカーを構築したり、スナップショットの作成の呼び出しが 202 SNAPSHOT_PROCESSING を返した後にポーリングしてファイルが生成済みかどうかを確認したりする際に利用してください。
各項目には、30 日間有効な署名付きのダウンロード url と、復元時に versionId として渡す version_id が含まれます。レスポンスはユーザーとデータベースごとに 30 分間キャッシュされるため、生成が完了したばかりのスナップショットはここに表示されるまで少し時間がかかることがあります。これらのスナップショットを復元するには、スナップショットの復元を参照してください。
パラメーター
string
必須
データベースのID。
レスポンス
string
呼び出しが成功したかどうかを示します。成功した場合は
success、失敗した場合は error です。array
レスポンスの内容。
表示 オブジェクトを切り替え
表示 オブジェクトを切り替え
string
スナップショットの名前。データベースIDに
_<type>、新しいスナップショットではさらに _<origin> のサフィックスが付きます。復元時にはこの値をそのまま snapshotId として渡してください。number
バックアップのサイズ(バイト単位)。
string
バックアップの最終更新日時。
string
ダウンロード URL の署名付きクエリ文字列。
string
スナップショットのバージョン。復元時に
versionId として渡します。string
スナップショットをダウンロードする署名付き URL。30 日間有効です。
string | null
スナップショットの取得元のランタイム。アプリケーションの言語(
javascript、python、rust など)またはデータベースエンジン(mongo、mysql、postgres、redis)。このフィールドが存在する前に取得されたスナップショットでは null です。string | null
スナップショットの作成方法。
manual(API、ダッシュボード、CLI から要求)または automatic(毎日のスケジュール実行)。古いスナップショットでは null です。{
"status":"success",
"response":[
{
"name":"a14b8d5e1cb7405a851eb4c075506121_mongo_manual",
"size":10644463,
"modified":"2025-08-13T13:29:11.263Z",
"key":"AWSAccessKeyId=accesskey&Expires=1757683751&Signature=VZ03MSxcNw3%2FtPezXv0IhTs0jq4%3D&versionId=45ec0b49-9af6-445e-a55c-abd7ec5278b2",
"version_id":"45ec0b49-9af6-445e-a55c-abd7ec5278b2",
"url":"https://snapshots.squarecloud.app/databases/<account_id>/<name>.zip?<signed-query-string>",
"runtime":"mongo",
"origin":"manual"
},
{
"name":"a14b8d5e1cb7405a851eb4c075506121_mongo_automatic",
"size":2742383,
"modified":"2025-08-13T00:01:47.010Z",
"key":"AWSAccessKeyId=accesskey&Expires=1757683751&Signature=7zw5apjyaOd1xPZl3gRgp8Y4yEs%3D&versionId=f65e1378-8717-45c5-8aec-bb233eedb5ce",
"version_id":"f65e1378-8717-45c5-8aec-bb233eedb5ce",
"url":"https://snapshots.squarecloud.app/databases/<account_id>/<name>.zip?<signed-query-string>",
"runtime":"mongo",
"origin":"automatic"
}
]
}
スナップショットはその
url からダウンロードします。リンクは 30 日間有効です。一般的なエラー
| コード | HTTP | 説明 |
|---|---|---|
DATABASE_NOT_FOUND | 404 | データベースが存在しないか、呼び出し元が所有していません。 |
関連項目
- CLI:
squarecloud db snapshot list - SDK:
api.databases.snapshots.list()(JavaScript),client.databases.snapshots.list()(Python),c.Databases.Snapshots.List()(Go)
⌘I
データベースのスナップショット一覧
curl --request GET \
--url https://api.squarecloud.app/v2/databases/{database_id}/snapshots \
--header 'Authorization: <authorization>'import requests
url = "https://api.squarecloud.app/v2/databases/{database_id}/snapshots"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.squarecloud.app/v2/databases/{database_id}/snapshots', 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.squarecloud.app/v2/databases/{database_id}/snapshots",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$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 := "https://api.squarecloud.app/v2/databases/{database_id}/snapshots"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.squarecloud.app/v2/databases/{database_id}/snapshots")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.squarecloud.app/v2/databases/{database_id}/snapshots")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"status":"success",
"response":[
{
"name":"a14b8d5e1cb7405a851eb4c075506121_mongo_manual",
"size":10644463,
"modified":"2025-08-13T13:29:11.263Z",
"key":"AWSAccessKeyId=accesskey&Expires=1757683751&Signature=VZ03MSxcNw3%2FtPezXv0IhTs0jq4%3D&versionId=45ec0b49-9af6-445e-a55c-abd7ec5278b2",
"version_id":"45ec0b49-9af6-445e-a55c-abd7ec5278b2",
"url":"https://snapshots.squarecloud.app/databases/<account_id>/<name>.zip?<signed-query-string>",
"runtime":"mongo",
"origin":"manual"
},
{
"name":"a14b8d5e1cb7405a851eb4c075506121_mongo_automatic",
"size":2742383,
"modified":"2025-08-13T00:01:47.010Z",
"key":"AWSAccessKeyId=accesskey&Expires=1757683751&Signature=7zw5apjyaOd1xPZl3gRgp8Y4yEs%3D&versionId=f65e1378-8717-45c5-8aec-bb233eedb5ce",
"version_id":"f65e1378-8717-45c5-8aec-bb233eedb5ce",
"url":"https://snapshots.squarecloud.app/databases/<account_id>/<name>.zip?<signed-query-string>",
"runtime":"mongo",
"origin":"automatic"
}
]
}

