Start the given workflow

Prev Next
Post
/v1/workflow_runs
Security
API Key: bearerToken
Header parameter nameAuthentication

A JWT bearer token to be passed once authenticated.

Body parameters
Expand All
object
graph_id
string (uuid) Required

UUID of a graph.

graph_version
string Required

Version of a graph.

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 Required
cluster_id
string (uuid) Required
aci_single_job
object (AciSingleJob)
cluster_id
string (uuid) Required
deployment_location
string
runtime_configs
object
property*
object (WorkflowObjectFinalAppPatch) additionalProperties
deployment
object (WorkflowAppDeployment)

Deployment info for an app. Exactly one of kubernetes or aci field must be set.

kubernetes
object (WorkflowAppKubernetes)
job_spec
object Required
aci
object (WorkflowAppAci)
exposed_ports
Array of object (DockerNetworkPort) Required

List of ports exposed for the azure container instance.

object

A port exposed by a docker container.

port
integer Required

A valid, specific port number from 1..65535 (inclusive).

protocol
string Required

Protocol Associated with a Port exposed by a docker container.

Valid values[ "Tcp", "Udp" ]
env_vars
object Required
property*
string additionalProperties
Responses
200

OK

Expand All
object
run
object (WorkflowRun)
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)
generic
object (WorkflowRunRawResponse)
kubernetes
aci