Skip to main content
POST
Create a stack from a stack profile

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
profile_id
string<uuid4>
required
deploy
boolean
default:false
new_stack_name
string | null
parameters
ParameterBinding · object[]
version
integer | null
upgrade_existing
boolean
default:false

Replace the contents of the stack already deployed from this profile under new_stack_name (or the profile's stack name) with this version, in place, instead of creating a new stack draft. The stack-name and resource renames are skipped, the update is applied immediately (deploy is implied), and the profile's deployment tracking moves to the new version. Answers 404 when no stack runs under that name and 409 when the stack was not deployed from this profile.

allow_chart_downgrade
boolean
default:false
deprecated

Retired. It used to admit every chart downgrade in the upgrade; it is still accepted as a boolean (and still only together with upgrade_existing), but it admits nothing. Send confirmed_chart_downgrades instead.

confirmed_chart_downgrades
ConfirmedChartDowngrade · object[]

The chart downgrades the person confirmed for an in-place upgrade, after the same request was refused with CHART_VERSION_DOWNGRADE because this profile version pins add-ons to older chart versions than the live stack declares. Each entry admits exactly the move it names; any other downgrade is refused again, naming every move. Accepted only together with upgrade_existing (422 otherwise).

Maximum array length: 200

Response

Successful Response

addons_count
integer
required
draft_id
string<uuid4>
required
manifests_count
integer
required
profile_version
integer
required
stack_name
string
required
deployed
boolean
default:false
job_count
integer
default:0
operation_id
string<uuid4> | null
warnings
string[]