shared_secure_embeds

Creates, updates, deletes, gets or lists a shared_secure_embeds resource.

Overview

Name	shared_secure_embeds
Type	Resource
Id	datadog.dashboards.shared_secure_embeds

Fields

The following fields are returned by SELECT queries:

get_dashboard_secure_embed

Name	Datatype	Description
id	string	Internal share ID. (example: 12345)
attributes	object	Attributes of an existing secure embed shared dashboard.
type	string	Resource type for secure embed get responses. (secure_embed_get_response) (example: secure_embed_get_response)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_dashboard_secure_embed	select	dashboard_id, token		Retrieve an existing secure embed configuration for a dashboard.
create_dashboard_secure_embed	insert	dashboard_id, data		Create a secure embed share for a dashboard. The response includes a one-time credential used for HMAC-SHA256 signing. Store it securely — it cannot be retrieved again.
update_dashboard_secure_embed	update	dashboard_id, token, data		Partially update a secure embed configuration. All fields are optional (PATCH semantics).
delete_dashboard_secure_embed	delete	dashboard_id, token		Delete a secure embed share for a dashboard.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
dashboard_id	string	The ID of the dashboard. (example: abc-def-ghi)
site	string	The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both.
token	string	The share token identifying the secure embed. (example: s3cur3t0k3n-abcdef123456)

SELECT examples

get_dashboard_secure_embed

Retrieve an existing secure embed configuration for a dashboard.

SELECT
id,
attributes,
type
FROM datadog.dashboards.shared_secure_embeds
WHERE dashboard_id = '{{ dashboard_id }}' -- required
AND token = '{{ token }}' -- required
;

INSERT examples

create_dashboard_secure_embed

Create a secure embed share for a dashboard. The response includes a one-time credential used for HMAC-SHA256 signing. Store it securely — it cannot be retrieved again.

INSERT INTO datadog.dashboards.shared_secure_embeds (
data,
dashboard_id
)
SELECT 
'{{ data }}' /* required */,
'{{ dashboard_id }}'
RETURNING
data
;

Manifest

# Description fields are for documentation purposes
- name: shared_secure_embeds
props:
  - name: dashboard_id
    value: "{{ dashboard_id }}"
    description: Required parameter for the shared_secure_embeds resource.
  - name: data
    description: |
      Data object for creating a secure embed.
    value:
      attributes:
        global_time:
          live_span: "{{ live_span }}"
        global_time_selectable: {{ global_time_selectable }}
        selectable_template_vars:
          - default_values: "{{ default_values }}"
            name: "{{ name }}"
            prefix: "{{ prefix }}"
            visible_tags: "{{ visible_tags }}"
        status: "{{ status }}"
        title: "{{ title }}"
        viewing_preferences:
          high_density: {{ high_density }}
          theme: "{{ theme }}"
      type: "{{ type }}"

UPDATE examples

update_dashboard_secure_embed

Partially update a secure embed configuration. All fields are optional (PATCH semantics).

UPDATE datadog.dashboards.shared_secure_embeds
SET 
data = '{{ data }}'
WHERE 
dashboard_id = '{{ dashboard_id }}' --required
AND token = '{{ token }}' --required
AND data = '{{ data }}' --required
RETURNING
data;

DELETE examples

delete_dashboard_secure_embed

Delete a secure embed share for a dashboard.

DELETE FROM datadog.dashboards.shared_secure_embeds
WHERE dashboard_id = '{{ dashboard_id }}' --required
AND token = '{{ token }}' --required
;