Lister les snapshots - Square Cloud

GET

databases

{database_id}

snapshots

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

}

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",
      "size":10644463,
      "modified":"2025-08-13T13:29:11.263Z",
      "key":"AWSAccessKeyId=accesskey&Expires=1757683751&Signature=VZ03MSxcNw3%2FtPezXv0IhTs0jq4%3D&versionId=45ec0b49-9af6-445e-a55c-abd7ec5278b2"
    },
    {
      "name":"a14b8d5e1cb7405a851eb4c075506121",
      "size":2742383,
      "modified":"2025-08-13T00:01:47.010Z",
      "key":"AWSAccessKeyId=accesskey&Expires=1757683751&Signature=7zw5apjyaOd1xPZl3gRgp8Y4yEs%3D&versionId=f65e1378-8717-45c5-8aec-bb233eedb5ce"
    }
  ]
}

string

requis

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

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é. Le champ key de chaque élément est une chaîne de requête signée ; ajoutez-la à l’URL de téléchargement décrite dans la note ci-dessous pour récupérer directement ce snapshot. 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 en cas de succès, error sinon.

array

Le contenu de la réponse.

Afficher Afficher l'objet

string

L’ID de votre base de données hébergée sur Square Cloud.

number

Taille de la sauvegarde en octets.

string

Date de la dernière modification de la sauvegarde.

string

Clé d’accès AWS pour la sauvegarde.

{
  "status":"success",
  "response":[
    {
      "name":"a14b8d5e1cb7405a851eb4c075506121",
      "size":10644463,
      "modified":"2025-08-13T13:29:11.263Z",
      "key":"AWSAccessKeyId=accesskey&Expires=1757683751&Signature=VZ03MSxcNw3%2FtPezXv0IhTs0jq4%3D&versionId=45ec0b49-9af6-445e-a55c-abd7ec5278b2"
    },
    {
      "name":"a14b8d5e1cb7405a851eb4c075506121",
      "size":2742383,
      "modified":"2025-08-13T00:01:47.010Z",
      "key":"AWSAccessKeyId=accesskey&Expires=1757683751&Signature=7zw5apjyaOd1xPZl3gRgp8Y4yEs%3D&versionId=f65e1378-8717-45c5-8aec-bb233eedb5ce"
    }
  ]
}

Le format de l’URL pour télécharger le snapshot souhaité est : https://snapshots.squarecloud.app/databases/{accountID}/{name}.zip?{key}

Erreurs courantes

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

Créer un snapshotEffectuer un snapshot de votre base de données. Limité à 1 requête toutes les 5 secondes.

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

}

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",
      "size":10644463,
      "modified":"2025-08-13T13:29:11.263Z",
      "key":"AWSAccessKeyId=accesskey&Expires=1757683751&Signature=VZ03MSxcNw3%2FtPezXv0IhTs0jq4%3D&versionId=45ec0b49-9af6-445e-a55c-abd7ec5278b2"
    },
    {
      "name":"a14b8d5e1cb7405a851eb4c075506121",
      "size":2742383,
      "modified":"2025-08-13T00:01:47.010Z",
      "key":"AWSAccessKeyId=accesskey&Expires=1757683751&Signature=7zw5apjyaOd1xPZl3gRgp8Y4yEs%3D&versionId=f65e1378-8717-45c5-8aec-bb233eedb5ce"
    }
  ]
}

​Paramètres

​Réponse

​Erreurs courantes

Paramètres

Réponse

Erreurs courantes