Import or update a cluster

Applies an ImportCluster specification: creates the cluster when no cluster with that name exists in your organisation, otherwise updates it, including its stacks and GitOps settings. By default the apply runs in the background and the call answers 202 with {"status": "accepted", "operation_id": "<id>"} (a 409 means an apply for the same cluster is already running). Follow the operation on /api/v1/org/executions/{execution_id}: it settles success or failed, and its step result carries the status code and body the apply would have answered synchronously, including the reason it was refused. Pass wait=true to run it synchronously and receive the result or the rejection reason directly.

POST /api/v1/clusters/import

Import or update a cluster

Python

import requests

url = "https://platform.ankra.app/api/v1/clusters/import"

payload = { "name": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

200

{
  "cluster_id": "<string>",
  "import_command": "<string>",
  "name": "<string>",
  "organisation_id": "<string>",
  "commit_sha": "<string>",
  "commit_url": "<string>",
  "errors": [],
  "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

Query Parameters

wait · boolean · default: false

Body

application/json

name · string · required

criticality · enum<string> | null

Available options: production, staging, development, disposable

description · string | null

environment · string | null

Required string length: 1 - 50

expected_git_repository · GitRepository · object | null

GitHub Git repository request shape.

Legacy repository: 'owner/name' format is preserved as the API contract because ankra-cli releases shipped to end-users send this shape. This class is the __external_type__ for GithubRepositoryResource; renaming or restructuring the fields is a permanent breaking change and is forbidden.

Show child attributes

spec · ResourceSpecification · object | null

Show child attributes

confirmed_member_removals · string[]

Members, as kind/name (kind addon, manifest or application), the caller confirms this apply may remove from the stacks it names because the definition 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: a definition exported before those members were added looks exactly the same. The browser import route does not apply this check.

Maximum array length: 200

prune · boolean · default: false

Confirm every removal this apply makes: a member of a stack the definition names that the definition no longer lists is stopped and deleted. Send it only when the definition is the complete, current source of truth for those stacks; otherwise name the members in confirmed_member_removals.

Response

200

application/json

Successful Response

CreateOrUpdateImportClusterResult

AsyncWriteAcceptedResponse

cluster_id · string<uuid4> · required

import_command · string · required

name · string · required

organisation_id · string<uuid4> · required

commit_sha · string | null

commit_url · string | null

errors · ResourceError · object[]

Show child attributes

warnings · ValidationWarning · object[]

Show child attributes