Update a deployment
curl --request PUT \
--url https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cspsConfig": {
"enabled": true,
"storageProvider": "<string>",
"awsRoleArn": "<string>",
"azureClientId": "<string>",
"azureContainer": "<string>",
"azureStorageAccount": "<string>",
"azureTenantId": "<string>",
"gcpServiceAccountEmail": "<string>",
"gcpWorkloadIdentityProvider": "<string>",
"gcsBucket": "<string>",
"s3Bucket": "<string>",
"s3Region": "<string>",
"s3Sse": "<string>"
},
"customDomain": "<string>",
"defaultLaunchpadViewGroup": "<string>",
"deployBranchMergeAllowed": true,
"deployBranchName": "<string>",
"deployBranchReadOnly": true,
"deployProjectRoot": "<string>",
"launchpadTabs": [
"<string>"
],
"name": "<string>",
"region": "<string>",
"releaseChannelVersion": "<string>",
"releaseChannelVersionHold": true,
"templateVariables": {}
}
'import requests
url = "https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}"
payload = {
"cspsConfig": {
"enabled": True,
"storageProvider": "<string>",
"awsRoleArn": "<string>",
"azureClientId": "<string>",
"azureContainer": "<string>",
"azureStorageAccount": "<string>",
"azureTenantId": "<string>",
"gcpServiceAccountEmail": "<string>",
"gcpWorkloadIdentityProvider": "<string>",
"gcsBucket": "<string>",
"s3Bucket": "<string>",
"s3Region": "<string>",
"s3Sse": "<string>"
},
"customDomain": "<string>",
"defaultLaunchpadViewGroup": "<string>",
"deployBranchMergeAllowed": True,
"deployBranchName": "<string>",
"deployBranchReadOnly": True,
"deployProjectRoot": "<string>",
"launchpadTabs": ["<string>"],
"name": "<string>",
"region": "<string>",
"releaseChannelVersion": "<string>",
"releaseChannelVersionHold": True,
"templateVariables": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
cspsConfig: {
enabled: true,
storageProvider: '<string>',
awsRoleArn: '<string>',
azureClientId: '<string>',
azureContainer: '<string>',
azureStorageAccount: '<string>',
azureTenantId: '<string>',
gcpServiceAccountEmail: '<string>',
gcpWorkloadIdentityProvider: '<string>',
gcsBucket: '<string>',
s3Bucket: '<string>',
s3Region: '<string>',
s3Sse: '<string>'
},
customDomain: '<string>',
defaultLaunchpadViewGroup: '<string>',
deployBranchMergeAllowed: true,
deployBranchName: '<string>',
deployBranchReadOnly: true,
deployProjectRoot: '<string>',
launchpadTabs: ['<string>'],
name: '<string>',
region: '<string>',
releaseChannelVersion: '<string>',
releaseChannelVersionHold: true,
templateVariables: {}
})
};
fetch('https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'cspsConfig' => [
'enabled' => true,
'storageProvider' => '<string>',
'awsRoleArn' => '<string>',
'azureClientId' => '<string>',
'azureContainer' => '<string>',
'azureStorageAccount' => '<string>',
'azureTenantId' => '<string>',
'gcpServiceAccountEmail' => '<string>',
'gcpWorkloadIdentityProvider' => '<string>',
'gcsBucket' => '<string>',
's3Bucket' => '<string>',
's3Region' => '<string>',
's3Sse' => '<string>'
],
'customDomain' => '<string>',
'defaultLaunchpadViewGroup' => '<string>',
'deployBranchMergeAllowed' => true,
'deployBranchName' => '<string>',
'deployBranchReadOnly' => true,
'deployProjectRoot' => '<string>',
'launchpadTabs' => [
'<string>'
],
'name' => '<string>',
'region' => '<string>',
'releaseChannelVersion' => '<string>',
'releaseChannelVersionHold' => true,
'templateVariables' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}"
payload := strings.NewReader("{\n \"cspsConfig\": {\n \"enabled\": true,\n \"storageProvider\": \"<string>\",\n \"awsRoleArn\": \"<string>\",\n \"azureClientId\": \"<string>\",\n \"azureContainer\": \"<string>\",\n \"azureStorageAccount\": \"<string>\",\n \"azureTenantId\": \"<string>\",\n \"gcpServiceAccountEmail\": \"<string>\",\n \"gcpWorkloadIdentityProvider\": \"<string>\",\n \"gcsBucket\": \"<string>\",\n \"s3Bucket\": \"<string>\",\n \"s3Region\": \"<string>\",\n \"s3Sse\": \"<string>\"\n },\n \"customDomain\": \"<string>\",\n \"defaultLaunchpadViewGroup\": \"<string>\",\n \"deployBranchMergeAllowed\": true,\n \"deployBranchName\": \"<string>\",\n \"deployBranchReadOnly\": true,\n \"deployProjectRoot\": \"<string>\",\n \"launchpadTabs\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"region\": \"<string>\",\n \"releaseChannelVersion\": \"<string>\",\n \"releaseChannelVersionHold\": true,\n \"templateVariables\": {}\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"cspsConfig\": {\n \"enabled\": true,\n \"storageProvider\": \"<string>\",\n \"awsRoleArn\": \"<string>\",\n \"azureClientId\": \"<string>\",\n \"azureContainer\": \"<string>\",\n \"azureStorageAccount\": \"<string>\",\n \"azureTenantId\": \"<string>\",\n \"gcpServiceAccountEmail\": \"<string>\",\n \"gcpWorkloadIdentityProvider\": \"<string>\",\n \"gcsBucket\": \"<string>\",\n \"s3Bucket\": \"<string>\",\n \"s3Region\": \"<string>\",\n \"s3Sse\": \"<string>\"\n },\n \"customDomain\": \"<string>\",\n \"defaultLaunchpadViewGroup\": \"<string>\",\n \"deployBranchMergeAllowed\": true,\n \"deployBranchName\": \"<string>\",\n \"deployBranchReadOnly\": true,\n \"deployProjectRoot\": \"<string>\",\n \"launchpadTabs\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"region\": \"<string>\",\n \"releaseChannelVersion\": \"<string>\",\n \"releaseChannelVersionHold\": true,\n \"templateVariables\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cspsConfig\": {\n \"enabled\": true,\n \"storageProvider\": \"<string>\",\n \"awsRoleArn\": \"<string>\",\n \"azureClientId\": \"<string>\",\n \"azureContainer\": \"<string>\",\n \"azureStorageAccount\": \"<string>\",\n \"azureTenantId\": \"<string>\",\n \"gcpServiceAccountEmail\": \"<string>\",\n \"gcpWorkloadIdentityProvider\": \"<string>\",\n \"gcsBucket\": \"<string>\",\n \"s3Bucket\": \"<string>\",\n \"s3Region\": \"<string>\",\n \"s3Sse\": \"<string>\"\n },\n \"customDomain\": \"<string>\",\n \"defaultLaunchpadViewGroup\": \"<string>\",\n \"deployBranchMergeAllowed\": true,\n \"deployBranchName\": \"<string>\",\n \"deployBranchReadOnly\": true,\n \"deployProjectRoot\": \"<string>\",\n \"launchpadTabs\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"region\": \"<string>\",\n \"releaseChannelVersion\": \"<string>\",\n \"releaseChannelVersionHold\": true,\n \"templateVariables\": {}\n}"
response = http.request(request)
puts response.read_body{
"deployBranchMergeAllowed": true,
"deployBranchName": "<string>",
"deployBranchReadOnly": true,
"deployProjectRoot": "<string>",
"id": 123,
"isCubeSqlEnabled": true,
"isSupportPreAggregations": true,
"name": "<string>",
"autoDomain": "<string>",
"cspsConfig": {
"enabled": true,
"storageProvider": "<string>",
"awsRoleArn": "<string>",
"azureClientId": "<string>",
"azureContainer": "<string>",
"azureStorageAccount": "<string>",
"azureTenantId": "<string>",
"gcpServiceAccountEmail": "<string>",
"gcpWorkloadIdentityProvider": "<string>",
"gcsBucket": "<string>",
"s3Bucket": "<string>",
"s3Region": "<string>",
"s3Sse": "<string>"
},
"cubeImageCloud": "<string>",
"cubeImageVersion": "<string>",
"customDomain": "<string>",
"defaultLaunchpadViewGroup": "<string>",
"deploymentUrl": "<string>",
"isCold": true,
"isManaged": true,
"launchpadTabs": [
"<string>"
],
"region": "<string>",
"releaseChannelVersion": "<string>",
"releaseChannelVersionHold": true,
"targetPlatform": "<string>",
"templateVariables": {}
}Deployments
Update a deployment
PUT
/
api
/
v1
/
deployments
/
{deploymentId}
Update a deployment
curl --request PUT \
--url https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cspsConfig": {
"enabled": true,
"storageProvider": "<string>",
"awsRoleArn": "<string>",
"azureClientId": "<string>",
"azureContainer": "<string>",
"azureStorageAccount": "<string>",
"azureTenantId": "<string>",
"gcpServiceAccountEmail": "<string>",
"gcpWorkloadIdentityProvider": "<string>",
"gcsBucket": "<string>",
"s3Bucket": "<string>",
"s3Region": "<string>",
"s3Sse": "<string>"
},
"customDomain": "<string>",
"defaultLaunchpadViewGroup": "<string>",
"deployBranchMergeAllowed": true,
"deployBranchName": "<string>",
"deployBranchReadOnly": true,
"deployProjectRoot": "<string>",
"launchpadTabs": [
"<string>"
],
"name": "<string>",
"region": "<string>",
"releaseChannelVersion": "<string>",
"releaseChannelVersionHold": true,
"templateVariables": {}
}
'import requests
url = "https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}"
payload = {
"cspsConfig": {
"enabled": True,
"storageProvider": "<string>",
"awsRoleArn": "<string>",
"azureClientId": "<string>",
"azureContainer": "<string>",
"azureStorageAccount": "<string>",
"azureTenantId": "<string>",
"gcpServiceAccountEmail": "<string>",
"gcpWorkloadIdentityProvider": "<string>",
"gcsBucket": "<string>",
"s3Bucket": "<string>",
"s3Region": "<string>",
"s3Sse": "<string>"
},
"customDomain": "<string>",
"defaultLaunchpadViewGroup": "<string>",
"deployBranchMergeAllowed": True,
"deployBranchName": "<string>",
"deployBranchReadOnly": True,
"deployProjectRoot": "<string>",
"launchpadTabs": ["<string>"],
"name": "<string>",
"region": "<string>",
"releaseChannelVersion": "<string>",
"releaseChannelVersionHold": True,
"templateVariables": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
cspsConfig: {
enabled: true,
storageProvider: '<string>',
awsRoleArn: '<string>',
azureClientId: '<string>',
azureContainer: '<string>',
azureStorageAccount: '<string>',
azureTenantId: '<string>',
gcpServiceAccountEmail: '<string>',
gcpWorkloadIdentityProvider: '<string>',
gcsBucket: '<string>',
s3Bucket: '<string>',
s3Region: '<string>',
s3Sse: '<string>'
},
customDomain: '<string>',
defaultLaunchpadViewGroup: '<string>',
deployBranchMergeAllowed: true,
deployBranchName: '<string>',
deployBranchReadOnly: true,
deployProjectRoot: '<string>',
launchpadTabs: ['<string>'],
name: '<string>',
region: '<string>',
releaseChannelVersion: '<string>',
releaseChannelVersionHold: true,
templateVariables: {}
})
};
fetch('https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'cspsConfig' => [
'enabled' => true,
'storageProvider' => '<string>',
'awsRoleArn' => '<string>',
'azureClientId' => '<string>',
'azureContainer' => '<string>',
'azureStorageAccount' => '<string>',
'azureTenantId' => '<string>',
'gcpServiceAccountEmail' => '<string>',
'gcpWorkloadIdentityProvider' => '<string>',
'gcsBucket' => '<string>',
's3Bucket' => '<string>',
's3Region' => '<string>',
's3Sse' => '<string>'
],
'customDomain' => '<string>',
'defaultLaunchpadViewGroup' => '<string>',
'deployBranchMergeAllowed' => true,
'deployBranchName' => '<string>',
'deployBranchReadOnly' => true,
'deployProjectRoot' => '<string>',
'launchpadTabs' => [
'<string>'
],
'name' => '<string>',
'region' => '<string>',
'releaseChannelVersion' => '<string>',
'releaseChannelVersionHold' => true,
'templateVariables' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}"
payload := strings.NewReader("{\n \"cspsConfig\": {\n \"enabled\": true,\n \"storageProvider\": \"<string>\",\n \"awsRoleArn\": \"<string>\",\n \"azureClientId\": \"<string>\",\n \"azureContainer\": \"<string>\",\n \"azureStorageAccount\": \"<string>\",\n \"azureTenantId\": \"<string>\",\n \"gcpServiceAccountEmail\": \"<string>\",\n \"gcpWorkloadIdentityProvider\": \"<string>\",\n \"gcsBucket\": \"<string>\",\n \"s3Bucket\": \"<string>\",\n \"s3Region\": \"<string>\",\n \"s3Sse\": \"<string>\"\n },\n \"customDomain\": \"<string>\",\n \"defaultLaunchpadViewGroup\": \"<string>\",\n \"deployBranchMergeAllowed\": true,\n \"deployBranchName\": \"<string>\",\n \"deployBranchReadOnly\": true,\n \"deployProjectRoot\": \"<string>\",\n \"launchpadTabs\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"region\": \"<string>\",\n \"releaseChannelVersion\": \"<string>\",\n \"releaseChannelVersionHold\": true,\n \"templateVariables\": {}\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"cspsConfig\": {\n \"enabled\": true,\n \"storageProvider\": \"<string>\",\n \"awsRoleArn\": \"<string>\",\n \"azureClientId\": \"<string>\",\n \"azureContainer\": \"<string>\",\n \"azureStorageAccount\": \"<string>\",\n \"azureTenantId\": \"<string>\",\n \"gcpServiceAccountEmail\": \"<string>\",\n \"gcpWorkloadIdentityProvider\": \"<string>\",\n \"gcsBucket\": \"<string>\",\n \"s3Bucket\": \"<string>\",\n \"s3Region\": \"<string>\",\n \"s3Sse\": \"<string>\"\n },\n \"customDomain\": \"<string>\",\n \"defaultLaunchpadViewGroup\": \"<string>\",\n \"deployBranchMergeAllowed\": true,\n \"deployBranchName\": \"<string>\",\n \"deployBranchReadOnly\": true,\n \"deployProjectRoot\": \"<string>\",\n \"launchpadTabs\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"region\": \"<string>\",\n \"releaseChannelVersion\": \"<string>\",\n \"releaseChannelVersionHold\": true,\n \"templateVariables\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cspsConfig\": {\n \"enabled\": true,\n \"storageProvider\": \"<string>\",\n \"awsRoleArn\": \"<string>\",\n \"azureClientId\": \"<string>\",\n \"azureContainer\": \"<string>\",\n \"azureStorageAccount\": \"<string>\",\n \"azureTenantId\": \"<string>\",\n \"gcpServiceAccountEmail\": \"<string>\",\n \"gcpWorkloadIdentityProvider\": \"<string>\",\n \"gcsBucket\": \"<string>\",\n \"s3Bucket\": \"<string>\",\n \"s3Region\": \"<string>\",\n \"s3Sse\": \"<string>\"\n },\n \"customDomain\": \"<string>\",\n \"defaultLaunchpadViewGroup\": \"<string>\",\n \"deployBranchMergeAllowed\": true,\n \"deployBranchName\": \"<string>\",\n \"deployBranchReadOnly\": true,\n \"deployProjectRoot\": \"<string>\",\n \"launchpadTabs\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"region\": \"<string>\",\n \"releaseChannelVersion\": \"<string>\",\n \"releaseChannelVersionHold\": true,\n \"templateVariables\": {}\n}"
response = http.request(request)
puts response.read_body{
"deployBranchMergeAllowed": true,
"deployBranchName": "<string>",
"deployBranchReadOnly": true,
"deployProjectRoot": "<string>",
"id": 123,
"isCubeSqlEnabled": true,
"isSupportPreAggregations": true,
"name": "<string>",
"autoDomain": "<string>",
"cspsConfig": {
"enabled": true,
"storageProvider": "<string>",
"awsRoleArn": "<string>",
"azureClientId": "<string>",
"azureContainer": "<string>",
"azureStorageAccount": "<string>",
"azureTenantId": "<string>",
"gcpServiceAccountEmail": "<string>",
"gcpWorkloadIdentityProvider": "<string>",
"gcsBucket": "<string>",
"s3Bucket": "<string>",
"s3Region": "<string>",
"s3Sse": "<string>"
},
"cubeImageCloud": "<string>",
"cubeImageVersion": "<string>",
"customDomain": "<string>",
"defaultLaunchpadViewGroup": "<string>",
"deploymentUrl": "<string>",
"isCold": true,
"isManaged": true,
"launchpadTabs": [
"<string>"
],
"region": "<string>",
"releaseChannelVersion": "<string>",
"releaseChannelVersionHold": true,
"targetPlatform": "<string>",
"templateVariables": {}
}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
Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.
Path Parameters
Body
application/json
UpdateDeploymentInput
Available options:
cubecloud, aws, gcp Available options:
upload, cubecloud, github, ssh Show child attributes
Show child attributes
Available options:
git, cli Available options:
latest, release Available options:
single, simpleCluster, multiCluster Response
200 - application/json
Available options:
cubecloud, aws, gcp Available options:
latest, release Available options:
single, simpleCluster, multiCluster Available options:
upload, cubecloud, github, ssh Available options:
project, upload, schema, github, ssh, databases, ready, demo Show child attributes
Show child attributes
Available options:
git, cli Available options:
git, deployRepo ⌘I