dashboard_list_items

Creates, updates, deletes, gets or lists a dashboard_list_items resource.

Overview

Name	dashboard_list_items
Type	Resource
Id	datadog.dashboards.dashboard_list_items

Fields

The following fields are returned by SELECT queries:

get_dashboard_list_items

Name	Datatype	Description
id	string	ID of the dashboard. (example: q5j-nti-fv6)
integration_id	string	The short name of the integration.
author	object	Creator of the object.
created	string (date-time)	Date of creation of the dashboard.
icon	string	URL to the icon of the dashboard.
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	string (date-time)	Date of last edition of the dashboard.
popularity	integer (int32)	Popularity of the dashboard.
tags	array	List of team names representing ownership of a dashboard.
title	string	Title of the dashboard.
type	string	The type of the dashboard. (custom_timeboard, custom_screenboard, integration_screenboard, integration_timeboard, host_timeboard) (example: host_timeboard)
url	string	URL path to the dashboard.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_dashboard_list_items	select	dashboard_list_id		Fetch the dashboard list’s dashboard definitions.
create_dashboard_list_items	insert	dashboard_list_id		Add dashboards to an existing dashboard list.
update_dashboard_list_items	replace	dashboard_list_id		Update dashboards of an existing dashboard list.
delete_dashboard_list_items	delete	dashboard_list_id		Delete dashboards from an existing dashboard list.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
dashboard_list_id	integer (int64)	ID of the dashboard list to delete items from.
site	string	The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both.

SELECT examples

get_dashboard_list_items

Fetch the dashboard list’s dashboard definitions.

SELECT
id,
integration_id,
author,
created,
icon,
is_favorite,
is_read_only,
is_shared,
modified,
popularity,
tags,
title,
type,
url
FROM datadog.dashboards.dashboard_list_items
WHERE dashboard_list_id = '{{ dashboard_list_id }}' -- required
;

INSERT examples

create_dashboard_list_items

Add dashboards to an existing dashboard list.

INSERT INTO datadog.dashboards.dashboard_list_items (
dashboards,
dashboard_list_id
)
SELECT 
'{{ dashboards }}',
'{{ dashboard_list_id }}'
RETURNING
added_dashboards_to_list
;

Manifest

# Description fields are for documentation purposes
- name: dashboard_list_items
props:
  - name: dashboard_list_id
    value: "{{ dashboard_list_id }}"
    description: Required parameter for the dashboard_list_items resource.
  - name: dashboards
    description: |
      List of dashboards to add the dashboard list.
    value:
      - id: "{{ id }}"
        type: "{{ type }}"

REPLACE examples

update_dashboard_list_items

Update dashboards of an existing dashboard list.

REPLACE datadog.dashboards.dashboard_list_items
SET 
dashboards = '{{ dashboards }}'
WHERE 
dashboard_list_id = '{{ dashboard_list_id }}' --required
RETURNING
dashboards;

DELETE examples

delete_dashboard_list_items

Delete dashboards from an existing dashboard list.

DELETE FROM datadog.dashboards.dashboard_list_items
WHERE dashboard_list_id = '{{ dashboard_list_id }}' --required
;