List application snapshots

GET

apps

{app_id}

snapshots

List application snapshots

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

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 every snapshot stored for an application, each with its size, last-modified date, and a signed url 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 version_id, pass them as snapshotId and versionId to Restore Snapshot to roll the application back to that point. Snapshots are only available with an active plan, the daily snapshot quota scales with the application’s RAM allocation. On workspace-shared applications the caller needs the admin role.

Parameters

string

required

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

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 application ID, optionally suffixed with _<runtime> and _<origin>. Pass it unchanged as snapshotId when restoring.

number

Size of the backup in bytes.

string

Date of the last modification of the backup.

string

The signed query string of the download URL.

string

The snapshot’s version. Pass it as versionId when restoring.

string

A signed URL that downloads the snapshot, valid for 30 days.

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=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
    }
  ]
}

Download a snapshot from its url. The link stays valid for 30 days.

Common errors

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

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

List application snapshots

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
    }
  ]
}

Get started

Account

Applications

Databases

Workspaces

AI

List application snapshots

Parameters

Response

Common errors

​Parameters

​Response

​Common errors

​Related

Parameters

Response

Common errors

Related