Crea Snapshot - Square Cloud

POST

databases

{database_id}

snapshots

Crea Snapshot

curl --request POST \
  --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.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', 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 => "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/databases/{database_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/databases/{database_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/databases/384443501775028242/a14b8d5e1cb7405a851eb4c075506121.zip?AWSAccessKeyId=accesskey&Expires=1757683751&Signature=JR3danhvtVywQmcaIanWsoJFqhQ%3D",
    "key":"AWSAccessKeyId=accesskey&Expires=1757683751&Signature=JR3danhvtVywQmcaIanWsoJFqhQ%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"
}

Ogni account può eseguire fino a (RAM / 256) * 2 snapshot ogni 24 ore.

string

obbligatorio

La chiave API del tuo account. Puoi trovarla nelle impostazioni del tuo account.

Cattura un backup puntuale dei dati del database e lo carica nello storage per snapshot di Square Cloud, restituendo un URL di download firmato valido per 30 giorni. Usalo prima di una migrazione rischiosa, di un Ripristino Snapshot manuale, oppure programmato per il disaster recovery. Una volta creato, lo snapshot compare anche in Elenca Snapshot.

Parametri

string

obbligatorio

L’ID del database.

Comportamento con soft deadline

Questa route segue un modello di soft deadline — non risponde più sempre in modo sincrono.

Se lo snapshot termina entro ~90 secondi, la route risponde con 200 success e un URL di download firmato (valido per 30 giorni), esattamente come prima.
Se lo snapshot richiede più di ~90 secondi per essere generato, la route risponde immediatamente con 202 e il codice SNAPSHOT_PROCESSING. Questo non è un errore. Lo snapshot continua a essere generato in background e comparirà nell’elenco degli snapshot autonomamente, di solito entro ~2 minuti. Questo è il comportamento previsto per database di grandi dimensioni.

Non usare questo endpoint POST come meccanismo di polling. Per verificare se uno snapshot SNAPSHOT_PROCESSING è stato completato, usa l’endpoint List Snapshots (GET) — non un altro POST. Rieseguire il POST dopo che lo snapshot è terminato avvia un nuovo snapshot da zero.

Il client dovrebbe diramare in base alla risposta come segue:

Risposta	Significato	Cosa fare
`status === "success"`	Lo snapshot è pronto.	Usa l’`url` per scaricarlo.
`status === "error"` e `code === "SNAPSHOT_PROCESSING"`	Lo snapshot è ancora in fase di generazione.	Attendi ~2 minuti, poi conferma tramite List Snapshots (`GET`). Non rieseguire il `POST`.
`status === "error"` con qualsiasi altro `code`	Errore effettivo.	Gestisci l’errore (vedi sotto).

Risposta

string

Indica se la chiamata è andata a buon fine. success in caso di successo, error in caso contrario.

object

Il contenuto della risposta. Presente solo quando status è success.

Mostra Mostra oggetto

string

L’URL per scaricare lo snapshot della tua applicazione.

string

La chiave per scaricare lo snapshot della tua applicazione.

202

Restituito quando lo snapshot supera la soft deadline di ~90 secondi. Lo snapshot è ancora in fase di generazione in background e comparirà nell’elenco degli snapshot autonomamente, di solito entro ~2 minuti. Non è un errore — attendi e conferma tramite l’endpoint di elenco GET.

Errori

Una richiesta di snapshot può essere rifiutata con 429 Too Many Requests. Usa il campo code per distinguere i due casi:

429

Cooldown a breve termine — hai raggiunto il limite per utente (1 richiesta / 5s) o per database (1 richiesta / 180s). Attendi e riprova a breve.

429

Quota giornaliera raggiunta — l’account ha esaurito la quota giornaliera di snapshot del proprio piano ((RAM / 256) × 2 per 24h). La quota si libera man mano che la finestra mobile di 24 ore avanza; per una quota giornaliera più alta, effettua l’upgrade del piano.

{
  "status":"success",
  "response":{
    "url":"https://snapshots.squarecloud.app/databases/384443501775028242/a14b8d5e1cb7405a851eb4c075506121.zip?AWSAccessKeyId=accesskey&Expires=1757683751&Signature=JR3danhvtVywQmcaIanWsoJFqhQ%3D",
    "key":"AWSAccessKeyId=accesskey&Expires=1757683751&Signature=JR3danhvtVywQmcaIanWsoJFqhQ%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"
}

Ripristina SnapshotRipristina un database a partire da un suo snapshot.

Crea Snapshot

curl --request POST \
  --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.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', 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 => "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/databases/{database_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/databases/{database_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/databases/384443501775028242/a14b8d5e1cb7405a851eb4c075506121.zip?AWSAccessKeyId=accesskey&Expires=1757683751&Signature=JR3danhvtVywQmcaIanWsoJFqhQ%3D",
    "key":"AWSAccessKeyId=accesskey&Expires=1757683751&Signature=JR3danhvtVywQmcaIanWsoJFqhQ%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"
}

​Parametri

​Comportamento con soft deadline

​Risposta

​Errori

Parametri

Comportamento con soft deadline

Risposta

Errori