Cloudflare API | Workflows › Instances › List Of Workflow Instances

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

Storage & Databases

Threat Intelligence

Brand Protection

Workers & Pages

Browser Rendering

Durable Objects

Workers For Platforms

Deletes a Workflow

Get Workflow details

List all Workflows

Create/modify Workflow

Batch create new Workflow instances

Create a new workflow instance

Get logs and status from instance

List of workflow instances

Shared

Workflows

workflows

Methods

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.

Get Workflow Details -> Envelope<{ id, class_name, created_on, 5 more... }>

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

Get Workflow details

List All Workflows -> V4PagePaginationArray<{ id, class_name, created_on, 5 more... }>

get/accounts/{account_id}/workflows

List all Workflows

Create Modify Workflow -> Envelope<{ id, class_name, created_on, 7 more... }>

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

Create/modify Workflow

Instances

workflows.instances

Methods

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

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

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

List Of Workflow Instances -> V4PagePaginationArray<{ id, created_on, ended_on, 5 more... }>

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

List of workflow instances

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

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.

page: number

Optional

(minimum: 1, default: 1)

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, page, per_page, 1 more... }

Optional

Request example

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/workflows/$WORKFLOW_NAME/instances \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"

200Example

{
  "errors": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "result": [
    {
      "id": "x",
      "ended_on": "2019-12-27T18:11:19.117Z",
      "started_on": "2019-12-27T18:11:19.117Z",
      "status": "queued",
      "version_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "workflow_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
    }
  ],
  "success": true,
  "result_info": {
    "count": 0,
    "page": 0,
    "per_page": 0,
    "total_count": 0
  }
}

Workflows Instances

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

Workflows Instances

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

Versions

workflows.versions

Methods

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

List Deployed Workflow Versions -> V4PagePaginationArray<{ id, class_name, created_on, 2 more... }>

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

List deployed Workflow versions