# Configurar proxy da instância

`POST /instance/proxy`

Pasta: **Proxy**

## Autenticação

```http
token: {{token}}
```

## Descrição

# Configurar proxy da instância

Define o modo de proxy da instância e, se necessário, a URL customizada. Após salvar, a API valida o alcance ao WhatsApp e pode solicitar restart da conexão.

## Endpoint

`POST {{baseUrl}}/instance/proxy`

## Autenticação

Envie o token da instância no header `token: {{token}}`.

## Corpo da requisição

| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| `mode` | string | Não | `dynamic` (padrão), `global`, `custom` ou `managed`. |
| `proxy_url` / `url` | string | Condicional | URL do proxy. Obrigatória quando `mode` é `custom`. |
| `enabled` | boolean | Não | Liga/desliga o uso de proxy. |

## Exemplo de Requisição

```bash
curl --request POST '{{baseUrl}}/instance/proxy' \
  --header 'token: {{token}}' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "mode": "dynamic",
  "enabled": true
}'
```

## Resposta de Sucesso

```json
{
  "success": true,
  "proxy": {
    "mode": "dynamic",
    "enabled": true
  },
  "restart_requested": true
}
```

## Erros comuns

- `401 Unauthorized`: header `token` ausente ou inválido.
- `400 Bad Request`: modo inválido, `proxy_url` ausente em `custom`, proxy global não configurado no servidor, ou validação de alcance ao WhatsApp falhou.
- `500 Internal Server Error`: falha ao persistir ou reiniciar a sessão.

## Observações

- Modos: `dynamic` (WARP/egress gerenciado), `global` (PROXY_URL do servidor), `custom` (sua URL), `managed`.
- A resposta pode incluir `restart_error` se o restart automático falhar.

## Corpo (exemplo)

```json
{
  "mode": "dynamic",
  "enabled": true
}
```

## cURL

```bash
curl -X POST "{{baseUrl}}/instance/proxy" \
  -H "token: {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "mode": "dynamic",
  "enabled": true
}'
```

---

[Índice da pasta](./index.md) · [Índice geral](../index.md) · [UI](https://gozap.dev/docs?op=proxy/configurar-proxy-da-instancia)