Appearance
gitops.application.update ​
Edit a GitOpsApplication's source/policy; reconcile its controller
Update a GitOpsApplication. Only supplied fields change. Toggling auto_sync starts/stops the controller poll loop accordingly.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-gitops |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | — |
application_uuid | uuid | Yes | — | — |
name | string | No | — | — |
description | string | No | — | — |
repo_path | string | No | — | — |
ref_kind | string | No | — | — |
ref | string | No | — | — |
target_namespace | string | No | — | — |
auto_sync | boolean | No | — | — |
self_heal | boolean | No | — | — |
prune | boolean | No | — | — |
poll_interval_seconds | integer | No | — | — |
config | json | No | — | — |
registry_account_uuid | uuid | No | — | Private registry for image pulls; omit to leave unchanged |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
application_uuid | uuid | No | — | — |
updated_fields | json | No | — | — |
controller_workflow_id | string | No | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | update | — |
failed | No | Yes | No | — | — |
updated | No | Yes | Yes | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | update | updated | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "gitops.application.update",
"initial_data": {
"organization_uuid": "value",
"application_uuid": "value"
}
}