Crear snapshot - Square Cloud

POST

apps

{app_id}

snapshots

Crear snapshot

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

const options = {method: 'POST', 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 => "POST",
  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("POST", 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::Post.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
    "status": "success",
    "response": {
        "url": "https://snapshots.squarecloud.app/applications/23457145698959364/a23d130fcc9ddaf2d288ae9599a4292c32.zip?AWSAccessKeyId=i06Xdad2dRD74Pm8Xly&Expires=1753081182&Signature=riWPedawcsouRAPGU5n3kGHnWoOuw%3D",
        "key": "AWSAccessKeyId=i06Xdad2dRD74Pm8Xly&Expires=1753081182&Signature=riWPedawcsouRAPGU5n3kGHnWoOuw%3D"
    }
}

{
  "status": "error",
  "code": "SNAPSHOT_PROCESSING"
}

{
  "status": "error",
  "code": "KEEP_CALM",
  "message": "You already requested a snapshot recently. Please wait a minute before trying again. 1r/5s"
}

{
  "status": "error",
  "code": "DAILY_SNAPSHOTS_LIMIT_REACHED",
  "message": "You are being rate limited for daily snapshots. 8r/24h"
}

Cada cuenta puede realizar hasta (RAM / 256) * 2 snapshots cada 24 horas.

string

requerido

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

Crear snapshot captura una copia .zip del almacenamiento completo de la aplicación en un momento dado y devuelve una URL de descarga firmada, dándote un punto de restauración antes de un cambio riesgoso o una forma de obtener un respaldo completo fuera de la plataforma. Para devolver la aplicación a ese estado más adelante, pasa el snapshot resultante a Restaurar snapshot; para inspeccionar o descargar snapshots anteriores sin crear uno nuevo, usa Listar snapshots. Los snapshots solo están disponibles en planes pagos, y la cuota diaria escala según la RAM de la aplicación ((RAM / 256) × 2 cada 24 horas). En aplicaciones compartidas dentro de un workspace, quien realiza la solicitud necesita el rol de Administrador.

Parámetros

string

requerido

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

Comportamiento de soft deadline

Esta ruta sigue un modelo de soft deadline: ya no siempre responde de forma síncrona.

Si el snapshot termina en ~90 segundos, la ruta responde con 200 success y una URL de descarga firmada (válida por 30 días), exactamente como antes.
Si el snapshot tarda más de ~90 segundos en generarse, la ruta responde de inmediato con 202 y el código SNAPSHOT_PROCESSING. Esto no es un fallo. El snapshot sigue generándose en segundo plano y aparecerá por sí solo en el listado de snapshots, normalmente en ~2 minutos. Este es el comportamiento esperado para aplicaciones grandes.

No uses este endpoint POST como mecanismo de sondeo. Para verificar si un snapshot en SNAPSHOT_PROCESSING ha finalizado, usa el endpoint Listar snapshots (GET), no otro POST. Volver a hacer un POST después de que el snapshot haya terminado inicia un snapshot completamente nuevo desde cero.

El cliente debe ramificar según la respuesta de la siguiente manera:

Respuesta	Significado	Qué hacer
`status === "success"`	El snapshot está listo.	Usa la `url` para descargarlo.
`status === "error"` y `code === "SNAPSHOT_PROCESSING"`	El snapshot aún se está generando.	Espera ~2 minutos y luego confirma mediante Listar snapshots (`GET`). No vuelvas a hacer `POST`.
`status === "error"` con cualquier otro `code`	Fallo real.	Maneja el error (ver abajo).

Respuesta

string

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

object

El contenido de la respuesta. Presente solo cuando status es success.

Mostrar Alternar objeto

string

La URL para descargar el snapshot de tu aplicación.

string

La clave para descargar el snapshot de tu aplicación.

202

Se devuelve cuando el snapshot supera el soft deadline de ~90 segundos. El snapshot sigue generándose en segundo plano y aparecerá por sí solo en el listado de snapshots, normalmente en ~2 minutos. No es un error: espera y confirma mediante el endpoint de listado GET.

Errores

Una solicitud de snapshot puede ser rechazada con 429 Too Many Requests. Usa el campo code para distinguir los dos casos:

429

Enfriamiento a corto plazo: alcanzaste el límite por usuario (1 solicitud / 5 s) o por aplicación (1 solicitud / 180 s). Espera un poco y reintenta en breve.

429

Cuota diaria alcanzada: la cuenta agotó la asignación diaria de snapshots de su plan ((RAM / 256) × 2 por cada 24 h). La cuota se libera a medida que avanza la ventana móvil de 24 horas; para una asignación diaria mayor, mejora el plan.

{
    "status": "success",
    "response": {
        "url": "https://snapshots.squarecloud.app/applications/23457145698959364/a23d130fcc9ddaf2d288ae9599a4292c32.zip?AWSAccessKeyId=i06Xdad2dRD74Pm8Xly&Expires=1753081182&Signature=riWPedawcsouRAPGU5n3kGHnWoOuw%3D",
        "key": "AWSAccessKeyId=i06Xdad2dRD74Pm8Xly&Expires=1753081182&Signature=riWPedawcsouRAPGU5n3kGHnWoOuw%3D"
    }
}

{
  "status": "error",
  "code": "SNAPSHOT_PROCESSING"
}

{
  "status": "error",
  "code": "KEEP_CALM",
  "message": "You already requested a snapshot recently. Please wait a minute before trying again. 1r/5s"
}

{
  "status": "error",
  "code": "DAILY_SNAPSHOTS_LIMIT_REACHED",
  "message": "You are being rate limited for daily snapshots. 8r/24h"
}

Restaurar SnapshotRestaura una aplicación a partir de un snapshot de la misma.

Crear snapshot

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

const options = {method: 'POST', 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 => "POST",
  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("POST", 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::Post.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
    "status": "success",
    "response": {
        "url": "https://snapshots.squarecloud.app/applications/23457145698959364/a23d130fcc9ddaf2d288ae9599a4292c32.zip?AWSAccessKeyId=i06Xdad2dRD74Pm8Xly&Expires=1753081182&Signature=riWPedawcsouRAPGU5n3kGHnWoOuw%3D",
        "key": "AWSAccessKeyId=i06Xdad2dRD74Pm8Xly&Expires=1753081182&Signature=riWPedawcsouRAPGU5n3kGHnWoOuw%3D"
    }
}

{
  "status": "error",
  "code": "SNAPSHOT_PROCESSING"
}

{
  "status": "error",
  "code": "KEEP_CALM",
  "message": "You already requested a snapshot recently. Please wait a minute before trying again. 1r/5s"
}

{
  "status": "error",
  "code": "DAILY_SNAPSHOTS_LIMIT_REACHED",
  "message": "You are being rate limited for daily snapshots. 8r/24h"
}

​Parámetros

​Comportamiento de soft deadline

​Respuesta

​Errores

Parámetros

Comportamiento de soft deadline

Respuesta

Errores