Skip to content
Cloudflare API
Start here
API Reference

Workflows

List all Workflows
GET/accounts/{account_id}/workflows
Get Workflow details
GET/accounts/{account_id}/workflows/{workflow_name}
Create/modify Workflow
PUT/accounts/{account_id}/workflows/{workflow_name}
Deletes a Workflow
DELETE/accounts/{account_id}/workflows/{workflow_name}
ModelsExpand Collapse
WorkflowListResponse = object { id, class_name, created_on, 5 more }
id: string
formatuuid
class_name: string
created_on: string
formatdate-time
instances: object { complete, errored, paused, 5 more }
complete: optional number
errored: optional number
paused: optional number
queued: optional number
running: optional number
terminated: optional number
waiting: optional number
waitingForPause: optional number
modified_on: string
formatdate-time
name: string
maxLength64
minLength1
script_name: string
triggered_on: string
formatdate-time
WorkflowGetResponse = object { id, class_name, created_on, 5 more }
id: string
formatuuid
class_name: string
created_on: string
formatdate-time
instances: object { complete, errored, paused, 5 more }
complete: optional number
errored: optional number
paused: optional number
queued: optional number
running: optional number
terminated: optional number
waiting: optional number
waitingForPause: optional number
modified_on: string
formatdate-time
name: string
maxLength64
minLength1
script_name: string
triggered_on: string
formatdate-time
WorkflowUpdateResponse = object { id, class_name, created_on, 7 more }
id: string
formatuuid
class_name: string
created_on: string
formatdate-time
is_deleted: number
modified_on: string
formatdate-time
name: string
maxLength64
minLength1
script_name: string
terminator_running: number
triggered_on: string
formatdate-time
version_id: string
formatuuid
WorkflowDeleteResponse = object { status, success }
status: "ok"
success: boolean

WorkflowsInstances

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
ModelsExpand Collapse
InstanceListResponse = object { id, created_on, ended_on, 5 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 5 more
One of the following:
"queued"
"running"
"paused"
"errored"
"terminated"
"complete"
"waitingForPause"
"waiting"
version_id: string
formatuuid
workflow_id: string
formatuuid
InstanceGetResponse = object { end, error, output, 9 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
start: string
formatdate-time
status: "queued" or "running" or "paused" or 5 more
One of the following:
"queued"
"running"
"paused"
"errored"
"terminated"
"complete"
"waitingForPause"
"waiting"
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, 4 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 }
retries: object { delay, limit, backoff }
delay: string or number

Specifies the delay duration.

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
end: string
formatdate-time
name: string
output: unknown
start: string
formatdate-time
success: boolean
type: "step"
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, 4 more }
end: string
formatdate-time
error: object { message, name }
message: string
name: string
finished: boolean
name: string
output: unknown or string or number or boolean
One of the following:
unknown
string
number
boolean
start: string
formatdate-time
type: "waitForEvent"
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
InstanceCreateResponse = object { id, status, version_id, workflow_id }
id: string
maxLength100
minLength1
status: "queued" or "running" or "paused" or 5 more
One of the following:
"queued"
"running"
"paused"
"errored"
"terminated"
"complete"
"waitingForPause"
"waiting"
version_id: string
formatuuid
workflow_id: string
formatuuid
InstanceBulkResponse = object { id, status, version_id, workflow_id }
id: string
maxLength100
minLength1
status: "queued" or "running" or "paused" or 5 more
One of the following:
"queued"
"running"
"paused"
"errored"
"terminated"
"complete"
"waitingForPause"
"waiting"
version_id: string
formatuuid
workflow_id: string
formatuuid

WorkflowsInstancesStatus

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 5 more
One of the following:
"queued"
"running"
"paused"
"errored"
"terminated"
"complete"
"waitingForPause"
"waiting"
timestamp: string

Accepts ISO 8601 with no timezone offsets and in UTC.

formatdate-time

WorkflowsInstancesEvents

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

WorkflowsVersions

List deployed Workflow versions
GET/accounts/{account_id}/workflows/{workflow_name}/versions
Get Workflow version details
GET/accounts/{account_id}/workflows/{workflow_name}/versions/{version_id}
ModelsExpand Collapse
VersionListResponse = object { id, class_name, created_on, 4 more }
id: string
formatuuid
class_name: string
created_on: string
formatdate-time
has_dag: boolean
modified_on: string
formatdate-time
workflow_id: string
formatuuid
limits: optional object { steps }
steps: optional number
minimum1
VersionGetResponse = object { id, class_name, created_on, 4 more }
id: string
formatuuid
class_name: string
created_on: string
formatdate-time
has_dag: boolean
modified_on: string
formatdate-time
workflow_id: string
formatuuid
limits: optional object { steps }
steps: optional number
minimum1