Get Workflow version details

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

Retrieves details for a specific deployed 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, 7 more }

id: string

formatuuid

class_name: string

created_on: string

formatdate-time

has_dag: boolean

language: "javascript" or "python"

The programming language of the workflow implementation.

One of the following:

"javascript"

"python"

modified_on: string

formatdate-time

workflow_id: string

formatuuid

concurrency: optional object { limit }

limit: optional number

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 object { error_retention, success_retention }

error_retention: optional number

Default error retention in milliseconds.

maximum9007199254740991

minimum-9007199254740991

success_retention: optional number

Default success retention in milliseconds.

maximum9007199254740991

minimum-9007199254740991

limits: optional object { steps }

steps: optional number

maximum9007199254740991

minimum1

success: true

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

count: number

per_page: number

total_count: number

cursor: optional string

page: optional number

total_pages: optional number

Get Workflow version details

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

{
  "errors": [],
  "messages": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "result": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "class_name": "class_name",
    "created_on": "2019-12-27T18:11:19.117Z",
    "has_dag": true,
    "language": "javascript",
    "modified_on": "2019-12-27T18:11:19.117Z",
    "workflow_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "concurrency": {
      "limit": 1
    },
    "default_retention": {
      "error_retention": -9007199254740991,
      "success_retention": -9007199254740991
    },
    "limits": {
      "steps": 1
    }
  },
  "success": true,
  "result_info": {
    "count": 0,
    "per_page": 0,
    "total_count": 0,
    "cursor": "cursor",
    "page": 0,
    "total_pages": 0
  }
}

Returns Examples

{
  "errors": [],
  "messages": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "result": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "class_name": "class_name",
    "created_on": "2019-12-27T18:11:19.117Z",
    "has_dag": true,
    "language": "javascript",
    "modified_on": "2019-12-27T18:11:19.117Z",
    "workflow_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "concurrency": {
      "limit": 1
    },
    "default_retention": {
      "error_retention": -9007199254740991,
      "success_retention": -9007199254740991
    },
    "limits": {
      "steps": 1
    }
  },
  "success": true,
  "result_info": {
    "count": 0,
    "per_page": 0,
    "total_count": 0,
    "cursor": "cursor",
    "page": 0,
    "total_pages": 0
  }
}