List Snapshots - Square Cloud

GET

apps

{app_id}

snapshots

List Snapshots

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

import requests

url = "https://api.squarecloud.app/v2/apps/{app_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/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))

}

HttpResponse<String> response = Unirest.get("https://api.squarecloud.app/v2/apps/{app_id}/snapshots")
  .header("Authorization", "<authorization>")
  .asString();

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",
      "size": 12900705,
      "modified": "2024-06-27T06:23:42.326Z",
      "key": "AWSAccessKeyId=access key"
    },
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab",
      "size": 12900705,
      "modified": "2024-06-26T07:05:40.000Z",
      "key": "AWSAccessKeyId=access key"
    },
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab",
      "size": 12900705,
      "modified": "2024-06-25T05:15:51.533Z",
      "key": "AWSAccessKeyId=access key"
    },
  ]
}

Authorization

string

required

The API key for your account. You can find this in your account settings.

List Snapshots returns every snapshot stored for an application, each with its size, last-modified date, and a signed key for downloading it. Use it to build a restore picker, or to confirm a snapshot from Create Snapshot has finished generating after a 202 SNAPSHOT_PROCESSING response, poll this endpoint rather than re-posting to create. The result is cached for 30 minutes per owner/application pair, so a snapshot that just finished generating in the background may take a short while to show up here even after the cluster has written it. Once you have a snapshot’s name and key, pass them to Restore Snapshot to roll the application back to that point. Snapshots are only available on paid plans, the daily snapshot quota scales with the application’s RAM allocation. On workspace-shared applications the caller needs the Administrator role.

Parameters

app_id

string

required

The ID of the application. You can find this in the URL of your application’s dashboard.

Response

status

string

Indicates whether the call was successful.. success if successful, error if not.

response

object

The contents of the response.

Show Toggle object

name

string

The ID of the application from which you fetched the snapshots.

size

number

Size of the backup in bytes.

modified

string

Date of the last modification of the backup.

key

string

AWS access key for the backup.

{
  "status": "success",
  "response": [
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab",
      "size": 12900705,
      "modified": "2024-06-27T06:23:42.326Z",
      "key": "AWSAccessKeyId=access key"
    },
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab",
      "size": 12900705,
      "modified": "2024-06-26T07:05:40.000Z",
      "key": "AWSAccessKeyId=access key"
    },
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab",
      "size": 12900705,
      "modified": "2024-06-25T05:15:51.533Z",
      "key": "AWSAccessKeyId=access key"
    },
  ]
}

The format of the URL to download the desired snapshot is: https://snapshots.squarecloud.app/applications/{accountID}/{name}.zip?{key}

Common errors

Code	HTTP	Meaning
`APP_NOT_FOUND`	404	No application with that ID exists for the resolved owner.

Create SnapshotPerform a snapshot of your application. It has a rate limit of 1 request every 5 seconds.

List Snapshots

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

import requests

url = "https://api.squarecloud.app/v2/apps/{app_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/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))

}

HttpResponse<String> response = Unirest.get("https://api.squarecloud.app/v2/apps/{app_id}/snapshots")
  .header("Authorization", "<authorization>")
  .asString();

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",
      "size": 12900705,
      "modified": "2024-06-27T06:23:42.326Z",
      "key": "AWSAccessKeyId=access key"
    },
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab",
      "size": 12900705,
      "modified": "2024-06-26T07:05:40.000Z",
      "key": "AWSAccessKeyId=access key"
    },
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab",
      "size": 12900705,
      "modified": "2024-06-25T05:15:51.533Z",
      "key": "AWSAccessKeyId=access key"
    },
  ]
}

​Parameters

​Response

​Common errors

Parameters

Response

Common errors