Promote and publish a workbook
curl --request POST \
--url https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/workbooks/{workbookId}/promotions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"expectedSourceHash": "<string>",
"idempotencyKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"targetDeploymentId": 2,
"expectedDestinationHash": "<string>",
"override": true,
"targetFolderId": 2
}
'import requests
url = "https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/workbooks/{workbookId}/promotions"
payload = {
"expectedSourceHash": "<string>",
"idempotencyKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"targetDeploymentId": 2,
"expectedDestinationHash": "<string>",
"override": True,
"targetFolderId": 2
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expectedSourceHash: '<string>',
idempotencyKey: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
targetDeploymentId: 2,
expectedDestinationHash: '<string>',
override: true,
targetFolderId: 2
})
};
fetch('https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/workbooks/{workbookId}/promotions', 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}/workbooks/{workbookId}/promotions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'expectedSourceHash' => '<string>',
'idempotencyKey' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'targetDeploymentId' => 2,
'expectedDestinationHash' => '<string>',
'override' => true,
'targetFolderId' => 2
]),
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}/workbooks/{workbookId}/promotions"
payload := strings.NewReader("{\n \"expectedSourceHash\": \"<string>\",\n \"idempotencyKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"targetDeploymentId\": 2,\n \"expectedDestinationHash\": \"<string>\",\n \"override\": true,\n \"targetFolderId\": 2\n}")
req, _ := http.NewRequest("POST", 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.post("https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/workbooks/{workbookId}/promotions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"expectedSourceHash\": \"<string>\",\n \"idempotencyKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"targetDeploymentId\": 2,\n \"expectedDestinationHash\": \"<string>\",\n \"override\": true,\n \"targetFolderId\": 2\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/workbooks/{workbookId}/promotions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expectedSourceHash\": \"<string>\",\n \"idempotencyKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"targetDeploymentId\": 2,\n \"expectedDestinationHash\": \"<string>\",\n \"override\": true,\n \"targetFolderId\": 2\n}"
response = http.request(request)
puts response.read_body{
"completedAt": "2023-12-25",
"destinationChangedSincePreview": true,
"destinationWasDiverged": true,
"id": 123,
"linkId": 123,
"outcome": "created",
"overrideRequested": true,
"performedBy": {
"authenticationMethod": "session",
"displayName": "<string>",
"userId": 123,
"apiKeyId": 123
},
"targetDashboardVersionId": 123,
"source": {
"availability": "available",
"deploymentId": 123,
"name": "<string>",
"workbookId": 123
},
"target": {
"availability": "available",
"deploymentId": 123,
"name": "<string>",
"workbookId": 123
}
}Workbook Promotions
Promote and publish a workbook
POST
/
api
/
v1
/
deployments
/
{deploymentId}
/
workbooks
/
{workbookId}
/
promotions
Promote and publish a workbook
curl --request POST \
--url https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/workbooks/{workbookId}/promotions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"expectedSourceHash": "<string>",
"idempotencyKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"targetDeploymentId": 2,
"expectedDestinationHash": "<string>",
"override": true,
"targetFolderId": 2
}
'import requests
url = "https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/workbooks/{workbookId}/promotions"
payload = {
"expectedSourceHash": "<string>",
"idempotencyKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"targetDeploymentId": 2,
"expectedDestinationHash": "<string>",
"override": True,
"targetFolderId": 2
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expectedSourceHash: '<string>',
idempotencyKey: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
targetDeploymentId: 2,
expectedDestinationHash: '<string>',
override: true,
targetFolderId: 2
})
};
fetch('https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/workbooks/{workbookId}/promotions', 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}/workbooks/{workbookId}/promotions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'expectedSourceHash' => '<string>',
'idempotencyKey' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'targetDeploymentId' => 2,
'expectedDestinationHash' => '<string>',
'override' => true,
'targetFolderId' => 2
]),
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}/workbooks/{workbookId}/promotions"
payload := strings.NewReader("{\n \"expectedSourceHash\": \"<string>\",\n \"idempotencyKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"targetDeploymentId\": 2,\n \"expectedDestinationHash\": \"<string>\",\n \"override\": true,\n \"targetFolderId\": 2\n}")
req, _ := http.NewRequest("POST", 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.post("https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/workbooks/{workbookId}/promotions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"expectedSourceHash\": \"<string>\",\n \"idempotencyKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"targetDeploymentId\": 2,\n \"expectedDestinationHash\": \"<string>\",\n \"override\": true,\n \"targetFolderId\": 2\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/workbooks/{workbookId}/promotions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expectedSourceHash\": \"<string>\",\n \"idempotencyKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"targetDeploymentId\": 2,\n \"expectedDestinationHash\": \"<string>\",\n \"override\": true,\n \"targetFolderId\": 2\n}"
response = http.request(request)
puts response.read_body{
"completedAt": "2023-12-25",
"destinationChangedSincePreview": true,
"destinationWasDiverged": true,
"id": 123,
"linkId": 123,
"outcome": "created",
"overrideRequested": true,
"performedBy": {
"authenticationMethod": "session",
"displayName": "<string>",
"userId": 123,
"apiKeyId": 123
},
"targetDashboardVersionId": 123,
"source": {
"availability": "available",
"deploymentId": 123,
"name": "<string>",
"workbookId": 123
},
"target": {
"availability": "available",
"deploymentId": 123,
"name": "<string>",
"workbookId": 123
}
}Promote the current workbook atomically if its source hash still matches the preview. Repeated promotions update the linked copy, including its deployment-scoped slug. Override replaces destination edits, never source validation or permissions. An idempotency key makes retries safe.
Authorizations
Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.
Body
application/json
ApplyWorkbookPromotionInput
Response
200 - application/json
Available options:
created, updated, unchanged Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes