- 필수 기능
- 시작하기
- Glossary
- 표준 속성
- Guides
- Agent
- 통합
- 개방형텔레메트리
- 개발자
- API
- Datadog Mobile App
- CoScreen
- Cloudcraft
- 앱 내
- 서비스 관리
- 인프라스트럭처
- 애플리케이션 성능
- APM
- Continuous Profiler
- 스팬 시각화
- 데이터 스트림 모니터링
- 데이터 작업 모니터링
- 디지털 경험
- 소프트웨어 제공
- 보안
- AI Observability
- 로그 관리
- 관리
API를 사용해 대시보드 목록과 상호 작용하여 대시보드 전체를 구성 및 검색하고 팀과 조직에 공유할 수 있습니다.
GET https://api.ap1.datadoghq.com/api/v1/dashboard/lists/manualhttps://api.datadoghq.eu/api/v1/dashboard/lists/manualhttps://api.ddog-gov.com/api/v1/dashboard/lists/manualhttps://api.datadoghq.com/api/v1/dashboard/lists/manualhttps://api.us3.datadoghq.com/api/v1/dashboard/lists/manualhttps://api.us5.datadoghq.com/api/v1/dashboard/lists/manual
Fetch all of your existing dashboard list definitions.
This endpoint requires the dashboards_read
permission.
OAuth apps require the dashboards_read
authorization scope to access this endpoint.
OK
Information on your dashboard lists.
항목
유형
설명
dashboard_lists
[object]
List of all your dashboard lists.
author
object
Object describing the creator of the shared element.
string
Email of the creator.
handle
string
Handle of the creator.
name
string
Name of the creator.
created
date-time
Date of creation of the dashboard list.
dashboard_count
int64
The number of dashboards in the list.
id
int64
The ID of the dashboard list.
is_favorite
boolean
Whether or not the list is in the favorites.
modified
date-time
Date of last edition of the dashboard list.
name [required]
string
The name of the dashboard list.
type
string
The type of dashboard list.
{
"dashboard_lists": [
{
"author": {
"email": "string",
"handle": "string",
"name": "string"
},
"created": "2019-09-19T10:00:00.000Z",
"dashboard_count": "integer",
"id": "integer",
"is_favorite": false,
"modified": "2019-09-19T10:00:00.000Z",
"name": "My Dashboard",
"type": "manual_dashboard_list"
}
]
}
Forbidden
Error response object.
{
"errors": [
"Bad Request"
]
}
Too many requests
Error response object.
{
"errors": [
"Bad Request"
]
}
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/lists/manual" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
"""
Get all dashboard lists returns "OK" response
"""
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboard_lists_api import DashboardListsApi
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = DashboardListsApi(api_client)
response = api_instance.list_dashboard_lists()
print(response)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"
# Get all dashboard lists returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardListsAPI.new
p api_instance.list_dashboard_lists()
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
require 'rubygems'
require 'dogapi'
api_key = '<DATADOG_API_KEY>'
app_key = '<DATADOG_APPLICATION_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
result = dog.get_all_dashboard_lists()
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
// Get all dashboard lists 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/datadogV1"
)
func main() {
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV1.NewDashboardListsApi(apiClient)
resp, r, err := api.ListDashboardLists(ctx)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DashboardListsApi.ListDashboardLists`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `DashboardListsApi.ListDashboardLists`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"
// Get all dashboard lists returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardListsApi;
import com.datadog.api.client.v1.model.DashboardListListResponse;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
DashboardListsApi apiInstance = new DashboardListsApi(defaultClient);
try {
DashboardListListResponse result = apiInstance.listDashboardLists();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DashboardListsApi#listDashboardLists");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"
from datadog import initialize, api
options = {
'api_key': '<DATADOG_API_KEY>',
'app_key': '<DATADOG_APPLICATION_KEY>'
}
initialize(**options)
api.DashboardList.get_all()
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python "example.py"
// Get all dashboard lists returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_dashboard_lists::DashboardListsAPI;
#[tokio::main]
async fn main() {
let configuration = datadog::Configuration::new();
let api = DashboardListsAPI::with_config(configuration);
let resp = api.list_dashboard_lists().await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
/**
* Get all dashboard lists returns "OK" response
*/
import { client, v1 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v1.DashboardListsApi(configuration);
apiInstance
.listDashboardLists()
.then((data: v1.DashboardListListResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"
GET https://api.ap1.datadoghq.com/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboardshttps://api.datadoghq.eu/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboardshttps://api.ddog-gov.com/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboardshttps://api.datadoghq.com/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboardshttps://api.us3.datadoghq.com/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboardshttps://api.us5.datadoghq.com/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards
Fetch the dashboard list’s dashboard definitions.
This endpoint requires the dashboards_read
permission.
OAuth apps require the dashboards_read
authorization scope to access this endpoint.
이름
유형
설명
dashboard_list_id [required]
integer
ID of the dashboard list to get items from.
OK
Dashboards within a list.
항목
유형
설명
dashboards [required]
[object]
List of dashboards in the dashboard list.
author
object
Creator of the object.
string
Email of the creator.
handle
string
Handle of the creator.
name
string
Name of the creator.
created
date-time
Date of creation of the dashboard.
icon
string
URL to the icon of the dashboard.
id [required]
string
ID of the dashboard.
integration_id
string
The short name of the integration.
is_favorite
boolean
Whether or not the dashboard is in the favorites.
is_read_only
boolean
Whether or not the dashboard is read only.
is_shared
boolean
Whether the dashboard is publicly shared or not.
modified
date-time
Date of last edition of the dashboard.
popularity
int32
Popularity of the dashboard.
tags
[string]
List of team names representing ownership of a dashboard.
title
string
Title of the dashboard.
type [required]
enum
The type of the dashboard.
Allowed enum values: custom_timeboard,custom_screenboard,integration_screenboard,integration_timeboard,host_timeboard
url
string
URL path to the dashboard.
total
int64
Number of dashboards in the dashboard list.
{
"dashboards": [
{
"author": {
"email": "string",
"handle": "string",
"name": "string"
},
"created": "2019-09-19T10:00:00.000Z",
"icon": "string",
"id": "q5j-nti-fv6",
"integration_id": "string",
"is_favorite": false,
"is_read_only": false,
"is_shared": false,
"modified": "2019-09-19T10:00:00.000Z",
"popularity": "integer",
"tags": [],
"title": "string",
"type": "host_timeboard",
"url": "string"
}
],
"total": "integer"
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export dashboard_list_id="CHANGE_ME"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/dashboard/lists/manual/${dashboard_list_id}/dashboards" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
"""
Get items of a Dashboard List returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.dashboard_lists_api import DashboardListsApi
# there is a valid "dashboard_list" in the system
DASHBOARD_LIST_ID = environ["DASHBOARD_LIST_ID"]
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = DashboardListsApi(api_client)
response = api_instance.get_dashboard_list_items(
dashboard_list_id=int(DASHBOARD_LIST_ID),
)
print(response)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"
# Get items of a Dashboard List returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::DashboardListsAPI.new
# there is a valid "dashboard_list" in the system
DASHBOARD_LIST_ID = ENV["DASHBOARD_LIST_ID"]
p api_instance.get_dashboard_list_items(DASHBOARD_LIST_ID.to_i)
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
require 'rubygems'
require 'dogapi'
api_key = '<DATADOG_API_KEY>'
app_key = '<DATADOG_APPLICATION_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
result = dog.v2.get_items_of_dashboard_list(4741)
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
// Get items of a Dashboard List returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"strconv"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
// there is a valid "dashboard_list" in the system
DashboardListID, _ := strconv.ParseInt(os.Getenv("DASHBOARD_LIST_ID"), 10, 64)
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewDashboardListsApi(apiClient)
resp, r, err := api.GetDashboardListItems(ctx, DashboardListID)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DashboardListsApi.GetDashboardListItems`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `DashboardListsApi.GetDashboardListItems`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"
// Get items of a Dashboard List returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.DashboardListsApi;
import com.datadog.api.client.v2.model.DashboardListItems;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
DashboardListsApi apiInstance = new DashboardListsApi(defaultClient);
// there is a valid "dashboard_list" in the system
Long DASHBOARD_LIST_ID = Long.parseLong(System.getenv("DASHBOARD_LIST_ID"));
try {
DashboardListItems result = apiInstance.getDashboardListItems(DASHBOARD_LIST_ID);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DashboardListsApi#getDashboardListItems");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"
from datadog import initialize, api
options = {
'api_key': '<DATADOG_API_KEY>',
'app_key': '<DATADOG_APPLICATION_KEY>'
}
initialize(**options)
api.DashboardList.v2.get_items(4741)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python "example.py"
// Get items of a Dashboard List returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_dashboard_lists::DashboardListsAPI;
#[tokio::main]
async fn main() {
// there is a valid "dashboard_list" in the system
let dashboard_list_id: i64 = std::env::var("DASHBOARD_LIST_ID").unwrap().parse().unwrap();
let configuration = datadog::Configuration::new();
let api = DashboardListsAPI::with_config(configuration);
let resp = api
.get_dashboard_list_items(dashboard_list_id.clone())
.await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
/**
* Get items of a Dashboard List returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v2.DashboardListsApi(configuration);
// there is a valid "dashboard_list" in the system
const DASHBOARD_LIST_ID = parseInt(process.env.DASHBOARD_LIST_ID as string);
const params: v2.DashboardListsApiGetDashboardListItemsRequest = {
dashboardListId: DASHBOARD_LIST_ID,
};
apiInstance
.getDashboardListItems(params)
.then((data: v2.DashboardListItems) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"
POST https://api.ap1.datadoghq.com/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboardshttps://api.datadoghq.eu/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboardshttps://api.ddog-gov.com/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboardshttps://api.datadoghq.com/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboardshttps://api.us3.datadoghq.com/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboardshttps://api.us5.datadoghq.com/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards
Add dashboards to an existing dashboard list.
이름
유형
설명
dashboard_list_id [required]
integer
ID of the dashboard list to add items to.
Dashboards to add to the dashboard list.
항목
유형
설명
dashboards
[object]
List of dashboards to add the dashboard list.
id [required]
string
ID of the dashboard.
type [required]
enum
The type of the dashboard.
Allowed enum values: custom_timeboard,custom_screenboard,integration_screenboard,integration_timeboard,host_timeboard
{
"dashboards": [
{
"id": "123-abc-456",
"type": "custom_screenboard"
}
]
}
{
"dashboards": [
{
"id": "123-abc-456",
"type": "custom_timeboard"
}
]
}
OK
Response containing a list of added dashboards.
항목
유형
설명
added_dashboards_to_list
[object]
List of dashboards added to the dashboard list.
id [required]
string
ID of the dashboard.
type [required]
enum
The type of the dashboard.
Allowed enum values: custom_timeboard,custom_screenboard,integration_screenboard,integration_timeboard,host_timeboard
{
"added_dashboards_to_list": [
{
"id": "q5j-nti-fv6",
"type": "host_timeboard"
}
]
}
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export dashboard_list_id="CHANGE_ME"
# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/dashboard/lists/manual/${dashboard_list_id}/dashboards" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"dashboards": [
{
"id": "123-abc-456",
"type": "custom_screenboard"
}
]
}
EOF
# Path parameters
export dashboard_list_id="CHANGE_ME"
# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/dashboard/lists/manual/${dashboard_list_id}/dashboards" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"dashboards": [
{
"id": "123-abc-456",
"type": "custom_timeboard"
}
]
}
EOF
// Add custom screenboard dashboard to an existing dashboard list returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"strconv"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
// there is a valid "dashboard_list" in the system
DashboardListID, _ := strconv.ParseInt(os.Getenv("DASHBOARD_LIST_ID"), 10, 64)
// there is a valid "screenboard_dashboard" in the system
ScreenboardDashboardID := os.Getenv("SCREENBOARD_DASHBOARD_ID")
body := datadogV2.DashboardListAddItemsRequest{
Dashboards: []datadogV2.DashboardListItemRequest{
{
Id: ScreenboardDashboardID,
Type: datadogV2.DASHBOARDTYPE_CUSTOM_SCREENBOARD,
},
},
}
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewDashboardListsApi(apiClient)
resp, r, err := api.CreateDashboardListItems(ctx, DashboardListID, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DashboardListsApi.CreateDashboardListItems`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `DashboardListsApi.CreateDashboardListItems`:\n%s\n", responseContent)
}
// Add custom timeboard dashboard to an existing dashboard list returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"strconv"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
// there is a valid "dashboard_list" in the system
DashboardListID, _ := strconv.ParseInt(os.Getenv("DASHBOARD_LIST_ID"), 10, 64)
// there is a valid "dashboard" in the system
DashboardID := os.Getenv("DASHBOARD_ID")
body := datadogV2.DashboardListAddItemsRequest{
Dashboards: []datadogV2.DashboardListItemRequest{
{
Id: DashboardID,
Type: datadogV2.DASHBOARDTYPE_CUSTOM_TIMEBOARD,
},
},
}
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewDashboardListsApi(apiClient)
resp, r, err := api.CreateDashboardListItems(ctx, DashboardListID, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DashboardListsApi.CreateDashboardListItems`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `DashboardListsApi.CreateDashboardListItems`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" go run "main.go"
// Add custom screenboard dashboard to an existing dashboard list returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.DashboardListsApi;
import com.datadog.api.client.v2.model.DashboardListAddItemsRequest;
import com.datadog.api.client.v2.model.DashboardListAddItemsResponse;
import com.datadog.api.client.v2.model.DashboardListItemRequest;
import com.datadog.api.client.v2.model.DashboardType;
import java.util.Collections;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
DashboardListsApi apiInstance = new DashboardListsApi(defaultClient);
// there is a valid "dashboard_list" in the system
Long DASHBOARD_LIST_ID = Long.parseLong(System.getenv("DASHBOARD_LIST_ID"));
// there is a valid "screenboard_dashboard" in the system
String SCREENBOARD_DASHBOARD_ID = System.getenv("SCREENBOARD_DASHBOARD_ID");
DashboardListAddItemsRequest body =
new DashboardListAddItemsRequest()
.dashboards(
Collections.singletonList(
new DashboardListItemRequest()
.id(SCREENBOARD_DASHBOARD_ID)
.type(DashboardType.CUSTOM_SCREENBOARD)));
try {
DashboardListAddItemsResponse result =
apiInstance.createDashboardListItems(DASHBOARD_LIST_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DashboardListsApi#createDashboardListItems");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
// Add custom timeboard dashboard to an existing dashboard list returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.DashboardListsApi;
import com.datadog.api.client.v2.model.DashboardListAddItemsRequest;
import com.datadog.api.client.v2.model.DashboardListAddItemsResponse;
import com.datadog.api.client.v2.model.DashboardListItemRequest;
import com.datadog.api.client.v2.model.DashboardType;
import java.util.Collections;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
DashboardListsApi apiInstance = new DashboardListsApi(defaultClient);
// there is a valid "dashboard_list" in the system
Long DASHBOARD_LIST_ID = Long.parseLong(System.getenv("DASHBOARD_LIST_ID"));
// there is a valid "dashboard" in the system
String DASHBOARD_ID = System.getenv("DASHBOARD_ID");
DashboardListAddItemsRequest body =
new DashboardListAddItemsRequest()
.dashboards(
Collections.singletonList(
new DashboardListItemRequest()
.id(DASHBOARD_ID)
.type(DashboardType.CUSTOM_TIMEBOARD)));
try {
DashboardListAddItemsResponse result =
apiInstance.createDashboardListItems(DASHBOARD_LIST_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DashboardListsApi#createDashboardListItems");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" java "Example.java"
"""
Add custom screenboard dashboard to an existing dashboard list returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.dashboard_lists_api import DashboardListsApi
from datadog_api_client.v2.model.dashboard_list_add_items_request import DashboardListAddItemsRequest
from datadog_api_client.v2.model.dashboard_list_item_request import DashboardListItemRequest
from datadog_api_client.v2.model.dashboard_type import DashboardType
# there is a valid "dashboard_list" in the system
DASHBOARD_LIST_ID = environ["DASHBOARD_LIST_ID"]
# there is a valid "screenboard_dashboard" in the system
SCREENBOARD_DASHBOARD_ID = environ["SCREENBOARD_DASHBOARD_ID"]
body = DashboardListAddItemsRequest(
dashboards=[
DashboardListItemRequest(
id=SCREENBOARD_DASHBOARD_ID,
type=DashboardType.CUSTOM_SCREENBOARD,
),
],
)
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = DashboardListsApi(api_client)
response = api_instance.create_dashboard_list_items(dashboard_list_id=int(DASHBOARD_LIST_ID), body=body)
print(response)
"""
Add custom timeboard dashboard to an existing dashboard list returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.dashboard_lists_api import DashboardListsApi
from datadog_api_client.v2.model.dashboard_list_add_items_request import DashboardListAddItemsRequest
from datadog_api_client.v2.model.dashboard_list_item_request import DashboardListItemRequest
from datadog_api_client.v2.model.dashboard_type import DashboardType
# there is a valid "dashboard_list" in the system
DASHBOARD_LIST_ID = environ["DASHBOARD_LIST_ID"]
# there is a valid "dashboard" in the system
DASHBOARD_ID = environ["DASHBOARD_ID"]
body = DashboardListAddItemsRequest(
dashboards=[
DashboardListItemRequest(
id=DASHBOARD_ID,
type=DashboardType.CUSTOM_TIMEBOARD,
),
],
)
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = DashboardListsApi(api_client)
response = api_instance.create_dashboard_list_items(dashboard_list_id=int(DASHBOARD_LIST_ID), body=body)
print(response)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"
# Add custom screenboard dashboard to an existing dashboard list returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::DashboardListsAPI.new
# there is a valid "dashboard_list" in the system
DASHBOARD_LIST_ID = ENV["DASHBOARD_LIST_ID"]
# there is a valid "screenboard_dashboard" in the system
SCREENBOARD_DASHBOARD_ID = ENV["SCREENBOARD_DASHBOARD_ID"]
body = DatadogAPIClient::V2::DashboardListAddItemsRequest.new({
dashboards: [
DatadogAPIClient::V2::DashboardListItemRequest.new({
id: SCREENBOARD_DASHBOARD_ID,
type: DatadogAPIClient::V2::DashboardType::CUSTOM_SCREENBOARD,
}),
],
})
p api_instance.create_dashboard_list_items(DASHBOARD_LIST_ID.to_i, body)
# Add custom timeboard dashboard to an existing dashboard list returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::DashboardListsAPI.new
# there is a valid "dashboard_list" in the system
DASHBOARD_LIST_ID = ENV["DASHBOARD_LIST_ID"]
# there is a valid "dashboard" in the system
DASHBOARD_ID = ENV["DASHBOARD_ID"]
body = DatadogAPIClient::V2::DashboardListAddItemsRequest.new({
dashboards: [
DatadogAPIClient::V2::DashboardListItemRequest.new({
id: DASHBOARD_ID,
type: DatadogAPIClient::V2::DashboardType::CUSTOM_TIMEBOARD,
}),
],
})
p api_instance.create_dashboard_list_items(DASHBOARD_LIST_ID.to_i, body)
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"
// Add custom screenboard dashboard to an existing dashboard list returns "OK"
// response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_dashboard_lists::DashboardListsAPI;
use datadog_api_client::datadogV2::model::DashboardListAddItemsRequest;
use datadog_api_client::datadogV2::model::DashboardListItemRequest;
use datadog_api_client::datadogV2::model::DashboardType;
#[tokio::main]
async fn main() {
// there is a valid "dashboard_list" in the system
let dashboard_list_id: i64 = std::env::var("DASHBOARD_LIST_ID").unwrap().parse().unwrap();
// there is a valid "screenboard_dashboard" in the system
let screenboard_dashboard_id = std::env::var("SCREENBOARD_DASHBOARD_ID").unwrap();
let body = DashboardListAddItemsRequest::new().dashboards(vec![DashboardListItemRequest::new(
screenboard_dashboard_id.clone(),
DashboardType::CUSTOM_SCREENBOARD,
)]);
let configuration = datadog::Configuration::new();
let api = DashboardListsAPI::with_config(configuration);
let resp = api
.create_dashboard_list_items(dashboard_list_id.clone(), body)
.await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
// Add custom timeboard dashboard to an existing dashboard list returns "OK"
// response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_dashboard_lists::DashboardListsAPI;
use datadog_api_client::datadogV2::model::DashboardListAddItemsRequest;
use datadog_api_client::datadogV2::model::DashboardListItemRequest;
use datadog_api_client::datadogV2::model::DashboardType;
#[tokio::main]
async fn main() {
// there is a valid "dashboard_list" in the system
let dashboard_list_id: i64 = std::env::var("DASHBOARD_LIST_ID").unwrap().parse().unwrap();
// there is a valid "dashboard" in the system
let dashboard_id = std::env::var("DASHBOARD_ID").unwrap();
let body = DashboardListAddItemsRequest::new().dashboards(vec![DashboardListItemRequest::new(
dashboard_id.clone(),
DashboardType::CUSTOM_TIMEBOARD,
)]);
let configuration = datadog::Configuration::new();
let api = DashboardListsAPI::with_config(configuration);
let resp = api
.create_dashboard_list_items(dashboard_list_id.clone(), body)
.await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run
/**
* Add custom screenboard dashboard to an existing dashboard list returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v2.DashboardListsApi(configuration);
// there is a valid "dashboard_list" in the system
const DASHBOARD_LIST_ID = parseInt(process.env.DASHBOARD_LIST_ID as string);
// there is a valid "screenboard_dashboard" in the system
const SCREENBOARD_DASHBOARD_ID = process.env.SCREENBOARD_DASHBOARD_ID as string;
const params: v2.DashboardListsApiCreateDashboardListItemsRequest = {
body: {
dashboards: [
{
id: SCREENBOARD_DASHBOARD_ID,
type: "custom_screenboard",
},
],
},
dashboardListId: DASHBOARD_LIST_ID,
};
apiInstance
.createDashboardListItems(params)
.then((data: v2.DashboardListAddItemsResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
/**
* Add custom timeboard dashboard to an existing dashboard list returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v2.DashboardListsApi(configuration);
// there is a valid "dashboard_list" in the system
const DASHBOARD_LIST_ID = parseInt(process.env.DASHBOARD_LIST_ID as string);
// there is a valid "dashboard" in the system
const DASHBOARD_ID = process.env.DASHBOARD_ID as string;
const params: v2.DashboardListsApiCreateDashboardListItemsRequest = {
body: {
dashboards: [
{
id: DASHBOARD_ID,
type: "custom_timeboard",
},
],
},
dashboardListId: DASHBOARD_LIST_ID,
};
apiInstance
.createDashboardListItems(params)
.then((data: v2.DashboardListAddItemsResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"
POST https://api.ap1.datadoghq.com/api/v1/dashboard/lists/manualhttps://api.datadoghq.eu/api/v1/dashboard/lists/manualhttps://api.ddog-gov.com/api/v1/dashboard/lists/manualhttps://api.datadoghq.com/api/v1/dashboard/lists/manualhttps://api.us3.datadoghq.com/api/v1/dashboard/lists/manualhttps://api.us5.datadoghq.com/api/v1/dashboard/lists/manual
Create an empty dashboard list.
This endpoint requires the dashboards_write
permission.
OAuth apps require the dashboards_write
authorization scope to access this endpoint.
Create a dashboard list request body.
항목
유형
설명
author
object
Object describing the creator of the shared element.
string
Email of the creator.
handle
string
Handle of the creator.
name
string
Name of the creator.
created
date-time
Date of creation of the dashboard list.
dashboard_count
int64
The number of dashboards in the list.
id
int64
The ID of the dashboard list.
is_favorite
boolean
Whether or not the list is in the favorites.
modified
date-time
Date of last edition of the dashboard list.
name [required]
string
The name of the dashboard list.
type
string
The type of dashboard list.
{
"name": "Example-Dashboard-List"
}
OK
Your Datadog Dashboards.
항목
유형
설명
author
object
Object describing the creator of the shared element.
string
Email of the creator.
handle
string
Handle of the creator.
name
string
Name of the creator.
created
date-time
Date of creation of the dashboard list.
dashboard_count
int64
The number of dashboards in the list.
id
int64
The ID of the dashboard list.
is_favorite
boolean
Whether or not the list is in the favorites.
modified
date-time
Date of last edition of the dashboard list.
name [required]
string
The name of the dashboard list.
type
string
The type of dashboard list.
{
"author": {
"email": "string",
"handle": "string",
"name": "string"
},
"created": "2019-09-19T10:00:00.000Z",
"dashboard_count": "integer",
"id": "integer",
"is_favorite": false,
"modified": "2019-09-19T10:00:00.000Z",
"name": "My Dashboard",
"type": "manual_dashboard_list"
}
Bad Request
Error response object.
{
"errors": [
"Bad Request"
]
}
Forbidden
Error response object.
{
"errors": [
"Bad Request"
]
}
Too many requests
Error response object.
{
"errors": [
"Bad Request"
]
}
# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/lists/manual" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"name": "Example-Dashboard-List"
}
EOF
// Create a dashboard list 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/datadogV1"
)
func main() {
body := datadogV1.DashboardList{
Name: "Example-Dashboard-List",
}
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV1.NewDashboardListsApi(apiClient)
resp, r, err := api.CreateDashboardList(ctx, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DashboardListsApi.CreateDashboardList`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `DashboardListsApi.CreateDashboardList`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"
// Create a dashboard list returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardListsApi;
import com.datadog.api.client.v1.model.DashboardList;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
DashboardListsApi apiInstance = new DashboardListsApi(defaultClient);
DashboardList body = new DashboardList().name("Example-Dashboard-List");
try {
DashboardList result = apiInstance.createDashboardList(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DashboardListsApi#createDashboardList");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"
from datadog import initialize, api
options = {
'api_key': '<DATADOG_API_KEY>',
'app_key': '<DATADOG_APPLICATION_KEY>'
}
initialize(**options)
name = 'My Dashboard List'
api.DashboardList.create(name=name)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python "example.py"
"""
Create a dashboard list returns "OK" response
"""
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboard_lists_api import DashboardListsApi
from datadog_api_client.v1.model.dashboard_list import DashboardList
body = DashboardList(
name="Example-Dashboard-List",
)
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = DashboardListsApi(api_client)
response = api_instance.create_dashboard_list(body=body)
print(response)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"
require 'rubygems'
require 'dogapi'
api_key = '<DATADOG_API_KEY>'
app_key = '<DATADOG_APPLICATION_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
name = 'My Dashboard List'
result = dog.create_dashboard_list(name)
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
# Create a dashboard list returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardListsAPI.new
body = DatadogAPIClient::V1::DashboardList.new({
name: "Example-Dashboard-List",
})
p api_instance.create_dashboard_list(body)
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
// Create a dashboard list returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_dashboard_lists::DashboardListsAPI;
use datadog_api_client::datadogV1::model::DashboardList;
#[tokio::main]
async fn main() {
let body = DashboardList::new("Example-Dashboard-List".to_string());
let configuration = datadog::Configuration::new();
let api = DashboardListsAPI::with_config(configuration);
let resp = api.create_dashboard_list(body).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
/**
* Create a dashboard list returns "OK" response
*/
import { client, v1 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v1.DashboardListsApi(configuration);
const params: v1.DashboardListsApiCreateDashboardListRequest = {
body: {
name: "Example-Dashboard-List",
},
};
apiInstance
.createDashboardList(params)
.then((data: v1.DashboardList) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"
GET https://api.ap1.datadoghq.com/api/v1/dashboard/lists/manual/{list_id}https://api.datadoghq.eu/api/v1/dashboard/lists/manual/{list_id}https://api.ddog-gov.com/api/v1/dashboard/lists/manual/{list_id}https://api.datadoghq.com/api/v1/dashboard/lists/manual/{list_id}https://api.us3.datadoghq.com/api/v1/dashboard/lists/manual/{list_id}https://api.us5.datadoghq.com/api/v1/dashboard/lists/manual/{list_id}
Fetch an existing dashboard list’s definition.
This endpoint requires the dashboards_read
permission.
OAuth apps require the dashboards_read
authorization scope to access this endpoint.
이름
유형
설명
list_id [required]
integer
ID of the dashboard list to fetch.
OK
Your Datadog Dashboards.
항목
유형
설명
author
object
Object describing the creator of the shared element.
string
Email of the creator.
handle
string
Handle of the creator.
name
string
Name of the creator.
created
date-time
Date of creation of the dashboard list.
dashboard_count
int64
The number of dashboards in the list.
id
int64
The ID of the dashboard list.
is_favorite
boolean
Whether or not the list is in the favorites.
modified
date-time
Date of last edition of the dashboard list.
name [required]
string
The name of the dashboard list.
type
string
The type of dashboard list.
{
"author": {
"email": "string",
"handle": "string",
"name": "string"
},
"created": "2019-09-19T10:00:00.000Z",
"dashboard_count": "integer",
"id": "integer",
"is_favorite": false,
"modified": "2019-09-19T10:00:00.000Z",
"name": "My Dashboard",
"type": "manual_dashboard_list"
}
Forbidden
Error response object.
{
"errors": [
"Bad Request"
]
}
Not Found
Error response object.
{
"errors": [
"Bad Request"
]
}
Too many requests
Error response object.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export list_id="CHANGE_ME"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/lists/manual/${list_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
"""
Get a dashboard list returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboard_lists_api import DashboardListsApi
# there is a valid "dashboard_list" in the system
DASHBOARD_LIST_ID = environ["DASHBOARD_LIST_ID"]
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = DashboardListsApi(api_client)
response = api_instance.get_dashboard_list(
list_id=int(DASHBOARD_LIST_ID),
)
print(response)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"
# Get a dashboard list returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardListsAPI.new
# there is a valid "dashboard_list" in the system
DASHBOARD_LIST_ID = ENV["DASHBOARD_LIST_ID"]
p api_instance.get_dashboard_list(DASHBOARD_LIST_ID.to_i)
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
require 'rubygems'
require 'dogapi'
api_key = '<DATADOG_API_KEY>'
app_key = '<DATADOG_APPLICATION_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
result = dog.get_dashboard_list(4741)
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
// Get a dashboard list returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"strconv"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV1"
)
func main() {
// there is a valid "dashboard_list" in the system
DashboardListID, _ := strconv.ParseInt(os.Getenv("DASHBOARD_LIST_ID"), 10, 64)
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV1.NewDashboardListsApi(apiClient)
resp, r, err := api.GetDashboardList(ctx, DashboardListID)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DashboardListsApi.GetDashboardList`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `DashboardListsApi.GetDashboardList`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"
// Get a dashboard list returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardListsApi;
import com.datadog.api.client.v1.model.DashboardList;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
DashboardListsApi apiInstance = new DashboardListsApi(defaultClient);
// there is a valid "dashboard_list" in the system
Long DASHBOARD_LIST_ID = Long.parseLong(System.getenv("DASHBOARD_LIST_ID"));
try {
DashboardList result = apiInstance.getDashboardList(DASHBOARD_LIST_ID);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DashboardListsApi#getDashboardList");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"
from datadog import initialize, api
options = {
'api_key': '<DATADOG_API_KEY>',
'app_key': '<DATADOG_APPLICATION_KEY>'
}
initialize(**options)
api.DashboardList.get(4741)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python "example.py"
// Get a dashboard list returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_dashboard_lists::DashboardListsAPI;
#[tokio::main]
async fn main() {
// there is a valid "dashboard_list" in the system
let dashboard_list_id: i64 = std::env::var("DASHBOARD_LIST_ID").unwrap().parse().unwrap();
let configuration = datadog::Configuration::new();
let api = DashboardListsAPI::with_config(configuration);
let resp = api.get_dashboard_list(dashboard_list_id.clone()).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
/**
* Get a dashboard list returns "OK" response
*/
import { client, v1 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v1.DashboardListsApi(configuration);
// there is a valid "dashboard_list" in the system
const DASHBOARD_LIST_ID = parseInt(process.env.DASHBOARD_LIST_ID as string);
const params: v1.DashboardListsApiGetDashboardListRequest = {
listId: DASHBOARD_LIST_ID,
};
apiInstance
.getDashboardList(params)
.then((data: v1.DashboardList) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"
PUT https://api.ap1.datadoghq.com/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboardshttps://api.datadoghq.eu/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboardshttps://api.ddog-gov.com/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboardshttps://api.datadoghq.com/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboardshttps://api.us3.datadoghq.com/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboardshttps://api.us5.datadoghq.com/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards
Update dashboards of an existing dashboard list.
이름
유형
설명
dashboard_list_id [required]
integer
ID of the dashboard list to update items from.
New dashboards of the dashboard list.
항목
유형
설명
dashboards
[object]
List of dashboards to update the dashboard list to.
id [required]
string
ID of the dashboard.
type [required]
enum
The type of the dashboard.
Allowed enum values: custom_timeboard,custom_screenboard,integration_screenboard,integration_timeboard,host_timeboard
{
"dashboards": [
{
"id": "123-abc-456",
"type": "custom_screenboard"
}
]
}
OK
Response containing a list of updated dashboards.
항목
유형
설명
dashboards
[object]
List of dashboards in the dashboard list.
id [required]
string
ID of the dashboard.
type [required]
enum
The type of the dashboard.
Allowed enum values: custom_timeboard,custom_screenboard,integration_screenboard,integration_timeboard,host_timeboard
{
"dashboards": [
{
"id": "q5j-nti-fv6",
"type": "host_timeboard"
}
]
}
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export dashboard_list_id="CHANGE_ME"
# Curl command
curl -X PUT "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/dashboard/lists/manual/${dashboard_list_id}/dashboards" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"dashboards": [
{
"id": "123-abc-456",
"type": "custom_screenboard"
}
]
}
EOF
// Update items of a dashboard list returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"strconv"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
// there is a valid "dashboard_list" in the system
DashboardListID, _ := strconv.ParseInt(os.Getenv("DASHBOARD_LIST_ID"), 10, 64)
// there is a valid "screenboard_dashboard" in the system
ScreenboardDashboardID := os.Getenv("SCREENBOARD_DASHBOARD_ID")
body := datadogV2.DashboardListUpdateItemsRequest{
Dashboards: []datadogV2.DashboardListItemRequest{
{
Id: ScreenboardDashboardID,
Type: datadogV2.DASHBOARDTYPE_CUSTOM_SCREENBOARD,
},
},
}
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewDashboardListsApi(apiClient)
resp, r, err := api.UpdateDashboardListItems(ctx, DashboardListID, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DashboardListsApi.UpdateDashboardListItems`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `DashboardListsApi.UpdateDashboardListItems`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" go run "main.go"
// Update items of a dashboard list returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.DashboardListsApi;
import com.datadog.api.client.v2.model.DashboardListItemRequest;
import com.datadog.api.client.v2.model.DashboardListUpdateItemsRequest;
import com.datadog.api.client.v2.model.DashboardListUpdateItemsResponse;
import com.datadog.api.client.v2.model.DashboardType;
import java.util.Collections;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
DashboardListsApi apiInstance = new DashboardListsApi(defaultClient);
// there is a valid "dashboard_list" in the system
Long DASHBOARD_LIST_ID = Long.parseLong(System.getenv("DASHBOARD_LIST_ID"));
// there is a valid "screenboard_dashboard" in the system
String SCREENBOARD_DASHBOARD_ID = System.getenv("SCREENBOARD_DASHBOARD_ID");
DashboardListUpdateItemsRequest body =
new DashboardListUpdateItemsRequest()
.dashboards(
Collections.singletonList(
new DashboardListItemRequest()
.id(SCREENBOARD_DASHBOARD_ID)
.type(DashboardType.CUSTOM_SCREENBOARD)));
try {
DashboardListUpdateItemsResponse result =
apiInstance.updateDashboardListItems(DASHBOARD_LIST_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DashboardListsApi#updateDashboardListItems");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" java "Example.java"
"""
Update items of a dashboard list returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.dashboard_lists_api import DashboardListsApi
from datadog_api_client.v2.model.dashboard_list_item_request import DashboardListItemRequest
from datadog_api_client.v2.model.dashboard_list_update_items_request import DashboardListUpdateItemsRequest
from datadog_api_client.v2.model.dashboard_type import DashboardType
# there is a valid "dashboard_list" in the system
DASHBOARD_LIST_ID = environ["DASHBOARD_LIST_ID"]
# there is a valid "screenboard_dashboard" in the system
SCREENBOARD_DASHBOARD_ID = environ["SCREENBOARD_DASHBOARD_ID"]
body = DashboardListUpdateItemsRequest(
dashboards=[
DashboardListItemRequest(
id=SCREENBOARD_DASHBOARD_ID,
type=DashboardType.CUSTOM_SCREENBOARD,
),
],
)
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = DashboardListsApi(api_client)
response = api_instance.update_dashboard_list_items(dashboard_list_id=int(DASHBOARD_LIST_ID), body=body)
print(response)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"
# Update items of a dashboard list returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::DashboardListsAPI.new
# there is a valid "dashboard_list" in the system
DASHBOARD_LIST_ID = ENV["DASHBOARD_LIST_ID"]
# there is a valid "screenboard_dashboard" in the system
SCREENBOARD_DASHBOARD_ID = ENV["SCREENBOARD_DASHBOARD_ID"]
body = DatadogAPIClient::V2::DashboardListUpdateItemsRequest.new({
dashboards: [
DatadogAPIClient::V2::DashboardListItemRequest.new({
id: SCREENBOARD_DASHBOARD_ID,
type: DatadogAPIClient::V2::DashboardType::CUSTOM_SCREENBOARD,
}),
],
})
p api_instance.update_dashboard_list_items(DASHBOARD_LIST_ID.to_i, body)
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"
// Update items of a dashboard list returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_dashboard_lists::DashboardListsAPI;
use datadog_api_client::datadogV2::model::DashboardListItemRequest;
use datadog_api_client::datadogV2::model::DashboardListUpdateItemsRequest;
use datadog_api_client::datadogV2::model::DashboardType;
#[tokio::main]
async fn main() {
// there is a valid "dashboard_list" in the system
let dashboard_list_id: i64 = std::env::var("DASHBOARD_LIST_ID").unwrap().parse().unwrap();
// there is a valid "screenboard_dashboard" in the system
let screenboard_dashboard_id = std::env::var("SCREENBOARD_DASHBOARD_ID").unwrap();
let body =
DashboardListUpdateItemsRequest::new().dashboards(vec![DashboardListItemRequest::new(
screenboard_dashboard_id.clone(),
DashboardType::CUSTOM_SCREENBOARD,
)]);
let configuration = datadog::Configuration::new();
let api = DashboardListsAPI::with_config(configuration);
let resp = api
.update_dashboard_list_items(dashboard_list_id.clone(), body)
.await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run
/**
* Update items of a dashboard list returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v2.DashboardListsApi(configuration);
// there is a valid "dashboard_list" in the system
const DASHBOARD_LIST_ID = parseInt(process.env.DASHBOARD_LIST_ID as string);
// there is a valid "screenboard_dashboard" in the system
const SCREENBOARD_DASHBOARD_ID = process.env.SCREENBOARD_DASHBOARD_ID as string;
const params: v2.DashboardListsApiUpdateDashboardListItemsRequest = {
body: {
dashboards: [
{
id: SCREENBOARD_DASHBOARD_ID,
type: "custom_screenboard",
},
],
},
dashboardListId: DASHBOARD_LIST_ID,
};
apiInstance
.updateDashboardListItems(params)
.then((data: v2.DashboardListUpdateItemsResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"
DELETE https://api.ap1.datadoghq.com/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboardshttps://api.datadoghq.eu/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboardshttps://api.ddog-gov.com/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboardshttps://api.datadoghq.com/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboardshttps://api.us3.datadoghq.com/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboardshttps://api.us5.datadoghq.com/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards
Delete dashboards from an existing dashboard list.
이름
유형
설명
dashboard_list_id [required]
integer
ID of the dashboard list to delete items from.
Dashboards to delete from the dashboard list.
항목
유형
설명
dashboards
[object]
List of dashboards to delete from the dashboard list.
id [required]
string
ID of the dashboard.
type [required]
enum
The type of the dashboard.
Allowed enum values: custom_timeboard,custom_screenboard,integration_screenboard,integration_timeboard,host_timeboard
{
"dashboards": [
{
"id": "123-abc-456",
"type": "custom_screenboard"
}
]
}
{
"dashboards": [
{
"id": "123-abc-456",
"type": "custom_timeboard"
}
]
}
OK
Response containing a list of deleted dashboards.
항목
유형
설명
deleted_dashboards_from_list
[object]
List of dashboards deleted from the dashboard list.
id [required]
string
ID of the dashboard.
type [required]
enum
The type of the dashboard.
Allowed enum values: custom_timeboard,custom_screenboard,integration_screenboard,integration_timeboard,host_timeboard
{
"deleted_dashboards_from_list": [
{
"id": "q5j-nti-fv6",
"type": "host_timeboard"
}
]
}
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export dashboard_list_id="CHANGE_ME"
# Curl command
curl -X DELETE "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/dashboard/lists/manual/${dashboard_list_id}/dashboards" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"dashboards": [
{
"id": "123-abc-456",
"type": "custom_screenboard"
}
]
}
EOF
# Path parameters
export dashboard_list_id="CHANGE_ME"
# Curl command
curl -X DELETE "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/dashboard/lists/manual/${dashboard_list_id}/dashboards" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"dashboards": [
{
"id": "123-abc-456",
"type": "custom_timeboard"
}
]
}
EOF
// Delete custom screenboard dashboard from an existing dashboard list returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"strconv"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
// there is a valid "dashboard_list" in the system
DashboardListID, _ := strconv.ParseInt(os.Getenv("DASHBOARD_LIST_ID"), 10, 64)
// there is a valid "screenboard_dashboard" in the system
ScreenboardDashboardID := os.Getenv("SCREENBOARD_DASHBOARD_ID")
body := datadogV2.DashboardListDeleteItemsRequest{
Dashboards: []datadogV2.DashboardListItemRequest{
{
Id: ScreenboardDashboardID,
Type: datadogV2.DASHBOARDTYPE_CUSTOM_SCREENBOARD,
},
},
}
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewDashboardListsApi(apiClient)
resp, r, err := api.DeleteDashboardListItems(ctx, DashboardListID, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DashboardListsApi.DeleteDashboardListItems`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `DashboardListsApi.DeleteDashboardListItems`:\n%s\n", responseContent)
}
// Delete custom timeboard dashboard from an existing dashboard list returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"strconv"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
// there is a valid "dashboard_list" in the system
DashboardListID, _ := strconv.ParseInt(os.Getenv("DASHBOARD_LIST_ID"), 10, 64)
// there is a valid "dashboard" in the system
DashboardID := os.Getenv("DASHBOARD_ID")
body := datadogV2.DashboardListDeleteItemsRequest{
Dashboards: []datadogV2.DashboardListItemRequest{
{
Id: DashboardID,
Type: datadogV2.DASHBOARDTYPE_CUSTOM_TIMEBOARD,
},
},
}
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewDashboardListsApi(apiClient)
resp, r, err := api.DeleteDashboardListItems(ctx, DashboardListID, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DashboardListsApi.DeleteDashboardListItems`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `DashboardListsApi.DeleteDashboardListItems`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" go run "main.go"
// Delete custom screenboard dashboard from an existing dashboard list returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.DashboardListsApi;
import com.datadog.api.client.v2.model.DashboardListDeleteItemsRequest;
import com.datadog.api.client.v2.model.DashboardListDeleteItemsResponse;
import com.datadog.api.client.v2.model.DashboardListItemRequest;
import com.datadog.api.client.v2.model.DashboardType;
import java.util.Collections;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
DashboardListsApi apiInstance = new DashboardListsApi(defaultClient);
// there is a valid "dashboard_list" in the system
Long DASHBOARD_LIST_ID = Long.parseLong(System.getenv("DASHBOARD_LIST_ID"));
// there is a valid "screenboard_dashboard" in the system
String SCREENBOARD_DASHBOARD_ID = System.getenv("SCREENBOARD_DASHBOARD_ID");
DashboardListDeleteItemsRequest body =
new DashboardListDeleteItemsRequest()
.dashboards(
Collections.singletonList(
new DashboardListItemRequest()
.id(SCREENBOARD_DASHBOARD_ID)
.type(DashboardType.CUSTOM_SCREENBOARD)));
try {
DashboardListDeleteItemsResponse result =
apiInstance.deleteDashboardListItems(DASHBOARD_LIST_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DashboardListsApi#deleteDashboardListItems");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
// Delete custom timeboard dashboard from an existing dashboard list returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.DashboardListsApi;
import com.datadog.api.client.v2.model.DashboardListDeleteItemsRequest;
import com.datadog.api.client.v2.model.DashboardListDeleteItemsResponse;
import com.datadog.api.client.v2.model.DashboardListItemRequest;
import com.datadog.api.client.v2.model.DashboardType;
import java.util.Collections;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
DashboardListsApi apiInstance = new DashboardListsApi(defaultClient);
// there is a valid "dashboard_list" in the system
Long DASHBOARD_LIST_ID = Long.parseLong(System.getenv("DASHBOARD_LIST_ID"));
// there is a valid "dashboard" in the system
String DASHBOARD_ID = System.getenv("DASHBOARD_ID");
DashboardListDeleteItemsRequest body =
new DashboardListDeleteItemsRequest()
.dashboards(
Collections.singletonList(
new DashboardListItemRequest()
.id(DASHBOARD_ID)
.type(DashboardType.CUSTOM_TIMEBOARD)));
try {
DashboardListDeleteItemsResponse result =
apiInstance.deleteDashboardListItems(DASHBOARD_LIST_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DashboardListsApi#deleteDashboardListItems");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" java "Example.java"
"""
Delete custom screenboard dashboard from an existing dashboard list returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.dashboard_lists_api import DashboardListsApi
from datadog_api_client.v2.model.dashboard_list_delete_items_request import DashboardListDeleteItemsRequest
from datadog_api_client.v2.model.dashboard_list_item_request import DashboardListItemRequest
from datadog_api_client.v2.model.dashboard_type import DashboardType
# there is a valid "dashboard_list" in the system
DASHBOARD_LIST_ID = environ["DASHBOARD_LIST_ID"]
# there is a valid "screenboard_dashboard" in the system
SCREENBOARD_DASHBOARD_ID = environ["SCREENBOARD_DASHBOARD_ID"]
body = DashboardListDeleteItemsRequest(
dashboards=[
DashboardListItemRequest(
id=SCREENBOARD_DASHBOARD_ID,
type=DashboardType.CUSTOM_SCREENBOARD,
),
],
)
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = DashboardListsApi(api_client)
response = api_instance.delete_dashboard_list_items(dashboard_list_id=int(DASHBOARD_LIST_ID), body=body)
print(response)
"""
Delete custom timeboard dashboard from an existing dashboard list returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.dashboard_lists_api import DashboardListsApi
from datadog_api_client.v2.model.dashboard_list_delete_items_request import DashboardListDeleteItemsRequest
from datadog_api_client.v2.model.dashboard_list_item_request import DashboardListItemRequest
from datadog_api_client.v2.model.dashboard_type import DashboardType
# there is a valid "dashboard_list" in the system
DASHBOARD_LIST_ID = environ["DASHBOARD_LIST_ID"]
# there is a valid "dashboard" in the system
DASHBOARD_ID = environ["DASHBOARD_ID"]
body = DashboardListDeleteItemsRequest(
dashboards=[
DashboardListItemRequest(
id=DASHBOARD_ID,
type=DashboardType.CUSTOM_TIMEBOARD,
),
],
)
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = DashboardListsApi(api_client)
response = api_instance.delete_dashboard_list_items(dashboard_list_id=int(DASHBOARD_LIST_ID), body=body)
print(response)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"
# Delete custom screenboard dashboard from an existing dashboard list returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::DashboardListsAPI.new
# there is a valid "dashboard_list" in the system
DASHBOARD_LIST_ID = ENV["DASHBOARD_LIST_ID"]
# there is a valid "screenboard_dashboard" in the system
SCREENBOARD_DASHBOARD_ID = ENV["SCREENBOARD_DASHBOARD_ID"]
body = DatadogAPIClient::V2::DashboardListDeleteItemsRequest.new({
dashboards: [
DatadogAPIClient::V2::DashboardListItemRequest.new({
id: SCREENBOARD_DASHBOARD_ID,
type: DatadogAPIClient::V2::DashboardType::CUSTOM_SCREENBOARD,
}),
],
})
p api_instance.delete_dashboard_list_items(DASHBOARD_LIST_ID.to_i, body)
# Delete custom timeboard dashboard from an existing dashboard list returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::DashboardListsAPI.new
# there is a valid "dashboard_list" in the system
DASHBOARD_LIST_ID = ENV["DASHBOARD_LIST_ID"]
# there is a valid "dashboard" in the system
DASHBOARD_ID = ENV["DASHBOARD_ID"]
body = DatadogAPIClient::V2::DashboardListDeleteItemsRequest.new({
dashboards: [
DatadogAPIClient::V2::DashboardListItemRequest.new({
id: DASHBOARD_ID,
type: DatadogAPIClient::V2::DashboardType::CUSTOM_TIMEBOARD,
}),
],
})
p api_instance.delete_dashboard_list_items(DASHBOARD_LIST_ID.to_i, body)
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"
// Delete custom screenboard dashboard from an existing dashboard list returns
// "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_dashboard_lists::DashboardListsAPI;
use datadog_api_client::datadogV2::model::DashboardListDeleteItemsRequest;
use datadog_api_client::datadogV2::model::DashboardListItemRequest;
use datadog_api_client::datadogV2::model::DashboardType;
#[tokio::main]
async fn main() {
// there is a valid "dashboard_list" in the system
let dashboard_list_id: i64 = std::env::var("DASHBOARD_LIST_ID").unwrap().parse().unwrap();
// there is a valid "screenboard_dashboard" in the system
let screenboard_dashboard_id = std::env::var("SCREENBOARD_DASHBOARD_ID").unwrap();
let body =
DashboardListDeleteItemsRequest::new().dashboards(vec![DashboardListItemRequest::new(
screenboard_dashboard_id.clone(),
DashboardType::CUSTOM_SCREENBOARD,
)]);
let configuration = datadog::Configuration::new();
let api = DashboardListsAPI::with_config(configuration);
let resp = api
.delete_dashboard_list_items(dashboard_list_id.clone(), body)
.await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
// Delete custom timeboard dashboard from an existing dashboard list returns "OK"
// response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_dashboard_lists::DashboardListsAPI;
use datadog_api_client::datadogV2::model::DashboardListDeleteItemsRequest;
use datadog_api_client::datadogV2::model::DashboardListItemRequest;
use datadog_api_client::datadogV2::model::DashboardType;
#[tokio::main]
async fn main() {
// there is a valid "dashboard_list" in the system
let dashboard_list_id: i64 = std::env::var("DASHBOARD_LIST_ID").unwrap().parse().unwrap();
// there is a valid "dashboard" in the system
let dashboard_id = std::env::var("DASHBOARD_ID").unwrap();
let body =
DashboardListDeleteItemsRequest::new().dashboards(vec![DashboardListItemRequest::new(
dashboard_id.clone(),
DashboardType::CUSTOM_TIMEBOARD,
)]);
let configuration = datadog::Configuration::new();
let api = DashboardListsAPI::with_config(configuration);
let resp = api
.delete_dashboard_list_items(dashboard_list_id.clone(), body)
.await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run
/**
* Delete custom screenboard dashboard from an existing dashboard list returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v2.DashboardListsApi(configuration);
// there is a valid "dashboard_list" in the system
const DASHBOARD_LIST_ID = parseInt(process.env.DASHBOARD_LIST_ID as string);
// there is a valid "screenboard_dashboard" in the system
const SCREENBOARD_DASHBOARD_ID = process.env.SCREENBOARD_DASHBOARD_ID as string;
const params: v2.DashboardListsApiDeleteDashboardListItemsRequest = {
body: {
dashboards: [
{
id: SCREENBOARD_DASHBOARD_ID,
type: "custom_screenboard",
},
],
},
dashboardListId: DASHBOARD_LIST_ID,
};
apiInstance
.deleteDashboardListItems(params)
.then((data: v2.DashboardListDeleteItemsResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
/**
* Delete custom timeboard dashboard from an existing dashboard list returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v2.DashboardListsApi(configuration);
// there is a valid "dashboard_list" in the system
const DASHBOARD_LIST_ID = parseInt(process.env.DASHBOARD_LIST_ID as string);
// there is a valid "dashboard" in the system
const DASHBOARD_ID = process.env.DASHBOARD_ID as string;
const params: v2.DashboardListsApiDeleteDashboardListItemsRequest = {
body: {
dashboards: [
{
id: DASHBOARD_ID,
type: "custom_timeboard",
},
],
},
dashboardListId: DASHBOARD_LIST_ID,
};
apiInstance
.deleteDashboardListItems(params)
.then((data: v2.DashboardListDeleteItemsResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"
PUT https://api.ap1.datadoghq.com/api/v1/dashboard/lists/manual/{list_id}https://api.datadoghq.eu/api/v1/dashboard/lists/manual/{list_id}https://api.ddog-gov.com/api/v1/dashboard/lists/manual/{list_id}https://api.datadoghq.com/api/v1/dashboard/lists/manual/{list_id}https://api.us3.datadoghq.com/api/v1/dashboard/lists/manual/{list_id}https://api.us5.datadoghq.com/api/v1/dashboard/lists/manual/{list_id}
Update the name of a dashboard list.
This endpoint requires the dashboards_write
permission.
OAuth apps require the dashboards_write
authorization scope to access this endpoint.
이름
유형
설명
list_id [required]
integer
ID of the dashboard list to update.
Update a dashboard list request body.
항목
유형
설명
author
object
Object describing the creator of the shared element.
string
Email of the creator.
handle
string
Handle of the creator.
name
string
Name of the creator.
created
date-time
Date of creation of the dashboard list.
dashboard_count
int64
The number of dashboards in the list.
id
int64
The ID of the dashboard list.
is_favorite
boolean
Whether or not the list is in the favorites.
modified
date-time
Date of last edition of the dashboard list.
name [required]
string
The name of the dashboard list.
type
string
The type of dashboard list.
{
"name": "updated Example-Dashboard-List"
}
OK
Your Datadog Dashboards.
항목
유형
설명
author
object
Object describing the creator of the shared element.
string
Email of the creator.
handle
string
Handle of the creator.
name
string
Name of the creator.
created
date-time
Date of creation of the dashboard list.
dashboard_count
int64
The number of dashboards in the list.
id
int64
The ID of the dashboard list.
is_favorite
boolean
Whether or not the list is in the favorites.
modified
date-time
Date of last edition of the dashboard list.
name [required]
string
The name of the dashboard list.
type
string
The type of dashboard list.
{
"author": {
"email": "string",
"handle": "string",
"name": "string"
},
"created": "2019-09-19T10:00:00.000Z",
"dashboard_count": "integer",
"id": "integer",
"is_favorite": false,
"modified": "2019-09-19T10:00:00.000Z",
"name": "My Dashboard",
"type": "manual_dashboard_list"
}
Bad Request
Error response object.
{
"errors": [
"Bad Request"
]
}
Forbidden
Error response object.
{
"errors": [
"Bad Request"
]
}
Not Found
Error response object.
{
"errors": [
"Bad Request"
]
}
Too many requests
Error response object.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export list_id="CHANGE_ME"
# Curl command
curl -X PUT "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/lists/manual/${list_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"name": "updated Example-Dashboard-List"
}
EOF
// Update a dashboard list returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"strconv"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV1"
)
func main() {
// there is a valid "dashboard_list" in the system
DashboardListID, _ := strconv.ParseInt(os.Getenv("DASHBOARD_LIST_ID"), 10, 64)
body := datadogV1.DashboardList{
Name: "updated Example-Dashboard-List",
}
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV1.NewDashboardListsApi(apiClient)
resp, r, err := api.UpdateDashboardList(ctx, DashboardListID, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DashboardListsApi.UpdateDashboardList`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `DashboardListsApi.UpdateDashboardList`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"
// Update a dashboard list returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardListsApi;
import com.datadog.api.client.v1.model.DashboardList;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
DashboardListsApi apiInstance = new DashboardListsApi(defaultClient);
// there is a valid "dashboard_list" in the system
Long DASHBOARD_LIST_ID = Long.parseLong(System.getenv("DASHBOARD_LIST_ID"));
DashboardList body = new DashboardList().name("updated Example-Dashboard-List");
try {
DashboardList result = apiInstance.updateDashboardList(DASHBOARD_LIST_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DashboardListsApi#updateDashboardList");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"
"""
Update a dashboard list returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboard_lists_api import DashboardListsApi
from datadog_api_client.v1.model.dashboard_list import DashboardList
# there is a valid "dashboard_list" in the system
DASHBOARD_LIST_ID = environ["DASHBOARD_LIST_ID"]
body = DashboardList(
name="updated Example-Dashboard-List",
)
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = DashboardListsApi(api_client)
response = api_instance.update_dashboard_list(list_id=int(DASHBOARD_LIST_ID), body=body)
print(response)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"
# Update a dashboard list returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardListsAPI.new
# there is a valid "dashboard_list" in the system
DASHBOARD_LIST_ID = ENV["DASHBOARD_LIST_ID"]
body = DatadogAPIClient::V1::DashboardList.new({
name: "updated Example-Dashboard-List",
})
p api_instance.update_dashboard_list(DASHBOARD_LIST_ID.to_i, body)
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
// Update a dashboard list returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_dashboard_lists::DashboardListsAPI;
use datadog_api_client::datadogV1::model::DashboardList;
#[tokio::main]
async fn main() {
// there is a valid "dashboard_list" in the system
let dashboard_list_id: i64 = std::env::var("DASHBOARD_LIST_ID").unwrap().parse().unwrap();
let body = DashboardList::new("updated Example-Dashboard-List".to_string());
let configuration = datadog::Configuration::new();
let api = DashboardListsAPI::with_config(configuration);
let resp = api
.update_dashboard_list(dashboard_list_id.clone(), body)
.await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.com