Skip to main content
GET
Get workflow

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

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

updated_at
string<date-time>

Timestamp when the workflow was last updated

version_number
integer

Current version number of the workflow

version_id
string<uuid>

ID of the current workflow version

input_schema
object | null

JSON schema defining the workflow's input variables

vault_schema
object | null

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.

allow_requeue
boolean

Whether automatic retries are enabled for this workflow. When false, the workflow will not be automatically retried on transient failures regardless of other recovery settings.

deny_requeue_past_dry_run_marker
boolean

When the workflow has a dry-run marker (end_here_on_dry_run), restricts automatic retries to failures that occur before the marker. Only effective when allow_requeue is true. Defaults to true.

enable_action_timing_recovery
boolean

Whether action timing recovery is enabled

enable_network_listener
boolean

Whether network listener capture is enabled for this workflow version