Listar snapshots da aplicação

GET

apps

{app_id}

snapshots

Listar snapshots da aplicação

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

obrigatório

A chave da API para sua conta. Você pode encontrá-la nas configurações da conta.

Requer uma chave de API com o escopo snapshots:read. Listar Snapshots retorna todos os snapshots armazenados de uma aplicação, cada um com seu tamanho, data da última modificação e uma url assinada para baixá-lo. Use-o para montar um seletor de restauração ou para confirmar que um snapshot de Criar Snapshot terminou de ser gerado após uma resposta 202 SNAPSHOT_PROCESSING; faça polling neste endpoint em vez de repetir o POST de criação. O resultado fica em cache por 30 minutos por par proprietário/aplicação, então um snapshot que acabou de terminar de ser gerado em segundo plano pode levar um instante para aparecer aqui, mesmo depois de o cluster já tê-lo gravado. Assim que você tiver o name e o version_id de um snapshot, passe-os como snapshotId e versionId para Restaurar Snapshot para voltar a aplicação a esse ponto. Snapshots estão disponíveis apenas com um plano ativo, e a cota diária de snapshots escala com a alocação de RAM da aplicação. Em aplicações compartilhadas em workspace, quem chama precisa da função admin.

Parâmetros

string

obrigatório

O ID da aplicação. Você pode encontrá-lo na URL da sua aplicação no dashboard.

Resposta

string

Indica se a chamada foi bem-sucedida: success se foi, error se não.

object

O conteúdo da resposta.

Mostrar Alternar objeto

string

O nome do snapshot: o ID da aplicação, opcionalmente com os sufixos _<runtime> e _<origin>. Envie-o sem alterações como snapshotId ao restaurar.

number

Tamanho do backup em bytes.

string

Data da última modificação do backup.

string

A query string assinada da URL de download.

string

A versão do snapshot. Passe-a como versionId ao restaurar.

string

Uma URL assinada que baixa o snapshot, válida por 30 dias.

string | null

Runtime de onde o snapshot foi tirado: a linguagem da aplicação (javascript, python, rust…) ou o motor do banco de dados (mongo, mysql, postgres, redis). null em snapshots tirados antes de este campo existir.

string | null

Como o snapshot foi criado: manual (pedido pela API, dashboard ou CLI) ou automatic (o snapshot diário agendado). null em snapshots mais antigos.

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

Baixe um snapshot pela sua url. O link continua válido por 30 dias.

Erros comuns

Código	HTTP	Significado
`APP_NOT_FOUND`	404	Não existe nenhuma aplicação com esse ID para o proprietário resolvido.

Relacionados

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

Listar snapshots da aplicação

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

Primeiros passos

Conta

Aplicações

Bancos de dados

Workspaces

IA

Listar snapshots da aplicação

Parâmetros

Resposta

Erros comuns

Relacionados

​Parâmetros

​Resposta

​Erros comuns

​Relacionados

Parâmetros

Resposta

Erros comuns

Relacionados