> ## Documentation Index
> Fetch the complete documentation index at: https://docs.squarecloud.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar todos os snapshots da conta

> Liste os snapshots automáticos das suas aplicações ou bancos de dados com GET /v2/users/snapshots, com tamanho, data e URL de download. Exige plano ativo.

<ParamField header="Authorization" type="string" placeholder="Chave da API" required>
  A chave da API para sua conta. Você pode encontrá-la nas [configurações da conta](https://squarecloud.app/pt-br/account/security).
</ParamField>

Requer uma chave de API com o [escopo](/pt-br/api-reference/authentication#escopos) `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](/pt-br/api-reference/endpoint/apps/info); para detalhes de banco de dados, veja [Consultar Informações do Banco de Dados](/pt-br/api-reference/endpoint/databases/info).

## Parâmetros

<ParamField query="scope" type="string" default="applications">
  Especifica o tipo de snapshots a serem recuperados.

  * `applications` (padrão): Retorna snapshots de aplicações
  * `databases`: Retorna snapshots de bancos de dados
</ParamField>

## Resposta

<ResponseField name="status" type="string">
  Indica se a chamada foi bem-sucedida: `success` se foi, `error` se não.
</ResponseField>

<ResponseField name="response" type="object">
  O conteúdo da resposta.

  <Expandable title="Alternar objeto">
    <ResponseField name="name" type="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.
    </ResponseField>

    <ResponseField name="size" type="number">
      Tamanho do snapshot em bytes.
    </ResponseField>

    <ResponseField name="modified" type="string">
      Data da última modificação do snapshot.
    </ResponseField>

    <ResponseField name="key" type="string">
      Chave de acesso AWS para o snapshot.
    </ResponseField>

    <ResponseField name="runtime" type="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.
    </ResponseField>

    <ResponseField name="origin" type="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.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json Response theme={"system"}
  {
    "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"
      }
    ]
  }
  ```
</ResponseExample>

<Note>O formato da URL para baixar o snapshot desejado é: [https://snapshots.squarecloud.app/applications/\{accountID}/\{name}.zip?\{key}](https://snapshots.squarecloud.app/applications/\{accountID}/\{name}.zip?\{key})</Note>

## 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()`](/pt-br/sdks/js/snapshots) (JavaScript), [`client.account.snapshots()`](/pt-br/sdks/py/snapshots) (Python), [`c.Account.Snapshots()`](/pt-br/sdks/go/snapshots) (Go)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.