Listar snapshots de la base de datos

GET

databases

{database_id}

snapshots

Listar snapshots de la base de datos

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

requerido

La clave de API de tu cuenta. Puedes encontrarla en la configuración de tu cuenta.

Requiere una clave de API con el scope snapshots:read. Lista todos los snapshots almacenados de una base de datos, del más reciente al más antiguo, con tamaño y fecha de última modificación de cada uno. Úsalo para construir un selector de restauración en un panel, o para sondear después de que una llamada a Crear Snapshot devuelva 202 SNAPSHOT_PROCESSING y confirmar que el archivo ya está disponible. Cada elemento incluye una url de descarga firmada, válida durante 30 días, y un version_id para enviar como versionId al restaurar. Las respuestas se almacenan en caché durante 30 minutos por usuario y base de datos, por lo que un snapshot recién generado puede tardar un momento en aparecer aquí. Para restaurar uno de estos snapshots, consulta Restaurar Snapshot.

Parámetros

string

requerido

El ID de la base de datos.

Respuesta

string

Indica si la llamada fue exitosa: success si lo fue, error si no.

array

El contenido de la respuesta.

Mostrar Alternar objeto

string

El nombre del snapshot: el ID de la base de datos con el sufijo _<type> y, en snapshots más recientes, _<origin>. Envíalo sin cambios como snapshotId al restaurar.

number

Tamaño del backup en bytes.

string

Fecha de la última modificación del backup.

string

La cadena de consulta firmada de la URL de descarga.

string

La versión del snapshot. Envíala como versionId al restaurar.

string

Una URL firmada que descarga el snapshot, válida durante 30 días.

string | null

Runtime del que se tomó el snapshot: el lenguaje de la aplicación (javascript, python, rust…) o el motor de la base de datos (mongo, mysql, postgres, redis). null en snapshots tomados antes de que existiera este campo.

string | null

Cómo se creó el snapshot: manual (solicitado por la API, el dashboard o la CLI) o automatic (el snapshot diario programado). null en snapshots más antiguos.

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

Descarga un snapshot desde su url. El enlace es válido durante 30 días.

Errores comunes

Código	HTTP	Significado
`DATABASE_NOT_FOUND`	404	La base de datos no existe o no pertenece al solicitante.

Relacionado

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

Listar snapshots de la base de datos

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

Primeros pasos

Cuenta

Aplicaciones

Bases de datos

Workspaces

IA

Listar snapshots de la base de datos

Parámetros

Respuesta

Errores comunes

Relacionado

​Parámetros

​Respuesta

​Errores comunes

​Relacionado

Parámetros

Respuesta

Errores comunes

Relacionado