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

# Lista de erros do Systemplane

> Consulte os tokens de erro que a API administrativa do Systemplane retorna, o status HTTP de cada um e o que fazer a respeito.

**Formato de erro**

A API administrativa do Systemplane retorna erros como um objeto JSON simples, com o media type `application/json`:

<CodeGroup>
  ```json JSON theme={null}
  {
    "code": 404,
    "title": "not_found",
    "message": "key not found"
  }
  ```
</CodeGroup>

Leia esses campos com atenção. O campo `code` guarda o status HTTP como número, não como token de texto. O token legível por máquina fica em `title`. Baseie a lógica em `title`, não em `code`.

**Definições de campo**

* **`code`** – O código de status HTTP, como um número inteiro. Repete o status da resposta.
* **`title`** – Um token curto e legível por máquina para a classe do erro. Use esse valor para tratamento programático.
* **`message`** – Uma descrição legível por humanos do que deu errado.

## Erros do cliente

***

| `title`                     | Descrição                                                                               | Status |
| --------------------------- | --------------------------------------------------------------------------------------- | ------ |
| `bad_request`               | O corpo da requisição está ausente, ilegível ou não tem um campo `value` utilizável.    | 400    |
| `unknown_key`               | A chave não está registrada no catálogo.                                                | 400    |
| `validation_error`          | O valor falha no validador da chave, ou o namespace ou a chave excede o tamanho máximo. | 400    |
| `not_supported`             | A operação não está disponível no modo multi-tenant.                                    | 400    |
| `tenant_connection_missing` | O banco de dados do tenant está ausente no contexto da requisição.                      | 400    |
| `nil_context`               | O contexto da requisição não está disponível.                                           | 400    |
| `forbidden`                 | O autorizador recusou a ação para essa identidade e esse namespace.                     | 403    |
| `not_found`                 | A chave ou entrada de catálogo solicitada não existe.                                   | 404    |

<Note>
  A autenticação roda na aplicação que hospeda a superfície administrativa, antes das rotas de configuração. Uma requisição que falha na autenticação recebe um 401 dessa aplicação host, em seu próprio formato de erro. Consulte a referência de API da aplicação cuja configuração você gerencia.
</Note>

## Erros do servidor

***

| `title`               | Descrição                                                                                                                         | Status |
| --------------------- | --------------------------------------------------------------------------------------------------------------------------------- | ------ |
| `internal_error`      | A requisição falhou dentro do serviço. A mensagem permanece genérica. Tente novamente e, se a falha continuar, contate o suporte. | 500    |
| `service_unavailable` | O armazenamento de configuração não foi iniciado, ou parou. Tente novamente após um curto intervalo.                              | 503    |
