Skip to main content
GET
Get deployment settings
Every setting of a deployment in one payload — the full contents of the console Settings pages (general, configuration flags, deploy, launchpad, Cube Store private storage), plus the read-only values displayed alongside them. Secrets are excluded; read environment variables through /env-vars instead. Writes go to PUT /:deploymentId, which accepts the same fields and returns this payload.

Authorizations

Authorization
string
header
required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

deploymentId
integer
required

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