latestSwagger 2.02026-08-1095121164.0 KB

94758829689e

sites

Get Workflow Status

Retrieves the current status of a workflow. Useful for polling workflow progress until completion.

get/v0/sites/{site_id}/workflows/{workflow_id}

Path parameters

site_idstring required

Site UUID

workflow_idstring required

Workflow ID

Response

active_descriptionstring

Active description of current workflow step

result'succeeded' | 'failed' | 'running'

Workflow result status

stepinteger

Current step number in workflow execution

Example response

{
  "active_description": "Backing up database",
  "final_task": {
    "messages": {
      "location": {
        "level": "info",
        "message": "/backups/archive_123.tar.gz"
      },
      "success": {
        "level": "info",
        "message": "Database backup created"
      }
    },
    "reason": "Backup completed successfully"
  },
  "operations": [
    {
      "description": "Deploy pantheon.yml",
      "id": "op-12345678-90ab-cdef-1234-567890abcdef",
      "log_output": "Successfully deployed configuration",
      "result": "succeeded",
      "run_time": 12.34,
      "type": "platform"
    }
  ],
  "result": "succeeded",
  "step": 3
}