Skip to main content
GET
/
workflows
/
{workflow_id}
Get workflow
curl --request GET \
  --url https://api.cloudcruise.com/workflows/{workflow_id} \
  --header 'cc-key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "nodes": [
    {}
  ],
  "edges": {},
  "description": "<string>",
  "version_number": 123,
  "version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "input_schema": {},
  "vault_schema": {},
  "enable_popup_handling": true,
  "enable_xpath_recovery": true,
  "enable_node_description_enrichment": true,
  "enable_error_code_generation": true,
  "enable_service_unavailable_recovery": true,
  "enable_incorrect_form_input_recovery": true,
  "enable_password_update_recovery": true,
  "enable_tfa_setup_recovery": true,
  "enable_action_timing_recovery": true,
  "origin_catalog_workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "origin_catalog_version_number": 123,
  "origin_catalog_workflow_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "origin_base_version_number": 123,
  "track_updates_from_catalog": true,
  "enable_network_listener": true,
  "skip_udp_proxying": true
}

Authorizations

​
cc-key
string
header
required

API key-based authentication. Provide your CloudCruise API key in the cc-key header.

Headers

​
cc-key
string

CloudCruise API key for authentication

Path Parameters

​
workflow_id
string
required

The ID of the workflow

Response

Successful operation

Full workflow definition including nodes and edges

​
id
string<uuid>
required

Unique identifier for the workflow

​
name
string
required

Name of the workflow

​
created_at
string<date-time>
required

Timestamp when the workflow was created

​
updated_at
string<date-time>
required

Timestamp when the workflow was last updated

​
workspace_id
string<uuid>
required

ID of the workspace this workflow belongs to

​
created_by
string<uuid>
required

ID of the user who created the workflow

​
nodes
object[]
required

Array of workflow step nodes

​
edges
object
required

Map of edges connecting workflow nodes

​
description
string | null

Description of the workflow

​
version_number
integer

Current version number of the workflow

​
version_id
string<uuid>

ID of the current workflow version

​
input_schema
object

JSON schema defining the workflow's input variables

​
vault_schema
object

Schema defining vault credentials and their configuration

​
enable_popup_handling
boolean

Whether popup handling is enabled for this workflow

​
enable_xpath_recovery
boolean

Whether XPath recovery is enabled for this workflow

​
enable_node_description_enrichment
boolean

Whether node descriptions are auto-enriched for reliability improvements

​
enable_error_code_generation
boolean

Whether error code generation is enabled for this workflow

​
enable_service_unavailable_recovery
boolean

Whether service unavailable recovery is enabled for this workflow

​
enable_incorrect_form_input_recovery
boolean

Whether incorrect form input recovery is enabled

​
enable_password_update_recovery
boolean

Whether password update recovery is enabled. When a site forces a password change, the Maintenance Agent classifies the error and sends a notification.

​
enable_tfa_setup_recovery
boolean

Whether automatic TFA setup recovery is enabled. When a site requires two-factor authentication setup during login, the Maintenance Agent can autonomously complete the enrollment and update the vault credential.

​
enable_action_timing_recovery
boolean

Whether action timing recovery is enabled for this workflow

​
origin_catalog_workflow_id
string<uuid> | null

ID of the catalog workflow this was forked from (if applicable)

​
origin_catalog_version_number
integer | null

Version number of the catalog workflow this was forked from

​
origin_catalog_workflow_version_id
string<uuid> | null

Specific origin catalog workflow version ID used as the base

​
origin_base_version_number
integer | null

Base version number used when deriving from a catalog workflow

​
track_updates_from_catalog
boolean

Whether to track updates from the origin catalog workflow

​
enable_network_listener
boolean

Whether network listener capture is enabled for this workflow version

​
skip_udp_proxying
boolean

Whether UDP proxying is skipped for this workflow version