Skip to main content
GET
Get workflow metadata

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

Query Parameters

version
string

Describe the highest release matching this exact version (1.2.3) or semver range (^1.2.0, ~1.2.3, 1.x). A bare integer N means the latest N.x.x. Cannot be combined with branch_id.

branch_id
string<uuid>

Describe this branch's latest version instead of the default branch's. Cannot be combined with version.

Response

Successful operation

input_schema
object

Full JSON schema used to validate run_input_variables, including workflow-level and derived schema constraints.

workspace_id
string<uuid>

ID of the workspace that owns the workflow

version_id
string<uuid>

UUID of the workflow version these schemas belong to

version
string

Semantic version of the workflow version these schemas belong to

Example:

"1.2.3"

branch_id
string<uuid>

Branch the described version was saved on

vault_schema
object

Schema defining vault credentials and their configuration

Example: