Skip to main content

Overview

Workflow jobs are instances of workflow job templates that have been executed. They contain multiple workflow job nodes, each representing a job, project update, or inventory update.

Endpoints

List Workflow Jobs

Retrieve Workflow Job

integer
Workflow job ID
string
Workflow job name
string
Status: new, pending, waiting, running, successful, failed, error, canceled
string
Start timestamp
string
Completion timestamp
number
Elapsed time in seconds
integer
Source workflow template ID
string
How workflow was launched: manual, relaunch, scheduled, dependency, webhook
string
Extra variables used
Links to related resources:
  • workflow_job_template - Source template
  • workflow_nodes - Workflow execution nodes
  • labels - Job labels
  • activity_stream - Activity log
  • notifications - Notifications sent
  • cancel - Cancel endpoint
  • relaunch - Relaunch endpoint

Workflow Nodes

Get the execution graph:
Each node includes:
  • id - Node ID
  • job - Associated job/update ID
  • unified_job_template - Template that was executed
  • identifier - Node identifier
  • do_not_run - Whether node was skipped
  • success - Whether node succeeded
  • failed - Whether node failed
  • related.success_nodes - Nodes executed on success
  • related.failure_nodes - Nodes executed on failure
  • related.always_nodes - Nodes always executed

Cancel Workflow

Cancels all running jobs in the workflow.

Relaunch Workflow

Labels

Notifications

Activity Stream

Filtering

Monitor Workflow Execution