Get all registered running workflows

Prev Next
Get
/v1/workflow_runs

Does not query the orchestrator backend but rather a database table of registered running workflows

Security
API Key: bearerToken
Header parameter nameAuthentication

A JWT bearer token to be passed once authenticated.

Query parameters
sort_by
string

Sort fields. In the format of key1:ASC,key2:DESC,key3:DESC

filter
string

A FilterQuery expression that specifies a filter to apply

limit
integer

Maximum amount of entries to provide (default is 1000)

previous_id
string (uuid)

Start after this Run ID

previous_sort_value
string

If a sort_by is specified that is not the ID (e.g. sort_by=name:ASC), then the value corresponding to that field of the previous_id entry must be given. This field is used for (1) efficient index lookup, and (2) to keep track of the current position in the collection, even if the previous_id entry is updated or deleted in the mean time.

Responses
200

OK

Expand All
object
workflow_runs
Array of object (WorkflowRun)
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)