For AI agents: A markdown version of this page is available at https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/ko/api/latest/dashboards/update-a-shared-dashboard.md. A documentation index is available at /llms.txt.
homeHomedocs문서apiAPI
Language
Datadog site

공유 대시보드 업데이트하기

PUThttps://api.datadoghq.com/api/v1/dashboard/public/{token}https://api.us3.datadoghq.com/api/v1/dashboard/public/{token}https://api.us5.datadoghq.com/api/v1/dashboard/public/{token}https://api.datadoghq.eu/api/v1/dashboard/public/{token}https://api.ap1.datadoghq.com/api/v1/dashboard/public/{token}https://api.ap2.datadoghq.com/api/v1/dashboard/public/{token}https://api.uk1.datadoghq.com/api/v1/dashboard/public/{token}https://api.ddog-gov.com/api/v1/dashboard/public/{token}https://api.us2.ddog-gov.com/api/v1/dashboard/public/{token}

개요

지정된 토큰과 연결된 공유 대시보드를 업데이트합니다.

This endpoint requires any of the following permissions:

  • dashboards_public_share
  • dashboards_embed_share
  • dashboards_invite_share

OAuth apps require one of the following authorization scopes to access this endpoint: dashboards_public_share, dashboards_embed_share, dashboards_invite_share.

인수

경로 파라미터

이름
유형
설명
token [required]
string

The token of the shared dashboard.

요청

Body Data (required)

대시보드 업데이트 요청 본문입니다.

항목
유형
설명
embeddable_domains
[string]

공유 대시보드의 설정을 업데이트합니다.

expiration
date-time

The time when an OPEN shared dashboard becomes publicly unavailable.

global_time
object

Timeframe setting for the shared dashboard.

global_time_selectable_enabled
boolean

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

invitees
[object]

The SharedDashboard invitees.

selectable_template_vars
[object]

List of objects representing template variables on the shared dashboard which can have selectable values.

share_list
[string]

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

share_type
enum

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

Allowed enum values: open, invite, embed
status
enum

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

Allowed enum values: active, paused
title
string

Title of the shared dashboard.

viewing_preferences
object

The viewing preferences for a shared dashboard.

응답

OK

The metadata object associated with how a dashboard has been/will be shared.

항목
유형
설명
author
object

User who shared the dashboard.

created
date-time

Date the dashboard was shared.

dashboard_id [required]
string

ID of the dashboard to share.

dashboard_type [required]
enum

The type of the associated private dashboard.

Allowed enum values: custom_timeboard, custom_screenboard
embeddable_domains
[string]

The SharedDashboard embeddable_domains.

expiration
date-time

The time when an OPEN shared dashboard becomes publicly unavailable.

global_time
object

Object containing the live span selection for the dashboard.

global_time_selectable_enabled
boolean

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

invitees
[object]

The SharedDashboard invitees.

last_accessed
date-time

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

public_url
string

URL of the shared dashboard.

selectable_template_vars
[object]

List of objects representing template variables on the shared dashboard which can have selectable values.

share_list
[string]

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

share_type
enum

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

Allowed enum values: open, invite, embed
status
enum

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

Allowed enum values: active, paused
title
string

Title of the shared dashboard.

token
string

A unique token assigned to the shared dashboard.

viewing_preferences
object

The viewing preferences for a shared dashboard.

코드 예시

Update a shared dashboard returns "OK" response
# Path parameters
export token="CHANGE_ME"

# 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 PUT "https://api.${DD_SITE}/api/v1/dashboard/public/${token}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "global_time": {
    "live_span": "15m"
  },
  "share_list": [],
  "share_type": "open"
}
EOF
# Path parameters
export token="CHANGE_ME"

# 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 PUT "https://api.${DD_SITE}/api/v1/dashboard/public/${token}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "global_time": {
    "live_span": "15m"
  },
  "share_list": [],
  "share_type": "open"
}
EOF
# Path parameters
export token="CHANGE_ME"

# 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 PUT "https://api.${DD_SITE}/api/v1/dashboard/public/${token}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "global_time": {
    "live_span": "15m"
  },
  "share_list": [],
  "share_type": "open"
}
EOF
# Path parameters
export token="CHANGE_ME"

# 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 PUT "https://api.${DD_SITE}/api/v1/dashboard/public/${token}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "global_time": {
    "live_span": "15m"
  },
  "share_list": [],
  "share_type": "open"
}
EOF
# Path parameters
export token="CHANGE_ME"

# 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 PUT "https://api.${DD_SITE}/api/v1/dashboard/public/${token}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "global_time": {
    "live_span": "15m"
  },
  "share_list": [],
  "share_type": "open"
}
EOF
# Path parameters
export token="CHANGE_ME"

# 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 PUT "https://api.${DD_SITE}/api/v1/dashboard/public/${token}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "global_time": {
    "live_span": "15m"
  },
  "share_list": [],
  "share_type": "open"
}
EOF
# Path parameters
export token="CHANGE_ME"

# 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 PUT "https://api.${DD_SITE}/api/v1/dashboard/public/${token}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "global_time": {
    "live_span": "15m"
  },
  "share_list": [],
  "share_type": "open"
}
EOF
# Path parameters
export token="CHANGE_ME"

# 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 PUT "https://api.${DD_SITE}/api/v1/dashboard/public/${token}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "global_time": {
    "live_span": "15m"
  },
  "share_list": [],
  "share_type": "open"
}
EOF
# Path parameters
export token="CHANGE_ME"

# 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 PUT "https://api.${DD_SITE}/api/v1/dashboard/public/${token}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "global_time": {
    "live_span": "15m"
  },
  "share_list": [],
  "share_type": "open"
}
EOF
Update a shared dashboard with selectable_template_vars returns "OK" response
# Path parameters
export token="CHANGE_ME"

# 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 PUT "https://api.${DD_SITE}/api/v1/dashboard/public/${token}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "global_time": {
    "live_span": "15m"
  },
  "share_list": [],
  "share_type": "open",
  "selectable_template_vars": [
    {
      "default_value": "*",
      "name": "group_by_var",
      "type": "group",
      "visible_tags": [
        "selectableValue1",
        "selectableValue2"
      ]
    }
  ]
}
EOF
# Path parameters
export token="CHANGE_ME"

# 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 PUT "https://api.${DD_SITE}/api/v1/dashboard/public/${token}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "global_time": {
    "live_span": "15m"
  },
  "share_list": [],
  "share_type": "open",
  "selectable_template_vars": [
    {
      "default_value": "*",
      "name": "group_by_var",
      "type": "group",
      "visible_tags": [
        "selectableValue1",
        "selectableValue2"
      ]
    }
  ]
}
EOF
# Path parameters
export token="CHANGE_ME"

# 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 PUT "https://api.${DD_SITE}/api/v1/dashboard/public/${token}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "global_time": {
    "live_span": "15m"
  },
  "share_list": [],
  "share_type": "open",
  "selectable_template_vars": [
    {
      "default_value": "*",
      "name": "group_by_var",
      "type": "group",
      "visible_tags": [
        "selectableValue1",
        "selectableValue2"
      ]
    }
  ]
}
EOF
# Path parameters
export token="CHANGE_ME"

# 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 PUT "https://api.${DD_SITE}/api/v1/dashboard/public/${token}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "global_time": {
    "live_span": "15m"
  },
  "share_list": [],
  "share_type": "open",
  "selectable_template_vars": [
    {
      "default_value": "*",
      "name": "group_by_var",
      "type": "group",
      "visible_tags": [
        "selectableValue1",
        "selectableValue2"
      ]
    }
  ]
}
EOF
# Path parameters
export token="CHANGE_ME"

# 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 PUT "https://api.${DD_SITE}/api/v1/dashboard/public/${token}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "global_time": {
    "live_span": "15m"
  },
  "share_list": [],
  "share_type": "open",
  "selectable_template_vars": [
    {
      "default_value": "*",
      "name": "group_by_var",
      "type": "group",
      "visible_tags": [
        "selectableValue1",
        "selectableValue2"
      ]
    }
  ]
}
EOF
# Path parameters
export token="CHANGE_ME"

# 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 PUT "https://api.${DD_SITE}/api/v1/dashboard/public/${token}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "global_time": {
    "live_span": "15m"
  },
  "share_list": [],
  "share_type": "open",
  "selectable_template_vars": [
    {
      "default_value": "*",
      "name": "group_by_var",
      "type": "group",
      "visible_tags": [
        "selectableValue1",
        "selectableValue2"
      ]
    }
  ]
}
EOF
# Path parameters
export token="CHANGE_ME"

# 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 PUT "https://api.${DD_SITE}/api/v1/dashboard/public/${token}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "global_time": {
    "live_span": "15m"
  },
  "share_list": [],
  "share_type": "open",
  "selectable_template_vars": [
    {
      "default_value": "*",
      "name": "group_by_var",
      "type": "group",
      "visible_tags": [
        "selectableValue1",
        "selectableValue2"
      ]
    }
  ]
}
EOF
# Path parameters
export token="CHANGE_ME"

# 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 PUT "https://api.${DD_SITE}/api/v1/dashboard/public/${token}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "global_time": {
    "live_span": "15m"
  },
  "share_list": [],
  "share_type": "open",
  "selectable_template_vars": [
    {
      "default_value": "*",
      "name": "group_by_var",
      "type": "group",
      "visible_tags": [
        "selectableValue1",
        "selectableValue2"
      ]
    }
  ]
}
EOF
# Path parameters
export token="CHANGE_ME"

# 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 PUT "https://api.${DD_SITE}/api/v1/dashboard/public/${token}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "global_time": {
    "live_span": "15m"
  },
  "share_list": [],
  "share_type": "open",
  "selectable_template_vars": [
    {
      "default_value": "*",
      "name": "group_by_var",
      "type": "group",
      "visible_tags": [
        "selectableValue1",
        "selectableValue2"
      ]
    }
  ]
}
EOF