API リファレンス

デプロイメント

プロジェクトのデプロイ、ロールバック、ステータス確認、デプロイメントの管理。

最終更新:

Deployment API

プロジェクトのデプロイを管理します。

デプロイ / 再デプロイ

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

リクエストボディ(任意):

{ "startOver": false }

新しいデプロイをトリガーします。失敗したデプロイの場合、システムは失敗したステップから自動的に再試行します。startOver: true を設定すると再試行検出をスキップし、パイプライン全体を最初から実行します。

レスポンス:

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

デプロイステータスの確認

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

リアルタイムのデプロイ進捗を返します。このエンドポイントをポーリングしてデプロイステータスを追跡します。

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

使用可能なステータス: queued, in_progress, completed, failed, cancelled

ロールバック

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

プロジェクトを以前の成功したデプロイに戻します。対象のデプロイのステータスは completed である必要があります。

デプロイのキャンセル

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

進行中のデプロイをキャンセルし、プロジェクトをドラフトステータスにリセットします。 プロジェクトのステータスが queuedgenerating、または deploying の場合にのみ機能します。

プロジェクトの再アクティブ化

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

保存されたコードリポジトリから新しいデプロイを作成することで、停止したプロジェクトを再アクティブ化します。1 クレジットを消費します。