Definir o endereço da app web
Define o endereço da app web do espaço de trabalho, substituindo o que tivesse, e devolve-o com o registo CNAME a publicar.
Executa a chamada real no seu espaço de trabalho.
PUT /app-host
Define o endereço da app web do espaço de trabalho, substituindo o que tivesse, e devolve-o com o registo CNAME a publicar.
O pedido
Parâmetros
hoststringobrigatório- Um subdomínio de um domínio verificado deste espaço de trabalho, como `mailbox.acme.com`, com 253 caracteres no máximo. É convertido em minúsculas, e um prefixo `https://`, um caminho e um ponto final são removidos. O próprio domínio não pode ser usado.
Exemplo
Requer domains:write, um plano pago e uma chave sem restrição de endereço ou domínio.
curl -X PUT "$OE/app-host" -H "$AUTH" -H "Content-Type: application/json" \ -d '{ "host": "mailbox.acme.com" }'{ "object": "app_host", "id": "ahost_3f9c2a71d0b84e56a1c7f2e9", "host": "mailbox.acme.com", "domainId": "b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f", "domain": "acme.com", "status": "pending", "active": false, "paused": false, "target": "cname.openemail.uk", "record": { "type": "CNAME", "name": "mailbox.acme.com", "value": "cname.openemail.uk" }, "error": null, "checkedAt": "2026-10-01T09:12:30.000Z", "verifiedAt": null, "available": true, "paidPlan": true, "domains": ["acme.com"], "suggested": "mailbox.acme.com"}O endereço começa como pending. Publique record no seu fornecedor de DNS exatamente como é dado e depois consulte GET /app-host periodicamente ou chame POST /app-host/verify. Fica ativo alguns minutos depois de o registo responder, assim que o seu certificado for emitido.
Definir o endereço que já tem não altera nada e volta a verificá-lo. Um endereço noutro domínio substitui o antigo assim que estiver configurado, e um no mesmo domínio substitui-o de imediato. Todas as sessões iniciadas num endereço substituído são terminadas.
Um espaço de trabalho no plano gratuito responde 403 plan_required. Um endereço fora dos domínios do espaço de trabalho responde 422 invalid_app_host, um num domínio não verificado 409 domain_not_verified, e um que outro espaço de trabalho usa 409 app_host_in_use.
