v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Dashboard Secure Embed

Update a secure embed for a dashboard

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

patch/api/v2/dashboard/{dashboard_id}/shared/secure-embed/{token}

Path parameters

dashboard_idstring required

The ID of the dashboard.

tokenstring required

The share token identifying the secure embed.

Request body

Example request

{
  "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": {
        "theme": "system"
      }
    },
    "type": "secure_embed_update_request"
  }
}

Response

Example 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": {
        "theme": "system"
      }
    },
    "id": "12345",
    "type": "secure_embed_update_response"
  }
}