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

# Excluir imagem

> Exclui uma imagem, as suas versões, o seu contexto e todas as aplicações criadas a partir dela.

> [!WARNING]
>
> Excluir uma imagem **também exclui todas as aplicações criadas a partir dela**. Cada aplicação segue as regras habituais de exclusão de uma aplicação, incluindo o snapshot de segurança nos planos que o têm.

Exige o escopo `images:delete` quando chamada com uma chave de API; `images:write` não o cobre. Quando a imagem tem aplicações, a chave também precisa do escopo `apps:delete`, pois elas também são excluídas. Sem ele, a chamada falha com `API_KEY_SCOPE_DENIED` e `details.required` com o valor `apps:delete`. A exclusão é recusada enquanto um build está em execução, e é permitida em planos que já não podem criar imagens.

**image\_id** `string` *required*

O ID da imagem.

**workspace\_id** `string`

Se a imagem pertencer a um workspace, o ID do workspace. Obrigatório para membros do workspace que atuam sobre uma imagem que não lhes pertence.

**confirm\_name** `string` *required*

Deve ser igual ao nome da imagem.

### Resposta

**response** `object`

**Mostrar objeto**

**deleted\_apps** `string[]`

Os IDs das aplicações excluídas junto com a imagem.

```json Response theme={null}
{
  "response": {
    "deleted_apps": ["app-abc123def456"]
  }
}
```

### Respostas de erro

**code** `string`

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

* `API_KEY_SCOPE_DENIED`: A chave de API não tem o escopo `images:delete`, ou a imagem tem aplicações e a chave não tem o escopo `apps:delete`. `details.required` informa o escopo que falta (`403`).
* `IMAGE_NOT_FOUND`: A imagem não existe ou você não tem acesso a ela (`404`).
* `IMAGE_NAME_MISMATCH`: `confirm_name` não é o nome da imagem (`400`).
* `IMAGE_BUILD_IN_PROGRESS`: Um build está em execução; aguarde o fim dele (`409`).
* `INTERNAL_SERVER_ERROR`: Falha inesperada (`500`).

```json Error Response theme={null}
{
  "code": "IMAGE_NAME_MISMATCH"
}
```


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