curl --request PUT \
--url https://api.cloudcruise.com/workflow-components/{component_id} \
--header 'Content-Type: application/json' \
--header 'cc-key: <api-key>' \
--data '
{
"componentData": {
"nodes": [
{
"workflowNode": {
"id": "<string>",
"name": "<string>",
"parameters": {},
"description": "<string>"
},
"position": {
"x": 123,
"y": 123
}
}
],
"workflowEdges": {},
"reactFlowEdges": [
{
"sourceId": "<string>",
"targetId": "<string>",
"sourceHandle": "<string>",
"targetHandle": "<string>"
}
],
"vault_schema": {}
},
"versionNote": "Fixed login XPath",
"propagate": true,
"sourceWorkflowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.cloudcruise.com/workflow-components/{component_id}"
payload = {
"componentData": {
"nodes": [
{
"workflowNode": {
"id": "<string>",
"name": "<string>",
"parameters": {},
"description": "<string>"
},
"position": {
"x": 123,
"y": 123
}
}
],
"workflowEdges": {},
"reactFlowEdges": [
{
"sourceId": "<string>",
"targetId": "<string>",
"sourceHandle": "<string>",
"targetHandle": "<string>"
}
],
"vault_schema": {}
},
"versionNote": "Fixed login XPath",
"propagate": True,
"sourceWorkflowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"cc-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'cc-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
componentData: {
nodes: [
{
workflowNode: {id: '<string>', name: '<string>', parameters: {}, description: '<string>'},
position: {x: 123, y: 123}
}
],
workflowEdges: {},
reactFlowEdges: [
{
sourceId: '<string>',
targetId: '<string>',
sourceHandle: '<string>',
targetHandle: '<string>'
}
],
vault_schema: {}
},
versionNote: 'Fixed login XPath',
propagate: true,
sourceWorkflowId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.cloudcruise.com/workflow-components/{component_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cloudcruise.com/workflow-components/{component_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'componentData' => [
'nodes' => [
[
'workflowNode' => [
'id' => '<string>',
'name' => '<string>',
'parameters' => [
],
'description' => '<string>'
],
'position' => [
'x' => 123,
'y' => 123
]
]
],
'workflowEdges' => [
],
'reactFlowEdges' => [
[
'sourceId' => '<string>',
'targetId' => '<string>',
'sourceHandle' => '<string>',
'targetHandle' => '<string>'
]
],
'vault_schema' => [
]
],
'versionNote' => 'Fixed login XPath',
'propagate' => true,
'sourceWorkflowId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"cc-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.cloudcruise.com/workflow-components/{component_id}"
payload := strings.NewReader("{\n \"componentData\": {\n \"nodes\": [\n {\n \"workflowNode\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"parameters\": {},\n \"description\": \"<string>\"\n },\n \"position\": {\n \"x\": 123,\n \"y\": 123\n }\n }\n ],\n \"workflowEdges\": {},\n \"reactFlowEdges\": [\n {\n \"sourceId\": \"<string>\",\n \"targetId\": \"<string>\",\n \"sourceHandle\": \"<string>\",\n \"targetHandle\": \"<string>\"\n }\n ],\n \"vault_schema\": {}\n },\n \"versionNote\": \"Fixed login XPath\",\n \"propagate\": true,\n \"sourceWorkflowId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("cc-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.cloudcruise.com/workflow-components/{component_id}")
.header("cc-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"componentData\": {\n \"nodes\": [\n {\n \"workflowNode\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"parameters\": {},\n \"description\": \"<string>\"\n },\n \"position\": {\n \"x\": 123,\n \"y\": 123\n }\n }\n ],\n \"workflowEdges\": {},\n \"reactFlowEdges\": [\n {\n \"sourceId\": \"<string>\",\n \"targetId\": \"<string>\",\n \"sourceHandle\": \"<string>\",\n \"targetHandle\": \"<string>\"\n }\n ],\n \"vault_schema\": {}\n },\n \"versionNote\": \"Fixed login XPath\",\n \"propagate\": true,\n \"sourceWorkflowId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloudcruise.com/workflow-components/{component_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["cc-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"componentData\": {\n \"nodes\": [\n {\n \"workflowNode\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"parameters\": {},\n \"description\": \"<string>\"\n },\n \"position\": {\n \"x\": 123,\n \"y\": 123\n }\n }\n ],\n \"workflowEdges\": {},\n \"reactFlowEdges\": [\n {\n \"sourceId\": \"<string>\",\n \"targetId\": \"<string>\",\n \"sourceHandle\": \"<string>\",\n \"targetHandle\": \"<string>\"\n }\n ],\n \"vault_schema\": {}\n },\n \"versionNote\": \"Fixed login XPath\",\n \"propagate\": true,\n \"sourceWorkflowId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"version_number": 2
}Update workflow component
Updates a workflow component’s component_data (nodes, edges, vault schema). Creates a new version of the component.
Propagation: By default, all workflows in the workspace that contain instances of this component are automatically updated to reflect the new template. Set propagate: false to skip propagation.
Multiple instances per workflow are supported. Each paste-instance is tracked by its own source_component_instance_id and updated independently.
sourceWorkflowId (advanced): Skips propagation for the entire workflow with the given id. The frontend uses this when a single instance was edited locally and saved back to the library. The editor already reflects the new structure, so re-propagating to the same workflow would be redundant. Caveat for multi-instance workflows: the skip is workflow-scoped, not instance-scoped. If the source workflow contains other instances of this component that were not part of the local edit, those instances will not be updated and will go stale. Pass sourceWorkflowId only when the source workflow contains exactly one instance of the component, or when every instance in it is already in sync with the new componentData. If unsure, omit sourceWorkflowId and let propagation update everything.
Typical usage:
GET /workflow-components/{component_id}/usageto see affected workflowsGET /workflow-components/{component_id}to fetch the current component- Modify
componentDataas needed PUT /workflow-components/{component_id}to save and propagate
curl --request PUT \
--url https://api.cloudcruise.com/workflow-components/{component_id} \
--header 'Content-Type: application/json' \
--header 'cc-key: <api-key>' \
--data '
{
"componentData": {
"nodes": [
{
"workflowNode": {
"id": "<string>",
"name": "<string>",
"parameters": {},
"description": "<string>"
},
"position": {
"x": 123,
"y": 123
}
}
],
"workflowEdges": {},
"reactFlowEdges": [
{
"sourceId": "<string>",
"targetId": "<string>",
"sourceHandle": "<string>",
"targetHandle": "<string>"
}
],
"vault_schema": {}
},
"versionNote": "Fixed login XPath",
"propagate": true,
"sourceWorkflowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.cloudcruise.com/workflow-components/{component_id}"
payload = {
"componentData": {
"nodes": [
{
"workflowNode": {
"id": "<string>",
"name": "<string>",
"parameters": {},
"description": "<string>"
},
"position": {
"x": 123,
"y": 123
}
}
],
"workflowEdges": {},
"reactFlowEdges": [
{
"sourceId": "<string>",
"targetId": "<string>",
"sourceHandle": "<string>",
"targetHandle": "<string>"
}
],
"vault_schema": {}
},
"versionNote": "Fixed login XPath",
"propagate": True,
"sourceWorkflowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"cc-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'cc-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
componentData: {
nodes: [
{
workflowNode: {id: '<string>', name: '<string>', parameters: {}, description: '<string>'},
position: {x: 123, y: 123}
}
],
workflowEdges: {},
reactFlowEdges: [
{
sourceId: '<string>',
targetId: '<string>',
sourceHandle: '<string>',
targetHandle: '<string>'
}
],
vault_schema: {}
},
versionNote: 'Fixed login XPath',
propagate: true,
sourceWorkflowId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.cloudcruise.com/workflow-components/{component_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cloudcruise.com/workflow-components/{component_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'componentData' => [
'nodes' => [
[
'workflowNode' => [
'id' => '<string>',
'name' => '<string>',
'parameters' => [
],
'description' => '<string>'
],
'position' => [
'x' => 123,
'y' => 123
]
]
],
'workflowEdges' => [
],
'reactFlowEdges' => [
[
'sourceId' => '<string>',
'targetId' => '<string>',
'sourceHandle' => '<string>',
'targetHandle' => '<string>'
]
],
'vault_schema' => [
]
],
'versionNote' => 'Fixed login XPath',
'propagate' => true,
'sourceWorkflowId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"cc-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.cloudcruise.com/workflow-components/{component_id}"
payload := strings.NewReader("{\n \"componentData\": {\n \"nodes\": [\n {\n \"workflowNode\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"parameters\": {},\n \"description\": \"<string>\"\n },\n \"position\": {\n \"x\": 123,\n \"y\": 123\n }\n }\n ],\n \"workflowEdges\": {},\n \"reactFlowEdges\": [\n {\n \"sourceId\": \"<string>\",\n \"targetId\": \"<string>\",\n \"sourceHandle\": \"<string>\",\n \"targetHandle\": \"<string>\"\n }\n ],\n \"vault_schema\": {}\n },\n \"versionNote\": \"Fixed login XPath\",\n \"propagate\": true,\n \"sourceWorkflowId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("cc-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.cloudcruise.com/workflow-components/{component_id}")
.header("cc-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"componentData\": {\n \"nodes\": [\n {\n \"workflowNode\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"parameters\": {},\n \"description\": \"<string>\"\n },\n \"position\": {\n \"x\": 123,\n \"y\": 123\n }\n }\n ],\n \"workflowEdges\": {},\n \"reactFlowEdges\": [\n {\n \"sourceId\": \"<string>\",\n \"targetId\": \"<string>\",\n \"sourceHandle\": \"<string>\",\n \"targetHandle\": \"<string>\"\n }\n ],\n \"vault_schema\": {}\n },\n \"versionNote\": \"Fixed login XPath\",\n \"propagate\": true,\n \"sourceWorkflowId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloudcruise.com/workflow-components/{component_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["cc-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"componentData\": {\n \"nodes\": [\n {\n \"workflowNode\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"parameters\": {},\n \"description\": \"<string>\"\n },\n \"position\": {\n \"x\": 123,\n \"y\": 123\n }\n }\n ],\n \"workflowEdges\": {},\n \"reactFlowEdges\": [\n {\n \"sourceId\": \"<string>\",\n \"targetId\": \"<string>\",\n \"sourceHandle\": \"<string>\",\n \"targetHandle\": \"<string>\"\n }\n ],\n \"vault_schema\": {}\n },\n \"versionNote\": \"Fixed login XPath\",\n \"propagate\": true,\n \"sourceWorkflowId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"version_number": 2
}Authorizations
Body
Payload for updating a workflow component's data. Creates a new version and (by default) propagates changes to every workflow in the workspace that contains instances of this component.
If the update originates from a workflow editor, pass that workflow's id here to skip it during propagation. Workflow-scoped, not instance-scoped: the entire workflow is skipped, including any other instances of this component in it. Use only when the source workflow contains exactly one instance of the component, or when every instance is already in sync with the new componentData. Otherwise omit and let propagation update everything.
Was this page helpful?

