Tools do Vercel
As 13 operações do Vercel que o seu produto executa na conta do cliente pelo Connect. Todas usam o mesmo endpoint, POST /api/tools/{tool}/execute.
- Listar timesGETLista os times a que a conta pertence. Cada item tem id, o teamId que as outras tools usam, e slug. Só um token de Full Account precisa de teamId: um token criado para um time já atua nesse time. Pagine passando pagination.next da resposta como until.
- Listar projetosGETLista os projetos da conta ou de um time, com suas configurações, vínculo com Git e últimos deployments. Cada item tem id e name, que as outras tools usam como o projeto. Pagine passando pagination.next da resposta como from.
- Criar projetoPOSTCria um projeto e o retorna, com seu id. Com gitRepository, cada push no repositório faz deploy automaticamente; o app da Vercel do provedor Git precisa ter acesso ao repositório. Configurações de build omitidas são detectadas pela Vercel.
- Atualizar projetoPATCHAltera o nome ou as configurações de build de um projeto e o retorna. Só os campos enviados mudam. As novas configurações valem a partir do próximo deployment.
- Listar deploymentsGETLista deployments, do mais novo ao mais antigo, com state, target, url e metadados do Git. Cada item tem uid, o id do deployment. Pagine passando pagination.next da resposta como until.
- Obter deploymentGETRetorna um deployment pelo id ou pela url, com readyState, target, alias, projectId e, para um build que falhou, errorCode e errorMessage.
- Criar deploymentPOSTInicia um deployment e o retorna, com id, url e readyState. Envie deploymentId para refazer o deploy de um deployment existente, ou gitSource para fazer deploy de um branch ou commit do repositório conectado. Sem target é um preview; production o torna o deployment de produção. O build leva minutos: acompanhe com Get deployment.
- Cancelar deploymentPATCHInterrompe um deployment ainda na fila ou em build e o retorna com readyState CANCELED.
- Promover deploymentPOSTAponta os domínios de produção de um projeto para um deployment existente, sem fazer o build de novo, como para reverter a produção a um deployment de produção mais antigo. Para colocar um preview em produção com um novo build, use Create deployment com seu deploymentId e target production. Responde 201 ou 202 quando aceito.
- Listar eventos do deploymentGETRetorna o log de build de um deployment como uma lista de eventos, cada um com type (como stdout, stderr ou command), created e o texto da linha. Use para ver por que um build falhou.
- Listar domínios do projetoGETLista os domínios de um projeto, com verified, o redirecionamento e o branch do Git de cada um. Pagine passando pagination.next da resposta como until.
- Adicionar domínio ao projetoPOSTAdiciona um domínio a um projeto e o retorna com verified. Depois aponte o DNS do domínio para a Vercel, como Get domain config mostra. Com verified false, o domínio está em uso em outro lugar: crie o registro TXT listado em verification e verifique no painel da Vercel. Um domínio já no projeto responde 400.
- Obter config do domínioGETInforma se o DNS de um domínio aponta para a Vercel: misconfigured, configuredBy e os valores recommendedIPv4 e recommendedCNAME a configurar no provedor de DNS.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
