Skip to content
Cloudflare API
Start here
API Reference
Workflows

Instances

List of workflow instances
GET/accounts/{account_id}/workflows/{workflow_name}/instances
Get logs and status from instance
GET/accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}
Create a new workflow instance
POST/accounts/{account_id}/workflows/{workflow_name}/instances
Batch create new Workflow instances
POST/accounts/{account_id}/workflows/{workflow_name}/instances/batch
Get full step output from instance
GET/accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/step
ModelsExpand Collapse
InstanceListResponse object { id, created_on, ended_on, 6 more }
id: string
maxLength100
minLength1
created_on: string
formatdate-time
ended_on: string
formatdate-time
modified_on: string
formatdate-time
started_on: string
formatdate-time
status: "queued" or "running" or "paused" or 6 more
One of the following:
"queued"
"running"
"paused"
"errored"
"terminated"
"complete"
"waitingForPause"
"waiting"
"rollingBack"
version_id: string
formatuuid
workflow_id: string
formatuuid
trigger_source: optional "unknown" or "api" or "binding" or 2 more
One of the following:
"unknown"
"api"
"binding"
"event"
"cron"
InstanceGetResponse object { end, error, output, 11 more }
end: string
formatdate-time
error: object { message, name }
message: string
name: string
output: string or number
One of the following:
string
number
params: unknown
queued: string
formatdate-time
rollback: object { error, outcome }
error: object { message, name }
message: string
name: string
outcome: "complete" or "failed"
One of the following:
"complete"
"failed"
start: string
formatdate-time
status: "queued" or "running" or "paused" or 6 more
One of the following:
"queued"
"running"
"paused"
"errored"
"terminated"
"complete"
"waitingForPause"
"waiting"
"rollingBack"
step_count: number
steps: array of object { attempts, config, end, 5 more } or object { end, error, finished, 3 more } or object { trigger, type } or object { end, error, finished, 5 more }
One of the following:
object { attempts, config, end, 5 more }
attempts: array of object { end, error, start, success }
end: string
formatdate-time
error: object { message, name }
message: string
name: string
start: string
formatdate-time
success: boolean
config: object { retries, timeout, sensitive }
retries: object { delay, limit, backoff }
delay: string or number

Specifies the delay duration. ‘[dynamic]’ indicates the delay is computed by a user-supplied function.

One of the following:
string
number
limit: number
backoff: optional "constant" or "linear" or "exponential"
One of the following:
"constant"
"linear"
"exponential"
timeout: string or number

Specifies the timeout duration.

One of the following:
string
number
sensitive: optional "output"

When set to ‘output’, step output is redacted from log and step output responses.

end: string
formatdate-time
name: string
output: string
start: string
formatdate-time
success: boolean
type: "step" or "rollback"
One of the following:
"step"
"rollback"
object { end, error, finished, 3 more }
end: string
formatdate-time
error: object { message, name }
message: string
name: string
finished: boolean
name: string
start: string
formatdate-time
type: "sleep"
object { trigger, type }
trigger: object { source }
source: string
type: "termination"
object { end, error, finished, 5 more }
end: string
formatdate-time
error: object { message, name }
message: string
name: string
finished: boolean
name: string
start: string
formatdate-time
type: "waitForEvent"
event_type: optional string
output: optional string
success: boolean
trigger: object { source }
source: "unknown" or "api" or "binding" or 2 more
One of the following:
"unknown"
"api"
"binding"
"event"
"cron"
versionId: string
formatuuid
schedule: optional object { cron, scheduledTime }
cron: string
scheduledTime: number
InstanceCreateResponse object { id, status, version_id, 2 more }
id: string
maxLength100
minLength1
status: "queued" or "running" or "paused" or 6 more
One of the following:
"queued"
"running"
"paused"
"errored"
"terminated"
"complete"
"waitingForPause"
"waiting"
"rollingBack"
version_id: string
formatuuid
workflow_id: string
formatuuid
trigger_source: optional "unknown" or "api" or "binding" or 2 more
One of the following:
"unknown"
"api"
"binding"
"event"
"cron"
InstanceBulkResponse object { id, status, version_id, 2 more }
id: string
maxLength100
minLength1
status: "queued" or "running" or "paused" or 6 more
One of the following:
"queued"
"running"
"paused"
"errored"
"terminated"
"complete"
"waitingForPause"
"waiting"
"rollingBack"
version_id: string
formatuuid
workflow_id: string
formatuuid
trigger_source: optional "unknown" or "api" or "binding" or 2 more
One of the following:
"unknown"
"api"
"binding"
"event"
"cron"
InstanceStepResponse object { error, status, event_type, output }
error: object { message, name }

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

message: string
name: string
status: "queued" or "running" or "paused" or 6 more
One of the following:
"queued"
"running"
"paused"
"errored"
"terminated"
"complete"
"waitingForPause"
"waiting"
"rollingBack"
event_type: optional string

The event type the step is waiting on, as supplied to step.waitForEvent. Only present when type=‘waitForEvent’.

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.

InstancesStatus

Change status of instance
PATCH/accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/status
ModelsExpand Collapse
StatusEditResponse object { status, timestamp }
status: "queued" or "running" or "paused" or 6 more
One of the following:
"queued"
"running"
"paused"
"errored"
"terminated"
"complete"
"waitingForPause"
"waiting"
"rollingBack"
timestamp: string

Accepts ISO 8601 with no timezone offsets and in UTC.

formatdate-time

InstancesEvents

Send event to instance
POST/accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/events/{event_type}
ModelsExpand Collapse
EventCreateResponse = unknown