> ## 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 snapshots do banco de dados

> Liste os snapshots de um banco de dados, do mais novo ao mais antigo, com GET /v2/databases/{database_id}/snapshots: tamanho, data, URL e IDs para restaurar.

<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`.

Lista todos os snapshots armazenados para um banco de dados, do mais recente para o mais antigo, com tamanho e data da última modificação de cada um. Use isso para montar um seletor de restauração em um dashboard, ou para verificar, após uma chamada de [Criar Snapshot](/pt-br/api-reference/endpoint/databases/snapshots/create) que retornou `202 SNAPSHOT_PROCESSING`, se o arquivo já está disponível.

Cada item traz uma `url` de download assinada, válida por 30 dias, e um `version_id` para passar como `versionId` ao restaurar. As respostas ficam em cache por 30 minutos por usuário e banco de dados, então um snapshot que acabou de ser gerado pode levar um tempo para aparecer aqui. Para restaurar um desses snapshots, veja [Restaurar Snapshot](/pt-br/api-reference/endpoint/databases/snapshots/restore).

## Parâmetros

<ParamField path="database_id" type="string" placeholder="ID do banco de dados" required>
  O ID do banco 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="array">
  O conteúdo da resposta.

  <Expandable title="Alternar objeto">
    <ResponseField name="name" type="string">
      O nome do snapshot: o ID do banco de dados com o sufixo `_<type>` e, em snapshots mais novos, `_<origin>`. Envie-o sem alterações como `snapshotId` ao restaurar.
    </ResponseField>

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

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

    <ResponseField name="key" type="string">
      A query string assinada da URL de download.
    </ResponseField>

    <ResponseField name="version_id" type="string">
      A versão do snapshot. Passe-a como `versionId` ao restaurar.
    </ResponseField>

    <ResponseField name="url" type="string">
      Uma URL assinada que baixa o snapshot, válida por 30 dias.
    </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 theme={"system"}
  {
    "status":"success",
    "response":[
      {
        "name":"a14b8d5e1cb7405a851eb4c075506121_mongo_manual",
        "size":10644463,
        "modified":"2025-08-13T13:29:11.263Z",
        "key":"AWSAccessKeyId=accesskey&Expires=1757683751&Signature=VZ03MSxcNw3%2FtPezXv0IhTs0jq4%3D&versionId=45ec0b49-9af6-445e-a55c-abd7ec5278b2",
        "version_id":"45ec0b49-9af6-445e-a55c-abd7ec5278b2",
        "url":"https://snapshots.squarecloud.app/databases/<account_id>/<name>.zip?<signed-query-string>",
        "runtime":"mongo",
        "origin":"manual"
      },
      {
        "name":"a14b8d5e1cb7405a851eb4c075506121_mongo_automatic",
        "size":2742383,
        "modified":"2025-08-13T00:01:47.010Z",
        "key":"AWSAccessKeyId=accesskey&Expires=1757683751&Signature=7zw5apjyaOd1xPZl3gRgp8Y4yEs%3D&versionId=f65e1378-8717-45c5-8aec-bb233eedb5ce",
        "version_id":"f65e1378-8717-45c5-8aec-bb233eedb5ce",
        "url":"https://snapshots.squarecloud.app/databases/<account_id>/<name>.zip?<signed-query-string>",
        "runtime":"mongo",
        "origin":"automatic"
      }
    ]
  }
  ```
</ResponseExample>

<Note>Baixe um snapshot pela sua `url`. O link continua válido por 30 dias.</Note>

## Erros comuns

| Código | HTTP | Significado |
| - | - | - |
| `DATABASE_NOT_FOUND` | 404 | O banco de dados não existe ou não pertence a quem fez a chamada. |

## Relacionados

* CLI: [`squarecloud db snapshot list`](/pt-br/cli-reference/snapshots#squarecloud-db-snapshot-list)
* SDKs: [`api.databases.snapshots.list()`](/pt-br/sdks/js/databases) (JavaScript), [`client.databases.snapshots.list()`](/pt-br/sdks/py/databases) (Python), [`c.Databases.Snapshots.List()`](/pt-br/sdks/go/databases) (Go)


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