Skip to content
Proud to collaborate with Microsoft for Startups

data.gitops.sync-run.record ​

Persist a GitOpsSyncRun and roll the application's status forward

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-gitops
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes——
application_uuiduuidYes——
workflow_idstringNo——
triggerstringYes——
statusstringYes—synced
commit_shastringNo——
resolved_refstringNo——
resultjsonNo——
error_messagestringNo——
applied_kindsjsonNo—apiVersion/Kind list applied this sync — remembered for prune scope

Output Schema ​

FieldTypeRequiredDefaultDescription
sync_run_uuiduuidNo——
application_statusstringNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—complete—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingcompletecompleted—
pendingfailfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "data.gitops.sync-run.record",
  "initial_data": {
    "organization_uuid": "value",
    "application_uuid": "value",
    "trigger": "value",
    "status": "value"
  }
}