Listar snapshots do banco de dados

GET

databases

{database_id}

snapshots

Listar snapshots do banco de dados

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

obrigatório

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

Requer uma chave de API com o escopo snapshots:read. 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 dashboard, ou para verificar, após uma chamada de Criar Snapshot que retornou 202 SNAPSHOT_PROCESSING, se o arquivo já está disponível. Cada item traz uma url de download assinada, válida por 30 dias, e um version_id para passar como versionId ao restaurar. 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

string

obrigatório

O ID do banco de dados.

Resposta

string

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

array

O conteúdo da resposta.

Mostrar Alternar objeto

string

O nome do snapshot: o ID do banco de dados com o sufixo _<type> e, em snapshots mais novos, _<origin>. Envie-o sem alterações como snapshotId ao restaurar.

number

Tamanho do backup em bytes.

string

Data da última modificação do backup.

string

A query string assinada da URL de download.

string

A versão do snapshot. Passe-a como versionId ao restaurar.

string

Uma URL assinada que baixa o snapshot, válida por 30 dias.

string | null

Runtime de onde o snapshot foi tirado: a linguagem da aplicação (javascript, python, rust…) ou o motor do banco de dados (mongo, mysql, postgres, redis). null em snapshots tirados antes de este campo existir.

string | null

Como o snapshot foi criado: manual (pedido pela API, dashboard ou CLI) ou automatic (o snapshot diário agendado). null em snapshots mais antigos.

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

Baixe um snapshot pela sua url. O link continua válido por 30 dias.

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.

Relacionados

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

Listar snapshots do banco de dados

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

Primeiros passos

Conta

Aplicações

Bancos de dados

Workspaces

IA

Listar snapshots do banco de dados

Parâmetros

Resposta

Erros comuns

Relacionados

​Parâmetros

​Resposta

​Erros comuns

​Relacionados

Parâmetros

Resposta

Erros comuns

Relacionados