api.GetDeploymentResponse

deployment object

from_versioninteger

Version tracking

idstring

Identity

job_idstring

job_typestring

namespacestring

spec object

Configuration

auto_promoteboolean

Auto-promote canary deployments

canary_countinteger

Canary-specific settings

canary_percentinteger

Percentage of canary nodes

health_check object

HealthCheck defines health check configuration (required for rolling/canary, ignored for immediate)

deadlinestring

Deadline is the maximum time to wait for an execution to become healthy (required) Example: "5m", "30s"

max_error_ratenumber

MaxErrorRate is the maximum error rate allowed during health checks (optional, default: 0.10) Example: 0.10 = 10% error rate

min_healthy_timestring

MinHealthyTime is the minimum continuous healthy duration required (optional, default: "30s") Example: "30s", "1m"

max_failed_nodesinteger

MaxFailedNodes is the maximum number of failed nodes before stopping (optional, default: 10)

max_failed_nodes_percentnumber

MaxFailedNodesPercent is the maximum percentage of failed nodes before stopping (optional, default: 10.0)

max_parallelinteger

MaxParallel is the maximum number of nodes to update in parallel (0 = all at once)

no_auto_rollbackboolean

NoAutoRollback disables automatic rollback on deployment failure (default: false = auto-rollback enabled)

strategytypes.DeploymentStrategyType (string)

Strategy: immediate|rolling|canary

Possible values: [immediate, rolling, canary]

status object

System-managed status

canary_nodesstring[]

Canary tracking (runtime state)

canary_promotedboolean

completed_atstring

created_atstring

Timestamps

current_waveinteger

failed_nodesinteger

health_check_deadlinestring

healthy_deadlinestring

last_progress_timestring

Health tracking

messagestring

revisioninteger

Change tracking Revision is incremented on any change to the deployment (progress updates, state changes, etc.)

statetypes.DeploymentStateType (string)

Current state

Possible values: [pending, in_progress, paused, completed, failed, canceled]

total_nodesinteger

Progress tracking

updated_atstring

updated_nodesinteger

to_versioninteger

typetypes.DeploymentType (string)

create, update, restart, rollback, stop

Possible values: [create, update, restart, rollback, stop]

api.GetDeploymentResponse

{
  "deployment": {
    "from_version": 0,
    "id": "string",
    "job_id": "string",
    "job_type": "string",
    "namespace": "string",
    "spec": {
      "auto_promote": true,
      "canary_count": 0,
      "canary_percent": 0,
      "health_check": {
        "deadline": "string",
        "max_error_rate": 0,
        "min_healthy_time": "string"
      },
      "max_failed_nodes": 0,
      "max_failed_nodes_percent": 0,
      "max_parallel": 0,
      "no_auto_rollback": true,
      "strategy": "immediate"
    },
    "status": {
      "canary_nodes": [
        "string"
      ],
      "canary_promoted": true,
      "completed_at": "string",
      "created_at": "string",
      "current_wave": 0,
      "failed_nodes": 0,
      "health_check_deadline": "string",
      "healthy_deadline": "string",
      "last_progress_time": "string",
      "message": "string",
      "revision": 0,
      "state": "pending",
      "total_nodes": 0,
      "updated_at": "string",
      "updated_nodes": 0
    },
    "to_version": 0,
    "type": "create"
  }
}