Skip to main content
PUT
Update a deployment
Update any subset of a deployment’s settings — everything the console’s Settings pages own — and read the full settings back. Fields you omit are left alone, and templateVariables is merged key-by-key rather than replaced, so setting one configuration flag never clears the others. releaseChannelVersion must be one of the versions GET /:deploymentId/versions lists for the target channel (in any of the forms it reports) — anything else is a 400, and the container image is resolved from the version rather than sent. Choosing a version that is not the channel’s latest also sets releaseChannelVersionHold unless you send it explicitly, so auto-upgrade does not undo the pin.

Authorizations

Authorization
string
header
required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

deploymentId
integer
required

Body

application/json

UpdateDeploymentInput

cloudProvider
enum<string> | null
Available options:
cubecloud,
aws,
gcp
creationMethod
enum<string> | null
Available options:
upload,
cubecloud,
github,
ssh
cspsConfig
object | null
customDomain
string | null
defaultLaunchpadViewGroup
string | null
deployBranchMergeAllowed
boolean | null
deployBranchName
string | null
deployBranchReadOnly
boolean | null
deployMode
enum<string> | null
Available options:
git,
cli
deployProjectRoot
string | null
launchpadTabs
string[] | null
name
string | null
region
string | null
releaseChannel
enum<string> | null
Available options:
latest,
release
releaseChannelVersion
string | null
releaseChannelVersionHold
boolean | null
template
enum<string> | null
Available options:
single,
simpleCluster,
multiCluster
templateVariables
object | null

Response

200 - application/json
cloudProvider
enum<string>
required
Available options:
cubecloud,
aws,
gcp
deployBranchMergeAllowed
boolean
required
deployBranchName
string
required
deployBranchReadOnly
boolean
required
deployProjectRoot
string
required
id
integer
required
isCubeSqlEnabled
boolean
required
isSupportPreAggregations
boolean
required
name
string
required
releaseChannel
enum<string>
required
Available options:
latest,
release
template
enum<string>
required
Available options:
single,
simpleCluster,
multiCluster
autoDomain
string | null
creationMethod
enum<string> | null
Available options:
upload,
cubecloud,
github,
ssh
creationStep
enum<string> | null
Available options:
project,
upload,
schema,
github,
ssh,
databases,
ready,
demo
cspsConfig
object | null
cubeImageCloud
string | null
cubeImageVersion
string | null
customDomain
string | null
defaultLaunchpadViewGroup
string | null
deployMode
enum<string> | null
Available options:
git,
cli
deploymentUrl
string | null
isCold
boolean | null
isManaged
boolean | null
launchpadTabs
string[] | null
region
string | null
releaseChannelVersion
string | null
releaseChannelVersionHold
boolean | null
repoType
enum<string> | null
Available options:
git,
deployRepo
targetPlatform
string | null
templateVariables
object | null