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

# Configurar domínio automaticamente

> Reservada para a configuração automática de DNS. Ainda não disponível: a rota hoje sempre responde 404 DOMAIN_CONNECT_UNAVAILABLE.

> [!WARNING]
>
> **Ainda não disponível.** A configuração automática de DNS não foi lançada, então hoje esta rota responde
> `404 DOMAIN_CONNECT_UNAVAILABLE` em todas as chamadas. Crie os registros por conta própria com
> [Registros DNS do domínio](https://docs.vertracloud.app/pt-br/api-reference/endpoint/apps/domains/dns.md).

A rota faz parte do contrato da API para que os clientes possam tratá-la. Ela exige o escopo `apps:write` quando
chamada com uma chave de API. O restante desta página descreve o formato da resposta, que nenhuma chamada retorna hoje.

**id** `string` *required*

O ID da aplicação.

**domain\_id** `string` *required*

O ID do domínio, obtido em [Listar domínios da aplicação](https://docs.vertracloud.app/pt-br/api-reference/endpoint/apps/domains/list.md).

**workspace\_id** `string`

Se a aplicação pertencer a um workspace, o ID do workspace. Obrigatório para membros do workspace que atuam em uma aplicação que não é deles.

### Resposta

**response** `APIApplicationDomainConnect`

**Mostrar objeto**

**url** `string`

O link a abrir no provedor de DNS para aprovar os registros.

```json Response theme={null}
{
  "response": {
    "url": "https://dns-provider.example/v2/domainTemplates/providers/..."
  }
}
```

> [!NOTE]
>
> O link é para você abrir, não para chamar. Depois de aprová-lo, o domínio passa para `active` quando o DNS
> propagar; acompanhe com [Listar domínios da aplicação](https://docs.vertracloud.app/pt-br/api-reference/endpoint/apps/domains/list.md).

### Respostas de erro

**code** `string`

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

* `VALIDATION_ERROR`: os parâmetros de caminho falharam na validação (`400`). A resposta também traz `message` e `path`.
* `AUTH_TOKEN_MISSING`, `API_KEY_INVALID`, `SESSION_REVOKED`: o cabeçalho `Authorization` está ausente, a chave de API é inválida ou a sessão do painel foi revogada (`401`).
* `API_KEY_IP_DENIED`: a chave de API está sendo usada a partir de um IP fora da sua lista de permissões (`403`).
* `USER_NOT_FOUND`: não foi possível identificar o usuário autenticado (`401`).
* `ACCESS_DENIED`: o usuário não tem permissão para atuar na aplicação (`403`).
* `API_KEY_SCOPE_DENIED`: a chave de API não tem o escopo `apps:write` (`403`).
* `APP_NOT_FOUND`: a aplicação especificada não existe (`404`).
* `DOMAIN_NOT_FOUND`: a aplicação não tem nenhum domínio com esse ID (`404`).
* `DOMAIN_CONNECT_UNAVAILABLE`: a configuração automática ainda não está disponível, então toda chamada responde este código (`404`). Use os registros manuais.
* `RATE_LIMIT_EXCEEDED`: foi atingido o orçamento de requisições da rota (`429`).
* `INTERNAL_SERVER_ERROR`: falha inesperada (`500`).

```json Error Response (404) theme={null}
{
  "code": "DOMAIN_CONNECT_UNAVAILABLE"
}
```

> [!NOTE]
>
> Esta rota tem um 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.