LogoCloudflare API

Workflows

workflows

Methods

List All Workflows -> V4PagePaginationArray<{ id, class_name, created_on, 5 more... }>
get/accounts/{account_id}/workflows
See More

Lists all workflows configured for the account.

Get Workflow Details -> Envelope<{ id, class_name, created_on, 5 more... }>
get/accounts/{account_id}/workflows/{workflow_name}

Retrieves configuration and metadata for a specific workflow.

Create Modify Workflow -> Envelope<{ id, class_name, created_on, 7 more... }>
put/accounts/{account_id}/workflows/{workflow_name}

Creates a new workflow or updates an existing workflow definition.

Deletes A Workflow -> Envelope<{ status, success }>
delete/accounts/{account_id}/workflows/{workflow_name}

Deletes a Workflow. This only deletes the Workflow and does not delete or modify any Worker associated to this Workflow or bounded to it.

Workflows

Instances

workflows.instances

Methods

List Of Workflow Instances -> V4PagePaginationArray<{ id, created_on, ended_on, 5 more... }>
get/accounts/{account_id}/workflows/{workflow_name}/instances

Lists all instances of a workflow with their execution status.

Security

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

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Workers Tail Read Workers Scripts Write Workers Scripts Read

path Parameters
account_id: string
workflow_name: string
(maxLength: 64, minLength: 1)
query Parameters
cursor: string
Optional

page and cursor are mutually exclusive, use one or the other.

date_end: string
Optional
(format: date-time)

Accepts ISO 8601 with no timezone offsets and in UTC.

date_start: string
Optional
(format: date-time)

Accepts ISO 8601 with no timezone offsets and in UTC.

direction:
Optional

should only be used when cursor is used, defines a new direction for the cursor

"asc"
"desc"
page: number
Optional
(minimum: 1)

page and cursor are mutually exclusive, use one or the other.

per_page: number
Optional
(maximum: 100, minimum: 1, default: 50)
status:
Optional
"queued"
"running"
"paused"
"errored"
"terminated"
"complete"
"waitingForPause"
"waiting"
Response fields
errors: Array<{ code, message }>
messages: Array<{ code, message }>
result: Array<{ id, created_on, ended_on, 5 more... }>
success: true
result_info: { count, per_page, total_count, 2 more... }
Optional
Request example
200Example
Get Logs And Status From Instance -> Envelope<{ end, error, output, 9 more... }>
get/accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}

Retrieves logs and execution status for a specific workflow instance.

Create A New Workflow Instance -> Envelope<{ id, status, version_id, 1 more... }>
post/accounts/{account_id}/workflows/{workflow_name}/instances

Creates a new instance of a workflow, starting its execution.

Batch Create New Workflow Instances -> SinglePage<{ id, status, version_id, 1 more... }>
post/accounts/{account_id}/workflows/{workflow_name}/instances/batch

Creates multiple workflow instances in a single batch operation.

WorkflowsInstances

Events

workflows.instances.events

Methods

Send Event To Instance -> Envelope<unknown>
post/accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/events/{event_type}

Sends an event to a running workflow instance to trigger state transitions.

WorkflowsInstances

Status

workflows.instances.status

Methods

Change Status Of Instance -> Envelope<{ status, timestamp }>
patch/accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/status

Changes the execution status of a workflow instance (e.g., pause, resume, terminate).

Workflows

Versions

workflows.versions

Methods

List Deployed Workflow Versions -> V4PagePaginationArray<{ id, class_name, created_on, 4 more... }>
get/accounts/{account_id}/workflows/{workflow_name}/versions

Lists all deployed versions of a workflow.

Get Workflow Version Details -> Envelope<{ id, class_name, created_on, 4 more... }>
get/accounts/{account_id}/workflows/{workflow_name}/versions/{version_id}

Retrieves details for a specific deployed workflow version.