Deployments

Get deployment settings

Changed on
get/api/v1/deployments/{deploymentId}/settings

Request

  • Base URL: https://your-tenant.cubecloud.dev
  • URL: https://your-tenant.cubecloud.dev/api/v1/deployments/{deploymentId}/settings
  • Auth: HTTP bearer

Path parameters

deploymentIdinteger required

Response

autoDomainstring nullable
cloudProvider'cubecloud' | 'aws' | 'gcp' required
creationMethod'upload' | 'cubecloud' | 'github' | 'ssh'
creationStep'project' | 'upload' | 'schema' | 'github' | 'ssh' | 'databases' | 'ready' | 'demo' required
cubeImageCloudstring nullable
cubeImageVersionstring nullable
customDomainstring nullable
defaultLaunchpadViewGroupstring nullable
deployBranchMergeAllowedboolean required
deployBranchNamestring required
deployBranchReadOnlyboolean required
deployMode'git' | 'cli'
deployProjectRootstring required
deploymentUrlstring required
idinteger required
isColdboolean nullable
isCubeSqlEnabledboolean required
isManagedboolean nullable
isSupportPreAggregationsboolean required
launchpadTabsstring[] nullable
namestring required
regionstring nullable
releaseChannel'latest' | 'release' required
releaseChannelVersionstring nullable
releaseChannelVersionHoldboolean nullable
repoType'git' | 'deployRepo'
targetPlatformstring nullable
template'single' | 'simpleCluster' | 'multiCluster' required
templateVariablesobject nullable

Changes

  • 97e151460143Revision changes
    • breaking

      the response's property type changed from no type to string for status

    • warning

      added the new databases enum value to the response property for the response status

    • warning

      added the new demo enum value to the response property for the response status

    • warning

      added the new github enum value to the response property for the response status

    • warning

      added the new project enum value to the response property for the response status

    • warning

      added the new ready enum value to the response property for the response status

    • warning

      added the new schema enum value to the response property for the response status

    • warning

      added the new ssh enum value to the response property for the response status

    • warning

      added the new upload enum value to the response property for the response status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      response property deploymentUrl list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      removed subschema #2 from the response property oneOf list for the response status

  • 29d481391a25Revision changes
    • info

      endpoint added