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

# Limpar cache

> Limpa o cache do subdomínio ou dos domínios personalizados de uma aplicação, opcionalmente só para caminhos específicos.

**id** `string` *required*

O ID da aplicação cujo cache será limpo.

**hostnames** `array`

Os hostnames a limpar. **Opcional** — omita (um body vazio também serve) e todos os hostnames que a
aplicação possui são limpos, que é o que um simples "limpar o cache desta aplicação" quer. Quando você envia
o campo, cada item precisa ser um hostname da própria aplicação: o seu `subdomain`, que já é um host
completo (`myapp.vertraweb.app` — não acrescente a zona de novo), ou o hostname de um dos seus domínios personalizados.
Qualquer outra coisa é rejeitada com `INVALID_HOSTNAME_FOR_APP`.

**paths** `array`

Um array opcional de URLs completas a limpar (por exemplo, `["https://example.com/path1", "https://example.com/path2"]`).
URLs cujo host não está entre os hostnames a limpar são descartadas; se nada sobrar, a
requisição falha com `NO_AUTHORIZED_PATHS`. Se omitido, tudo sob cada hostname é limpo.

### Resposta

Em caso de sucesso, retorna `200` com `{ "response": null }`.

```json Response theme={null}
{
  "response": null
}
```

### Respostas de erro

**code** `string`

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

* `VALIDATION_ERROR`: o path parameter ou o body falhou na validação (`400`). A resposta
  também traz `message` e `path`.
* `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 pôde ser identificado (`401`).
* `ACCESS_DENIED`: o usuário não tem permissão para agir sobre a aplicação (`403`).
* `INVALID_HOSTNAME_FOR_APP`: um dos `hostnames` não pertence à aplicação (`403`).
* `APP_NOT_FOUND`: a aplicação informada não existe (`404`).
* `APP_NOT_PUBLISHED`: a aplicação não tem subdomínio nem domínio personalizado, então não há cache de borda
  para limpar (`400`).
* `NO_AUTHORIZED_PATHS`: nenhum dos `paths` enviados pertence aos hostnames informados (`400`).
* `INTERNAL_SERVER_ERROR`: a CDN rejeitou a limpeza, ou ocorreu uma falha inesperada (`500`).

**message** `string`

Uma mensagem descritiva com detalhes adicionais sobre o erro.

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

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

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

> [!NOTE]
>
> Esta rota tem orçamento próprio de 10 requisições por minuto. Veja [Limite de requisições](https://docs.vertracloud.app/pt-br/api-reference/introduction.md#como-a-api-tem-limite-de-taxa).


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