Skip to content
Mintlify
Mintlify
Administración

Activar implementación de vista previa

POST/project/preview/{projectId}

Usa este endpoint para crear o actualizar de forma programática una implementación de vista previa para una rama de Git. Si ya existe una vista previa para la rama especificada, el endpoint activa una reimplementación en lugar de crear un duplicado.

La respuesta incluye un statusId que puedes pasar a Get deployment status para rastrear el progreso de la implementación.

La branch debe existir en el repositorio conectado a tu proyecto de Mintlify. Las ramas de forks no son compatibles. La aplicación de GitHub de Mintlify debe estar instalada en un repositorio para generar una vista previa, por lo que no puede generar vistas previas a partir de ramas de forks. Consulta Solicitudes de extracción de forks para saber cómo previsualizar cambios de un fork.

  • Pipelines CI/CD: Crea automáticamente implementaciones de vista previa cuando se abren o actualizan solicitudes de extracción.
  • Vistas previas programadas: Genera vistas previas de ramas de funcionalidades de larga duración de forma programada.
  • Herramientas personalizadas: Integra la creación de vistas previas en flujos de trabajo internos o bots de Slack.

Las vistas previas creadas con este endpoint son accesibles públicamente a menos que habilites la autenticación para tus vistas previas, lo cual se aplica a todas las vistas previas de tu implementación. No puedes proteger con contraseña una vista previa individual a través de este endpoint. Consulta Restringir el acceso a las implementaciones de vista previa.

Este endpoint permite hasta 5 solicitudes por minuto por organización.

Was this page helpful?Suggest editsRaise issue