Pular para o conteúdo principal

Como é um erro?

Todo erro usa o mesmo envelope, descrito na introdução da API. O status HTTP indica a categoria, code é uma string estável, segura para usar em condicionais, e details — quando presente — traz os números necessários para agir (um limite, um tempo de espera, o escopo que falta).
message é para humanos e pode mudar; nunca tome decisões no seu código com base nela. Para problemas de deploy e de execução que não vêm da própria API (loops de falha, dependências ausentes, OOMKilled), veja Erros comuns — esta página cobre apenas os valores code estáveis com que a API responde.
VALIDATION_ERROR (400) cobre problemas de formato da requisição em todas as rotas — um campo obrigatório ausente, o tipo errado, um valor fora da faixa. details.path indica o campo com problema, por exemplo "memory" ou "user.name".

Autenticação e chaves de API

Planos e cobrança

Aplicações

Códigos de falha de build

Quando um build ou uma instalação falha, GET /v1/apps/{id} retorna o código em last_build_error (null após um build bem-sucedido); o detalhe está nos logs da aplicação.

Deploy e GitHub

Arquivos

Blob Storage

Códigos reaproveitados: VALIDATION_ERROR, PLAN_RESTRICTED_FEATURE, RATE_LIMIT_EXCEEDED (com retry_after; também usado para o limite de um upload por segundo abaixo do Enterprise-12), API_KEY_SCOPE_DENIED, WORKSPACE_PERMISSION_DENIED e INVALID_CUSTOM_DOMAIN_FORMAT.

Rede e domínios

Bancos de dados

Variáveis de ambiente

Snapshots

Imagens Docker personalizadas

Veja Imagens Docker personalizadas.

Templates

O deploy de um template é assíncrono; as falhas chegam no job de deploy e nos seus eventos. Veja Erros de template.

Stacks

Alterações que podem mudar variáveis ou certificados retornam restart_required e apps_to_restart: veja Criar stack.

Workspaces

Limites de taxa e cotas

Veja limites de taxa para o detalhamento completo dos orçamentos por plano.

Geral

Este catálogo lista todos os códigos do contrato público da API. Uma rota ainda pode responder outros erros HTTP padrão (como um 404 genérico para um caminho desconhecido) que não trazem nenhum destes valores de code.
Última modificação em 30 de outubro de 2026