Update a secure embed for a dashboard

v2 (latest)

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

PATCH https://api.ap1.datadoghq.com/api/v2/dashboard/{dashboard_id}/shared/secure-embed/{token}https://api.ap2.datadoghq.com/api/v2/dashboard/{dashboard_id}/shared/secure-embed/{token}https://api.datadoghq.eu/api/v2/dashboard/{dashboard_id}/shared/secure-embed/{token}https://api.ddog-gov.com/api/v2/dashboard/{dashboard_id}/shared/secure-embed/{token}https://api.us2.ddog-gov.com/api/v2/dashboard/{dashboard_id}/shared/secure-embed/{token}https://api.datadoghq.com/api/v2/dashboard/{dashboard_id}/shared/secure-embed/{token}https://api.us3.datadoghq.com/api/v2/dashboard/{dashboard_id}/shared/secure-embed/{token}https://api.us5.datadoghq.com/api/v2/dashboard/{dashboard_id}/shared/secure-embed/{token}

Overview

Partially update a secure embed configuration. All fields are optional (PATCH semantics). This endpoint requires the dashboards_embed_share permission.

OAuth apps require the dashboards_embed_share authorization scope to access this endpoint.

Arguments

Path Parameters

Name

Type

Description

dashboard_id [required]

string

The ID of the dashboard.

token [required]

string

The share token identifying the secure embed.

Request

Body Data (required)

Secure embed update request body.

Expand All

Field

Type

Description

data [required]

object

Data object for updating a secure embed.

{
  "data": {
    "attributes": {
      "global_time": {
        "live_span": "1h"
      },
      "global_time_selectable": true,
      "selectable_template_vars": [
        {
          "default_values": [
            "1"
          ],
          "name": "org_id",
          "prefix": "org_id",
          "visible_tags": [
            "1"
          ]
        }
      ],
      "status": "active",
      "title": "Q1 Metrics Dashboard (Updated)",
      "viewing_preferences": {
        "high_density": false,
        "theme": "system"
      }
    },
    "type": "secure_embed_update_request"
  }
}

Response

Response for updating a secure embed shared dashboard.

Expand All

Field

Type

Description

data [required]

object

Data object for a secure embed update response.

{
  "data": {
    "attributes": {
      "created_at": "2026-03-11T18:30:00.000000",
      "credential_suffix": "ab3f",
      "dashboard_id": "abc-def-ghi",
      "global_time": {
        "live_span": "1h"
      },
      "global_time_selectable": true,
      "id": "12345",
      "selectable_template_vars": [
        {
          "default_values": [
            "1"
          ],
          "name": "org_id",
          "prefix": "org_id",
          "visible_tags": [
            "1"
          ]
        }
      ],
      "share_type": "secure_embed",
      "status": "active",
      "title": "Q1 Metrics Dashboard (Updated)",
      "token": "s3cur3t0k3n-abcdef123456",
      "url": "https://p.datadoghq.com/sb/secure-embed/s3cur3t0k3n-abcdef123456",
      "viewing_preferences": {
        "high_density": false,
        "theme": "system"
      }
    },
    "id": "12345",
    "type": "secure_embed_update_response"
  }
}

Forbidden

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Not Found

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  ## default
# 

# Path parameters
export dashboard_id="abc-def-ghi"
export token="s3cur3t0k3n-abcdef123456"
# Curl command
curl -X PATCH "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/dashboard/${dashboard_id}/shared/secure-embed/${token}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "status": "active",
      "title": "Q1 Metrics Dashboard (Updated)"
    },
    "type": "secure_embed_update_request"
  }
}
EOF

                

"""
Update a secure embed for a dashboard returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.dashboard_secure_embed_api import DashboardSecureEmbedApi
from datadog_api_client.v2.model.secure_embed_global_time import SecureEmbedGlobalTime
from datadog_api_client.v2.model.secure_embed_global_time_live_span import SecureEmbedGlobalTimeLiveSpan
from datadog_api_client.v2.model.secure_embed_selectable_template_variable import SecureEmbedSelectableTemplateVariable
from datadog_api_client.v2.model.secure_embed_status import SecureEmbedStatus
from datadog_api_client.v2.model.secure_embed_update_request import SecureEmbedUpdateRequest
from datadog_api_client.v2.model.secure_embed_update_request_attributes import SecureEmbedUpdateRequestAttributes
from datadog_api_client.v2.model.secure_embed_update_request_data import SecureEmbedUpdateRequestData
from datadog_api_client.v2.model.secure_embed_update_request_type import SecureEmbedUpdateRequestType
from datadog_api_client.v2.model.secure_embed_viewing_preferences import SecureEmbedViewingPreferences
from datadog_api_client.v2.model.secure_embed_viewing_preferences_theme import SecureEmbedViewingPreferencesTheme

body = SecureEmbedUpdateRequest(
    data=SecureEmbedUpdateRequestData(
        attributes=SecureEmbedUpdateRequestAttributes(
            global_time=SecureEmbedGlobalTime(
                live_span=SecureEmbedGlobalTimeLiveSpan.PAST_ONE_HOUR,
            ),
            global_time_selectable=True,
            selectable_template_vars=[
                SecureEmbedSelectableTemplateVariable(
                    default_values=[
                        "1",
                    ],
                    name="org_id",
                    prefix="org_id",
                    visible_tags=[
                        "1",
                    ],
                ),
            ],
            status=SecureEmbedStatus.ACTIVE,
            title="Q1 Metrics Dashboard (Updated)",
            viewing_preferences=SecureEmbedViewingPreferences(
                high_density=False,
                theme=SecureEmbedViewingPreferencesTheme.SYSTEM,
            ),
        ),
        type=SecureEmbedUpdateRequestType.SECURE_EMBED_UPDATE_REQUEST,
    ),
)

configuration = Configuration()
configuration.unstable_operations["update_dashboard_secure_embed"] = True
with ApiClient(configuration) as api_client:
    api_instance = DashboardSecureEmbedApi(api_client)
    response = api_instance.update_dashboard_secure_embed(dashboard_id="dashboard_id", token="token", body=body)

    print(response)

Instructions

First install the library and its dependencies and then save the example to example.py and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"

# Update a secure embed for a dashboard returns "OK" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
  config.unstable_operations["v2.update_dashboard_secure_embed".to_sym] = true
end
api_instance = DatadogAPIClient::V2::DashboardSecureEmbedAPI.new

body = DatadogAPIClient::V2::SecureEmbedUpdateRequest.new({
  data: DatadogAPIClient::V2::SecureEmbedUpdateRequestData.new({
    attributes: DatadogAPIClient::V2::SecureEmbedUpdateRequestAttributes.new({
      global_time: DatadogAPIClient::V2::SecureEmbedGlobalTime.new({
        live_span: DatadogAPIClient::V2::SecureEmbedGlobalTimeLiveSpan::PAST_ONE_HOUR,
      }),
      global_time_selectable: true,
      selectable_template_vars: [
        DatadogAPIClient::V2::SecureEmbedSelectableTemplateVariable.new({
          default_values: [
            "1",
          ],
          name: "org_id",
          prefix: "org_id",
          visible_tags: [
            "1",
          ],
        }),
      ],
      status: DatadogAPIClient::V2::SecureEmbedStatus::ACTIVE,
      title: "Q1 Metrics Dashboard (Updated)",
      viewing_preferences: DatadogAPIClient::V2::SecureEmbedViewingPreferences.new({
        high_density: false,
        theme: DatadogAPIClient::V2::SecureEmbedViewingPreferencesTheme::SYSTEM,
      }),
    }),
    type: DatadogAPIClient::V2::SecureEmbedUpdateRequestType::SECURE_EMBED_UPDATE_REQUEST,
  }),
})
p api_instance.update_dashboard_secure_embed("dashboard_id", "token", body)

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"

// Update a secure embed for a dashboard returns "OK" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)

func main() {
	body := datadogV2.SecureEmbedUpdateRequest{
		Data: datadogV2.SecureEmbedUpdateRequestData{
			Attributes: datadogV2.SecureEmbedUpdateRequestAttributes{
				GlobalTime: &datadogV2.SecureEmbedGlobalTime{
					LiveSpan: datadogV2.SECUREEMBEDGLOBALTIMELIVESPAN_PAST_ONE_HOUR.Ptr(),
				},
				GlobalTimeSelectable: datadog.PtrBool(true),
				SelectableTemplateVars: []datadogV2.SecureEmbedSelectableTemplateVariable{
					{
						DefaultValues: []string{
							"1",
						},
						Name:   datadog.PtrString("org_id"),
						Prefix: datadog.PtrString("org_id"),
						VisibleTags: []string{
							"1",
						},
					},
				},
				Status: datadogV2.SECUREEMBEDSTATUS_ACTIVE.Ptr(),
				Title:  datadog.PtrString("Q1 Metrics Dashboard (Updated)"),
				ViewingPreferences: &datadogV2.SecureEmbedViewingPreferences{
					HighDensity: datadog.PtrBool(false),
					Theme:       datadogV2.SECUREEMBEDVIEWINGPREFERENCESTHEME_SYSTEM.Ptr(),
				},
			},
			Type: datadogV2.SECUREEMBEDUPDATEREQUESTTYPE_SECURE_EMBED_UPDATE_REQUEST,
		},
	}
	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	configuration.SetUnstableOperationEnabled("v2.UpdateDashboardSecureEmbed", true)
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewDashboardSecureEmbedApi(apiClient)
	resp, r, err := api.UpdateDashboardSecureEmbed(ctx, "dashboard_id", "token", body)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DashboardSecureEmbedApi.UpdateDashboardSecureEmbed`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `DashboardSecureEmbedApi.UpdateDashboardSecureEmbed`:\n%s\n", responseContent)
}

Instructions

First install the library and its dependencies and then save the example to main.go and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"

// Update a secure embed for a dashboard returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.DashboardSecureEmbedApi;
import com.datadog.api.client.v2.model.SecureEmbedGlobalTime;
import com.datadog.api.client.v2.model.SecureEmbedGlobalTimeLiveSpan;
import com.datadog.api.client.v2.model.SecureEmbedSelectableTemplateVariable;
import com.datadog.api.client.v2.model.SecureEmbedStatus;
import com.datadog.api.client.v2.model.SecureEmbedUpdateRequest;
import com.datadog.api.client.v2.model.SecureEmbedUpdateRequestAttributes;
import com.datadog.api.client.v2.model.SecureEmbedUpdateRequestData;
import com.datadog.api.client.v2.model.SecureEmbedUpdateRequestType;
import com.datadog.api.client.v2.model.SecureEmbedUpdateResponse;
import com.datadog.api.client.v2.model.SecureEmbedViewingPreferences;
import com.datadog.api.client.v2.model.SecureEmbedViewingPreferencesTheme;
import java.util.Collections;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    defaultClient.setUnstableOperationEnabled("v2.updateDashboardSecureEmbed", true);
    DashboardSecureEmbedApi apiInstance = new DashboardSecureEmbedApi(defaultClient);

    SecureEmbedUpdateRequest body =
        new SecureEmbedUpdateRequest()
            .data(
                new SecureEmbedUpdateRequestData()
                    .attributes(
                        new SecureEmbedUpdateRequestAttributes()
                            .globalTime(
                                new SecureEmbedGlobalTime()
                                    .liveSpan(SecureEmbedGlobalTimeLiveSpan.PAST_ONE_HOUR))
                            .globalTimeSelectable(true)
                            .selectableTemplateVars(
                                Collections.singletonList(
                                    new SecureEmbedSelectableTemplateVariable()
                                        .defaultValues(Collections.singletonList("1"))
                                        .name("org_id")
                                        .prefix("org_id")
                                        .visibleTags(Collections.singletonList("1"))))
                            .status(SecureEmbedStatus.ACTIVE)
                            .title("Q1 Metrics Dashboard (Updated)")
                            .viewingPreferences(
                                new SecureEmbedViewingPreferences()
                                    .highDensity(false)
                                    .theme(SecureEmbedViewingPreferencesTheme.SYSTEM)))
                    .type(SecureEmbedUpdateRequestType.SECURE_EMBED_UPDATE_REQUEST));

    try {
      SecureEmbedUpdateResponse result =
          apiInstance.updateDashboardSecureEmbed("abc-def-ghi", "s3cur3t0k3n-abcdef123456", body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println(
          "Exception when calling DashboardSecureEmbedApi#updateDashboardSecureEmbed");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Instructions

First install the library and its dependencies and then save the example to Example.java and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"

// Update a secure embed for a dashboard returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_dashboard_secure_embed::DashboardSecureEmbedAPI;
use datadog_api_client::datadogV2::model::SecureEmbedGlobalTime;
use datadog_api_client::datadogV2::model::SecureEmbedGlobalTimeLiveSpan;
use datadog_api_client::datadogV2::model::SecureEmbedSelectableTemplateVariable;
use datadog_api_client::datadogV2::model::SecureEmbedStatus;
use datadog_api_client::datadogV2::model::SecureEmbedUpdateRequest;
use datadog_api_client::datadogV2::model::SecureEmbedUpdateRequestAttributes;
use datadog_api_client::datadogV2::model::SecureEmbedUpdateRequestData;
use datadog_api_client::datadogV2::model::SecureEmbedUpdateRequestType;
use datadog_api_client::datadogV2::model::SecureEmbedViewingPreferences;
use datadog_api_client::datadogV2::model::SecureEmbedViewingPreferencesTheme;

#[tokio::main]
async fn main() {
    let body = SecureEmbedUpdateRequest::new(SecureEmbedUpdateRequestData::new(
        SecureEmbedUpdateRequestAttributes::new()
            .global_time(
                SecureEmbedGlobalTime::new()
                    .live_span(SecureEmbedGlobalTimeLiveSpan::PAST_ONE_HOUR),
            )
            .global_time_selectable(true)
            .selectable_template_vars(vec![SecureEmbedSelectableTemplateVariable::new()
                .default_values(vec!["1".to_string()])
                .name("org_id".to_string())
                .prefix("org_id".to_string())
                .visible_tags(vec!["1".to_string()])])
            .status(SecureEmbedStatus::ACTIVE)
            .title("Q1 Metrics Dashboard (Updated)".to_string())
            .viewing_preferences(
                SecureEmbedViewingPreferences::new()
                    .high_density(false)
                    .theme(SecureEmbedViewingPreferencesTheme::SYSTEM),
            ),
        SecureEmbedUpdateRequestType::SECURE_EMBED_UPDATE_REQUEST,
    ));
    let mut configuration = datadog::Configuration::new();
    configuration.set_unstable_operation_enabled("v2.UpdateDashboardSecureEmbed", true);
    let api = DashboardSecureEmbedAPI::with_config(configuration);
    let resp = api
        .update_dashboard_secure_embed("dashboard_id".to_string(), "token".to_string(), body)
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

Instructions

First install the library and its dependencies and then save the example to src/main.rs and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run

/**
 * Update a secure embed for a dashboard returns "OK" response
 */

import { client, v2 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
configuration.unstableOperations["v2.updateDashboardSecureEmbed"] = true;
const apiInstance = new v2.DashboardSecureEmbedApi(configuration);

const params: v2.DashboardSecureEmbedApiUpdateDashboardSecureEmbedRequest = {
  body: {
    data: {
      attributes: {
        globalTime: {
          liveSpan: "1h",
        },
        globalTimeSelectable: true,
        selectableTemplateVars: [
          {
            defaultValues: ["1"],
            name: "org_id",
            prefix: "org_id",
            visibleTags: ["1"],
          },
        ],
        status: "active",
        title: "Q1 Metrics Dashboard (Updated)",
        viewingPreferences: {
          highDensity: false,
          theme: "system",
        },
      },
      type: "secure_embed_update_request",
    },
  },
  dashboardId: "dashboard_id",
  token: "token",
};

apiInstance
  .updateDashboardSecureEmbed(params)
  .then((data: v2.SecureEmbedUpdateResponse) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

Instructions

First install the library and its dependencies and then save the example to example.ts and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"

Update a secure embed for a dashboard

Overview

Arguments

Path Parameters

Request

Body Data (required)

Response

Code Example

Update a secure embed for a dashboard

Update a secure embed for a dashboard

Instructions

Update a secure embed for a dashboard

Instructions

Update a secure embed for a dashboard

Instructions

Update a secure embed for a dashboard

Instructions

Update a secure embed for a dashboard

Instructions

Update a secure embed for a dashboard

Instructions

How can I help you today?