List all account snapshots

GET

users

snapshots

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

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

fetch('https://api.squarecloud.app/v2/users/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/users/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/users/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/users/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=accesskey",
      "runtime": "javascript",
      "origin": "manual"
    },
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab_javascript_automatic",
      "size": 12900705,
      "modified": "2024-06-26T07:05:40.000Z",
      "key": "AWSAccessKeyId=accesskey",
      "runtime": "javascript",
      "origin": "automatic"
    }
  ]
}

string

required

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

Requires an API key with the snapshots:read scope. List Snapshots returns the automatic backups Square Cloud keeps for your applications or databases, each entry pairing a signed download URL fragment with its size and last-modified date. Use it to build a restore picker or audit retention in your own tooling instead of checking the dashboard manually. Results are cached per user and scope for 30 minutes; a cache miss counts against a tighter limit of 3 calls per 60 seconds, after which the caller is blocked for a short period. Listing snapshots requires an active plan, an account without one gets a 402. Snapshots are grouped by scope, applications by default or databases via the scope parameter below. For application details, see Get Application Info; for database details, see Get Database Info.

Parameters

string

default:"applications"

Specifies the type of snapshots to retrieve.

applications (default): Returns snapshots of applications
databases: Returns snapshots of databases

Response

string

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

object

The contents of the response.

Show Toggle object

string

The snapshot’s name: the ID of the application or database it belongs to, optionally suffixed with _<runtime> and _<origin>. Pass it unchanged as snapshotId when restoring.

number

Size of the snapshot in bytes.

string

Date of the last modification of the snapshot.

string

AWS access key for the snapshot.

string | null

Runtime the snapshot was taken from: the application’s language (javascript, python, rust…) or the database engine (mongo, mysql, postgres, redis). null on snapshots taken before this field existed.

string | null

How the snapshot was created: manual (requested through the API, dashboard or CLI) or automatic (the daily scheduled snapshot). null on older snapshots.

{
  "status": "success",
  "response": [
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab_javascript_manual",
      "size": 12900705,
      "modified": "2024-06-27T06:23:42.326Z",
      "key": "AWSAccessKeyId=accesskey",
      "runtime": "javascript",
      "origin": "manual"
    },
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab_javascript_automatic",
      "size": 12900705,
      "modified": "2024-06-26T07:05:40.000Z",
      "key": "AWSAccessKeyId=accesskey",
      "runtime": "javascript",
      "origin": "automatic"
    }
  ]
}

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
`INVALID_SCOPE`	400	The `scope` query parameter is not `applications` or `databases`.
`UPGRADE_REQUIRED`	402	The account has no active plan; listing snapshots requires one.
`RATE_LIMITED`	429	The rate limit was reached. Wait and retry.

SDKs: api.account.snapshots() (JavaScript), client.account.snapshots() (Python), c.Account.Snapshots() (Go)

List all account snapshots

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

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

fetch('https://api.squarecloud.app/v2/users/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/users/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/users/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/users/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=accesskey",
      "runtime": "javascript",
      "origin": "manual"
    },
    {
      "name": "1d2cdc0d6ebd435c91315c6329d12eab_javascript_automatic",
      "size": 12900705,
      "modified": "2024-06-26T07:05:40.000Z",
      "key": "AWSAccessKeyId=accesskey",
      "runtime": "javascript",
      "origin": "automatic"
    }
  ]
}

Get started

Account

Applications

Databases

Workspaces

AI

List all account snapshots

Parameters

Response

Common errors

​Parameters

​Response

​Common errors

​Related

Parameters

Response

Common errors

Related