LogoCloudflare API

Workflows

workflows

Methods

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

List all Workflows

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

Get Workflow details

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

Create/modify Workflow

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.

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 Scripts Write

path Parameters
account_id: string
workflow_name: string
(maxLength: 64, minLength: 1)
Response fields
errors: Array<{ code, message }>
messages: Array<{ code, message }>
result: { status, success }
success: true
result_info: { count, per_page, total_count, 2 more... }
Optional
Request example
200Example
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

List of workflow instances

Get Logs And Status From Instance -> Envelope<{ end, error, output, 8 more... }>
get/accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}

Get logs and status from instance

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

Create a new workflow instance

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

Batch create new Workflow instances

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}

Send event to instance

WorkflowsInstances

Status

workflows.instances.status

Methods

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

Change status of instance

Workflows

Versions

workflows.versions

Methods

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

List deployed Workflow versions

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

Get Workflow version details