Cloudflare API | Workflows › list

API Reference

Account & User Management

Resource Sharing

AI

Certificate Management

Certificate Authorities

Client Certificates

Custom Certificates

Custom Hostnames

Keyless Certificates

MTLS Certificates

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

Cloudflare One

DNS

Account Custom Nameservers

Domain/Zone Management

IP Addresses

Media

Networking

Magic Cloud Networking

Magic Network Monitoring

Network Interconnects

Observability

Security Center

Radar

Routing & Performance

Rules

Cloud Connector

Managed Transforms

URL Normalization

Security

Schema Validation

Content Scanning

Leaked Credential Checks

Token Validation

Storage & Databases

R2 Data Catalog

Threat Intelligence

Brand Protection

Workers & Pages

Browser Rendering

Durable Objects

Workers For Platforms

List all Workflows

Get Workflow details

Create/modify Workflow

Deletes a Workflow

Shared

Workflows

Workflows

Methods

client.workflows.list(, ):

V4PagePaginationArray

<

WorkflowListResponse

>

get/accounts/{account_id}/workflows

List all Workflows

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

Parameters

params:

WorkflowListParams

account_id: string

Path param

page?: number

(minimum: 1)

Query param

per_page?: number

(maximum: 100, minimum: 1)

Query param

search?: string

(maxLength: 64, minLength: 1)

Query param: Allows filtering workflows` name.

Returns

WorkflowListResponse{

id: string

(format: uuid)

class_name: string

created_on: string

(format: date-time)

instances:

modified_on: string

(format: date-time)

name: string

(maxLength: 64, minLength: 1)

script_name: string

triggered_on: string | null

(format: date-time)

Request example

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const workflowListResponse of client.workflows.list({ account_id: 'account_id' })) {
  console.log(workflowListResponse.id);
}

200Example

{
  "errors": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "result": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "class_name": "class_name",
      "created_on": "2019-12-27T18:11:19.117Z",
      "instances": {
        "complete": 0,
        "errored": 0,
        "paused": 0,
        "queued": 0,
        "running": 0,
        "terminated": 0,
        "waiting": 0,
        "waitingForPause": 0
      },
      "modified_on": "2019-12-27T18:11:19.117Z",
      "name": "x",
      "script_name": "script_name",
      "triggered_on": "2019-12-27T18:11:19.117Z"
    }
  ],
  "success": true,
  "result_info": {
    "count": 0,
    "per_page": 0,
    "total_count": 0,
    "cursor": "cursor",
    "page": 0
  }
}

client.workflows.get(, , ):

WorkflowGetResponse

get/accounts/{account_id}/workflows/{workflow_name}

Get Workflow details

client.workflows.update(, , ):

WorkflowUpdateResponse

put/accounts/{account_id}/workflows/{workflow_name}

Create/modify Workflow

client.workflows.delete(, , ):

WorkflowDeleteResponse

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.

Instances

Workflows.Instances

Methods

client.workflows.instances.list(, , ):

V4PagePaginationArray

<

InstanceListResponse

>

get/accounts/{account_id}/workflows/{workflow_name}/instances

List of workflow instances

client.workflows.instances.get(, , , ):

InstanceGetResponse

get/accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}

Get logs and status from instance

client.workflows.instances.create(, , ):

InstanceCreateResponse

post/accounts/{account_id}/workflows/{workflow_name}/instances

Create a new workflow instance

client.workflows.instances.bulk(, , ):

<

InstanceBulkResponse

>

post/accounts/{account_id}/workflows/{workflow_name}/instances/batch

Batch create new Workflow instances

Workflows Instances

Events

Workflows.Instances.Events

Methods

client.workflows.instances.events.create(, , , , ):

EventCreateResponse

post/accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/events/{event_type}

Send event to instance

Workflows Instances

Status

Workflows.Instances.Status

Methods

client.workflows.instances.status.edit(, , , ):

StatusEditResponse

patch/accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/status

Change status of instance

Versions

Workflows.Versions

Methods

client.workflows.versions.list(, , ):

V4PagePaginationArray

<

VersionListResponse

>

get/accounts/{account_id}/workflows/{workflow_name}/versions

List deployed Workflow versions

client.workflows.versions.get(, , , ):

VersionGetResponse

get/accounts/{account_id}/workflows/{workflow_name}/versions/{version_id}

Get Workflow version details