Get full step output from instance

GET/accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/step

Retrieves the full, untruncated output for a specific step on a workflow instance. Returns a flat status-shaped JSON body with step status (‘running’ | ‘waiting’ | ‘complete’ | ‘errored’), error (nullable), and output (the step value, or null while running/waiting/errored). When the step returned a ReadableStream from step.do, the response is served as ‘application/octet-stream’ with the raw bytes as the body instead of JSON. A status='running' response with non-null error indicates the step is currently retrying after a prior attempt failed.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Workers Tail ReadWorkers Scripts WriteWorkers Scripts Read

Path ParametersExpand Collapse

account_id: string

workflow_name: string

maxLength64

minLength1

instance_id: string

maxLength100

minLength1

Query ParametersExpand Collapse

Exact step name from the instance logs response, including the generated counter suffix.

minLength1

type: "step" or "waitForEvent"

Step type to disambiguate step.do and waitForEvent entries that share the same name.

One of the following:

"step"

"waitForEvent"

attempt: optional number

Specific attempt number to retrieve output or error for.

exclusiveMinimum

minimum0

ReturnsExpand Collapse

errors: array of object { code, message }

code: number

message: string

messages: array of object { code, message }

code: number

message: string

result: object { error, status, output }

error: object { message, name }

Error details when status=‘errored’; null otherwise.

message: string

status: "queued" or "running" or "paused" or 6 more

One of the following:

"queued"

"running"

"paused"

"errored"

"terminated"

"complete"

"waitingForPause"

"waiting"

"rollingBack"

output: optional unknown

Full step output or waitForEvent payload without truncation. Sensitive outputs are returned as ‘[REDACTED]’. Populated when status=‘complete’. May be a ReadableStream when the step returned one from step.do; stream outputs are served as application/octet-stream rather than JSON.

success: true

result_info: optional object { count, per_page, total_count, 3 more }

per_page: number

total_count: number

cursor: optional string

page: optional number

total_pages: optional number

Get full step output from instance

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/workflows/$WORKFLOW_NAME/instances/$INSTANCE_ID/step \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

{
  "errors": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "result": {
    "error": {
      "message": "message",
      "name": "name"
    },
    "status": "queued",
    "output": {}
  },
  "success": true,
  "result_info": {
    "count": 0,
    "per_page": 0,
    "total_count": 0,
    "cursor": "cursor",
    "page": 0,
    "total_pages": 0
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "result": {
    "error": {
      "message": "message",
      "name": "name"
    },
    "status": "queued",
    "output": {}
  },
  "success": true,
  "result_info": {
    "count": 0,
    "per_page": 0,
    "total_count": 0,
    "cursor": "cursor",
    "page": 0,
    "total_pages": 0
  }
}