workflows_instances

Creates, updates, deletes, gets or lists a workflows_instances resource.

Overview

Name	workflows_instances
Type	Resource
Id	cloudflare.workflows.workflows_instances

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_by_account	insert	workflow_name, account_id		Creates a new instance of a workflow, starting its execution.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_id	string	The Cloudflare account ID.
workflow_name	string	The Workflow name.

INSERT examples

create_by_account

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

INSERT INTO cloudflare.workflows.workflows_instances (
instance_id,
instance_retention,
params,
workflow_name,
account_id
)
SELECT 
'{{ instance_id }}',
'{{ instance_retention }}',
'{{ params }}',
'{{ workflow_name }}',
'{{ account_id }}'
RETURNING
errors,
messages,
result,
result_info,
success
;

Manifest

# Description fields are for documentation purposes
- name: workflows_instances
props:
  - name: workflow_name
    value: "{{ workflow_name }}"
    description: Required parameter for the workflows_instances resource.
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the workflows_instances resource.
  - name: instance_id
    value: "{{ instance_id }}"
  - name: instance_retention
    value:
      error_retention: {{ error_retention }}
      success_retention: {{ success_retention }}
  - name: params
    value: "{{ params }}"