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

# Criar snapshot da aplicação

> Faz um snapshot de uma aplicação ou do volume de um banco de dados agora. O snapshot aparece na lista e pode ser restaurado ou baixado como qualquer outro.

**id** `string` *required*

O ID da aplicação ou do banco de dados a ser salvo em snapshot.

**scope** `string` *required*

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

> [!NOTE]
>
> **Dois limites se aplicam aos snapshots manuais, além das 5 requisições por minuto da rota.** O mesmo
> recurso pode receber um snapshot a cada **5 minutos**, e uma conta pode criar no máximo **10
> snapshots por hora** somando todos os seus recursos. Ao ultrapassar qualquer um dos limites, a API responde
> `429 SNAPSHOT_RATE_LIMITED` com `details.scope` (`resource` ou `account`) e
> `details.retry_after` em segundos. Os snapshots que a plataforma faz por conta própria (antes de um delete ou de um
> reset) não contam. Veja [Limite de requisições](https://docs.vertracloud.app/pt-br/api-reference/introduction.md#como-a-api-tem-limite-de-taxa).

### Resposta

**response** `object`

O snapshot criado.

**Mostrar objeto**

**id** `string`

O ID do snapshot. Use-o com [restaurar](https://docs.vertracloud.app/pt-br/api-reference/endpoint/apps/snapshots/restore.md) e
[baixar](https://docs.vertracloud.app/pt-br/api-reference/endpoint/apps/snapshots/download.md).

**resource\_id** `string`

O ID do recurso ao qual este snapshot pertence.

**type** `number`

`1` para uma aplicação, `2` para um banco de dados.

**size** `number`

Tamanho em kilobytes.

**resource\_name** `string | null`

O nome que o recurso tinha no momento em que o snapshot foi feito.

**created\_at** `string`

Quando o snapshot foi feito.

**expires\_at** `string`

Quando o snapshot será apagado automaticamente.

```json Response theme={null}
{
  "response": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "resource_id": "550e8400-e29b-41d4-a716-446655440001",
    "type": 1,
    "size": 1260,
    "resource_name": "my-bot",
    "created_at": "2026-09-16T15:00:00.000Z",
    "expires_at": "2026-10-16T15:00:00.000Z"
  }
}
```

### 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.
* `PLAN_NOT_ALLOWED`: o plano da conta não inclui snapshots manuais (`403`).
* `DATABASE_NOT_RUNNING`: o banco de dados precisa estar em execução para gerar um snapshot (`409`). O Redis não tem essa exigência.
* `SNAPSHOT_RATE_LIMITED`: o recurso recebeu um snapshot há menos de 5 minutos, ou a conta já criou 10 snapshots nesta hora (`429`). Vem com `details.scope` e `details.retry_after`.
* `OPERATION_IN_PROGRESS`: outra operação de ciclo de vida no mesmo recurso já está em execução (`409`). Nenhum snapshot foi feito — aguarde alguns segundos e tente de novo.
* `INTERNAL_SERVER_ERROR`: o snapshot não pôde ser armazenado, ou ocorreu uma falha inesperada (`500`). Tente de novo mais tarde.

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

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

```json Error Response (429) theme={null}
{
  "code": "SNAPSHOT_RATE_LIMITED",
  "details": {
    "scope": "resource",
    "retry_after": 212
  }
}
```

```json Error Response (409) theme={null}
{
  "code": "OPERATION_IN_PROGRESS"
}
```

```json Error Response (409) theme={null}
{
  "code": "DATABASE_NOT_RUNNING"
}
```


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