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

# Restaurar snapshot da aplicação

> Restaura um snapshot especificado em uma aplicação ou banco de dados e, em seguida, refaz o build e reinicia o recurso automaticamente.

**id** `string` *required*

O ID da aplicação ou do banco de dados para o qual o snapshot será restaurado.

**snapshot\_id** `string` *required*

O ID do snapshot a restaurar.

**scope** `string` *required*

O tipo do recurso. Valores possíveis: `applications`, `databases`.

**resource\_id** `string`

Opcional. Substitui o recurso de destino para restauração entre recursos. Se omitido, restaura no recurso informado em `id`.

**restore\_image\_version** `boolean`

Somente para uma aplicação que roda uma imagem Docker personalizada. Quando `true`, a restauração também volta para a versão da imagem que a aplicação rodava no momento do snapshot, se ela ainda existir. Padrão `false`: só os dados são restaurados e a aplicação mantém a versão atual da imagem.

### Resposta

**response** `object`

Confirmação de que o processo de restauração foi iniciado.

**Mostrar objeto**

**message** `string`

Uma mensagem confirmando que a restauração foi iniciada.

**warning** `string`

Presente quando `restore_image_version` era `true`, mas a versão da imagem registrada no snapshot não existe mais: `IMAGE_VERSION_NOT_FOUND`. Só os dados foram restaurados e a aplicação continua na versão atual.

```json Response theme={null}
{
  "response": {
    "message": "Restoration started and rebuild triggered"
  }
}
```

### Respostas de erro

**code** `string`

O código de erro que indica o motivo da falha. Valores possíveis:

* `AUTH_TOKEN_MISSING`, `API_KEY_INVALID`, `SESSION_REVOKED`: o header `Authorization` está ausente, a chave de API é inválida ou a sessão do painel foi revogada (`401`).
* `API_KEY_IP_DENIED`, `API_KEY_SCOPE_DENIED`: a chave de API é usada a partir de um IP fora da sua allowlist, ou não tem o escopo que a rota exige (`403`).
* `USER_NOT_FOUND`: o usuário autenticado não foi encontrado.
* `APP_NOT_FOUND`: a aplicação informada não existe.
* `DATABASE_NOT_FOUND`: o banco de dados informado não existe.
* `ACCESS_DENIED`: o usuário não é dono do recurso ou do snapshot.
* `RESTORE_COOLDOWN`: uma operação de restauração foi feita neste recurso há pouco tempo. Aguarde antes de tentar de novo.
* `TYPE_MISMATCH`: o tipo do recurso do snapshot não corresponde ao tipo do recurso de destino.
* `SNAPSHOT_ENGINE_MISMATCH`: o snapshot pertence a um motor de banco de dados diferente do de destino (`400`).
* `SNAPSHOT_VERSION_NEWER`: o snapshot foi feito em uma versão principal mais nova do que a do banco de dados de destino; nada é alterado (`400`).
* `SNAPSHOT_NOT_FOUND`: o snapshot informado não existe.
* `INVALID_ZIP_STRUCTURE`: o arquivo do snapshot está danificado, ou um snapshot de aplicação não tem arquivos (`400`). A restauração é recusada antes de qualquer alteração: os arquivos da aplicação e o banco de dados permanecem como estavam.
* `OPERATION_IN_PROGRESS`: outra operação de ciclo de vida no mesmo recurso já está em execução (`409`). Nada foi restaurado — aguarde alguns segundos e tente de novo. Veja [Códigos de erro comuns](https://docs.vertracloud.app/pt-br/api-reference/introduction.md#quais-códigos-de-erro-a-api-pode-retornar).
* `SNAPSHOT_IMPORT_FAILED`: a restauração falhou ao carregar os dados (`500`). O banco de dados fica em execução e vazio; o snapshot continua disponível para tentar de novo.
* `INTERNAL_SERVER_ERROR`: ocorreu um erro inesperado no servidor.

```json Error Response (401) theme={null}
{
  "code": "AUTH_TOKEN_MISSING"
}
```

```json Error Response (403) theme={null}
{
  "code": "ACCESS_DENIED"
}
```

```json Error Response (404) theme={null}
{
  "code": "APP_NOT_FOUND"
}
```

```json Error Response (404) theme={null}
{
  "code": "SNAPSHOT_NOT_FOUND"
}
```

```json Error Response (429) theme={null}
{
  "code": "RESTORE_COOLDOWN"
}
```

```json Error Response (400) theme={null}
{
  "code": "TYPE_MISMATCH",
  "message": "Cannot restore snapshot to a different resource type"
}
```

```json Error Response (400) theme={null}
{
  "code": "SNAPSHOT_ENGINE_MISMATCH"
}
```

```json Error Response (500) theme={null}
{
  "code": "SNAPSHOT_IMPORT_FAILED"
}
```


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