Dokumentacja API

Wdrożenia

Wdrażaj, cofaj, sprawdzaj status i zarządzaj wdrożeniami projektu.

Ostatnia aktualizacja:

API wdrożeń

Zarządzaj wdrożeniami swoich projektów.

Wdrożenie / ponowne wdrożenie

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

Treść żądania (opcjonalna):

{ "startOver": false }

Uruchamia nowe wdrożenie. W przypadku nieudanych wdrożeń system automatycznie ponawia próbę od kroku, który się nie powiódł. Ustaw startOver: true, aby pominąć wykrywanie ponowień i uruchomić pełny potok od początku.

Odpowiedź:

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

Sprawdzanie statusu wdrożenia

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

Zwraca postęp wdrożenia w czasie rzeczywistym. Odpytuj ten punkt końcowy, aby śledzić status wdrożenia.

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

Możliwe statusy: queued, in_progress, completed, failed, cancelled

Cofanie wdrożenia

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

Przywraca projekt do poprzedniego pomyślnego wdrożenia. Docelowe wdrożenie musi mieć status completed.

Anulowanie wdrożenia

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

Anuluje trwające wdrożenie i resetuje projekt do statusu roboczego. Działa tylko wtedy, gdy status projektu to queued, generatinglub deploying.

Reaktywacja projektu

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

Reaktywuje zawieszony projekt, tworząc nowe wdrożenie z zachowanego repozytorium kodu. Kosztuje 1 kredyt.