dashboard_lists

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

Overview

Name	dashboard_lists
Type	Resource
Id	datadog.dashboards.dashboard_lists

Fields

The following fields are returned by SELECT queries:

get_dashboard_list

Name	Datatype	Description
id	integer (int64)	The ID of the dashboard list.
name	string	The name of the dashboard list. (example: My Dashboard)
author	object	Object describing the creator of the shared element.
created	string (date-time)	Date of creation of the dashboard list.
dashboard_count	integer (int64)	The number of dashboards in the list.
is_favorite	boolean	Whether or not the list is in the favorites.
modified	string (date-time)	Date of last edition of the dashboard list.
type	string	The type of dashboard list. (example: manual_dashboard_list)

list_dashboard_lists

Name	Datatype	Description
id	integer (int64)	The ID of the dashboard list.
name	string	The name of the dashboard list. (example: My Dashboard)
author	object	Object describing the creator of the shared element.
created	string (date-time)	Date of creation of the dashboard list.
dashboard_count	integer (int64)	The number of dashboards in the list.
is_favorite	boolean	Whether or not the list is in the favorites.
modified	string (date-time)	Date of last edition of the dashboard list.
type	string	The type of dashboard list. (example: manual_dashboard_list)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_dashboard_list	select	list_id		Fetch an existing dashboard list's definition.
list_dashboard_lists	select			Fetch all of your existing dashboard list definitions.
create_dashboard_list	insert	name		Create an empty dashboard list.
update_dashboard_list	replace	list_id, name		Update the name of a dashboard list.
delete_dashboard_list	delete	list_id		Delete a 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
list_id	integer (int64)	ID of the dashboard list to delete.
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

Fetch an existing dashboard list's definition.

SELECT
id,
name,
author,
created,
dashboard_count,
is_favorite,
modified,
type
FROM datadog.dashboards.dashboard_lists
WHERE list_id = '{{ list_id }}' -- required
;

list_dashboard_lists

Fetch all of your existing dashboard list definitions.

SELECT
id,
name,
author,
created,
dashboard_count,
is_favorite,
modified,
type
FROM datadog.dashboards.dashboard_lists
;

INSERT examples

create_dashboard_list

Create an empty dashboard list.

INSERT INTO datadog.dashboards.dashboard_lists (
name
)
SELECT 
'{{ name }}' /* required */
RETURNING
id,
name,
author,
created,
dashboard_count,
is_favorite,
modified,
type
;

Manifest

# Description fields are for documentation purposes
- name: dashboard_lists
props:
  - name: name
    value: "{{ name }}"
    description: |
      The name of the dashboard list.

REPLACE examples

update_dashboard_list

Update the name of a dashboard list.

REPLACE datadog.dashboards.dashboard_lists
SET 
name = '{{ name }}'
WHERE 
list_id = '{{ list_id }}' --required
AND name = '{{ name }}' --required
RETURNING
id,
name,
author,
created,
dashboard_count,
is_favorite,
modified,
type;

DELETE examples

delete_dashboard_list

Delete a dashboard list.

DELETE FROM datadog.dashboards.dashboard_lists
WHERE list_id = '{{ list_id }}' --required
;