Get Workflow version details

workflows.versions.get(, ) -> VersionGetResponse

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

ParametersExpand Collapse

account_id: str

workflow_name: str

maxLength64

minLength1

version_id: str

formatuuid

ReturnsExpand Collapse

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

Get Workflow version details

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
version = client.workflows.versions.get(
    version_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    account_id="account_id",
    workflow_name="x",
)
print(version.id)

{
  "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
  }
}