DAdatadog
Dashboards

Update a shared dashboard

Update a shared dashboard associated with the specified token.

put/api/v1/dashboard/public/{token}

Request

  • Base URL
    https://api.datadoghq.com
  • URL
    https://api.datadoghq.com/api/v1/dashboard/public/{token}
  • Auth
    • API key in header DD-API-KEY and API key in header DD-APPLICATION-KEY
    • or OAuth 2
      Authorization code: /oauth2/v1/authorize
      Token URL: /oauth2/v1/token scopes: dashboards_public_share
    • or OAuth 2
      Authorization code: /oauth2/v1/authorize
      Token URL: /oauth2/v1/token scopes: dashboards_embed_share
    • or OAuth 2
      Authorization code: /oauth2/v1/authorize
      Token URL: /oauth2/v1/token scopes: dashboards_invite_share

Path parameters

tokenstring required

The token of the shared dashboard.

Request body

embeddable_domainsstring[]

The SharedDashboard embeddable_domains.

expirationstring date-time nullable

The time when an OPEN shared dashboard becomes publicly unavailable.

global_time_selectable_enabledboolean nullable

Whether to allow viewers to select a different global time setting for the shared dashboard.

share_liststring[] nullable

List of email addresses that can be given access to the shared dashboard.

share_type'open' | 'invite' | 'embed' nullable

Type of sharing access (either open to anyone who has the public URL or invite-only).

status'active' | 'paused'

Active means the dashboard is publicly available. Paused means the dashboard is not publicly available.

titlestring

Title of the shared dashboard.

Example request

{
  "global_time": {
    "live_span": "1h"
  },
  "share_list": [
    "test@datadoghq.com",
    "test2@datadoghq.com"
  ],
  "share_type": "invite"
}

Response

OK

createdstring date-time

Date the dashboard was shared.

dashboard_idstring required

ID of the dashboard to share.

dashboard_type'custom_timeboard' | 'custom_screenboard' required

The type of the associated private dashboard.

embeddable_domainsstring[]

The SharedDashboard embeddable_domains.

expirationstring date-time nullable

The time when an OPEN shared dashboard becomes publicly unavailable.

global_time_selectable_enabledboolean nullable

Whether to allow viewers to select a different global time setting for the shared dashboard.

last_accessedstring date-time nullable

The last time the shared dashboard was accessed. Null if never accessed.

public_urlstring

URL of the shared dashboard.

share_liststring[] nullable

List of email addresses that can receive an invitation to access to the shared dashboard.

share_type'open' | 'invite' | 'embed' nullable

Type of sharing access (either open to anyone who has the public URL or invite-only).

status'active' | 'paused'

Active means the dashboard is publicly available. Paused means the dashboard is not publicly available.

titlestring

Title of the shared dashboard.

tokenstring

A unique token assigned to the shared dashboard.

Example response

{
  "author": {
    "handle": "test@datadoghq.com"
  },
  "dashboard_id": "123-abc-456",
  "dashboard_type": "custom_timeboard",
  "embeddable_domains": [
    "https://domain.atlassian.net/",
    "http://myserver.com/"
  ],
  "global_time": {
    "live_span": "1h"
  },
  "invitees": [
    {
      "access_expiration": "2030-01-01T12:00:00.00Z",
      "email": "test@datadoghq.com"
    },
    {
      "access_expiration": null,
      "email": "test2@datadoghq.com"
    }
  ],
  "selectable_template_vars": [
    {
      "default_value": "*",
      "name": "exampleVar",
      "prefix": "test",
      "visible_tags": [
        "selectableValue1",
        "selectableValue2"
      ]
    }
  ],
  "share_list": [
    "test@datadoghq.com",
    "test2@email.com"
  ],
  "status": "active"
}

Changes

No recorded changes to this operation across all 1 revision of this API.