Tools de Vercel
Las 13 operaciones de Vercel que tu producto ejecuta en la cuenta de tu cliente con Connect. Todas usan el mismo endpoint, POST /api/tools/{tool}/execute.
- Listar equiposGETLista los equipos a los que pertenece la cuenta. Cada elemento tiene id, el teamId que usan las otras tools, y slug. Solo un token de Full Account necesita teamId: un token creado para un equipo ya actúa en ese equipo. Pagina pasando pagination.next de la respuesta como until.
- Listar proyectosGETLista los proyectos de la cuenta o de un equipo, con sus ajustes, vínculo con Git y últimos deployments. Cada elemento tiene id y name, que las otras tools usan como el proyecto. Pagina pasando pagination.next de la respuesta como from.
- Crear proyectoPOSTCrea un proyecto y lo devuelve, con su id. Con gitRepository, cada push al repositorio hace deploy automáticamente; la app de Vercel del proveedor Git debe tener acceso al repositorio. Los ajustes de build omitidos los detecta Vercel.
- Actualizar proyectoPATCHCambia el nombre o los ajustes de build de un proyecto y lo devuelve. Solo cambian los campos enviados. Los nuevos ajustes se aplican desde el próximo deployment.
- Listar deploymentsGETLista deployments, del más nuevo al más antiguo, con state, target, url y metadatos de Git. Cada elemento tiene uid, el id del deployment. Pagina pasando pagination.next de la respuesta como until.
- Obtener deploymentGETDevuelve un deployment por su id o su url, con readyState, target, alias, projectId y, para un build fallido, errorCode y errorMessage.
- Crear deploymentPOSTInicia un deployment y lo devuelve, con id, url y readyState. Envía deploymentId para volver a desplegar un deployment existente, o gitSource para desplegar una rama o commit del repositorio conectado. Sin target es un preview; production lo convierte en el deployment de producción. El build tarda minutos: síguelo con Get deployment.
- Cancelar deploymentPATCHDetiene un deployment que sigue en cola o en build y lo devuelve con readyState CANCELED.
- Promover deploymentPOSTApunta los dominios de producción de un proyecto a un deployment existente, sin volver a hacer el build, por ejemplo para revertir la producción a un deployment de producción anterior. Para poner un preview en producción con un nuevo build, usa Create deployment con su deploymentId y target production. Responde 201 o 202 cuando se acepta.
- Listar eventos del deploymentGETDevuelve el log de build de un deployment como una lista de eventos, cada uno con type (como stdout, stderr o command), created y el texto de la línea. Úsalo para ver por qué falló un build.
- Listar dominios del proyectoGETLista los dominios de un proyecto, con verified, la redirección y la rama de Git de cada uno. Pagina pasando pagination.next de la respuesta como until.
- Agregar dominio al proyectoPOSTAgrega un dominio a un proyecto y lo devuelve con verified. Después apunta el DNS del dominio a Vercel, como muestra Get domain config. Con verified false, el dominio está en uso en otro lugar: crea el registro TXT listado en verification y verifícalo en el panel de Vercel. Un dominio que ya está en el proyecto responde 400.
- Obtener config del dominioGETIndica si el DNS de un dominio apunta a Vercel: misconfigured, configuredBy y los valores recommendedIPv4 y recommendedCNAME a configurar en el proveedor de DNS.
Toolkits de la misma categoría
Ver los 100 toolkitsMira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
