Skip to content
Cloudflare API
Start here
API Reference

Workflows

List all Workflows
client.workflows.list(WorkflowListParams { account_id, page, per_page, search } params, RequestOptionsoptions?): V4PagePaginationArray<WorkflowListResponse { id, class_name, created_on, 5 more } >
GET/accounts/{account_id}/workflows
Get Workflow details
client.workflows.get(stringworkflowName, WorkflowGetParams { account_id } params, RequestOptionsoptions?): WorkflowGetResponse { id, class_name, created_on, 5 more }
GET/accounts/{account_id}/workflows/{workflow_name}
Create/modify Workflow
client.workflows.update(stringworkflowName, WorkflowUpdateParams { account_id, class_name, script_name, limits } params, RequestOptionsoptions?): WorkflowUpdateResponse { id, class_name, created_on, 7 more }
PUT/accounts/{account_id}/workflows/{workflow_name}
Deletes a Workflow
client.workflows.delete(stringworkflowName, WorkflowDeleteParams { account_id } params, RequestOptionsoptions?): WorkflowDeleteResponse { status, success }
DELETE/accounts/{account_id}/workflows/{workflow_name}
ModelsExpand Collapse
WorkflowListResponse { id, class_name, created_on, 5 more }
id: string
formatuuid
class_name: string
created_on: string
formatdate-time
instances: Instances { complete, errored, paused, 5 more }
complete?: number
errored?: number
paused?: number
queued?: number
running?: number
terminated?: number
waiting?: number
waitingForPause?: number
modified_on: string
formatdate-time
name: string
maxLength64
minLength1
script_name: string
triggered_on: string | null
formatdate-time
WorkflowGetResponse { id, class_name, created_on, 5 more }
id: string
formatuuid
class_name: string
created_on: string
formatdate-time
instances: Instances { complete, errored, paused, 5 more }
complete?: number
errored?: number
paused?: number
queued?: number
running?: number
terminated?: number
waiting?: number
waitingForPause?: number
modified_on: string
formatdate-time
name: string
maxLength64
minLength1
script_name: string
triggered_on: string | null
formatdate-time
WorkflowUpdateResponse { 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 | null
formatdate-time
version_id: string
formatuuid
WorkflowDeleteResponse { status, success }
status: "ok"
success: boolean | null

WorkflowsInstances

List of workflow instances
client.workflows.instances.list(stringworkflowName, InstanceListParams { account_id, cursor, date_end, 5 more } params, RequestOptionsoptions?): V4PagePaginationArray<InstanceListResponse { id, created_on, ended_on, 5 more } >
GET/accounts/{account_id}/workflows/{workflow_name}/instances
Get logs and status from instance
client.workflows.instances.get(stringworkflowName, stringinstanceId, InstanceGetParams { account_id, order, simple } params, RequestOptionsoptions?): InstanceGetResponse { end, error, output, 9 more }
GET/accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}
Create a new workflow instance
client.workflows.instances.create(stringworkflowName, InstanceCreateParams { account_id, instance_id, instance_retention, params } params, RequestOptionsoptions?): InstanceCreateResponse { id, status, version_id, workflow_id }
POST/accounts/{account_id}/workflows/{workflow_name}/instances
Batch create new Workflow instances
client.workflows.instances.bulk(stringworkflowName, InstanceBulkParams { account_id, body } params, RequestOptionsoptions?): SinglePage<InstanceBulkResponse { id, status, version_id, workflow_id } >
POST/accounts/{account_id}/workflows/{workflow_name}/instances/batch
ModelsExpand Collapse
InstanceListResponse { id, created_on, ended_on, 5 more }
id: string
maxLength100
minLength1
created_on: string
formatdate-time
ended_on: string | null
formatdate-time
modified_on: string
formatdate-time
started_on: string | null
formatdate-time
status: "queued" | "running" | "paused" | 5 more
One of the following:
"queued"
"running"
"paused"
"errored"
"terminated"
"complete"
"waitingForPause"
"waiting"
version_id: string
formatuuid
workflow_id: string
formatuuid
InstanceGetResponse { end, error, output, 9 more }
end: string | null
formatdate-time
error: Error | null
message: string
name: string
output: string | number
One of the following:
string
number
params: unknown
queued: string
formatdate-time
start: string | null
formatdate-time
status: "queued" | "running" | "paused" | 5 more
One of the following:
"queued"
"running"
"paused"
"errored"
"terminated"
"complete"
"waitingForPause"
"waiting"
step_count: number
steps: Array<UnionMember0 { attempts, config, end, 5 more } | UnionMember1 { end, error, finished, 3 more } | UnionMember2 { trigger, type } | UnionMember3 { end, error, finished, 4 more } >
One of the following:
UnionMember0 { attempts, config, end, 5 more }
attempts: Array<Attempt>
end: string | null
formatdate-time
error: Error | null
message: string
name: string
start: string
formatdate-time
success: boolean | null
config: Config { retries, timeout }
retries: Retries { delay, limit, backoff }
delay: string | number

Specifies the delay duration.

One of the following:
string
number
limit: number
backoff?: "constant" | "linear" | "exponential"
One of the following:
"constant"
"linear"
"exponential"
timeout: string | number

Specifies the timeout duration.

One of the following:
string
number
end: string | null
formatdate-time
name: string
output: string | null
start: string
formatdate-time
success: boolean | null
type: "step"
UnionMember1 { end, error, finished, 3 more }
end: string
formatdate-time
error: Error | null
message: string
name: string
finished: boolean
name: string
start: string
formatdate-time
type: "sleep"
UnionMember2 { trigger, type }
trigger: Trigger { source }
source: string
type: "termination"
UnionMember3 { end, error, finished, 4 more }
end: string
formatdate-time
error: Error | null
message: string
name: string
finished: boolean
name: string
start: string
formatdate-time
type: "waitForEvent"
output?: string
success: boolean | null
trigger: Trigger { source }
source: "unknown" | "api" | "binding" | 2 more
One of the following:
"unknown"
"api"
"binding"
"event"
"cron"
versionId: string
formatuuid
InstanceCreateResponse { id, status, version_id, workflow_id }
id: string
maxLength100
minLength1
status: "queued" | "running" | "paused" | 5 more
One of the following:
"queued"
"running"
"paused"
"errored"
"terminated"
"complete"
"waitingForPause"
"waiting"
version_id: string
formatuuid
workflow_id: string
formatuuid
InstanceBulkResponse { id, status, version_id, workflow_id }
id: string
maxLength100
minLength1
status: "queued" | "running" | "paused" | 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
client.workflows.instances.status.edit(stringworkflowName, stringinstanceId, StatusEditParams { account_id, status } params, RequestOptionsoptions?): StatusEditResponse { status, timestamp }
PATCH/accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/status
ModelsExpand Collapse
StatusEditResponse { status, timestamp }
status: "queued" | "running" | "paused" | 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
client.workflows.instances.events.create(stringworkflowName, stringinstanceId, stringeventType, EventCreateParams { account_id, body } params, RequestOptionsoptions?): EventCreateResponse
POST/accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/events/{event_type}
ModelsExpand Collapse
EventCreateResponse = unknown

WorkflowsVersions

List deployed Workflow versions
client.workflows.versions.list(stringworkflowName, VersionListParams { account_id, page, per_page } params, RequestOptionsoptions?): V4PagePaginationArray<VersionListResponse { id, class_name, created_on, 4 more } >
GET/accounts/{account_id}/workflows/{workflow_name}/versions
Get Workflow version details
client.workflows.versions.get(stringworkflowName, stringversionId, VersionGetParams { account_id } params, RequestOptionsoptions?): VersionGetResponse { id, class_name, created_on, 4 more }
GET/accounts/{account_id}/workflows/{workflow_name}/versions/{version_id}
ModelsExpand Collapse
VersionListResponse { 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?: Limits { steps }
steps?: number
minimum1
VersionGetResponse { 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?: Limits { steps }
steps?: number
minimum1