argocd.application.update-spec ​
UpdateSpec updates an application spec
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-argocd |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
base_url | string | Yes | — | Argocd API root, e.g. https://<host>/api |
api_token | string | No | — | Bearer token; omit to use the workflow's token env var |
name | string | Yes | — | — |
destination | json | No | — | — |
ignoredifferences | list | No | — | — |
info | list | No | — | — |
project | string | No | — | Project is a reference to the project this application belongs to. The empty string means that application belongs to the 'default' project. |
revisionhistorylimit | integer | No | — | RevisionHistoryLimit limits the number of items kept in the application's revision history, which is used for informational purposes as well as for rollbacks to previous versions. This should only be changed in exceptional circumstances. Setting to zero will store no history. This will reduce storage used. Increasing will increase the space used to store the history, so we do not recommend increasing it. Default is 10. |
source | json | No | — | — |
sourcehydrator | json | No | — | SourceHydrator specifies a dry "don't repeat yourself" source for manifests, a sync source from which to sync hydrated manifests, and an optional hydrateTo location to act as a "staging" aread for hydrated manifests. |
sources | list | No | — | — |
syncpolicy | json | No | — | — |
validate | boolean | No | — | — |
appnamespace | string | No | — | — |
project_2 | string | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
base_url | string | Yes | — | Argocd API root, e.g. https://<host>/api |
api_token | string | No | — | Bearer token; omit to use the workflow's token env var |
name | string | Yes | — | — |
destination | json | No | — | — |
ignoredifferences | list | No | — | — |
info | list | No | — | — |
project | string | No | — | Project is a reference to the project this application belongs to. The empty string means that application belongs to the 'default' project. |
revisionhistorylimit | integer | No | — | RevisionHistoryLimit limits the number of items kept in the application's revision history, which is used for informational purposes as well as for rollbacks to previous versions. This should only be changed in exceptional circumstances. Setting to zero will store no history. This will reduce storage used. Increasing will increase the space used to store the history, so we do not recommend increasing it. Default is 10. |
source | json | No | — | — |
sourcehydrator | json | No | — | SourceHydrator specifies a dry "don't repeat yourself" source for manifests, a sync source from which to sync hydrated manifests, and an optional hydrateTo location to act as a "staging" aread for hydrated manifests. |
sources | list | No | — | — |
syncpolicy | json | No | — | — |
validate | boolean | No | — | — |
appnamespace | string | No | — | — |
project_2 | string | No | — | — |
status_code | integer | No | — | HTTP status code of the completed call |
response | json | No | — | Parsed JSON response body |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_at | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
failed_at_state | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | Waiting to call PUT /api/v1/applications/{name}/spec |
completed | No | Yes | Yes | — | HTTP call succeeded |
failed | No | Yes | No | — | HTTP call failed |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | Perform PUT /api/v1/applications/{name}/spec |
* (any state) | fail | failed | Record the failure reason |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "argocd.application.update-spec",
"initial_data": {
"base_url": "value",
"name": "value"
}
}