Lister les snapshots d'une base de données

GET

databases

{database_id}

snapshots

Lister les snapshots d'une base de données

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))

}

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"
    }
  ]
}

string

requis

La clé d’API de votre compte. Vous pouvez la trouver dans les paramètres de votre compte.

Nécessite une clé API avec le scope snapshots:read. Liste tous les snapshots stockés pour une base de données, du plus récent au plus ancien, avec la taille et la date de dernière modification de chacun. Utilisez-la pour construire un sélecteur de restauration dans un tableau de bord, ou pour effectuer un polling après qu’un appel à Créer un snapshot a renvoyé 202 SNAPSHOT_PROCESSING, afin de confirmer que le fichier est bien arrivé. Chaque élément porte une url de téléchargement signée, valable 30 jours, et un version_id à transmettre comme versionId lors de la restauration. Les réponses sont mises en cache pendant 30 minutes par utilisateur et par base de données, un snapshot qui vient tout juste d’être généré peut donc mettre un court instant à apparaître ici. Pour restaurer l’un de ces snapshots, consultez Restaurer un snapshot.

Paramètres

string

requis

L’ID de la base de données.

Réponse

string

Indique si l’appel a réussi : success si c’est le cas, error sinon.

array

Le contenu de la réponse.

Afficher Afficher l'objet

string

Le nom du snapshot : l’ID de la base de données suffixé par _<type> et, pour les snapshots récents, _<origin>. Transmettez-le tel quel comme snapshotId lors de la restauration.

number

Taille de la sauvegarde en octets.

string

Date de la dernière modification de la sauvegarde.

string

La chaîne de requête signée de l’URL de téléchargement.

string

La version du snapshot. Transmettez-la comme versionId lors de la restauration.

string

Une URL signée qui télécharge le snapshot, valable 30 jours.

string | null

Runtime dont provient le snapshot : le langage de l’application (javascript, python, rust…) ou le moteur de la base de données (mongo, mysql, postgres, redis). null pour les snapshots pris avant l’existence de ce champ.

string | null

Comment le snapshot a été créé : manual (demandé via l’API, le dashboard ou la CLI) ou automatic (le snapshot quotidien planifié). null pour les snapshots plus anciens.

{
  "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"
    }
  ]
}

Téléchargez un snapshot depuis son url. Le lien reste valable 30 jours.

Erreurs courantes

Code	HTTP	Signification
`DATABASE_NOT_FOUND`	404	La base de données n’existe pas ou n’appartient pas à l’appelant.

Voir aussi

CLI : squarecloud db snapshot list
SDK : api.databases.snapshots.list() (JavaScript), client.databases.snapshots.list() (Python), c.Databases.Snapshots.List() (Go)

Lister les snapshots d'une base de données

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))

}

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"
    }
  ]
}

Premiers pas

Compte

Applications

Bases de données

Workspaces

IA

Lister les snapshots d'une base de données

Paramètres

Réponse

Erreurs courantes

Voir aussi

​Paramètres

​Réponse

​Erreurs courantes

​Voir aussi

Paramètres

Réponse

Erreurs courantes

Voir aussi