For AI agents: A markdown version of this page is available at https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/api/latest/dashboard-secure-embed/get-a-secure-embed-for-a-dashboard.md. A documentation index is available at /llms.txt.
Language
Datadog site

Get a secure embed for a dashboard

WARNINGNote: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.
GEThttps://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}https://api.datadoghq.eu/api/v2/dashboard/{dashboard_id}/shared/secure-embed/{token}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.uk1.datadoghq.com/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}

Overview

Retrieve an existing secure embed configuration for a dashboard.

This endpoint requires the dashboards_read permission.

OAuth apps require the dashboards_read 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.

Response

OK

Response for getting a secure embed shared dashboard.

Field
Type
Description
data [required]
object

Data object for a secure embed get response.

Code Example

Get a secure embed for a dashboard
# Path parameters
export dashboard_id="abc-def-ghi"
export token="s3cur3t0k3n-abcdef123456"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/dashboard/${dashboard_id}/shared/secure-embed/${token}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export dashboard_id="abc-def-ghi"
export token="s3cur3t0k3n-abcdef123456"

# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/dashboard/${dashboard_id}/shared/secure-embed/${token}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export dashboard_id="abc-def-ghi"
export token="s3cur3t0k3n-abcdef123456"

# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/dashboard/${dashboard_id}/shared/secure-embed/${token}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export dashboard_id="abc-def-ghi"
export token="s3cur3t0k3n-abcdef123456"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/dashboard/${dashboard_id}/shared/secure-embed/${token}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export dashboard_id="abc-def-ghi"
export token="s3cur3t0k3n-abcdef123456"

# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/dashboard/${dashboard_id}/shared/secure-embed/${token}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export dashboard_id="abc-def-ghi"
export token="s3cur3t0k3n-abcdef123456"

# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/dashboard/${dashboard_id}/shared/secure-embed/${token}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export dashboard_id="abc-def-ghi"
export token="s3cur3t0k3n-abcdef123456"

# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/dashboard/${dashboard_id}/shared/secure-embed/${token}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export dashboard_id="abc-def-ghi"
export token="s3cur3t0k3n-abcdef123456"

# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/dashboard/${dashboard_id}/shared/secure-embed/${token}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Path parameters
export dashboard_id="abc-def-ghi"
export token="s3cur3t0k3n-abcdef123456"

# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/dashboard/${dashboard_id}/shared/secure-embed/${token}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"