Listar todos os snapshots da conta

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

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 os backups automáticos que a Square Cloud mantém para suas aplicações ou bancos de dados, cada item combinando um fragmento de URL de download assinado com seu tamanho e data da última modificação. Use isso para montar um seletor de restauração ou auditar a retenção na sua própria ferramenta, em vez de checar o dashboard manualmente. Os resultados ficam em cache por usuário e escopo por 30 minutos; uma falha de cache conta para um limite mais restrito de 3 chamadas a cada 60 segundos, após o qual quem chamou fica bloqueado por um curto período. Listar snapshots requer um plano ativo; uma conta sem ele recebe um 402. Os snapshots são agrupados por escopo, aplicações por padrão ou bancos de dados via o parâmetro scope abaixo. Para detalhes de aplicação, veja Consultar Informações da Aplicação; para detalhes de banco de dados, veja Consultar Informações do Banco de Dados.

Parâmetros

string

padrão:"applications"

Especifica o tipo de snapshots a serem recuperados.

applications (padrão): Retorna snapshots de aplicações
databases: Retorna snapshots de bancos de dados

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 ou do banco de dados ao qual ele pertence, opcionalmente com os sufixos _<runtime> e _<origin>. Envie-o sem alterações como snapshotId ao restaurar.

number

Tamanho do snapshot em bytes.

string

Data da última modificação do snapshot.

string

Chave de acesso AWS para o snapshot.

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

O formato da URL para baixar o snapshot desejado é: https://snapshots.squarecloud.app/applications/{accountID}/{name}.zip?{key}

Erros comuns

Código	HTTP	Significado
`INVALID_SCOPE`	400	O parâmetro de consulta `scope` não é `applications` nem `databases`.
`UPGRADE_REQUIRED`	402	A conta não tem plano ativo; listar snapshots requer um.
`RATE_LIMITED`	429	O limite de requisições foi atingido. Aguarde e tente novamente.

Relacionados

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

Listar todos os snapshots da conta

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

Primeiros passos

Conta

Aplicações

Bancos de dados

Workspaces

IA

Listar todos os snapshots da conta

Parâmetros

Resposta

Erros comuns

Relacionados

​Parâmetros

​Resposta

​Erros comuns

​Relacionados

Parâmetros

Resposta

Erros comuns

Relacionados