Skip to main content
PATCH
Set and remove stack variables (browser session)

Authorizations

Authorization
string
header
required

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

Path Parameters

cluster_id
string<uuid>
required
stack_name
string
required

Body

application/json
set
object

Variables to set, by name. Names must match ^\w+$ (letters, digits and underscores; the ${{ ankra. }} grammar). A null value is refused; list the name in unset to remove it.

unset
string[]

Names of variables to remove. A name in both set and unset is removed.

Response

The edit was applied, or the live stack already satisfied it (changed false, nothing written).

changed
boolean
required

False when the live stack already satisfied the edit and nothing was written.

commit_sha
string | null
required
commit_url
string | null
required
job_count
integer
required
operation_id
string | null
required
set
object
required
stack_name
string
required
unset
string[]
required