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

# Restaurar snapshot da aplicação

> Volte os arquivos de uma aplicação para um snapshot com POST /v2/apps/{app_id}/snapshots/restore, usando o snapshotId e o versionId da listagem.

<Warning>Esta rota possui limite de taxa de 1 requisição a cada 60 segundos.</Warning>

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

Restaurar Snapshot volta o armazenamento de uma aplicação para um [snapshot](/pt-br/api-reference/endpoint/apps/snapshots/create) anterior, substituindo os arquivos atuais pelos que foram capturados no momento do snapshot. Use-o para se recuperar de um deploy ruim ou de uma exclusão acidental. Obtenha os valores de `snapshotId` e `versionId` em [Listar Snapshots](/pt-br/api-reference/endpoint/apps/snapshots/list); eles não são algo que você constrói manualmente.

`snapshotId` é o `name` do snapshot exatamente como [Listar Snapshots](/pt-br/api-reference/endpoint/apps/snapshots/list) retorna (o ID da aplicação, opcionalmente com os sufixos `_<runtime>` e `_<origin>`), e `versionId` precisa corresponder ao formato de chave de versão do S3; valores malformados são rejeitados antes de a restauração ser despachada. A restauração para a aplicação, troca os arquivos pelos do snapshot e a inicia de novo, então não é preciso reiniciar depois. Enquanto ela roda (até cerca de 2 minutos), [iniciar](/pt-br/api-reference/endpoint/apps/start), [parar](/pt-br/api-reference/endpoint/apps/stop), [reiniciar](/pt-br/api-reference/endpoint/apps/restart) e excluir respondem `403 RESTORE_IN_PROGRESS`.

Snapshots (e, portanto, restaurações) estão disponíveis apenas com um plano ativo. Em aplicações compartilhadas em workspace, quem chama precisa da [função](/pt-br/api-reference/endpoint/workspace/members/invite#funções) `admin`.

## Parâmetros

<ParamField path="app_id" type="string" placeholder="ID da Aplicação" required>
  O ID da aplicação. Você pode encontrá-lo na URL da sua aplicação no dashboard.
</ParamField>

<ParamField body="snapshotId" type="string" placeholder="ID da Snapshot" required>
  O `name` do snapshot na listagem (o ID da aplicação, opcionalmente com os sufixos `_<runtime>` e `_<origin>`), enviado exatamente como retornado.
</ParamField>

<ParamField body="versionId" type="string" placeholder="Chave de versão da Snapshot" required>
  O `version_id` do snapshot, como [Listar Snapshots](/pt-br/api-reference/endpoint/apps/snapshots/list) o retorna.
</ParamField>

## Resposta

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

<ResponseExample>
  ```json theme={"system"}
  {
    "status":"success"
  }
  ```
</ResponseExample>

## Erros comuns

| Código | HTTP | Significado |
| - | - | - |
| `MISSING_PARAMETERS` | 400 | `snapshotId` ou `versionId` está ausente. |
| `INVALID_SNAPSHOT_ID` | 400 | `snapshotId` não é um nome de snapshot como retornado pela listagem (um ID, opcionalmente com até dois sufixos `_<tag>`). |
| `INVALID_VERSION_ID` | 400 | `versionId` não corresponde ao formato esperado de chave de versão do S3. |
| `SNAPSHOT_NOT_FOUND` | 404 | Não existe nenhum snapshot com esse ID e versão para esta aplicação. |
| `APP_NOT_FOUND` | 404 | A aplicação não existe, ou o dono dela não existe mais. |
| `SNAPSHOT_RESTORE_FAILED` | 404 | A restauração falhou. Este é o único código de falha; `SNAPSHOT_NOT_FOUND` significa que o snapshot não existe. |

## Relacionados

* CLI: [`squarecloud app snapshot restore`](/pt-br/cli-reference/snapshots#squarecloud-app-snapshot-restore)
* SDKs: [`api.apps.snapshots.restore()`](/pt-br/sdks/js/snapshots) (JavaScript), [`client.apps.snapshots.restore()`](/pt-br/sdks/py/snapshots) (Python), [`c.Apps.Snapshots.Restore()`](/pt-br/sdks/go/snapshots) (Go)


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