Enable or disable signed embedding for a dashboard

PATCH /v1/embed/dashboard/{publicId}

Enable or disable signed embedding for a dashboard

cURL

curl --request PATCH \
  --url https://{tenant}.cubecloud.dev/api/v1/embed/dashboard/{publicId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allowEmbed": true
}
'

import requests

url = "https://{tenant}.cubecloud.dev/api/v1/embed/dashboard/{publicId}"

payload = { "allowEmbed": True }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({allowEmbed: true})
};

fetch('https://{tenant}.cubecloud.dev/api/v1/embed/dashboard/{publicId}', 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/embed/dashboard/{publicId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'allowEmbed' => true
  ]),
  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/embed/dashboard/{publicId}"

	payload := strings.NewReader("{\n  \"allowEmbed\": true\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://{tenant}.cubecloud.dev/api/v1/embed/dashboard/{publicId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"allowEmbed\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenant}.cubecloud.dev/api/v1/embed/dashboard/{publicId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"allowEmbed\": true\n}"

response = http.request(request)
puts response.read_body

200

{
  "allowEmbed": true,
  "publicId": "<string>"
}

🔒 Admin only. Requires administrator privileges — the authenticated principal (API key, embed JWT, or any bearer token) must belong to a user with the admin role.

Sets the dashboard’s “Allow signed embedding” flag (allowEmbed), which gates the customer-signed embedding path: with the flag off, embed sessions fetching GET /v1/embed/dashboard/{publicId} receive 403. Trusted cube-cloud session flows (screenshoter, creator mode) and dashboards shared with all embed users are not affected by this flag.

Note that the flag alone does not make a dashboard embeddable — it must also be published and shared with the embed tenant. Returns 404 if the dashboard does not exist.

Authorizations

Authorization · string · header · required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

publicId · string · required

Body

application/json

UpdateDashboardEmbeddingInput

allowEmbed · boolean · required

Whether customer-signed embedding is allowed for this dashboard ("Allow signed embedding" in the UI). true lets embed sessions fetch the dashboard via GET /v1/embed/dashboard/{publicId}; false makes that fetch return 403. Does not affect creator-mode sessions or dashboards shared with all embed users.

Response

200 - application/json

allowEmbed · boolean · required

publicId · string · required