Referência da API

Deployments

Faz deploy, rollback, verifica status e gere deployments de projeto.

Última atualização:

API de Deployments

Gere os deployments dos teus projetos.

Publicar / Republicar

POST /api/v1/projects/{projectId}/deploy

Corpo do Pedido (opcional):

{ "startOver": false }

Desencadeia um novo deployment. Para deployments falhados, o sistema tenta automaticamente a partir do passo que falhou. DefinestartOver: true para ignorar a deteção de retry e executar o pipeline completo desde o início.

Resposta:

{
  "data": {
    "id": "deployment-uuid",
    "version": 3,
    "status": "queued",
    "isRetry": false,
    "queuePriority": 2
  }
}

Verificar Estado do Deployment

GET /api/v1/projects/{projectId}/status

Devolve o progresso do deployment em tempo real. Faz polling a este endpoint para acompanhar o estado do deployment.

{
  "data": {
    "step": 3,
    "totalSteps": 6,
    "status": "in_progress",
    "message": "Building your app...",
    "progress": 50
  }
}

Estados possíveis: queued, in_progress, completed, failed, cancelled

Rollback

POST /api/v1/projects/{projectId}/rollback
{ "targetDeploymentId": "deployment-uuid" }

Reverte um projeto para um deployment anterior bem-sucedido. O deployment alvo deve ter o estado completed.

Cancelar Deployment

POST /api/v1/projects/{projectId}/cancel

Cancela um deployment em curso e repõe o projeto no estado de rascunho. Funciona apenas quando o estado do projeto é queued,generating ou deploying.

Reativar Projeto

POST /api/v1/projects/{projectId}/reactivate

Reativa um projeto suspenso, criando um novo deployment a partir do repositório de código preservado. Custa 1 crédito.

AnteriorProjetosSeguinteDomínios Personalizados