Deployments API

Trigger and manage deployments.

List Deployments

GET /api/v1/deployments

Query Parameters

Parameter	Type	Description
service	string	Filter by service
status	string	Filter by status (pending, running, success, failed)
from	string	Start date
to	string	End date

Response

{
  "data": [
    {
      "id": "dpl_abc123",
      "service": "api-gateway",
      "version": "v2.4.1",
      "status": "success",
      "strategy": "rolling",
      "started_at": "2025-01-15T10:00:00Z",
      "completed_at": "2025-01-15T10:05:00Z",
      "triggered_by": "john@example.com"
    }
  ]
}

Get Deployment

GET /api/v1/deployments/:id

Trigger Deployment

POST /api/v1/deployments

Request Body

{
  "service": "api-gateway",
  "version": "v2.4.1",
  "strategy": "rolling",
  "options": {
    "max_unavailable": 1,
    "health_check_timeout": "60s"
  }
}

Deployment Strategies

Strategy	Description
rolling	Gradual replacement of instances
blue-green	Switch traffic to new version
canary	Gradual traffic shift (10%, 50%, 100%)
recreate	Stop all, then start new

Response

{
  "data": {
    "id": "dpl_xyz789",
    "service": "api-gateway",
    "version": "v2.4.1",
    "status": "pending",
    "started_at": "2025-01-15T10:00:00Z"
  }
}

Rollback Deployment

POST /api/v1/deployments/:id/rollback

Or rollback to specific version:

{
  "target_version": "v2.4.0"
}

Cancel Deployment

POST /api/v1/deployments/:id/cancel

Deployment Logs

GET /api/v1/deployments/:id/logs

{
  "data": {
    "logs": [
      { "timestamp": "2025-01-15T10:00:00Z", "message": "Starting deployment..." },
      { "timestamp": "2025-01-15T10:00:05Z", "message": "Pulling image v2.4.1..." },
      { "timestamp": "2025-01-15T10:00:30Z", "message": "Starting new instances..." }
    ]
  }
}