List shared dashboards for a dashboard
ADVERTENCIANote: This endpoint is in preview and is subject to change.
If you have any feedback, contact Datadog support.
GET
https://api.datadoghq.com/api/v2/dashboard/{dashboard_id}/sharedhttps://api.us3.datadoghq.com/api/v2/dashboard/{dashboard_id}/sharedhttps://api.us5.datadoghq.com/api/v2/dashboard/{dashboard_id}/sharedhttps://api.datadoghq.eu/api/v2/dashboard/{dashboard_id}/sharedhttps://api.ap1.datadoghq.com/api/v2/dashboard/{dashboard_id}/sharedhttps://api.ap2.datadoghq.com/api/v2/dashboard/{dashboard_id}/sharedhttps://api.uk1.datadoghq.com/api/v2/dashboard/{dashboard_id}/sharedhttps://api.ddog-gov.com/api/v2/dashboard/{dashboard_id}/sharedhttps://api.us2.ddog-gov.com/api/v2/dashboard/{dashboard_id}/sharedDescripción general
Retrieve shared dashboards associated with the specified dashboard.
This endpoint requires the dashboards_read permission.
OAuth apps require the dashboards_read authorization scope to access this endpoint.
Argumentos
Parámetros de ruta
Nombre
Type
Descripción
dashboard_id [required]string
ID of the dashboard.
Respuesta
OK
Response containing shared dashboards for a dashboard.
Campo
Type
Descripción
data [required][object]
Shared dashboards for the dashboard.
attributes [required]object
Attributes of a shared dashboard response.
created_at [required]date-time
Time when the shared dashboard was created.
embeddable_domains [required][string]
Domains where embed-type shared dashboards can be embedded.
expiration [required]date-time
Time when the shared dashboard expires.
global_time [required]object
Default time range configuration for the shared dashboard.
global_time_selectable [required]boolean
Whether viewers can select a different global time setting.
invitees [required][object]
Invitees for invite-only shared dashboards.
access_expiration [required]date-time
Time when the invitee's access expires.
created_at [required]date-time
Time when the invitee was added.
email [required]string
Email address of the invitee.
last_accessed [required]date-time
Time when the shared dashboard was last accessed.
selectable_template_vars [required][object]
Template variables that viewers can modify.
allow_any_value [required]boolean
Whether viewers can see all tag values for the template variable and specify any value.
default_values [required][string]
Default selected values for the variable.
name [required]string
Name of the template variable.
prefix [required]string
Tag prefix for the variable.
type [required]string
Type of the template variable.
visible_tags [required][string]
Restricts which tag values are visible to the viewer.
share_type [required]enum
Type of dashboard sharing.
Allowed enum values:
open, invite, embed, secure-embedsharer_disabled [required]boolean
Whether the user who shared the dashboard is disabled.
status [required]enum
Status of the shared dashboard.
Allowed enum values:
active, pausedtitle [required]string
Display title for the shared dashboard.
token [required]string
Token assigned to the shared dashboard.
url [required]string
URL for the shared dashboard.
viewing_preferences [required]object
Display settings for the shared dashboard.
high_density [required]boolean
Whether widgets are displayed in high-density mode.
theme [required]enum
The theme of the shared dashboard view. system follows the viewer's system default.
Allowed enum values:
system, light, darkid [required]string
ID of the shared dashboard.
relationships [required]object
Relationships of a shared dashboard.
dashboard [required]object
Dashboard associated with the shared dashboard.
data [required]object
Dashboard relationship data.
id [required]string
ID of the dashboard.
type [required]enum
Included dashboard resource type.
dashboardAllowed enum values:
dashboardsharer [required]object
User who shared the dashboard.
data [required]object
Relationship to user object.
id [required]string
A unique identifier that represents the user.
type [required]enum
User resource type.
userAllowed enum values:
usertype [required]enum
Shared dashboard resource type.
shared_dashboardAllowed enum values:
shared_dashboardincluded [required][<oneOf>]
Users and dashboards related to the shared dashboards.
<type=dashboard>object
Included dashboard resource.
attributes [required]object
Attributes of the included dashboard.
title [required]string
Dashboard title.
id [required]string
ID of the dashboard.
type [required]enum
Included dashboard resource type.
dashboardAllowed enum values:
dashboard<type=user>object
Included user resource.
attributes [required]object
Attributes of the included user.
handle [required]string
User handle.
name [required]string
User display name.
id [required]string
ID of the user.
type [required]enum
User resource type.
userAllowed enum values:
user{
"data": [
{
"attributes": {
"created_at": "2026-01-01T00:00:00.000Z",
"embeddable_domains": [
"https://example.com"
],
"expiration": "2026-02-01T00:00:00.000Z",
"global_time": {
"live_span": "1h"
},
"global_time_selectable": false,
"invitees": [
{
"access_expiration": "2026-01-15T09:30:00.000Z",
"created_at": "2026-01-01T00:00:00.000Z",
"email": "jane.doe@example.com"
}
],
"last_accessed": "2026-01-15T09:30:00.000Z",
"selectable_template_vars": [
{
"allow_any_value": false,
"default_values": [
"prod"
],
"name": "environment",
"prefix": "env",
"type": "group",
"visible_tags": [
"prod"
]
}
],
"share_type": "invite",
"sharer_disabled": false,
"status": "active",
"title": "Q1 Metrics Dashboard",
"token": "abc-123-token",
"url": "https://p.datadoghq.com/sb/abc-123-token",
"viewing_preferences": {
"high_density": false,
"theme": "system"
}
},
"id": "12345",
"relationships": {
"dashboard": {
"data": {
"id": "abc-def-ghi",
"type": "dashboard"
}
},
"sharer": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "user"
}
}
},
"type": "shared_dashboard"
}
],
"included": [
{
"attributes": {
"title": "Q1 Metrics Dashboard"
},
"id": "abc-def-ghi",
"type": "dashboard"
}
]
}Forbidden
API error response.
Campo
Type
Descripción
errors [required][object]
A list of errors.
detailstring
A human-readable explanation specific to this occurrence of the error.
metaobject
Non-standard meta-information about the error
sourceobject
References to the source of the error.
headerstring
A string indicating the name of a single request header which caused the error.
parameterstring
A string indicating which URI query parameter caused the error.
pointerstring
A JSON pointer to the value in the request document that caused the error.
statusstring
Status code of the response.
titlestring
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Dashboard Not Found
API error response.
Campo
Type
Descripción
errors [required][object]
A list of errors.
detailstring
A human-readable explanation specific to this occurrence of the error.
metaobject
Non-standard meta-information about the error
sourceobject
References to the source of the error.
headerstring
A string indicating the name of a single request header which caused the error.
parameterstring
A string indicating which URI query parameter caused the error.
pointerstring
A JSON pointer to the value in the request document that caused the error.
statusstring
Status code of the response.
titlestring
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Too many requests
API error response.
Campo
Type
Descripción
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Ejemplo de código
List shared dashboards for a dashboard
# Path parameters
export dashboard_id="abc-def-ghi"
# 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" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export dashboard_id="abc-def-ghi"
# 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" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export dashboard_id="abc-def-ghi"
# 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" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export dashboard_id="abc-def-ghi"
# 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" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export dashboard_id="abc-def-ghi"
# 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" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export dashboard_id="abc-def-ghi"
# 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" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export dashboard_id="abc-def-ghi"
# 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" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export dashboard_id="abc-def-ghi"
# 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" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export dashboard_id="abc-def-ghi"
# 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" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"List shared dashboards for a dashboard
// List shared dashboards for a dashboard returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
ctx := datadog.NewDefaultContext(context.Background())
ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
configuration := datadog.NewConfiguration()
configuration.SetUnstableOperationEnabled("v2.ListSharedDashboardsByDashboardId", true)
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewDashboardSharingApi(apiClient)
resp, r, err := api.ListSharedDashboardsByDashboardId(ctx, "abc-def-ghi")
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DashboardSharingApi.ListSharedDashboardsByDashboardId`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `DashboardSharingApi.ListSharedDashboardsByDashboardId`:\n%s\n", responseContent)
}
Instructions
First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"List shared dashboards for a dashboard
// List shared dashboards for a dashboard returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.DashboardSharingApi;
import com.datadog.api.client.v2.model.ListSharedDashboardsResponse;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
defaultClient.setUnstableOperationEnabled("v2.listSharedDashboardsByDashboardId", true);
DashboardSharingApi apiInstance = new DashboardSharingApi(defaultClient);
try {
ListSharedDashboardsResponse result =
apiInstance.listSharedDashboardsByDashboardId("abc-def-ghi");
System.out.println(result);
} catch (ApiException e) {
System.err.println(
"Exception when calling DashboardSharingApi#listSharedDashboardsByDashboardId");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Instructions
First install the library and its dependencies and then save the example to Example.java and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"List shared dashboards for a dashboard
"""
List shared dashboards for a dashboard returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.dashboard_sharing_api import DashboardSharingApi
configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
configuration.unstable_operations["list_shared_dashboards_by_dashboard_id"] = True
with ApiClient(configuration) as api_client:
api_instance = DashboardSharingApi(api_client)
response = api_instance.list_shared_dashboards_by_dashboard_id(
dashboard_id="abc-def-ghi",
)
print(response)
Instructions
First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"List shared dashboards for a dashboard
# List shared dashboards for a dashboard returns "OK" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.access_token = ENV["DD_BEARER_TOKEN"]
config.unstable_operations["v2.list_shared_dashboards_by_dashboard_id".to_sym] = true
end
api_instance = DatadogAPIClient::V2::DashboardSharingAPI.new
p api_instance.list_shared_dashboards_by_dashboard_id("abc-def-ghi")
Instructions
First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"List shared dashboards for a dashboard
// List shared dashboards for a dashboard returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_dashboard_sharing::DashboardSharingAPI;
#[tokio::main]
async fn main() {
let mut configuration = datadog::Configuration::new();
configuration.set_unstable_operation_enabled("v2.list_shared_dashboards_by_dashboard_id", true);
let api = DashboardSharingAPI::with_config(configuration);
let resp = api
.list_shared_dashboards_by_dashboard_id("abc-def-ghi".to_string())
.await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
Instructions
First install the library and its dependencies and then save the example to src/main.rs and run following commands:
DD_SITE="datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us3.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us5.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="datadoghq.eu" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap2.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="uk1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runList shared dashboards for a dashboard
/**
* List shared dashboards for a dashboard returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration({
authMethods: {
AuthZ: {
accessToken: process.env.DD_BEARER_TOKEN as string,
},
},
});
configuration.unstableOperations["v2.listSharedDashboardsByDashboardId"] = true;
const apiInstance = new v2.DashboardSharingApi(configuration);
const params: v2.DashboardSharingApiListSharedDashboardsByDashboardIdRequest = {
dashboardId: "abc-def-ghi",
};
apiInstance
.listSharedDashboardsByDashboardId(params)
.then((data: v2.ListSharedDashboardsResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
Instructions
First install the library and its dependencies and then save the example to example.ts and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"