Patch
/v1/workflow_runs/{run-id}
Security
API Key: bearerToken
Header parameter nameAuthentication
A JWT bearer token to be passed once authenticated.
Path parameters
run-id
string (uuid) Required
An instance of a running workflow.
Body parameters
Request to update a workflow run
object
run_status
string
Valid values[
"PENDING",
"RUNNING",
"FAILED",
"SUCCEEDED",
"TERMINATING",
"TERMINATED",
"UNKNOWN"
]
Responses
200
OK
object
run_id
string (uuid)
Run ID of running workflow
run_status
string
Valid values[
"PENDING",
"RUNNING",
"FAILED",
"SUCCEEDED",
"TERMINATING",
"TERMINATED",
"UNKNOWN"
]
created_at
integer (int64)
Time workflow was started.
graph_id
string (uuid)
graph_version
string
The current version of the running graph, not necessarily the same version that was started originally.
group_id
string (uuid)
deployment
object (WorkflowDeployment)
Deployment info for a workflow. Exactly one of kubernetes_single_job or aci_single_job field must be set.
kubernetes_single_job
object (KubernetesSingleJob)
namespace
string
cluster_id
string (uuid)
aci_single_job
object (AciSingleJob)
cluster_id
string (uuid)
deployment_location
string
workflow_cluster_data
object (WorkflowRunData)
AciSingleJob
object (AciWorkflowRunData)
app_id
string (uuid)
build_id
string (uuid)
config_id
string
cluster_id
string (uuid)
container_group_name
string
deployment_name
string
KubernetesSingleJob
object (KubernetesWorkflowRunData)
app_id
string (uuid)
build_id
string (uuid)
config_id
string
cluster_id
string (uuid)