Cloudflare API | Workflows › List All Workflows

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/workflows \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"

200Example

{
  "errors": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "result": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "class_name": "class_name",
      "created_on": "2019-12-27T18:11:19.117Z",
      "instances": {
        "complete": 0,
        "errored": 0,
        "paused": 0,
        "queued": 0,
        "running": 0,
        "terminated": 0,
        "unknown": 0,
        "waiting": 0,
        "waitingForPause": 0
      },
      "modified_on": "2019-12-27T18:11:19.117Z",
      "name": "x",
      "script_name": "script_name",
      "triggered_on": "2019-12-27T18:11:19.117Z"
    }
  ],
  "success": true,
  "result_info": {
    "count": 0,
    "page": 0,
    "per_page": 0,
    "total_count": 0
  }
}

Create Modify Workflow -> Envelope<{ id, class_name, created_on, 5 more... }>

put/accounts/{account_id}/workflows/{workflow_name}

Create/modify Workflow

Workflows

Instances

workflows.instances

Methods

Create A New Workflow Instance -> Envelope<{ id, status, version_id, 1 more... }>

post/accounts/{account_id}/workflows/{workflow_name}/instances

Create a new workflow instance

Get Logs And Status From Instance -> Envelope<{ end, error, output, 8 more... }>

get/accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}

Get logs and status from instance

List Of Workflow Instances -> V4PagePaginationArray<{ id, created_on, ended_on, 5 more... }>

get/accounts/{account_id}/workflows/{workflow_name}/instances

List of workflow instances

Workflows Instances

Status

workflows.instances.status

Methods

Change Status Of Instance -> Envelope<{ status, timestamp }>

patch/accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/status

Change status of instance

Workflows

Versions

workflows.versions

Methods

Get Workflow Version Details -> Envelope<{ id, class_name, created_on, 2 more... }>

get/accounts/{account_id}/workflows/{workflow_name}/versions/{version_id}

Get Workflow version details

List Deployed Workflow Versions -> V4PagePaginationArray<{ id, class_name, created_on, 2 more... }>

get/accounts/{account_id}/workflows/{workflow_name}/versions

List deployed Workflow versions