Create a cluster stack

Creates a stack on the cluster from a specification holding exactly one stack, deploys it, and commits it to the cluster’s GitOps repository when one is connected. The response carries validation errors and warnings, the commit, and the operation_id of the deployment; a failed Git push answers 422. On a sandbox cluster the deployment is simulated and settled before the response, so the operation has already succeeded. Requires stacks.write on the cluster; a caller without it is refused with 403.

POST /api/v1/org/clusters/imported/{cluster_id}/stacks

Create a cluster stack

Python

import requests

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

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.post(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

Body

application/json

spec · ResourceSpecification · object · required

Show child attributes

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