Skip to content
Cloudflare API
Start here
API Reference
Workflows

Versions

List deployed Workflow versions
workflows.versions.list(strworkflow_name, VersionListParams**kwargs) -> SyncV4PagePaginationArray[VersionListResponse]
GET/accounts/{account_id}/workflows/{workflow_name}/versions
Get Workflow version details
workflows.versions.get(strversion_id, VersionGetParams**kwargs) -> VersionGetResponse
GET/accounts/{account_id}/workflows/{workflow_name}/versions/{version_id}
Get Workflow version graph
workflows.versions.graph(strversion_id, VersionGraphParams**kwargs) -> VersionGraphResponse
GET/accounts/{account_id}/workflows/{workflow_name}/versions/{version_id}/graph
ModelsExpand Collapse
class VersionListResponse: …
id: str
formatuuid
class_name: str
created_on: datetime
formatdate-time
has_dag: bool
language: Literal["javascript", "python"]

The programming language of the workflow implementation.

One of the following:
"javascript"
"python"
modified_on: datetime
formatdate-time
workflow_id: str
formatuuid
concurrency: Optional[Concurrency]
limit: Optional[int]

Maximum number of instances of this workflow that can run concurrently. Additional instances are queued and started as running instances complete. Must not exceed the account concurrency limit.

maximum9007199254740991
minimum1
default_retention: Optional[DefaultRetention]
error_retention: Optional[int]

Default error retention in milliseconds.

maximum9007199254740991
minimum-9007199254740991
success_retention: Optional[int]

Default success retention in milliseconds.

maximum9007199254740991
minimum-9007199254740991
limits: Optional[Limits]
steps: Optional[int]
maximum9007199254740991
minimum1
class VersionGetResponse: …
id: str
formatuuid
class_name: str
created_on: datetime
formatdate-time
has_dag: bool
language: Literal["javascript", "python"]

The programming language of the workflow implementation.

One of the following:
"javascript"
"python"
modified_on: datetime
formatdate-time
workflow_id: str
formatuuid
concurrency: Optional[Concurrency]
limit: Optional[int]

Maximum number of instances of this workflow that can run concurrently. Additional instances are queued and started as running instances complete. Must not exceed the account concurrency limit.

maximum9007199254740991
minimum1
default_retention: Optional[DefaultRetention]
error_retention: Optional[int]

Default error retention in milliseconds.

maximum9007199254740991
minimum-9007199254740991
success_retention: Optional[int]

Default success retention in milliseconds.

maximum9007199254740991
minimum-9007199254740991
limits: Optional[Limits]
steps: Optional[int]
maximum9007199254740991
minimum1
class VersionGraphResponse: …
id: str
formatuuid
class_name: str
created_on: datetime
formatdate-time
graph: Optional[Graph]

Versioned workflow graph payload.

version: float
workflow: GraphWorkflow

A parsed workflow entrypoint with its step graph.

class_name: str
functions: Dict[str, GraphWorkflowFunctions]
name: str
nodes: List[object]

Child nodes (recursive).

type: Literal["function_def"]
nodes: List[GraphWorkflowNode]
One of the following:
class GraphWorkflowNodeUnionMember0: …
duration: Union[float, str]

Duration as milliseconds (number) or human-readable string.

One of the following:
float
str
name: str
type: Literal["step_sleep"]
resolves: Optional[float]
starts: Optional[float]
class GraphWorkflowNodeUnionMember1: …
config: GraphWorkflowNodeUnionMember1Config

Configuration for a step (retries and timeout).

retries: GraphWorkflowNodeUnionMember1ConfigRetries

Retry policy for a step.

backoff: Literal["constant", "linear", "exponential"]

Backoff strategy for step retries.

One of the following:
"constant"
"linear"
"exponential"
delay: Union[float, str]

Duration as milliseconds (number) or human-readable string.

One of the following:
float
str
limit: float
timeout: Union[float, str]

Duration as milliseconds (number) or human-readable string.

One of the following:
float
str
name: str
nodes: List[object]

Child nodes (recursive).

type: Literal["step_do"]
resolves: Optional[float]
starts: Optional[float]
class GraphWorkflowNodeUnionMember2: …
name: str
options: Optional[GraphWorkflowNodeUnionMember2Options]

Options for a waitForEvent step.

event_type: str
timeout: Union[float, str]

Duration as milliseconds (number) or human-readable string.

One of the following:
float
str
type: Literal["step_wait_for_event"]
payload: Optional[GraphWorkflowNodeUnionMember2Payload]

Shape descriptor for JSON payloads.

One of the following:
class GraphWorkflowNodeUnionMember2PayloadType: …
type: Literal["unknown"]
class GraphWorkflowNodeUnionMember2PayloadUnionMember1: …
fields: Dict[str, object]

Nested JsonShape fields (recursive structure).

type: Literal["object"]
resolves: Optional[float]
starts: Optional[float]
class GraphWorkflowNodeUnionMember3: …
name: str
timestamp: str
type: Literal["step_sleep_until"]
resolves: Optional[float]
starts: Optional[float]
class GraphWorkflowNodeUnionMember4: …
nodes: List[object]

Child nodes (recursive).

type: Literal["loop"]
class GraphWorkflowNodeUnionMember5: …
kind: Literal["all", "any", "all_settled", "race"]

Parallel execution strategy.

One of the following:
"all"
"any"
"all_settled"
"race"
nodes: List[object]

Child nodes (recursive).

type: Literal["parallel"]
class GraphWorkflowNodeUnionMember6: …
catch_block: Optional[GraphWorkflowNodeUnionMember6CatchBlock]
nodes: List[object]

Child nodes (recursive).

type: Literal["block"]
finally_block: Optional[GraphWorkflowNodeUnionMember6FinallyBlock]
nodes: List[object]

Child nodes (recursive).

type: Literal["block"]
try_block: Optional[GraphWorkflowNodeUnionMember6TryBlock]
nodes: List[object]

Child nodes (recursive).

type: Literal["block"]
type: Literal["try"]
class GraphWorkflowNodeUnionMember7: …
nodes: List[object]

Child nodes (recursive).

type: Literal["block"]
class GraphWorkflowNodeUnionMember8: …
branches: List[GraphWorkflowNodeUnionMember8Branch]
condition: Optional[str]
nodes: List[object]

Child nodes (recursive).

type: Literal["if"]
class GraphWorkflowNodeUnionMember9: …
branches: List[GraphWorkflowNodeUnionMember9Branch]
condition: Optional[str]
nodes: List[object]

Child nodes (recursive).

discriminant: str
type: Literal["switch"]
class GraphWorkflowNodeUnionMember10: …
class_name: str
functions: Dict[str, GraphWorkflowNodeUnionMember10Functions]
name: str
nodes: List[object]

Child nodes (recursive).

type: Literal["function_def"]
nodes: List[object]

Child nodes (recursive).

type: Literal["start"]
payload: Optional[GraphWorkflowNodeUnionMember10Payload]

Shape descriptor for JSON payloads.

One of the following:
class GraphWorkflowNodeUnionMember10PayloadType: …
type: Literal["unknown"]
class GraphWorkflowNodeUnionMember10PayloadUnionMember1: …
fields: Dict[str, object]

Nested JsonShape fields (recursive structure).

type: Literal["object"]
class GraphWorkflowNodeUnionMember11: …
name: str
type: Literal["function_call"]
resolves: Optional[float]
starts: Optional[float]
class GraphWorkflowNodeUnionMember12: …
name: str
nodes: List[object]

Child nodes (recursive).

type: Literal["function_def"]
class GraphWorkflowNodeUnionMember13: …
kind: Literal["break", "return"]

Break or return from a loop.

One of the following:
"break"
"return"
type: Literal["break"]
payload: Optional[GraphWorkflowPayload]

Shape descriptor for JSON payloads.

One of the following:
class GraphWorkflowPayloadType: …
type: Literal["unknown"]
class GraphWorkflowPayloadUnionMember1: …
fields: Dict[str, object]

Nested JsonShape fields (recursive structure).

type: Literal["object"]
modified_on: datetime
formatdate-time
workflow_id: str
formatuuid