Pular para o conteúdo principal
PATCH
Alterar subdomínio da aplicação
string
obrigatório
O ID da aplicação.
string
Se a aplicação pertencer a um workspace, o ID do workspace. Obrigatório para membros do workspace que agem sobre uma aplicação que não lhes pertence.
string
obrigatório
O novo subdomínio, sem o sufixo .vertraweb.app (por exemplo, myapp). Entre 3 e 50 caracteres, seguindo ^[a-z0-9][a-z0-9-]*[a-z0-9]$ — letras minúsculas, dígitos e hífens, sem nunca começar ou terminar com hífen.

Resposta

object
Esta rota apenas renomeia um subdomínio existente. Uma aplicação criada sem publicação na web responde APP_HAS_NO_SUBDOMAIN — ligue a publicação primeiro com Publicar aplicação na web.
O subdomínio anterior é liberado no momento em que a mudança é concluída. Ele não fica reservado para você, e qualquer pessoa pode pegá-lo depois.

Respostas de erro

string
O código de erro que indica o motivo da falha. Valores possíveis:
  • VALIDATION_ERROR: o path parameter ou o body falhou na validação (400). A resposta também traz message e path.
  • AUTH_TOKEN_MISSING, API_KEY_INVALID, SESSION_REVOKED: o header Authorization está ausente, a chave de API é inválida ou a sessão do painel foi revogada (401).
  • API_KEY_IP_DENIED, API_KEY_SCOPE_DENIED: a chave de API é usada a partir de um IP fora da sua allowlist, ou não tem o escopo que a rota exige (403).
  • USER_NOT_FOUND: o usuário autenticado não pôde ser identificado (401).
  • ACCESS_DENIED: o usuário não tem permissão para agir sobre a aplicação (403).
  • PLAN_DOES_NOT_SUPPORT_CUSTOM_SUBDOMAIN: o plano do dono não permite escolher o nome do subdomínio (403).
  • APP_NOT_FOUND: a aplicação informada não existe (404).
  • APP_HAS_NO_SUBDOMAIN: a aplicação não está publicada na web, então não há nada a renomear (400).
  • INVALID_SUBDOMAIN_FORMAT: o valor não é um subdomínio válido depois da normalização (400).
  • SUBDOMAIN_FORBIDDEN: o subdomínio pedido está na lista de nomes reservados da plataforma (400).
  • SUBDOMAIN_TAKEN: outra aplicação já usa esse subdomínio (409).
  • SUBDOMAIN_CHANGE_RATE_LIMITED: o subdomínio desta aplicação foi alterado há menos de 5 minutos (429).
  • INTERNAL_SERVER_ERROR: falha inesperada (500).
string
Uma mensagem descritiva com detalhes adicionais sobre o erro.
Esta rota tem orçamento próprio de 5 requisições por minuto, além do cooldown de 5 minutos entre alterações do endereço público de uma aplicação. Esse cooldown é compartilhado com a Publicar: publicar uma aplicação também a inicia, e despublicar e publicar de novo com outro nome não contorna o limite. Veja Limite de requisições.
Última modificação em 28 de outubro de 2026