Interagissez avec vos listes de dashboards via l’API pour faciliter l’organisation, la recherche et le partage de tous vos dashboards avec votre équipe et votre organisation.
POST https://api.datadoghq.eu/api/v1/dashboardhttps://api.datadoghq.com/api/v1/dashboard
Créez un dashboard à l’aide des options spécifiées.
Corps de requête pour la création d’un dashboard.
Champ
Type
Description
author_handle
string
Identifier of the dashboard author.
created_at
date-time
Creation date of the dashboard.
description
string
Description of the dashboard.
id
string
ID of the dashboard.
is_read_only
boolean
Whether this dashboard is read-only. If True, only the author and admins can make changes to it.
layout_type [required]
enum
Layout type of the dashboard.
Allowed enum values: ordered,free
modified_at
date-time
Modification date of the dashboard.
notify_list
[string]
List of handles of users to notify when changes are made to this dashboard.
template_variable_presets
[object]
Array of template variables saved views.
name
string
The name of the variable.
template_variables
[object]
List of variables.
name
string
The name of the variable.
value
string
The value of the template variable within the saved view.
template_variables
[object]
List of template variables for this dashboard.
default
string
The default value for the template variable on dashboard load.
name [required]
string
The name of the variable.
prefix
string
The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.
title [required]
string
Title of the dashboard.
url
string
The URL of the dashboard.
widgets [required]
[object]
List of widgets to display on the dashboard.
id
int64
ID of the widget.
layout
object
The layout for a widget on a free dashboard.
height [required]
int64
The height of the widget. Should be a non-negative integer.
width [required]
int64
The width of the widget. Should be a non-negative integer.
x [required]
int64
The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y [required]
int64
The position of the widget on the y (vertical) axis. Should be a non-negative integer.
{
"description": "string",
"is_read_only": false,
"layout_type": "string",
"notify_list": [],
"template_variable_presets": [
{
"name": "string",
"template_variables": [
{
"name": "string",
"value": "string"
}
]
}
],
"template_variables": [
{
"default": "my-host",
"name": "host1",
"prefix": "host"
}
],
"title": "",
"widgets": [
{
"definition": "[object Object]",
"id": "integer",
"layout": {
"height": 0,
"width": 0,
"x": 0,
"y": 0
}
}
]
}OK
A dashboard is Datadog’s tool for visually tracking, analyzing, and displaying key performance metrics, which enable you to monitor the health of your infrastructure.
Champ
Type
Description
author_handle
string
Identifier of the dashboard author.
created_at
date-time
Creation date of the dashboard.
description
string
Description of the dashboard.
id
string
ID of the dashboard.
is_read_only
boolean
Whether this dashboard is read-only. If True, only the author and admins can make changes to it.
layout_type [required]
enum
Layout type of the dashboard.
Allowed enum values: ordered,free
modified_at
date-time
Modification date of the dashboard.
notify_list
[string]
List of handles of users to notify when changes are made to this dashboard.
template_variable_presets
[object]
Array of template variables saved views.
name
string
The name of the variable.
template_variables
[object]
List of variables.
name
string
The name of the variable.
value
string
The value of the template variable within the saved view.
template_variables
[object]
List of template variables for this dashboard.
default
string
The default value for the template variable on dashboard load.
name [required]
string
The name of the variable.
prefix
string
The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.
title [required]
string
Title of the dashboard.
url
string
The URL of the dashboard.
widgets [required]
[object]
List of widgets to display on the dashboard.
id
int64
ID of the widget.
layout
object
The layout for a widget on a free dashboard.
height [required]
int64
The height of the widget. Should be a non-negative integer.
width [required]
int64
The width of the widget. Should be a non-negative integer.
x [required]
int64
The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y [required]
int64
The position of the widget on the y (vertical) axis. Should be a non-negative integer.
{
"author_handle": "test@datadoghq.com",
"created_at": "2019-09-19T10:00:00.000Z",
"description": "string",
"id": "123-abc-456",
"is_read_only": false,
"layout_type": "string",
"modified_at": "2019-09-19T10:00:00.000Z",
"notify_list": [],
"template_variable_presets": [
{
"name": "string",
"template_variables": [
{
"name": "string",
"value": "string"
}
]
}
],
"template_variables": [
{
"default": "my-host",
"name": "host1",
"prefix": "host"
}
],
"title": "",
"url": "/dashboard/123-abc-456/example-dashboard-title",
"widgets": [
{
"definition": "[object Object]",
"id": "integer",
"layout": {
"height": 0,
"width": 0,
"x": 0,
"y": 0
}
}
]
}Bad Request
Error response object.
{
"errors": [
"Bad Request"
]
}Authentication Error
Error response object.
{
"errors": [
"Bad Request"
]
}
# Curl command
curl -X POST "https://api.datadoghq.eu"https://api.datadoghq.com/api/v1/dashboard" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_CLIENT_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_CLIENT_APP_KEY}" \
-d @- << EOF
{
"layout_type": null,
"template_variables": [
{
"name": "host1"
}
],
"title": "",
"widgets": [
{
"definition": "[object Object]",
"layout": {
"height": 0,
"width": 0,
"x": 0,
"y": 0
}
}
]
}
EOF
package main
import (
"context"
"encoding/json"
"fmt"
"os"
datadog "github.com/DataDog/datadog-api-client-go/api/v1/datadog"
)
func main() {
ctx := context.WithValue(
context.Background(),
datadog.ContextAPIKeys,
map[string]datadog.APIKey{
"apiKeyAuth": {
Key: os.Getenv("DD_CLIENT_API_KEY"),
},
"appKeyAuth": {
Key: os.Getenv("DD_CLIENT_APP_KEY"),
},
},
)
body := *datadog.NewDashboard(datadog.DashboardLayoutType("ordered"), "Title_example", []datadog.Widget{*datadog.NewWidget(datadog.WidgetDefinition{AlertGraphWidgetDefinition: datadog.NewAlertGraphWidgetDefinition("AlertId_example", datadog.AlertGraphWidgetDefinitionType("alert_graph"), datadog.WidgetVizType("timeseries"))})}) // Dashboard | Create a dashboard request body.
configuration := datadog.NewConfiguration()
api_client := datadog.NewAPIClient(configuration)
resp, r, err := api_client.DashboardsApi.CreateDashboard(ctx).Body(body).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.CreateDashboard``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateDashboard`: Dashboard
response_content, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from DashboardsApi.CreateDashboard:\n%s\n", response_content)
}
// Import classes:
import java.util.*;
import com.datadog.api.v1.client.ApiClient;
import com.datadog.api.v1.client.ApiException;
import com.datadog.api.v1.client.Configuration;
import com.datadog.api.v1.client.auth.*;
import com.datadog.api.v1.client.model.*;
import com.datadog.api.v1.client.api.DashboardsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure the Datadog site to send API calls to
HashMap<String, String> serverVariables = new HashMap<String, String>();
String site = System.getenv("DD_SITE");
if (site != null) {
serverVariables.put("site", site);
defaultClient.setServerVariables(serverVariables);
}
// Configure API key authorization:
HashMap<String, String> secrets = new HashMap<String, String>();
secrets.put("apiKeyAuth", System.getenv("DD_CLIENT_API_KEY"));
secrets.put("appKeyAuth", System.getenv("DD_CLIENT_APP_KEY"));
defaultClient.configureApiKeys(secrets);
DashboardsApi apiInstance = new DashboardsApi(defaultClient);
Dashboard body = new Dashboard(); // Dashboard | Create a dashboard request body.
try {
Dashboard result = apiInstance.createDashboard()
.body(body)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DashboardsApi#createDashboard");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
from datadog import initialize, api
options = {
'api_key': '<DATADOG_API_KEY>',
'app_key': '<DATADOG_APPLICATION_KEY>'
}
initialize(**options)
title = 'Average Memory Free Shell'
widgets = [{
'definition': {
'type': 'timeseries',
'requests': [
{'q': 'avg:system.mem.free{*}'}
],
'title': 'Average Memory Free'
}
}]
layout_type = 'ordered'
description = 'A dashboard with memory info.'
is_read_only = True
notify_list = ['user@domain.com']
template_variables = [{
'name': 'host1',
'prefix': 'host',
'default': 'my-host'
}]
saved_views = [{
'name': 'Saved views for hostname 2',
'template_variables': [{'name': 'host', 'value': '<HOSTNAME_2>'}]}
]
api.Dashboard.create(title=title,
widgets=widgets,
layout_type=layout_type,
description=description,
is_read_only=is_read_only,
notify_list=notify_list,
template_variables=template_variables,
template_variable_presets=saved_view)
import os
from dateutil.parser import parse as dateutil_parser
import datadog_api_client.v1
from datadog_api_client.v1.api import dashboards_api
from datadog_api_client.v1.models import *
from pprint import pprint
# Defining the host is optional and defaults to https://api.datadoghq.com
# See configuration.py for a list of all supported configuration parameters.
configuration = datadog_api_client.v1.Configuration(
host = "https://api.datadoghq.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: apiKeyAuth
configuration.api_key['apiKeyAuth'] = os.getenv('DD_CLIENT_API_KEY')
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKeyAuth'] = 'Bearer'
# Configure API key authorization: appKeyAuth
configuration.api_key['appKeyAuth'] = os.getenv('DD_CLIENT_APP_KEY')
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['appKeyAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with datadog_api_client.v1.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = dashboards_api.DashboardsApi(api_client)
body = Dashboard(
author_handle="test@datadoghq.com",
created_at=dateutil_parser('1970-01-01T00:00:00.00Z'),
description="description_example",
id="123-abc-456",
is_read_only=False,
layout_type=DashboardLayoutType("ordered"),
modified_at=dateutil_parser('1970-01-01T00:00:00.00Z'),
notify_list=[
"notify_list_example",
],
template_variable_presets=[
DashboardTemplateVariablePreset(
name="name_example",
template_variables=[
DashboardTemplateVariablePresetValue(
name="name_example",
value="value_example",
),
],
),
],
template_variables=[
DashboardTemplateVariables(
default="my-host",
name="host1",
prefix="host",
),
],
title="",
url="/dashboard/123-abc-456/example-dashboard-title",
widgets=[{"definition":{"requests":{"fill":{"q":"system.cpu.user"}},"type":"hostmap"}}],
) # Dashboard | Create a dashboard request body.
# example passing only required values which don't have defaults set
try:
# Create a new dashboard
api_response = api_instance.create_dashboard(body)
pprint(api_response)
except datadog_api_client.v1.ApiException as e:
print("Exception when calling DashboardsApi->create_dashboard: %s\n" % e)
require 'rubygems'
require 'dogapi'
api_key = '<DATADOG_API_KEY>'
app_key = '<DATADOG_APPLICATION_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Create a dashboard.
title = 'Average Memory Free Shell'
widgets = [{
'definition': {
'type' => 'timeseries',
'requests' => [
{'q' => 'avg:system.mem.free{*}'}
],
'title' => 'Average Memory Free'
}
}]
layout_type = 'ordered'
description = 'A dashboard with memory info.'
is_read_only = true
notify_list = ['user@domain.com']
template_variables = [{
'name' => 'host',
'prefix' => 'host',
'default' => '<HOSTNAME_1>'
}]
saved_view = [{
'name': 'Saved views for hostname 2',
'template_variables': [{'name': 'host', 'value': '<HOSTNAME_2>'}]}
]
dog.create_board(title, widgets, layout_type, {
:description => description,
:is_read_only => is_read_only,
:notify_list => notify_list,
:template_variables => template_variables,
:template_variable_presets => saved_view
})
require 'time'
require 'datadog_api_client/v1'
# setup authorization
DatadogAPIClient::V1.configure do |config|
# Configure API key authorization: apiKeyAuth
config.api_key['apiKeyAuth'] = ENV["DD_CLIENT_API_KEY"]
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['apiKeyAuth'] = 'Bearer'
# Configure API key authorization: appKeyAuth
config.api_key['appKeyAuth'] = ENV["DD_CLIENT_APP_KEY"]
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['appKeyAuth'] = 'Bearer'
end
api_instance = DatadogAPIClient::V1::DashboardsApi.new
body = DatadogAPIClient::V1::Dashboard.new({layout_type: DatadogAPIClient::V1::DashboardLayoutType::ORDERED, title: 'title_example', widgets: [DatadogAPIClient::V1::Widget.new({definition: DatadogAPIClient::V1::AlertGraphWidgetDefinition.new({alert_id: 'alert_id_example', type: DatadogAPIClient::V1::AlertGraphWidgetDefinitionType::ALERT_GRAPH, viz_type: DatadogAPIClient::V1::WidgetVizType::TIMESERIES})})]}) # Dashboard | Create a dashboard request body.
begin
# Create a new dashboard
result = api_instance.create_dashboard(body)
p result
rescue DatadogAPIClient::V1::ApiError => e
puts "Error when calling DashboardsApi->create_dashboard: #{e}"
end
POST https://api.datadoghq.eu/api/v1/dashboard/publichttps://api.datadoghq.com/api/v1/dashboard/public
Share a specified private dashboard, generating a URL at which it can be publicly viewed.
Create a shared dashboard request body.
Champ
Type
Description
author
object
User who shared the dashboard.
handle
string
Identifier of the user who shared the dashboard.
name
string
Name of the user who shared the dashboard.
created_at
date-time
Date the dashboard was shared.
dashboard_id [required]
string
ID of the dashboard to share.
dashboard_type [required]
enum
The type of the associated private dashboard.
Allowed enum values: custom_timeboard,custom_screenboard
global_time
enum
Dashboard global time live_span selection
Allowed enum values: 15m,1h,4h,1d,2d,1w,1mo,3mo
global_time_selectable_enabled
boolean
Whether to allow viewers to select a different global time setting for the shared dashboard.
public_url
string
URL of the shared dashboard.
selectable_template_vars
[object]
List of objects representing template variables on the shared dashboard which can have selectable values.
default_value
string
The default value of the template variable.
name
string
Name of the template variable.
prefix
string
The tag/attribute key associated with the template variable.
visible_tags
[string]
List of visible tag values on the shared dashboard.
share_list
[string]
List of email addresses that can receive an invitation to access to the shared dashboard.
share_type
enum
Type of sharing access (either open to anyone who has the public URL or invite-only).
Allowed enum values: open,invite
token
string
A unique token assigned to the shared dashboard.
{
"dashboard_id": "123-abc-456",
"dashboard_type": "custom_timeboard",
"global_time": "1h",
"global_time_selectable_enabled": false,
"selectable_template_vars": [
{
"default_value": "*",
"name": "exampleVar",
"prefix": "test",
"visible_tags": "selectableValue1,selectableValue2"
}
],
"share_list": [
"test@datadoghq.com",
"test2@email.com"
],
"share_type": "string"
}OK
The metadata object associated with how a dashboard has been/will be shared.
Champ
Type
Description
author
object
User who shared the dashboard.
handle
string
Identifier of the user who shared the dashboard.
name
string
Name of the user who shared the dashboard.
created_at
date-time
Date the dashboard was shared.
dashboard_id [required]
string
ID of the dashboard to share.
dashboard_type [required]
enum
The type of the associated private dashboard.
Allowed enum values: custom_timeboard,custom_screenboard
global_time
enum
Dashboard global time live_span selection
Allowed enum values: 15m,1h,4h,1d,2d,1w,1mo,3mo
global_time_selectable_enabled
boolean
Whether to allow viewers to select a different global time setting for the shared dashboard.
public_url
string
URL of the shared dashboard.
selectable_template_vars
[object]
List of objects representing template variables on the shared dashboard which can have selectable values.
default_value
string
The default value of the template variable.
name
string
Name of the template variable.
prefix
string
The tag/attribute key associated with the template variable.
visible_tags
[string]
List of visible tag values on the shared dashboard.
share_list
[string]
List of email addresses that can receive an invitation to access to the shared dashboard.
share_type
enum
Type of sharing access (either open to anyone who has the public URL or invite-only).
Allowed enum values: open,invite
token
string
A unique token assigned to the shared dashboard.
{
"author": {
"handle": "test@datadoghq.com",
"name": "string"
},
"created_at": "2019-09-19T10:00:00.000Z",
"dashboard_id": "123-abc-456",
"dashboard_type": "custom_timeboard",
"global_time": "1h",
"global_time_selectable_enabled": false,
"public_url": "string",
"selectable_template_vars": [
{
"default_value": "*",
"name": "exampleVar",
"prefix": "test",
"visible_tags": "selectableValue1,selectableValue2"
}
],
"share_list": [
"test@datadoghq.com",
"test2@email.com"
],
"share_type": "string",
"token": "string"
}Bad Request
Error response object.
{
"errors": [
"Bad Request"
]
}Forbidden
Error response object.
{
"errors": [
"Bad Request"
]
}Dashboard Not Found
Error response object.
{
"errors": [
"Bad Request"
]
}
## json-request-body
#
# Curl command
curl -X POST "https://api.datadoghq.eu"https://api.datadoghq.com/api/v1/dashboard/public" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_CLIENT_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_CLIENT_APP_KEY}" \
-d @- << EOF
{
"dashboard_id": "123-abc-456",
"dashboard_type": "custom_timeboard",
"share_type": "open"
}
EOF
DELETE https://api.datadoghq.eu/api/v1/dashboard/{dashboard_id}https://api.datadoghq.com/api/v1/dashboard/{dashboard_id}
Supprimez un dashboard à l’aide de l’ID spécifié.
Nom
Type
Description
dashboard_id [required]
string
The ID of the dashboard.
OK
Response from the delete dashboard call.
{
"deleted_dashboard_id": "string"
}Authentication Error
Error response object.
{
"errors": [
"Bad Request"
]
}Dashboards Not Found
Error response object.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export dashboard_id="CHANGE_ME"
# Curl command
curl -X DELETE "https://api.datadoghq.eu"https://api.datadoghq.com/api/v1/dashboard/${dashboard_id}" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_CLIENT_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_CLIENT_APP_KEY}"
package main
import (
"context"
"encoding/json"
"fmt"
"os"
datadog "github.com/DataDog/datadog-api-client-go/api/v1/datadog"
)
func main() {
ctx := context.WithValue(
context.Background(),
datadog.ContextAPIKeys,
map[string]datadog.APIKey{
"apiKeyAuth": {
Key: os.Getenv("DD_CLIENT_API_KEY"),
},
"appKeyAuth": {
Key: os.Getenv("DD_CLIENT_APP_KEY"),
},
},
)
dashboardId := "dashboardId_example" // string | The ID of the dashboard.
configuration := datadog.NewConfiguration()
api_client := datadog.NewAPIClient(configuration)
resp, r, err := api_client.DashboardsApi.DeleteDashboard(ctx, dashboardId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.DeleteDashboard``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DeleteDashboard`: DashboardDeleteResponse
response_content, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from DashboardsApi.DeleteDashboard:\n%s\n", response_content)
}
// Import classes:
import java.util.*;
import com.datadog.api.v1.client.ApiClient;
import com.datadog.api.v1.client.ApiException;
import com.datadog.api.v1.client.Configuration;
import com.datadog.api.v1.client.auth.*;
import com.datadog.api.v1.client.model.*;
import com.datadog.api.v1.client.api.DashboardsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure the Datadog site to send API calls to
HashMap<String, String> serverVariables = new HashMap<String, String>();
String site = System.getenv("DD_SITE");
if (site != null) {
serverVariables.put("site", site);
defaultClient.setServerVariables(serverVariables);
}
// Configure API key authorization:
HashMap<String, String> secrets = new HashMap<String, String>();
secrets.put("apiKeyAuth", System.getenv("DD_CLIENT_API_KEY"));
secrets.put("appKeyAuth", System.getenv("DD_CLIENT_APP_KEY"));
defaultClient.configureApiKeys(secrets);
DashboardsApi apiInstance = new DashboardsApi(defaultClient);
String dashboardId = "dashboardId_example"; // String | The ID of the dashboard.
try {
DashboardDeleteResponse result = apiInstance.deleteDashboard(dashboardId)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DashboardsApi#deleteDashboard");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
from datadog import initialize, api
options = {
'api_key': '<DATADOG_API_KEY>',
'app_key': '<DATADOG_APPLICATION_KEY>'
}
initialize(**options)
dashboard_id = '<DASHBOARD_ID>'
api.Dashboard.delete(dashboard_id)
import os
from dateutil.parser import parse as dateutil_parser
import datadog_api_client.v1
from datadog_api_client.v1.api import dashboards_api
from datadog_api_client.v1.models import *
from pprint import pprint
# Defining the host is optional and defaults to https://api.datadoghq.com
# See configuration.py for a list of all supported configuration parameters.
configuration = datadog_api_client.v1.Configuration(
host = "https://api.datadoghq.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: apiKeyAuth
configuration.api_key['apiKeyAuth'] = os.getenv('DD_CLIENT_API_KEY')
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKeyAuth'] = 'Bearer'
# Configure API key authorization: appKeyAuth
configuration.api_key['appKeyAuth'] = os.getenv('DD_CLIENT_APP_KEY')
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['appKeyAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with datadog_api_client.v1.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = dashboards_api.DashboardsApi(api_client)
dashboard_id = "dashboard_id_example" # str | The ID of the dashboard.
# example passing only required values which don't have defaults set
try:
# Delete a dashboard
api_response = api_instance.delete_dashboard(dashboard_id)
pprint(api_response)
except datadog_api_client.v1.ApiException as e:
print("Exception when calling DashboardsApi->delete_dashboard: %s\n" % e)
require 'rubygems'
require 'dogapi'
api_key = '<DATADOG_API_KEY>'
app_key = '<DATADOG_APPLICATION_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
dashboard_id = '<DASHBOARD_ID>'
dog.delete_board(dashboard_id)
require 'time'
require 'datadog_api_client/v1'
# setup authorization
DatadogAPIClient::V1.configure do |config|
# Configure API key authorization: apiKeyAuth
config.api_key['apiKeyAuth'] = ENV["DD_CLIENT_API_KEY"]
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['apiKeyAuth'] = 'Bearer'
# Configure API key authorization: appKeyAuth
config.api_key['appKeyAuth'] = ENV["DD_CLIENT_APP_KEY"]
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['appKeyAuth'] = 'Bearer'
end
api_instance = DatadogAPIClient::V1::DashboardsApi.new
dashboard_id = 'dashboard_id_example' # String | The ID of the dashboard.
begin
# Delete a dashboard
result = api_instance.delete_dashboard(dashboard_id)
p result
rescue DatadogAPIClient::V1::ApiError => e
puts "Error when calling DashboardsApi->delete_dashboard: #{e}"
end
GET https://api.datadoghq.eu/api/v1/dashboard/{dashboard_id}https://api.datadoghq.com/api/v1/dashboard/{dashboard_id}
Récupérez un dashboard à l’aide de l’ID spécifié.
Nom
Type
Description
dashboard_id [required]
string
The ID of the dashboard.
OK
A dashboard is Datadog’s tool for visually tracking, analyzing, and displaying key performance metrics, which enable you to monitor the health of your infrastructure.
Champ
Type
Description
author_handle
string
Identifier of the dashboard author.
created_at
date-time
Creation date of the dashboard.
description
string
Description of the dashboard.
id
string
ID of the dashboard.
is_read_only
boolean
Whether this dashboard is read-only. If True, only the author and admins can make changes to it.
layout_type [required]
enum
Layout type of the dashboard.
Allowed enum values: ordered,free
modified_at
date-time
Modification date of the dashboard.
notify_list
[string]
List of handles of users to notify when changes are made to this dashboard.
template_variable_presets
[object]
Array of template variables saved views.
name
string
The name of the variable.
template_variables
[object]
List of variables.
name
string
The name of the variable.
value
string
The value of the template variable within the saved view.
template_variables
[object]
List of template variables for this dashboard.
default
string
The default value for the template variable on dashboard load.
name [required]
string
The name of the variable.
prefix
string
The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.
title [required]
string
Title of the dashboard.
url
string
The URL of the dashboard.
widgets [required]
[object]
List of widgets to display on the dashboard.
id
int64
ID of the widget.
layout
object
The layout for a widget on a free dashboard.
height [required]
int64
The height of the widget. Should be a non-negative integer.
width [required]
int64
The width of the widget. Should be a non-negative integer.
x [required]
int64
The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y [required]
int64
The position of the widget on the y (vertical) axis. Should be a non-negative integer.
{
"author_handle": "test@datadoghq.com",
"created_at": "2019-09-19T10:00:00.000Z",
"description": "string",
"id": "123-abc-456",
"is_read_only": false,
"layout_type": "string",
"modified_at": "2019-09-19T10:00:00.000Z",
"notify_list": [],
"template_variable_presets": [
{
"name": "string",
"template_variables": [
{
"name": "string",
"value": "string"
}
]
}
],
"template_variables": [
{
"default": "my-host",
"name": "host1",
"prefix": "host"
}
],
"title": "",
"url": "/dashboard/123-abc-456/example-dashboard-title",
"widgets": [
{
"definition": "[object Object]",
"id": "integer",
"layout": {
"height": 0,
"width": 0,
"x": 0,
"y": 0
}
}
]
}Authentication Error
Error response object.
{
"errors": [
"Bad Request"
]
}Item Not Found
Error response object.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export dashboard_id="CHANGE_ME"
# Curl command
curl -X GET "https://api.datadoghq.eu"https://api.datadoghq.com/api/v1/dashboard/${dashboard_id}" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_CLIENT_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_CLIENT_APP_KEY}"
package main
import (
"context"
"encoding/json"
"fmt"
"os"
datadog "github.com/DataDog/datadog-api-client-go/api/v1/datadog"
)
func main() {
ctx := context.WithValue(
context.Background(),
datadog.ContextAPIKeys,
map[string]datadog.APIKey{
"apiKeyAuth": {
Key: os.Getenv("DD_CLIENT_API_KEY"),
},
"appKeyAuth": {
Key: os.Getenv("DD_CLIENT_APP_KEY"),
},
},
)
dashboardId := "dashboardId_example" // string | The ID of the dashboard.
configuration := datadog.NewConfiguration()
api_client := datadog.NewAPIClient(configuration)
resp, r, err := api_client.DashboardsApi.GetDashboard(ctx, dashboardId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.GetDashboard``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetDashboard`: Dashboard
response_content, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from DashboardsApi.GetDashboard:\n%s\n", response_content)
}
// Import classes:
import java.util.*;
import com.datadog.api.v1.client.ApiClient;
import com.datadog.api.v1.client.ApiException;
import com.datadog.api.v1.client.Configuration;
import com.datadog.api.v1.client.auth.*;
import com.datadog.api.v1.client.model.*;
import com.datadog.api.v1.client.api.DashboardsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure the Datadog site to send API calls to
HashMap<String, String> serverVariables = new HashMap<String, String>();
String site = System.getenv("DD_SITE");
if (site != null) {
serverVariables.put("site", site);
defaultClient.setServerVariables(serverVariables);
}
// Configure API key authorization:
HashMap<String, String> secrets = new HashMap<String, String>();
secrets.put("apiKeyAuth", System.getenv("DD_CLIENT_API_KEY"));
secrets.put("appKeyAuth", System.getenv("DD_CLIENT_APP_KEY"));
defaultClient.configureApiKeys(secrets);
DashboardsApi apiInstance = new DashboardsApi(defaultClient);
String dashboardId = "dashboardId_example"; // String | The ID of the dashboard.
try {
Dashboard result = apiInstance.getDashboard(dashboardId)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DashboardsApi#getDashboard");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
from datadog import initialize, api
options = {
'api_key': '<DATADOG_API_KEY>',
'app_key': '<DATADOG_APPLICATION_KEY>'
}
initialize(**options)
dashboard_id = '<DASHBOARD_ID>'
api.Dashboard.get(dashboard_id)
import os
from dateutil.parser import parse as dateutil_parser
import datadog_api_client.v1
from datadog_api_client.v1.api import dashboards_api
from datadog_api_client.v1.models import *
from pprint import pprint
# Defining the host is optional and defaults to https://api.datadoghq.com
# See configuration.py for a list of all supported configuration parameters.
configuration = datadog_api_client.v1.Configuration(
host = "https://api.datadoghq.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: apiKeyAuth
configuration.api_key['apiKeyAuth'] = os.getenv('DD_CLIENT_API_KEY')
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKeyAuth'] = 'Bearer'
# Configure API key authorization: appKeyAuth
configuration.api_key['appKeyAuth'] = os.getenv('DD_CLIENT_APP_KEY')
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['appKeyAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with datadog_api_client.v1.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = dashboards_api.DashboardsApi(api_client)
dashboard_id = "dashboard_id_example" # str | The ID of the dashboard.
# example passing only required values which don't have defaults set
try:
# Get a dashboard
api_response = api_instance.get_dashboard(dashboard_id)
pprint(api_response)
except datadog_api_client.v1.ApiException as e:
print("Exception when calling DashboardsApi->get_dashboard: %s\n" % e)
require 'rubygems'
require 'dogapi'
api_key = '<DATADOG_API_KEY>'
app_key = '<DATADOG_APPLICATION_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
dashboard_id = '<DASHBOARD_ID>'
dog.get_board(dashboard_id)
require 'time'
require 'datadog_api_client/v1'
# setup authorization
DatadogAPIClient::V1.configure do |config|
# Configure API key authorization: apiKeyAuth
config.api_key['apiKeyAuth'] = ENV["DD_CLIENT_API_KEY"]
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['apiKeyAuth'] = 'Bearer'
# Configure API key authorization: appKeyAuth
config.api_key['appKeyAuth'] = ENV["DD_CLIENT_APP_KEY"]
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['appKeyAuth'] = 'Bearer'
end
api_instance = DatadogAPIClient::V1::DashboardsApi.new
dashboard_id = 'dashboard_id_example' # String | The ID of the dashboard.
begin
# Get a dashboard
result = api_instance.get_dashboard(dashboard_id)
p result
rescue DatadogAPIClient::V1::ApiError => e
puts "Error when calling DashboardsApi->get_dashboard: #{e}"
end
GET https://api.datadoghq.eu/api/v1/dashboard/public/{token}https://api.datadoghq.com/api/v1/dashboard/public/{token}
Fetch an existing shared dashboard’s sharing metadata associated with the specified token.
Nom
Type
Description
token [required]
string
The token of the shared dashboard. Generated when a dashboard is shared.
OK
The metadata object associated with how a dashboard has been/will be shared.
Champ
Type
Description
author
object
User who shared the dashboard.
handle
string
Identifier of the user who shared the dashboard.
name
string
Name of the user who shared the dashboard.
created_at
date-time
Date the dashboard was shared.
dashboard_id [required]
string
ID of the dashboard to share.
dashboard_type [required]
enum
The type of the associated private dashboard.
Allowed enum values: custom_timeboard,custom_screenboard
global_time
enum
Dashboard global time live_span selection
Allowed enum values: 15m,1h,4h,1d,2d,1w,1mo,3mo
global_time_selectable_enabled
boolean
Whether to allow viewers to select a different global time setting for the shared dashboard.
public_url
string
URL of the shared dashboard.
selectable_template_vars
[object]
List of objects representing template variables on the shared dashboard which can have selectable values.
default_value
string
The default value of the template variable.
name
string
Name of the template variable.
prefix
string
The tag/attribute key associated with the template variable.
visible_tags
[string]
List of visible tag values on the shared dashboard.
share_list
[string]
List of email addresses that can receive an invitation to access to the shared dashboard.
share_type
enum
Type of sharing access (either open to anyone who has the public URL or invite-only).
Allowed enum values: open,invite
token
string
A unique token assigned to the shared dashboard.
{
"author": {
"handle": "test@datadoghq.com",
"name": "string"
},
"created_at": "2019-09-19T10:00:00.000Z",
"dashboard_id": "123-abc-456",
"dashboard_type": "custom_timeboard",
"global_time": "1h",
"global_time_selectable_enabled": false,
"public_url": "string",
"selectable_template_vars": [
{
"default_value": "*",
"name": "exampleVar",
"prefix": "test",
"visible_tags": "selectableValue1,selectableValue2"
}
],
"share_list": [
"test@datadoghq.com",
"test2@email.com"
],
"share_type": "string",
"token": "string"
}Forbidden
Error response object.
{
"errors": [
"Bad Request"
]
}Shared Dashboard Not Found
Error response object.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export token="CHANGE_ME"
# Curl command
curl -X GET "https://api.datadoghq.eu"https://api.datadoghq.com/api/v1/dashboard/public/${token}" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_CLIENT_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_CLIENT_APP_KEY}"
GET https://api.datadoghq.eu/api/v1/dashboardhttps://api.datadoghq.com/api/v1/dashboard
Récupérez tous les dashboards.
Remarque : cette requête ne renvoie pas les dashboards prédéfinis, mais uniquement les dashboards personnalisés créés ou clonés.
OK
Dashboard summary response.
Champ
Type
Description
dashboards
[object]
List of dashboard definitions.
author_handle
string
Identifier of the dashboard author.
created_at
date-time
Creation date of the dashboard.
description
string
Description of the dashboard.
id
string
Dashboard identifier.
is_read_only
boolean
Whether this dashboard is read-only. If True, only the author and admins can make changes to it.
layout_type
enum
Layout type of the dashboard.
Allowed enum values: ordered,free
modified_at
date-time
Modification date of the dashboard.
title
string
Title of the dashboard.
url
string
URL of the dashboard.
{
"dashboards": [
{
"author_handle": "string",
"created_at": "2019-09-19T10:00:00.000Z",
"description": "string",
"id": "string",
"is_read_only": false,
"layout_type": "string",
"modified_at": "2019-09-19T10:00:00.000Z",
"title": "string",
"url": "string"
}
]
}Authentication Error
Error response object.
{
"errors": [
"Bad Request"
]
}
# Curl command
curl -X GET "https://api.datadoghq.eu"https://api.datadoghq.com/api/v1/dashboard" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_CLIENT_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_CLIENT_APP_KEY}"
package main
import (
"context"
"encoding/json"
"fmt"
"os"
datadog "github.com/DataDog/datadog-api-client-go/api/v1/datadog"
)
func main() {
ctx := context.WithValue(
context.Background(),
datadog.ContextAPIKeys,
map[string]datadog.APIKey{
"apiKeyAuth": {
Key: os.Getenv("DD_CLIENT_API_KEY"),
},
"appKeyAuth": {
Key: os.Getenv("DD_CLIENT_APP_KEY"),
},
},
)
configuration := datadog.NewConfiguration()
api_client := datadog.NewAPIClient(configuration)
resp, r, err := api_client.DashboardsApi.ListDashboards(ctx).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.ListDashboards``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ListDashboards`: DashboardSummary
response_content, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from DashboardsApi.ListDashboards:\n%s\n", response_content)
}
// Import classes:
import java.util.*;
import com.datadog.api.v1.client.ApiClient;
import com.datadog.api.v1.client.ApiException;
import com.datadog.api.v1.client.Configuration;
import com.datadog.api.v1.client.auth.*;
import com.datadog.api.v1.client.model.*;
import com.datadog.api.v1.client.api.DashboardsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure the Datadog site to send API calls to
HashMap<String, String> serverVariables = new HashMap<String, String>();
String site = System.getenv("DD_SITE");
if (site != null) {
serverVariables.put("site", site);
defaultClient.setServerVariables(serverVariables);
}
// Configure API key authorization:
HashMap<String, String> secrets = new HashMap<String, String>();
secrets.put("apiKeyAuth", System.getenv("DD_CLIENT_API_KEY"));
secrets.put("appKeyAuth", System.getenv("DD_CLIENT_APP_KEY"));
defaultClient.configureApiKeys(secrets);
DashboardsApi apiInstance = new DashboardsApi(defaultClient);
try {
DashboardSummary result = apiInstance.listDashboards()
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DashboardsApi#listDashboards");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
from datadog import initialize, api
options = {
'api_key': '<DATADOG_API_KEY>',
'app_key': '<DATADOG_APPLICATION_KEY>'
}
initialize(**options)
api.Dashboard.get_all()
import os
from dateutil.parser import parse as dateutil_parser
import datadog_api_client.v1
from datadog_api_client.v1.api import dashboards_api
from datadog_api_client.v1.models import *
from pprint import pprint
# Defining the host is optional and defaults to https://api.datadoghq.com
# See configuration.py for a list of all supported configuration parameters.
configuration = datadog_api_client.v1.Configuration(
host = "https://api.datadoghq.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: apiKeyAuth
configuration.api_key['apiKeyAuth'] = os.getenv('DD_CLIENT_API_KEY')
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKeyAuth'] = 'Bearer'
# Configure API key authorization: appKeyAuth
configuration.api_key['appKeyAuth'] = os.getenv('DD_CLIENT_APP_KEY')
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['appKeyAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with datadog_api_client.v1.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = dashboards_api.DashboardsApi(api_client)
# example, this endpoint has no required or optional parameters
try:
# Get all dashboards
api_response = api_instance.list_dashboards()
pprint(api_response)
except datadog_api_client.v1.ApiException as e:
print("Exception when calling DashboardsApi->list_dashboards: %s\n" % e)
require 'rubygems'
require 'dogapi'
api_key = '<DATADOG_API_KEY>'
app_key = '<DATADOG_APPLICATION_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
dog.get_all_boards()
require 'time'
require 'datadog_api_client/v1'
# setup authorization
DatadogAPIClient::V1.configure do |config|
# Configure API key authorization: apiKeyAuth
config.api_key['apiKeyAuth'] = ENV["DD_CLIENT_API_KEY"]
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['apiKeyAuth'] = 'Bearer'
# Configure API key authorization: appKeyAuth
config.api_key['appKeyAuth'] = ENV["DD_CLIENT_APP_KEY"]
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['appKeyAuth'] = 'Bearer'
end
api_instance = DatadogAPIClient::V1::DashboardsApi.new
begin
# Get all dashboards
result = api_instance.list_dashboards
p result
rescue DatadogAPIClient::V1::ApiError => e
puts "Error when calling DashboardsApi->list_dashboards: #{e}"
end
GET https://api.datadoghq.eu/api/v1/dashboard/public/{token}/invitationhttps://api.datadoghq.com/api/v1/dashboard/public/{token}/invitation
Describe the invitations that exist for the given shared dashboard (paginated).
Nom
Type
Description
token [required]
string
Token of the shared dashboard for which to fetch invitations.
Nom
Type
Description
page_size
integer
The number of records to return in a single request.
page_number
integer
The page to access (base 0).
OK
Invitations data and metadata that exists for a shared dashboard returned by the API.
Champ
Type
Description
data [required]
<oneOf>
An object or list of objects containing the information for an invitation to a shared dashboard.
Option 1
object
Object containing the information for an invitation to a shared dashboard.
attributes [required]
object
Attributes of the shared dashboard invitation
created_at
date-time
When the invitation was sent.
string
An email address that an invitation has been (or if used in invitation request, will be) sent to.
has_session
boolean
Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email).
invitation_expiry
date-time
When the invitation expires.
session_expiry
date-time
When the invited user's session expires. null if the invitation has no associated session.
share_token
string
The unique token of the shared dashboard that was (or is to be) shared.
type [required]
enum
Type for shared dashboard invitation request body.
Allowed enum values: public_dashboard_invitation
Option 2
[object]
A list of objects containing the information for an invitation(s) to a shared dashboard.
attributes [required]
object
Attributes of the shared dashboard invitation
created_at
date-time
When the invitation was sent.
string
An email address that an invitation has been (or if used in invitation request, will be) sent to.
has_session
boolean
Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email).
invitation_expiry
date-time
When the invitation expires.
session_expiry
date-time
When the invited user's session expires. null if the invitation has no associated session.
share_token
string
The unique token of the shared dashboard that was (or is to be) shared.
type [required]
enum
Type for shared dashboard invitation request body.
Allowed enum values: public_dashboard_invitation
meta
object
Pagination metadata returned by the API.
page
object
Object containing the total count of invitations across all pages
total_count
int64
The total number of invitations on this shared board, across all pages.
{
"data": [
"undefined"
],
"meta": {
"page": {
"total_count": "integer"
}
}
}Forbidden
Error response object.
{
"errors": [
"Bad Request"
]
}Not Found
Error response object.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export token="CHANGE_ME"
# Curl command
curl -X GET "https://api.datadoghq.eu"https://api.datadoghq.com/api/v1/dashboard/public/${token}/invitation" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_CLIENT_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_CLIENT_APP_KEY}"
DELETE https://api.datadoghq.eu/api/v1/dashboard/public/{token}https://api.datadoghq.com/api/v1/dashboard/public/{token}
Revoke the public URL for a dashboard (rendering it private) associated with the specified token.
Nom
Type
Description
token [required]
string
The token of the shared dashboard.
OK
Response containing token of deleted shared dashboard.
{
"deleted_public_dashboard_token": "string"
}Forbidden
Error response object.
{
"errors": [
"Bad Request"
]
}Shared Dashboard Not Found
Error response object.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export token="CHANGE_ME"
# Curl command
curl -X DELETE "https://api.datadoghq.eu"https://api.datadoghq.com/api/v1/dashboard/public/${token}" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_CLIENT_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_CLIENT_APP_KEY}"
DELETE https://api.datadoghq.eu/api/v1/dashboard/public/{token}/invitationhttps://api.datadoghq.com/api/v1/dashboard/public/{token}/invitation
Revoke previously sent invitation emails and active sessions used to access a given shared dashboard for specific email addresses.
Nom
Type
Description
token [required]
string
The token of the shared dashboard.
Shared Dashboard Invitation deletion request body.
Champ
Type
Description
data [required]
<oneOf>
An object or list of objects containing the information for an invitation to a shared dashboard.
Option 1
object
Object containing the information for an invitation to a shared dashboard.
attributes [required]
object
Attributes of the shared dashboard invitation
created_at
date-time
When the invitation was sent.
string
An email address that an invitation has been (or if used in invitation request, will be) sent to.
has_session
boolean
Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email).
invitation_expiry
date-time
When the invitation expires.
session_expiry
date-time
When the invited user's session expires. null if the invitation has no associated session.
share_token
string
The unique token of the shared dashboard that was (or is to be) shared.
type [required]
enum
Type for shared dashboard invitation request body.
Allowed enum values: public_dashboard_invitation
Option 2
[object]
A list of objects containing the information for an invitation(s) to a shared dashboard.
attributes [required]
object
Attributes of the shared dashboard invitation
created_at
date-time
When the invitation was sent.
string
An email address that an invitation has been (or if used in invitation request, will be) sent to.
has_session
boolean
Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email).
invitation_expiry
date-time
When the invitation expires.
session_expiry
date-time
When the invited user's session expires. null if the invitation has no associated session.
share_token
string
The unique token of the shared dashboard that was (or is to be) shared.
type [required]
enum
Type for shared dashboard invitation request body.
Allowed enum values: public_dashboard_invitation
meta
object
Pagination metadata returned by the API.
page
object
Object containing the total count of invitations across all pages
total_count
int64
The total number of invitations on this shared board, across all pages.
{
"data": [
"undefined"
]
}OK
Forbidden
Error response object.
{
"errors": [
"Bad Request"
]
}Not Found
Error response object.
{
"errors": [
"Bad Request"
]
}
## json-request-body
#
# Path parameters
export token="CHANGE_ME"
# Curl command
curl -X DELETE "https://api.datadoghq.eu"https://api.datadoghq.com/api/v1/dashboard/public/${token}/invitation" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_CLIENT_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_CLIENT_APP_KEY}" \
-d @- << EOF
{
"data": [
{
"attributes": {
"email": "test@datadoghq.com"
},
"type": "public_dashboard_invitation"
}
]
}
EOF
POST https://api.datadoghq.eu/api/v1/dashboard/public/{token}/invitationhttps://api.datadoghq.com/api/v1/dashboard/public/{token}/invitation
Send emails to specified email addresses containing links to access a given authenticated shared dashboard. Email addresses must already belong to the authenticated shared dashboard’s share_list.
Nom
Type
Description
token [required]
string
The token of the shared dashboard.
Shared Dashboard Invitation request body.
Champ
Type
Description
data [required]
<oneOf>
An object or list of objects containing the information for an invitation to a shared dashboard.
Option 1
object
Object containing the information for an invitation to a shared dashboard.
attributes [required]
object
Attributes of the shared dashboard invitation
created_at
date-time
When the invitation was sent.
string
An email address that an invitation has been (or if used in invitation request, will be) sent to.
has_session
boolean
Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email).
invitation_expiry
date-time
When the invitation expires.
session_expiry
date-time
When the invited user's session expires. null if the invitation has no associated session.
share_token
string
The unique token of the shared dashboard that was (or is to be) shared.
type [required]
enum
Type for shared dashboard invitation request body.
Allowed enum values: public_dashboard_invitation
Option 2
[object]
A list of objects containing the information for an invitation(s) to a shared dashboard.
attributes [required]
object
Attributes of the shared dashboard invitation
created_at
date-time
When the invitation was sent.
string
An email address that an invitation has been (or if used in invitation request, will be) sent to.
has_session
boolean
Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email).
invitation_expiry
date-time
When the invitation expires.
session_expiry
date-time
When the invited user's session expires. null if the invitation has no associated session.
share_token
string
The unique token of the shared dashboard that was (or is to be) shared.
type [required]
enum
Type for shared dashboard invitation request body.
Allowed enum values: public_dashboard_invitation
meta
object
Pagination metadata returned by the API.
page
object
Object containing the total count of invitations across all pages
total_count
int64
The total number of invitations on this shared board, across all pages.
{
"data": [
"undefined"
]
}OK
Invitations data and metadata that exists for a shared dashboard returned by the API.
Champ
Type
Description
data [required]
<oneOf>
An object or list of objects containing the information for an invitation to a shared dashboard.
Option 1
object
Object containing the information for an invitation to a shared dashboard.
attributes [required]
object
Attributes of the shared dashboard invitation
created_at
date-time
When the invitation was sent.
string
An email address that an invitation has been (or if used in invitation request, will be) sent to.
has_session
boolean
Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email).
invitation_expiry
date-time
When the invitation expires.
session_expiry
date-time
When the invited user's session expires. null if the invitation has no associated session.
share_token
string
The unique token of the shared dashboard that was (or is to be) shared.
type [required]
enum
Type for shared dashboard invitation request body.
Allowed enum values: public_dashboard_invitation
Option 2
[object]
A list of objects containing the information for an invitation(s) to a shared dashboard.
attributes [required]
object
Attributes of the shared dashboard invitation
created_at
date-time
When the invitation was sent.
string
An email address that an invitation has been (or if used in invitation request, will be) sent to.
has_session
boolean
Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email).
invitation_expiry
date-time
When the invitation expires.
session_expiry
date-time
When the invited user's session expires. null if the invitation has no associated session.
share_token
string
The unique token of the shared dashboard that was (or is to be) shared.
type [required]
enum
Type for shared dashboard invitation request body.
Allowed enum values: public_dashboard_invitation
meta
object
Pagination metadata returned by the API.
page
object
Object containing the total count of invitations across all pages
total_count
int64
The total number of invitations on this shared board, across all pages.
{
"data": [
"undefined"
],
"meta": {
"page": {
"total_count": "integer"
}
}
}Bad Request
Error response object.
{
"errors": [
"Bad Request"
]
}Forbidden
Error response object.
{
"errors": [
"Bad Request"
]
}Not Found
Error response object.
{
"errors": [
"Bad Request"
]
}
## json-request-body
#
# Path parameters
export token="CHANGE_ME"
# Curl command
curl -X POST "https://api.datadoghq.eu"https://api.datadoghq.com/api/v1/dashboard/public/${token}/invitation" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_CLIENT_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_CLIENT_APP_KEY}" \
-d @- << EOF
{
"data": [
{
"attributes": {
"email": "test@datadoghq.com"
},
"type": "public_dashboard_invitation"
}
]
}
EOF
PUT https://api.datadoghq.eu/api/v1/dashboard/{dashboard_id}https://api.datadoghq.com/api/v1/dashboard/{dashboard_id}
Mettez à jour un dashboard à l’aide de l’ID spécifié.
Nom
Type
Description
dashboard_id [required]
string
The ID of the dashboard.
Corps de requête pour la mise à jour d’un dashboard.
Champ
Type
Description
author_handle
string
Identifier of the dashboard author.
created_at
date-time
Creation date of the dashboard.
description
string
Description of the dashboard.
id
string
ID of the dashboard.
is_read_only
boolean
Whether this dashboard is read-only. If True, only the author and admins can make changes to it.
layout_type [required]
enum
Layout type of the dashboard.
Allowed enum values: ordered,free
modified_at
date-time
Modification date of the dashboard.
notify_list
[string]
List of handles of users to notify when changes are made to this dashboard.
template_variable_presets
[object]
Array of template variables saved views.
name
string
The name of the variable.
template_variables
[object]
List of variables.
name
string
The name of the variable.
value
string
The value of the template variable within the saved view.
template_variables
[object]
List of template variables for this dashboard.
default
string
The default value for the template variable on dashboard load.
name [required]
string
The name of the variable.
prefix
string
The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.
title [required]
string
Title of the dashboard.
url
string
The URL of the dashboard.
widgets [required]
[object]
List of widgets to display on the dashboard.
id
int64
ID of the widget.
layout
object
The layout for a widget on a free dashboard.
height [required]
int64
The height of the widget. Should be a non-negative integer.
width [required]
int64
The width of the widget. Should be a non-negative integer.
x [required]
int64
The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y [required]
int64
The position of the widget on the y (vertical) axis. Should be a non-negative integer.
{
"description": "string",
"is_read_only": false,
"layout_type": "string",
"notify_list": [],
"template_variable_presets": [
{
"name": "string",
"template_variables": [
{
"name": "string",
"value": "string"
}
]
}
],
"template_variables": [
{
"default": "my-host",
"name": "host1",
"prefix": "host"
}
],
"title": "",
"widgets": [
{
"definition": "[object Object]",
"id": "integer",
"layout": {
"height": 0,
"width": 0,
"x": 0,
"y": 0
}
}
]
}OK
A dashboard is Datadog’s tool for visually tracking, analyzing, and displaying key performance metrics, which enable you to monitor the health of your infrastructure.
Champ
Type
Description
author_handle
string
Identifier of the dashboard author.
created_at
date-time
Creation date of the dashboard.
description
string
Description of the dashboard.
id
string
ID of the dashboard.
is_read_only
boolean
Whether this dashboard is read-only. If True, only the author and admins can make changes to it.
layout_type [required]
enum
Layout type of the dashboard.
Allowed enum values: ordered,free
modified_at
date-time
Modification date of the dashboard.
notify_list
[string]
List of handles of users to notify when changes are made to this dashboard.
template_variable_presets
[object]
Array of template variables saved views.
name
string
The name of the variable.
template_variables
[object]
List of variables.
name
string
The name of the variable.
value
string
The value of the template variable within the saved view.
template_variables
[object]
List of template variables for this dashboard.
default
string
The default value for the template variable on dashboard load.
name [required]
string
The name of the variable.
prefix
string
The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.
title [required]
string
Title of the dashboard.
url
string
The URL of the dashboard.
widgets [required]
[object]
List of widgets to display on the dashboard.
id
int64
ID of the widget.
layout
object
The layout for a widget on a free dashboard.
height [required]
int64
The height of the widget. Should be a non-negative integer.
width [required]
int64
The width of the widget. Should be a non-negative integer.
x [required]
int64
The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y [required]
int64
The position of the widget on the y (vertical) axis. Should be a non-negative integer.
{
"author_handle": "test@datadoghq.com",
"created_at": "2019-09-19T10:00:00.000Z",
"description": "string",
"id": "123-abc-456",
"is_read_only": false,
"layout_type": "string",
"modified_at": "2019-09-19T10:00:00.000Z",
"notify_list": [],
"template_variable_presets": [
{
"name": "string",
"template_variables": [
{
"name": "string",
"value": "string"
}
]
}
],
"template_variables": [
{
"default": "my-host",
"name": "host1",
"prefix": "host"
}
],
"title": "",
"url": "/dashboard/123-abc-456/example-dashboard-title",
"widgets": [
{
"definition": "[object Object]",
"id": "integer",
"layout": {
"height": 0,
"width": 0,
"x": 0,
"y": 0
}
}
]
}Bad Request
Error response object.
{
"errors": [
"Bad Request"
]
}Authentication Error
Error response object.
{
"errors": [
"Bad Request"
]
}Item Not Found
Error response object.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export dashboard_id="CHANGE_ME"
# Curl command
curl -X PUT "https://api.datadoghq.eu"https://api.datadoghq.com/api/v1/dashboard/${dashboard_id}" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_CLIENT_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_CLIENT_APP_KEY}" \
-d @- << EOF
{
"layout_type": null,
"template_variables": [
{
"name": "host1"
}
],
"title": "",
"widgets": [
{
"definition": "[object Object]",
"layout": {
"height": 0,
"width": 0,
"x": 0,
"y": 0
}
}
]
}
EOF
package main
import (
"context"
"encoding/json"
"fmt"
"os"
datadog "github.com/DataDog/datadog-api-client-go/api/v1/datadog"
)
func main() {
ctx := context.WithValue(
context.Background(),
datadog.ContextAPIKeys,
map[string]datadog.APIKey{
"apiKeyAuth": {
Key: os.Getenv("DD_CLIENT_API_KEY"),
},
"appKeyAuth": {
Key: os.Getenv("DD_CLIENT_APP_KEY"),
},
},
)
dashboardId := "dashboardId_example" // string | The ID of the dashboard.
body := *datadog.NewDashboard(datadog.DashboardLayoutType("ordered"), "Title_example", []datadog.Widget{*datadog.NewWidget(datadog.WidgetDefinition{AlertGraphWidgetDefinition: datadog.NewAlertGraphWidgetDefinition("AlertId_example", datadog.AlertGraphWidgetDefinitionType("alert_graph"), datadog.WidgetVizType("timeseries"))})}) // Dashboard | Update Dashboard request body.
configuration := datadog.NewConfiguration()
api_client := datadog.NewAPIClient(configuration)
resp, r, err := api_client.DashboardsApi.UpdateDashboard(ctx, dashboardId).Body(body).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.UpdateDashboard``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `UpdateDashboard`: Dashboard
response_content, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from DashboardsApi.UpdateDashboard:\n%s\n", response_content)
}
// Import classes:
import java.util.*;
import com.datadog.api.v1.client.ApiClient;
import com.datadog.api.v1.client.ApiException;
import com.datadog.api.v1.client.Configuration;
import com.datadog.api.v1.client.auth.*;
import com.datadog.api.v1.client.model.*;
import com.datadog.api.v1.client.api.DashboardsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure the Datadog site to send API calls to
HashMap<String, String> serverVariables = new HashMap<String, String>();
String site = System.getenv("DD_SITE");
if (site != null) {
serverVariables.put("site", site);
defaultClient.setServerVariables(serverVariables);
}
// Configure API key authorization:
HashMap<String, String> secrets = new HashMap<String, String>();
secrets.put("apiKeyAuth", System.getenv("DD_CLIENT_API_KEY"));
secrets.put("appKeyAuth", System.getenv("DD_CLIENT_APP_KEY"));
defaultClient.configureApiKeys(secrets);
DashboardsApi apiInstance = new DashboardsApi(defaultClient);
String dashboardId = "dashboardId_example"; // String | The ID of the dashboard.
Dashboard body = new Dashboard(); // Dashboard | Update Dashboard request body.
try {
Dashboard result = apiInstance.updateDashboard(dashboardId)
.body(body)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DashboardsApi#updateDashboard");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
import os
from dateutil.parser import parse as dateutil_parser
import datadog_api_client.v1
from datadog_api_client.v1.api import dashboards_api
from datadog_api_client.v1.models import *
from pprint import pprint
# Defining the host is optional and defaults to https://api.datadoghq.com
# See configuration.py for a list of all supported configuration parameters.
configuration = datadog_api_client.v1.Configuration(
host = "https://api.datadoghq.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: apiKeyAuth
configuration.api_key['apiKeyAuth'] = os.getenv('DD_CLIENT_API_KEY')
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKeyAuth'] = 'Bearer'
# Configure API key authorization: appKeyAuth
configuration.api_key['appKeyAuth'] = os.getenv('DD_CLIENT_APP_KEY')
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['appKeyAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with datadog_api_client.v1.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = dashboards_api.DashboardsApi(api_client)
dashboard_id = "dashboard_id_example" # str | The ID of the dashboard.
body = Dashboard(
author_handle="test@datadoghq.com",
created_at=dateutil_parser('1970-01-01T00:00:00.00Z'),
description="description_example",
id="123-abc-456",
is_read_only=False,
layout_type=DashboardLayoutType("ordered"),
modified_at=dateutil_parser('1970-01-01T00:00:00.00Z'),
notify_list=[
"notify_list_example",
],
template_variable_presets=[
DashboardTemplateVariablePreset(
name="name_example",
template_variables=[
DashboardTemplateVariablePresetValue(
name="name_example",
value="value_example",
),
],
),
],
template_variables=[
DashboardTemplateVariables(
default="my-host",
name="host1",
prefix="host",
),
],
title="",
url="/dashboard/123-abc-456/example-dashboard-title",
widgets=[{"definition":{"requests":{"fill":{"q":"system.cpu.user"}},"type":"hostmap"}}],
) # Dashboard | Update Dashboard request body.
# example passing only required values which don't have defaults set
try:
# Update a dashboard
api_response = api_instance.update_dashboard(dashboard_id, body)
pprint(api_response)
except datadog_api_client.v1.ApiException as e:
print("Exception when calling DashboardsApi->update_dashboard: %s\n" % e)
require 'time'
require 'datadog_api_client/v1'
# setup authorization
DatadogAPIClient::V1.configure do |config|
# Configure API key authorization: apiKeyAuth
config.api_key['apiKeyAuth'] = ENV["DD_CLIENT_API_KEY"]
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['apiKeyAuth'] = 'Bearer'
# Configure API key authorization: appKeyAuth
config.api_key['appKeyAuth'] = ENV["DD_CLIENT_APP_KEY"]
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['appKeyAuth'] = 'Bearer'
end
api_instance = DatadogAPIClient::V1::DashboardsApi.new
dashboard_id = 'dashboard_id_example' # String | The ID of the dashboard.
body = DatadogAPIClient::V1::Dashboard.new({layout_type: DatadogAPIClient::V1::DashboardLayoutType::ORDERED, title: 'title_example', widgets: [DatadogAPIClient::V1::Widget.new({definition: DatadogAPIClient::V1::AlertGraphWidgetDefinition.new({alert_id: 'alert_id_example', type: DatadogAPIClient::V1::AlertGraphWidgetDefinitionType::ALERT_GRAPH, viz_type: DatadogAPIClient::V1::WidgetVizType::TIMESERIES})})]}) # Dashboard | Update Dashboard request body.
begin
# Update a dashboard
result = api_instance.update_dashboard(dashboard_id, body)
p result
rescue DatadogAPIClient::V1::ApiError => e
puts "Error when calling DashboardsApi->update_dashboard: #{e}"
end
PUT https://api.datadoghq.eu/api/v1/dashboard/public/{token}https://api.datadoghq.com/api/v1/dashboard/public/{token}
Update a shared dashboard associated with the specified token.
Nom
Type
Description
token [required]
string
The token of the shared dashboard.
Update Dashboard request body.
Champ
Type
Description
global_time [required]
object
Timeframe setting for the shared dashboard.
live_span
enum
Dashboard global time live_span selection
Allowed enum values: 15m,1h,4h,1d,2d,1w,1mo,3mo
global_time_selectable_enabled
boolean
Whether to allow viewers to select a different global time setting for the shared dashboard.
selectable_template_vars
[object]
List of objects representing template variables on the shared dashboard which can have selectable values.
default_value
string
The default value of the template variable.
name
string
Name of the template variable.
prefix
string
The tag/attribute key associated with the template variable.
visible_tags
[string]
List of visible tag values on the shared dashboard.
share_list
[string]
List of email addresses that can be given access to the shared dashboard.
share_type
enum
Type of sharing access (either open to anyone who has the public URL or invite-only).
Allowed enum values: open,invite
{
"global_time": {
"live_span": "1h"
},
"global_time_selectable_enabled": false,
"selectable_template_vars": [
{
"default_value": "*",
"name": "exampleVar",
"prefix": "test",
"visible_tags": "selectableValue1,selectableValue2"
}
],
"share_list": [
"test@datadoghq.com",
"test2@email.com"
],
"share_type": "string"
}OK
The metadata object associated with how a dashboard has been/will be shared.
Champ
Type
Description
author
object
User who shared the dashboard.
handle
string
Identifier of the user who shared the dashboard.
name
string
Name of the user who shared the dashboard.
created_at
date-time
Date the dashboard was shared.
dashboard_id [required]
string
ID of the dashboard to share.
dashboard_type [required]
enum
The type of the associated private dashboard.
Allowed enum values: custom_timeboard,custom_screenboard
global_time
enum
Dashboard global time live_span selection
Allowed enum values: 15m,1h,4h,1d,2d,1w,1mo,3mo
global_time_selectable_enabled
boolean
Whether to allow viewers to select a different global time setting for the shared dashboard.
public_url
string
URL of the shared dashboard.
selectable_template_vars
[object]
List of objects representing template variables on the shared dashboard which can have selectable values.
default_value
string
The default value of the template variable.
name
string
Name of the template variable.
prefix
string
The tag/attribute key associated with the template variable.
visible_tags
[string]
List of visible tag values on the shared dashboard.
share_list
[string]
List of email addresses that can receive an invitation to access to the shared dashboard.
share_type
enum
Type of sharing access (either open to anyone who has the public URL or invite-only).
Allowed enum values: open,invite
token
string
A unique token assigned to the shared dashboard.
{
"author": {
"handle": "test@datadoghq.com",
"name": "string"
},
"created_at": "2019-09-19T10:00:00.000Z",
"dashboard_id": "123-abc-456",
"dashboard_type": "custom_timeboard",
"global_time": "1h",
"global_time_selectable_enabled": false,
"public_url": "string",
"selectable_template_vars": [
{
"default_value": "*",
"name": "exampleVar",
"prefix": "test",
"visible_tags": "selectableValue1,selectableValue2"
}
],
"share_list": [
"test@datadoghq.com",
"test2@email.com"
],
"share_type": "string",
"token": "string"
}Bad Request
Error response object.
{
"errors": [
"Bad Request"
]
}Authentication Error
Error response object.
{
"errors": [
"Bad Request"
]
}Item Not Found
Error response object.
{
"errors": [
"Bad Request"
]
}
## json-request-body
#
# Path parameters
export token="CHANGE_ME"
# Curl command
curl -X PUT "https://api.datadoghq.eu"https://api.datadoghq.com/api/v1/dashboard/public/${token}" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_CLIENT_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_CLIENT_APP_KEY}" \
-d @- << EOF
{
"global_time": {
"live_span": "1h"
},
"selectable_template_vars": [
{
"default_value": "*",
"name": "exampleVar",
"prefix": "test",
"visible_tags": [
"selectableValue1",
"selectableValue2"
]
}
],
"share_list": [
"test@datadoghq.com",
"test2@datadoghq.com"
],
"share_type": "invite"
}
EOF