Get Workflow version graph

GET/accounts/{account_id}/workflows/{workflow_name}/versions/{version_id}/graph

Retrieves the graph visualization of a workflow version.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Workers Tail ReadWorkers Scripts WriteWorkers Scripts Read

Path ParametersExpand Collapse

account_id: string

workflow_name: string

maxLength64

minLength1

version_id: string

formatuuid

ReturnsExpand Collapse

errors: array of object { code, message }

code: number

message: string

messages: array of object { code, message }

code: number

message: string

result: object { id, class_name, created_on, 3 more }

id: string

formatuuid

class_name: string

created_on: string

formatdate-time

graph: object { version, workflow }

Versioned workflow graph payload.

version: number

workflow: object { class_name, functions, nodes, payload }

A parsed workflow entrypoint with its step graph.

class_name: string

functions: map[object { name, nodes, type } ]

nodes: array of unknown

Child nodes (recursive).

type: "function_def"

nodes: array of object { duration, name, type, 2 more } or object { config, name, nodes, 3 more } or object { name, options, type, 3 more } or 11 more

One of the following:

object { duration, name, type, 2 more }

duration: number or string

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

One of the following:

number

string

type: "step_sleep"

resolves: optional number

starts: optional number

object { config, name, nodes, 3 more }

config: object { retries, timeout }

Configuration for a step (retries and timeout).

retries: object { backoff, delay, limit }

Retry policy for a step.

backoff: "constant" or "linear" or "exponential"

Backoff strategy for step retries.

One of the following:

"constant"

"linear"

"exponential"

delay: number or string

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

One of the following:

number

string

limit: number

timeout: number or string

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

One of the following:

number

string

nodes: array of unknown

Child nodes (recursive).

type: "step_do"

resolves: optional number

starts: optional number

object { name, options, type, 3 more }

options: object { event_type, timeout }

Options for a waitForEvent step.

event_type: string

timeout: number or string

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

One of the following:

number

string

type: "step_wait_for_event"

payload: optional object { type } or object { fields, type }

Shape descriptor for JSON payloads.

One of the following:

Type object { type }

type: "unknown"

object { fields, type }

fields: map[unknown]

Nested JsonShape fields (recursive structure).

type: "object"

resolves: optional number

starts: optional number

object { name, timestamp, type, 2 more }

timestamp: string

type: "step_sleep_until"

resolves: optional number

starts: optional number

object { nodes, type }

nodes: array of unknown

Child nodes (recursive).

type: "loop"

object { kind, nodes, type }

kind: "all" or "any" or "all_settled" or "race"

Parallel execution strategy.

One of the following:

"all"

"any"

"all_settled"

"race"

nodes: array of unknown

Child nodes (recursive).

type: "parallel"

object { catch_block, finally_block, try_block, type }

catch_block: object { nodes, type }

nodes: array of unknown

Child nodes (recursive).

type: "block"

finally_block: object { nodes, type }

nodes: array of unknown

Child nodes (recursive).

type: "block"

try_block: object { nodes, type }

nodes: array of unknown

Child nodes (recursive).

type: "block"

type: "try"

object { nodes, type }

nodes: array of unknown

Child nodes (recursive).

type: "block"

object { branches, type }

branches: array of object { condition, nodes }

condition: string

nodes: array of unknown

Child nodes (recursive).

type: "if"

object { branches, discriminant, type }

branches: array of object { condition, nodes }

condition: string

nodes: array of unknown

Child nodes (recursive).

discriminant: string

type: "switch"

object { class_name, functions, nodes, 2 more }

class_name: string

functions: map[object { name, nodes, type } ]

nodes: array of unknown

Child nodes (recursive).

type: "function_def"

nodes: array of unknown

Child nodes (recursive).

type: "start"

payload: optional object { type } or object { fields, type }

Shape descriptor for JSON payloads.

One of the following:

Type object { type }

type: "unknown"

object { fields, type }

fields: map[unknown]

Nested JsonShape fields (recursive structure).

type: "object"

object { name, type, resolves, starts }

type: "function_call"

resolves: optional number

starts: optional number

object { name, nodes, type }

nodes: array of unknown

Child nodes (recursive).

type: "function_def"

object { kind, type }

kind: "break" or "return"

Break or return from a loop.

One of the following:

"break"

"return"

type: "break"

payload: optional object { type } or object { fields, type }

Shape descriptor for JSON payloads.

One of the following:

Type object { type }

type: "unknown"

object { fields, type }

fields: map[unknown]

Nested JsonShape fields (recursive structure).

type: "object"

modified_on: string

formatdate-time

workflow_id: string

formatuuid

success: true

result_info: optional object { count, per_page, total_count, 3 more }

per_page: number

total_count: number

cursor: optional string

page: optional number

total_pages: optional number

Get Workflow version graph

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/workflows/$WORKFLOW_NAME/versions/$VERSION_ID/graph \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

{
  "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",
    "graph": {
      "version": 0,
      "workflow": {
        "class_name": "class_name",
        "functions": {
          "foo": {
            "name": "name",
            "nodes": [
              {}
            ],
            "type": "function_def"
          }
        },
        "nodes": [
          {
            "duration": 0,
            "name": "name",
            "type": "step_sleep",
            "resolves": 0,
            "starts": 0
          }
        ],
        "payload": {
          "type": "unknown"
        }
      }
    },
    "modified_on": "2019-12-27T18:11:19.117Z",
    "workflow_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  },
  "success": true,
  "result_info": {
    "count": 0,
    "per_page": 0,
    "total_count": 0,
    "cursor": "cursor",
    "page": 0,
    "total_pages": 0
  }
}

Returns Examples

{
  "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",
    "graph": {
      "version": 0,
      "workflow": {
        "class_name": "class_name",
        "functions": {
          "foo": {
            "name": "name",
            "nodes": [
              {}
            ],
            "type": "function_def"
          }
        },
        "nodes": [
          {
            "duration": 0,
            "name": "name",
            "type": "step_sleep",
            "resolves": 0,
            "starts": 0
          }
        ],
        "payload": {
          "type": "unknown"
        }
      }
    },
    "modified_on": "2019-12-27T18:11:19.117Z",
    "workflow_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  },
  "success": true,
  "result_info": {
    "count": 0,
    "per_page": 0,
    "total_count": 0,
    "cursor": "cursor",
    "page": 0,
    "total_pages": 0
  }
}