Update a cluster stack

Surgical partial update of a stack’s addons/manifests.

Accepts the same body as the web UI endpoint. Callers must set partial_stack=true to merge-update (vs replace) the named stack. Requires stacks.write on the cluster; a caller without it is refused with 403.

PATCH /api/v1/org/clusters/imported/{cluster_id}/stacks/{stack_name}

Update a cluster stack

Python

import requests

url = "https://platform.ankra.app/api/v1/org/clusters/imported/{cluster_id}/stacks/{stack_name}"

payload = { "spec": {
        "argo_cd": {
            "namespace": "<string>",
            "version": "<string>"
        },
        "git_repository": {
            "branch": "<string>",
            "credential_name": "<string>",
            "repository": "<string>",
            "provider": "github"
        },
        "helm_registries": [
            {
                "name": "<string>",
                "url": "<string>",
                "credential_name": "<string>",
                "exclude_charts": ["<string>"]
            }
        ],
        "kubernetes": { "version": "0.0.0" },
        "prometheus_credential": {
            "name": "<string>",
            "password": "<string>",
            "token": "<string>",
            "username": "<string>"
        },
        "prometheus_metrics": {
            "endpoint": "<string>",
            "credential_name": "<string>",
            "flavor": "<string>",
            "tenant_id": "<string>"
        },
        "provider": "imported",
        "stacks": []
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

200

{
  "stack_name": "<string>",
  "commit_sha": "<string>",
  "commit_url": "<string>",
  "errors": [],
  "job_count": 0,
  "noop_count": 0,
  "operation_id": "<string>",
  "settings_only_count": 0,
  "warnings": []
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization · string | null

x-ankra-organisation-id · string | null

Path Parameters

cluster_id · string<uuid4> · required

stack_name · string · required

Body

application/json

spec · ResourceSpecification · object · required

Show child attributes

allow_chart_downgrade · boolean · default: false · deprecated

Retired. It used to admit every chart downgrade in the write, including ones the person was never shown; it is still accepted as a boolean, but it admits nothing. Send confirmed_chart_downgrades instead.

confirmed_chart_downgrades · ConfirmedChartDowngrade · object[]

The chart downgrades the person confirmed. A write that moves a member's chart_version BELOW the currently declared version is refused with 422 CHART_VERSION_DOWNGRADE, whose detail.details.downgrades names every move, so that a stale whole-stack snapshot cannot silently revert somebody else's chart bump. Re-send the write with those rows here: each admits exactly the move it names, and a downgrade the list does not name (a version that moved while the question was open) is refused again, naming every move with confirmed marking the ones already named.

Maximum array length: 200

Show child attributes

draft_id · string<uuid4> | null

expected_digest · string | null

The change-set digest the caller reviewed, as GET /drafts/stacks/{draft_id}/diff reports it for draft_id. Optional: omit it and the write behaves exactly as before. When sent, the server recomputes the change set inside the write transaction, under the cluster lock, and refuses with 422 CHANGE_SET_DRIFTED if it no longer matches - so an approval cannot ship a draft that moved since it was read.

partial_stack · boolean · default: false

resource_version · string | null

confirmed_member_removals · string[]

On the bearer route, for a full replace (partial_stack false) without draft_id: the members, as kind/name, the caller confirms the write may remove because the body no longer lists them. Without it (or prune) such a removal is refused with 422 STACK_MEMBER_REMOVAL_UNCONFIRMED naming the members, and nothing is written.

Maximum array length: 200

prune · boolean · default: false

On the bearer route, for a full replace without draft_id: confirm every removal the write makes. Send it only when the body is the complete, current definition of the stack.

Response

200

application/json

Successful Response

stack_name · string · required

commit_sha · string | null

commit_url · string | null

errors · ResourceError · object[]

Show child attributes

job_count · integer · default: 0

noop_count · integer · default: 0

operation_id · string<uuid4> | null

settings_only_count · integer · default: 0

warnings · ValidationWarning · object[]

Show child attributes