---
title: Workflows
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# Workflows
##### [List all Workflows](https://developers.cloudflare.com/api/resources/workflows/methods/list)
GET/accounts/{account\_id}/workflows
##### [Get Workflow details](https://developers.cloudflare.com/api/resources/workflows/methods/get)
GET/accounts/{account\_id}/workflows/{workflow\_name}
##### [Create/modify Workflow](https://developers.cloudflare.com/api/resources/workflows/methods/update)
PUT/accounts/{account\_id}/workflows/{workflow\_name}
##### [Deletes a Workflow](https://developers.cloudflare.com/api/resources/workflows/methods/delete)
DELETE/accounts/{account\_id}/workflows/{workflow\_name}
##### ModelsExpand Collapse
WorkflowListResponse object {id, class\_name, created\_on, 7 more }
id: string
formatuuid
Link to this property
class\_name: string
Link to this property
created\_on: string
formatdate-time
Link to this property
instances: map\[number]
Link to this property
modified\_on: string
formatdate-time
Link to this property
name: string
maxLength64
minLength1
Link to this property
script\_name: string
Link to this property
triggered\_on: string
formatdate-time
Link to this property
schedules: optional array of object {cron, next\_instance }
cron: string
Link to this property
next\_instance: string
Link to this property
Link to this property
script\_deleted: optional boolean
Whether the bound Worker was deleted, leaving this Workflow inactive.
Link to this property
[Link to this property](<#(resource)%20workflows%20%3E%20(model)%20workflow_list_response%20%3E%20(schema)>)
WorkflowGetResponse object {id, class\_name, created\_on, 7 more }
id: string
formatuuid
Link to this property
class\_name: string
Link to this property
created\_on: string
formatdate-time
Link to this property
instances: map\[number]
Link to this property
modified\_on: string
formatdate-time
Link to this property
name: string
maxLength64
minLength1
Link to this property
script\_name: string
Link to this property
triggered\_on: string
formatdate-time
Link to this property
schedules: optional array of object {cron, next\_instance }
cron: string
Link to this property
next\_instance: string
Link to this property
Link to this property
script\_deleted: optional boolean
Whether the bound Worker was deleted, leaving this Workflow inactive.
Link to this property
[Link to this property](<#(resource)%20workflows%20%3E%20(model)%20workflow_get_response%20%3E%20(schema)>)
WorkflowUpdateResponse object {id, class\_name, created\_on, 7 more }
id: string
formatuuid
Link to this property
class\_name: string
Link to this property
created\_on: string
formatdate-time
Link to this property
is\_deleted: number
Link to this property
modified\_on: string
formatdate-time
Link to this property
name: string
maxLength64
minLength1
Link to this property
script\_name: string
Link to this property
terminator\_running: number
Link to this property
triggered\_on: string
formatdate-time
Link to this property
version\_id: string
formatuuid
Link to this property
[Link to this property](<#(resource)%20workflows%20%3E%20(model)%20workflow_update_response%20%3E%20(schema)>)
WorkflowDeleteResponse object {status, success }
status: "ok"
Link to this property
success: boolean
Link to this property
[Link to this property](<#(resource)%20workflows%20%3E%20(model)%20workflow_delete_response%20%3E%20(schema)>)
#### WorkflowsInstances
##### [List of workflow instances](https://developers.cloudflare.com/api/resources/workflows/subresources/instances/methods/list)
GET/accounts/{account\_id}/workflows/{workflow\_name}/instances
##### [Get logs and status from instance](https://developers.cloudflare.com/api/resources/workflows/subresources/instances/methods/get)
GET/accounts/{account\_id}/workflows/{workflow\_name}/instances/{instance\_id}
##### [Create a new workflow instance](https://developers.cloudflare.com/api/resources/workflows/subresources/instances/methods/create)
POST/accounts/{account\_id}/workflows/{workflow\_name}/instances
##### [Batch create new Workflow instances](https://developers.cloudflare.com/api/resources/workflows/subresources/instances/methods/bulk)
POST/accounts/{account\_id}/workflows/{workflow\_name}/instances/batch
##### [Get full step output from instance](https://developers.cloudflare.com/api/resources/workflows/subresources/instances/methods/step)
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
Link to this property
created\_on: string
formatdate-time
Link to this property
ended\_on: string
formatdate-time
Link to this property
modified\_on: string
formatdate-time
Link to this property
started\_on: string
formatdate-time
Link to this property
status: "queued"or "running"or "paused"or 6 more
One of the following:
"queued"
Link to this property
"running"
Link to this property
"paused"
Link to this property
"errored"
Link to this property
"terminated"
Link to this property
"complete"
Link to this property
"waitingForPause"
Link to this property
"waiting"
Link to this property
"rollingBack"
Link to this property
Link to this property
version\_id: string
formatuuid
Link to this property
workflow\_id: string
formatuuid
Link to this property
trigger\_source: optional "unknown"or "api"or "binding"or 2 more
One of the following:
"unknown"
Link to this property
"api"
Link to this property
"binding"
Link to this property
"event"
Link to this property
"cron"
Link to this property
Link to this property
[Link to this property](<#(resource)%20workflows.instances%20%3E%20(model)%20instance_list_response%20%3E%20(schema)>)
InstanceGetResponse object {end, error, output, 11 more }
end: string
formatdate-time
Link to this property
error: object {message, name }
message: string
Link to this property
name: string
Link to this property
Link to this property
output: stringor number
One of the following:
string
Link to this property
number
Link to this property
Link to this property
params: unknown
Link to this property
queued: string
formatdate-time
Link to this property
rollback: object {error, outcome }
error: object {message, name }
message: string
Link to this property
name: string
Link to this property
Link to this property
outcome: "complete"or "failed"
One of the following:
"complete"
Link to this property
"failed"
Link to this property
Link to this property
Link to this property
start: string
formatdate-time
Link to this property
status: "queued"or "running"or "paused"or 6 more
One of the following:
"queued"
Link to this property
"running"
Link to this property
"paused"
Link to this property
"errored"
Link to this property
"terminated"
Link to this property
"complete"
Link to this property
"waitingForPause"
Link to this property
"waiting"
Link to this property
"rollingBack"
Link to this property
Link to this property
step\_count: number
maximum9007199254740991
minimum-9007199254740991
Link to this property
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
Link to this property
error: object {message, name }
message: string
Link to this property
name: string
Link to this property
Link to this property
start: string
formatdate-time
Link to this property
success: boolean
Link to this property
Link to this property
config: object {retries, timeout, sensitive }
retries: object {delay, limit, backoff }
delay: stringor number
Specifies the delay duration. The value ‘\[dynamic]’ means that a user-supplied function computes the delay.
One of the following:
string
Link to this property
number
Link to this property
Link to this property
limit: number
Link to this property
backoff: optional "constant"or "linear"or "exponential"
One of the following:
"constant"
Link to this property
"linear"
Link to this property
"exponential"
Link to this property
Link to this property
Link to this property
timeout: stringor number
Specifies the timeout duration.
One of the following:
string
Link to this property
number
Link to this property
Link to this property
sensitive: optional "output"
When set to ‘output’, step output is redacted from log and step output responses.
Link to this property
Link to this property
end: string
formatdate-time
Link to this property
name: string
Link to this property
output: string
Link to this property
start: string
formatdate-time
Link to this property
success: boolean
Link to this property
type: "step"or "rollback"
One of the following:
"step"
Link to this property
"rollback"
Link to this property
Link to this property
Link to this property
object {end, error, finished, 3 more }
end: string
formatdate-time
Link to this property
error: object {message, name }
message: string
Link to this property
name: string
Link to this property
Link to this property
finished: boolean
Link to this property
name: string
Link to this property
start: string
formatdate-time
Link to this property
type: "sleep"
Link to this property
Link to this property
object {trigger, type }
trigger: object {source }
source: string
Link to this property
Link to this property
type: "termination"
Link to this property
Link to this property
object {end, error, finished, 5 more }
end: string
formatdate-time
Link to this property
error: object {message, name }
message: string
Link to this property
name: string
Link to this property
Link to this property
finished: boolean
Link to this property
name: string
Link to this property
start: string
formatdate-time
Link to this property
type: "waitForEvent"
Link to this property
event\_type: optional string
Link to this property
output: optional string
Link to this property
Link to this property
Link to this property
success: boolean
Link to this property
trigger: object {source }
source: "unknown"or "api"or "binding"or 2 more
One of the following:
"unknown"
Link to this property
"api"
Link to this property
"binding"
Link to this property
"event"
Link to this property
"cron"
Link to this property
Link to this property
Link to this property
versionId: string
formatuuid
Link to this property
schedule: optional object {cron, scheduledTime }
cron: string
Link to this property
scheduledTime: number
Link to this property
Link to this property
[Link to this property](<#(resource)%20workflows.instances%20%3E%20(model)%20instance_get_response%20%3E%20(schema)>)
InstanceCreateResponse object {id, status, version\_id, 2 more }
id: string
maxLength100
minLength1
Link to this property
status: "queued"or "running"or "paused"or 6 more
One of the following:
"queued"
Link to this property
"running"
Link to this property
"paused"
Link to this property
"errored"
Link to this property
"terminated"
Link to this property
"complete"
Link to this property
"waitingForPause"
Link to this property
"waiting"
Link to this property
"rollingBack"
Link to this property
Link to this property
version\_id: string
formatuuid
Link to this property
workflow\_id: string
formatuuid
Link to this property
trigger\_source: optional "unknown"or "api"or "binding"or 2 more
One of the following:
"unknown"
Link to this property
"api"
Link to this property
"binding"
Link to this property
"event"
Link to this property
"cron"
Link to this property
Link to this property
[Link to this property](<#(resource)%20workflows.instances%20%3E%20(model)%20instance_create_response%20%3E%20(schema)>)
InstanceBulkResponse object {id, status, version\_id, 2 more }
id: string
maxLength100
minLength1
Link to this property
status: "queued"or "running"or "paused"or 6 more
One of the following:
"queued"
Link to this property
"running"
Link to this property
"paused"
Link to this property
"errored"
Link to this property
"terminated"
Link to this property
"complete"
Link to this property
"waitingForPause"
Link to this property
"waiting"
Link to this property
"rollingBack"
Link to this property
Link to this property
version\_id: string
formatuuid
Link to this property
workflow\_id: string
formatuuid
Link to this property
trigger\_source: optional "unknown"or "api"or "binding"or 2 more
One of the following:
"unknown"
Link to this property
"api"
Link to this property
"binding"
Link to this property
"event"
Link to this property
"cron"
Link to this property
Link to this property
[Link to this property](<#(resource)%20workflows.instances%20%3E%20(model)%20instance_bulk_response%20%3E%20(schema)>)
InstanceStepResponse object {error, status, event\_type, output }
error: object {message, name }
Error details when status=‘errored’; null otherwise.
message: string
Link to this property
name: string
Link to this property
Link to this property
status: "queued"or "running"or "paused"or 6 more
One of the following:
"queued"
Link to this property
"running"
Link to this property
"paused"
Link to this property
"errored"
Link to this property
"terminated"
Link to this property
"complete"
Link to this property
"waitingForPause"
Link to this property
"waiting"
Link to this property
"rollingBack"
Link to this property
Link to this property
event\_type: optional string
The event type the step is waiting on, as supplied to step.waitForEvent. Only present when type=‘waitForEvent’.
Link to this property
output: optional unknown
Contains the full step output or waitForEvent payload without truncation. Uses ‘\[REDACTED]’ for sensitive outputs. Contains a value when status=‘complete’. May contain a ReadableStream when step.do returns one; the response serves stream outputs as application/octet-stream rather than JSON.
Link to this property
[Link to this property](<#(resource)%20workflows.instances%20%3E%20(model)%20instance_step_response%20%3E%20(schema)>)
#### WorkflowsInstancesStatus
##### [Change status of instance](https://developers.cloudflare.com/api/resources/workflows/subresources/instances/subresources/status/methods/edit)
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"
Link to this property
"running"
Link to this property
"paused"
Link to this property
"errored"
Link to this property
"terminated"
Link to this property
"complete"
Link to this property
"waitingForPause"
Link to this property
"waiting"
Link to this property
"rollingBack"
Link to this property
Link to this property
timestamp: string
Accepts ISO 8601 with no timezone offsets and in UTC.
formatdate-time
Link to this property
[Link to this property](<#(resource)%20workflows.instances.status%20%3E%20(model)%20status_edit_response%20%3E%20(schema)>)
#### WorkflowsInstancesEvents
##### [Send event to instance](https://developers.cloudflare.com/api/resources/workflows/subresources/instances/subresources/events/methods/create)
POST/accounts/{account\_id}/workflows/{workflow\_name}/instances/{instance\_id}/events/{event\_type}
##### ModelsExpand Collapse
EventCreateResponse object {instanceId, timestamp }
instanceId: string
Link to this property
timestamp: string
Accepts ISO 8601 with no timezone offsets and in UTC.
formatdate-time
Link to this property
[Link to this property](<#(resource)%20workflows.instances.events%20%3E%20(model)%20event_create_response%20%3E%20(schema)>)
#### WorkflowsVersions
##### [List deployed Workflow versions](https://developers.cloudflare.com/api/resources/workflows/subresources/versions/methods/list)
GET/accounts/{account\_id}/workflows/{workflow\_name}/versions
##### [Get Workflow version details](https://developers.cloudflare.com/api/resources/workflows/subresources/versions/methods/get)
GET/accounts/{account\_id}/workflows/{workflow\_name}/versions/{version\_id}
##### [Get Workflow version graph](https://developers.cloudflare.com/api/resources/workflows/subresources/versions/methods/graph)
GET/accounts/{account\_id}/workflows/{workflow\_name}/versions/{version\_id}/graph
##### ModelsExpand Collapse
VersionListResponse object {id, class\_name, created\_on, 7 more }
id: string
formatuuid
Link to this property
class\_name: string
Link to this property
created\_on: string
formatdate-time
Link to this property
has\_dag: boolean
Link to this property
language: "javascript"or "python"
The programming language of the workflow implementation.
One of the following:
"javascript"
Link to this property
"python"
Link to this property
Link to this property
modified\_on: string
formatdate-time
Link to this property
workflow\_id: string
formatuuid
Link to this property
concurrency: optional object {limit }
limit: optional number
Maximum number of instances of this workflow that can run concurrently. Additional instances are queued and started as running instances complete. Must not exceed the account concurrency limit.
maximum9007199254740991
minimum1
Link to this property
Link to this property
default\_retention: optional object {error\_retention, success\_retention }
error\_retention: optional number
Default error retention in milliseconds.
maximum9007199254740991
minimum-9007199254740991
Link to this property
success\_retention: optional number
Default success retention in milliseconds.
maximum9007199254740991
minimum-9007199254740991
Link to this property
Link to this property
limits: optional object {steps }
steps: optional number
maximum9007199254740991
minimum1
Link to this property
Link to this property
[Link to this property](<#(resource)%20workflows.versions%20%3E%20(model)%20version_list_response%20%3E%20(schema)>)
VersionGetResponse object {id, class\_name, created\_on, 7 more }
id: string
formatuuid
Link to this property
class\_name: string
Link to this property
created\_on: string
formatdate-time
Link to this property
has\_dag: boolean
Link to this property
language: "javascript"or "python"
The programming language of the workflow implementation.
One of the following:
"javascript"
Link to this property
"python"
Link to this property
Link to this property
modified\_on: string
formatdate-time
Link to this property
workflow\_id: string
formatuuid
Link to this property
concurrency: optional object {limit }
limit: optional number
Maximum number of instances of this workflow that can run concurrently. Additional instances are queued and started as running instances complete. Must not exceed the account concurrency limit.
maximum9007199254740991
minimum1
Link to this property
Link to this property
default\_retention: optional object {error\_retention, success\_retention }
error\_retention: optional number
Default error retention in milliseconds.
maximum9007199254740991
minimum-9007199254740991
Link to this property
success\_retention: optional number
Default success retention in milliseconds.
maximum9007199254740991
minimum-9007199254740991
Link to this property
Link to this property
limits: optional object {steps }
steps: optional number
maximum9007199254740991
minimum1
Link to this property
Link to this property
[Link to this property](<#(resource)%20workflows.versions%20%3E%20(model)%20version_get_response%20%3E%20(schema)>)
VersionGraphResponse object {id, class\_name, created\_on, 3 more }
id: string
formatuuid
Link to this property
class\_name: string
Link to this property
created\_on: string
formatdate-time
Link to this property
graph: object {version, workflow }
Versioned workflow graph payload.
version: number
Link to this property
workflow: object {class\_name, functions, nodes, payload }
A parsed workflow entrypoint with its step graph.
class\_name: string
Link to this property
functions: map\[object {name, nodes, type } ]
name: string
Link to this property
nodes: array of unknown
Child nodes (recursive).
Link to this property
type: "function\_def"
Link to this property
Link to this property
nodes: array of object {duration, name, type, 2 more } or object {config, name, nodes, 3 more } or object {name, options, type, 3 more } or 11 more
One of the following:
object {duration, name, type, 2 more }
duration: numberor string
Duration as milliseconds (number) or human-readable string.
One of the following:
number
Link to this property
string
Link to this property
Link to this property
name: string
Link to this property
type: "step\_sleep"
Link to this property
resolves: optional number
Link to this property
starts: optional number
Link to this property
Link to this property
object {config, name, nodes, 3 more }
config: object {retries, timeout }
Configuration for a step (retries and timeout).
retries: object {backoff, delay, limit }
Retry policy for a step.
backoff: "constant"or "linear"or "exponential"
Backoff strategy for step retries.
One of the following:
"constant"
Link to this property
"linear"
Link to this property
"exponential"
Link to this property
Link to this property
delay: numberor string
Duration as milliseconds (number) or human-readable string.
One of the following:
number
Link to this property
string
Link to this property
Link to this property
limit: number
Link to this property
Link to this property
timeout: numberor string
Duration as milliseconds (number) or human-readable string.
One of the following:
number
Link to this property
string
Link to this property
Link to this property
Link to this property
name: string
Link to this property
nodes: array of unknown
Child nodes (recursive).
Link to this property
type: "step\_do"
Link to this property
resolves: optional number
Link to this property
starts: optional number
Link to this property
Link to this property
object {name, options, type, 3 more }
name: string
Link to this property
options: object {event\_type, timeout }
Options for a waitForEvent step.
event\_type: string
Link to this property
timeout: numberor string
Duration as milliseconds (number) or human-readable string.
One of the following:
number
Link to this property
string
Link to this property
Link to this property
Link to this property
type: "step\_wait\_for\_event"
Link to this property
payload: optional object {type } or object {fields, type }
Shape descriptor for JSON payloads.
One of the following:
Type object {type }
type: "unknown"
Link to this property
Link to this property
object {fields, type }
fields: map\[unknown]
Nested JsonShape fields (recursive structure).
Link to this property
type: "object"
Link to this property
Link to this property
Link to this property
resolves: optional number
Link to this property
starts: optional number
Link to this property
Link to this property
object {name, timestamp, type, 2 more }
name: string
Link to this property
timestamp: string
Link to this property
type: "step\_sleep\_until"
Link to this property
resolves: optional number
Link to this property
starts: optional number
Link to this property
Link to this property
object {nodes, type }
nodes: array of unknown
Child nodes (recursive).
Link to this property
type: "loop"
Link to this property
Link to this property
object {kind, nodes, type }
kind: "all"or "any"or "all\_settled"or "race"
Parallel execution strategy.
One of the following:
"all"
Link to this property
"any"
Link to this property
"all\_settled"
Link to this property
"race"
Link to this property
Link to this property
nodes: array of unknown
Child nodes (recursive).
Link to this property
type: "parallel"
Link to this property
Link to this property
object {catch\_block, finally\_block, try\_block, type }
catch\_block: object {nodes, type }
nodes: array of unknown
Child nodes (recursive).
Link to this property
type: "block"
Link to this property
Link to this property
finally\_block: object {nodes, type }
nodes: array of unknown
Child nodes (recursive).
Link to this property
type: "block"
Link to this property
Link to this property
try\_block: object {nodes, type }
nodes: array of unknown
Child nodes (recursive).
Link to this property
type: "block"
Link to this property
Link to this property
type: "try"
Link to this property
Link to this property
object {nodes, type }
nodes: array of unknown
Child nodes (recursive).
Link to this property
type: "block"
Link to this property
Link to this property
object {branches, type }
branches: array of object {condition, nodes }
condition: string
Link to this property
nodes: array of unknown
Child nodes (recursive).
Link to this property
Link to this property
type: "if"
Link to this property
Link to this property
object {branches, discriminant, type }
branches: array of object {condition, nodes }
condition: string
Link to this property
nodes: array of unknown
Child nodes (recursive).
Link to this property
Link to this property
discriminant: string
Link to this property
type: "switch"
Link to this property
Link to this property
object {class\_name, functions, nodes, 2 more }
class\_name: string
Link to this property
functions: map\[object {name, nodes, type } ]
name: string
Link to this property
nodes: array of unknown
Child nodes (recursive).
Link to this property
type: "function\_def"
Link to this property
Link to this property
nodes: array of unknown
Child nodes (recursive).
Link to this property
type: "start"
Link to this property
payload: optional object {type } or object {fields, type }
Shape descriptor for JSON payloads.
One of the following:
Type object {type }
type: "unknown"
Link to this property
Link to this property
object {fields, type }
fields: map\[unknown]
Nested JsonShape fields (recursive structure).
Link to this property
type: "object"
Link to this property
Link to this property
Link to this property
Link to this property
object {name, type, resolves, starts }
name: string
Link to this property
type: "function\_call"
Link to this property
resolves: optional number
Link to this property
starts: optional number
Link to this property
Link to this property
object {name, nodes, type }
name: string
Link to this property
nodes: array of unknown
Child nodes (recursive).
Link to this property
type: "function\_def"
Link to this property
Link to this property
object {kind, type }
kind: "break"or "return"
Break or return from a loop.
One of the following:
"break"
Link to this property
"return"
Link to this property
Link to this property
type: "break"
Link to this property
Link to this property
Link to this property
payload: optional object {type } or object {fields, type }
Shape descriptor for JSON payloads.
One of the following:
Type object {type }
type: "unknown"
Link to this property
Link to this property
object {fields, type }
fields: map\[unknown]
Nested JsonShape fields (recursive structure).
Link to this property
type: "object"
Link to this property
Link to this property
Link to this property
Link to this property
Link to this property
modified\_on: string
formatdate-time
Link to this property
workflow\_id: string
formatuuid
Link to this property
[Link to this property](<#(resource)%20workflows.versions%20%3E%20(model)%20version_graph_response%20%3E%20(schema)>)