Listar snapshots - Square Cloud

GET

databases

{database_id}

snapshots

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

Authorization

string

obrigatório

A chave da API para sua conta. Você pode encontrá-la nas configurações da conta.

Lista todos os snapshots armazenados para um banco de dados, do mais recente para o mais antigo, com tamanho e data da última modificação de cada um. Use isso para montar um seletor de restauração em um painel, ou para verificar, após uma chamada de Criar Snapshot que retornou 202 SNAPSHOT_PROCESSING, se o arquivo já está disponível. O campo key de cada item é uma query string assinada; anexe-a à URL de download descrita na nota abaixo para baixar aquele snapshot diretamente. As respostas ficam em cache por 30 minutos por usuário e banco de dados, então um snapshot que acabou de ser gerado pode levar um tempo para aparecer aqui. Para restaurar um desses snapshots, veja Restaurar Snapshot.

Parâmetros

database_id

string

obrigatório

O ID do banco de dados.

Resposta

status

string

Indica se a chamada foi bem-sucedida. success se bem-sucedida, error se não.

response

array

O conteúdo da resposta.

Mostrar Alternar objeto

name

string

O id do seu banco de dados hospedado na Square Cloud.

size

number

Tamanho do backup em bytes.

modified

string

Data da última modificação do backup.

key

string

Chave de acesso AWS para o backup.

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

O formato da URL para baixar o snapshot desejado é: https://snapshots.squarecloud.app/databases/{accountID}/{name}.zip?{key}

Erros comuns

Código	HTTP	Significado
`DATABASE_NOT_FOUND`	404	O banco de dados não existe ou não pertence a quem fez a chamada.

Criar snapshotRealizar um snapshot de seu banco de dados. Possui limite de taxa de 1 requisição a cada 5 segundos.

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

​Parâmetros

​Resposta

​Erros comuns

Parâmetros

Resposta

Erros comuns