Listar snapshots de la aplicación

GET

apps

{app_id}

snapshots

Listar snapshots de la aplicación

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/{app_id}/snapshots \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/apps/{app_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/apps/{app_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/apps/{app_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/apps/{app_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": "1d2cdc0d6ebd435c91315c6329d12eab_javascript_manual",
      "size": 12900705,
      "modified": "2024-06-27T06:23:42.326Z",
      "key": "AWSAccessKeyId=access key",
      "version_id": "3HL4kqtJlcpXroDTDmJ.rmSpXd3dIbrHY",
      "url": "https://snapshots.squarecloud.app/applications/<account_id>/<name>.zip?<signed-query-string>",
      "runtime": "javascript",
      "origin": "manual"
    },
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab_javascript_automatic",
      "size": 12900705,
      "modified": "2024-06-26T07:05:40.000Z",
      "key": "AWSAccessKeyId=access key",
      "version_id": "Qm8cFZ2vY1tBn4LhXw0e.KpR7sUjD9aGz",
      "url": "https://snapshots.squarecloud.app/applications/<account_id>/<name>.zip?<signed-query-string>",
      "runtime": "javascript",
      "origin": "automatic"
    },
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab",
      "size": 12900705,
      "modified": "2024-06-25T05:15:51.533Z",
      "key": "AWSAccessKeyId=access key",
      "version_id": "yT5wN0cE3hJ.bV8mLq2XoZr6dAiK4sPf",
      "url": "https://snapshots.squarecloud.app/applications/<account_id>/<name>.zip?<signed-query-string>",
      "runtime": null,
      "origin": null
    }
  ]
}

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. Listar snapshots devuelve todos los snapshots almacenados para una aplicación, cada uno con su tamaño, fecha de última modificación y una url firmada para descargarlo. Úsalo para construir un selector de restauración, o para confirmar que un snapshot creado con Crear snapshot terminó de generarse tras una respuesta 202 SNAPSHOT_PROCESSING; consulta este endpoint en lugar de volver a hacer POST a crear. El resultado se almacena en caché durante 30 minutos por par propietario/aplicación, así que un snapshot que acaba de terminar de generarse en segundo plano puede tardar un poco en aparecer aquí, incluso después de que el clúster lo haya escrito. Una vez que tengas el name y el version_id de un snapshot, pásalos como snapshotId y versionId a Restaurar snapshot para regresar la aplicación a ese punto. Los snapshots solo están disponibles con un plan activo; la cuota diaria de snapshots escala según la asignación de RAM de la aplicación. En aplicaciones compartidas dentro de un workspace, quien realiza la solicitud necesita el rol admin.

Parámetros

string

requerido

El ID de la aplicación. Puedes encontrarlo en la URL del panel de tu aplicación.

Respuesta

string

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

object

El contenido de la respuesta.

Mostrar Alternar objeto

string

El nombre del snapshot: el ID de la aplicación, opcionalmente con los sufijos _<runtime> y _<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": "1d2cdc0d6ebd435c91315c6329d12eab_javascript_manual",
      "size": 12900705,
      "modified": "2024-06-27T06:23:42.326Z",
      "key": "AWSAccessKeyId=access key",
      "version_id": "3HL4kqtJlcpXroDTDmJ.rmSpXd3dIbrHY",
      "url": "https://snapshots.squarecloud.app/applications/<account_id>/<name>.zip?<signed-query-string>",
      "runtime": "javascript",
      "origin": "manual"
    },
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab_javascript_automatic",
      "size": 12900705,
      "modified": "2024-06-26T07:05:40.000Z",
      "key": "AWSAccessKeyId=access key",
      "version_id": "Qm8cFZ2vY1tBn4LhXw0e.KpR7sUjD9aGz",
      "url": "https://snapshots.squarecloud.app/applications/<account_id>/<name>.zip?<signed-query-string>",
      "runtime": "javascript",
      "origin": "automatic"
    },
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab",
      "size": 12900705,
      "modified": "2024-06-25T05:15:51.533Z",
      "key": "AWSAccessKeyId=access key",
      "version_id": "yT5wN0cE3hJ.bV8mLq2XoZr6dAiK4sPf",
      "url": "https://snapshots.squarecloud.app/applications/<account_id>/<name>.zip?<signed-query-string>",
      "runtime": null,
      "origin": null
    }
  ]
}

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

Errores comunes

Código	HTTP	Significado
`APP_NOT_FOUND`	404	No existe ninguna aplicación con ese ID para el propietario resuelto.

Relacionado

CLI: squarecloud app snapshot list
SDKs: api.apps.snapshots.list() (JavaScript), client.apps.snapshots.list() (Python), c.Apps.Snapshots.List() (Go)

Listar snapshots de la aplicación

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/{app_id}/snapshots \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/apps/{app_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/apps/{app_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/apps/{app_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/apps/{app_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": "1d2cdc0d6ebd435c91315c6329d12eab_javascript_manual",
      "size": 12900705,
      "modified": "2024-06-27T06:23:42.326Z",
      "key": "AWSAccessKeyId=access key",
      "version_id": "3HL4kqtJlcpXroDTDmJ.rmSpXd3dIbrHY",
      "url": "https://snapshots.squarecloud.app/applications/<account_id>/<name>.zip?<signed-query-string>",
      "runtime": "javascript",
      "origin": "manual"
    },
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab_javascript_automatic",
      "size": 12900705,
      "modified": "2024-06-26T07:05:40.000Z",
      "key": "AWSAccessKeyId=access key",
      "version_id": "Qm8cFZ2vY1tBn4LhXw0e.KpR7sUjD9aGz",
      "url": "https://snapshots.squarecloud.app/applications/<account_id>/<name>.zip?<signed-query-string>",
      "runtime": "javascript",
      "origin": "automatic"
    },
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab",
      "size": 12900705,
      "modified": "2024-06-25T05:15:51.533Z",
      "key": "AWSAccessKeyId=access key",
      "version_id": "yT5wN0cE3hJ.bV8mLq2XoZr6dAiK4sPf",
      "url": "https://snapshots.squarecloud.app/applications/<account_id>/<name>.zip?<signed-query-string>",
      "runtime": null,
      "origin": null
    }
  ]
}

Primeros pasos

Cuenta

Aplicaciones

Bases de datos

Workspaces

IA

Listar snapshots de la aplicación

Parámetros

Respuesta

Errores comunes

Relacionado

​Parámetros

​Respuesta

​Errores comunes

​Relacionado

Parámetros

Respuesta

Errores comunes

Relacionado