statuspage_maintenance_templates

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

Overview

Name	statuspage_maintenance_templates
Type	Resource
Id	datadog.service_management.statuspage_maintenance_templates

Fields

The following fields are returned by SELECT queries:

get_maintenance_template

Name	Datatype	Description
id	string	The ID of the maintenance template.
attributes	object	The attributes of a maintenance template.
relationships	object	The relationships of a maintenance template.
type	string	Maintenance templates resource type. (maintenance_templates) (default: maintenance_templates, example: maintenance_templates)

list_maintenance_templates

Name	Datatype	Description
id	string	The ID of the maintenance template.
attributes	object	The attributes of a maintenance template.
relationships	object	The relationships of a maintenance template.
type	string	Maintenance templates resource type. (maintenance_templates) (default: maintenance_templates, example: maintenance_templates)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_maintenance_template	select	page_id, template_id	include	Retrieves a specific maintenance template by its ID.
list_maintenance_templates	select	page_id	include	Lists all maintenance templates for a status page.
create_maintenance_template	insert	page_id	include	Creates a new maintenance template.
update_maintenance_template	update	page_id, template_id	include	Updates an existing maintenance template's attributes.
delete_maintenance_template	delete	page_id, template_id		Deletes a maintenance template by its ID (soft delete).

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
page_id	string (uuid)	The ID of the status page.
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.
template_id	string (uuid)	The ID of the degradation or maintenance template.
include	string	Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page.

SELECT examples

get_maintenance_template

Retrieves a specific maintenance template by its ID.

SELECT
id,
attributes,
relationships,
type
FROM datadog.service_management.statuspage_maintenance_templates
WHERE page_id = '{{ page_id }}' -- required
AND template_id = '{{ template_id }}' -- required
AND include = '{{ include }}'
;

list_maintenance_templates

Lists all maintenance templates for a status page.

SELECT
id,
attributes,
relationships,
type
FROM datadog.service_management.statuspage_maintenance_templates
WHERE page_id = '{{ page_id }}' -- required
AND include = '{{ include }}'
;

INSERT examples

create_maintenance_template

Creates a new maintenance template.

INSERT INTO datadog.service_management.statuspage_maintenance_templates (
data,
page_id,
include
)
SELECT 
'{{ data }}',
'{{ page_id }}',
'{{ include }}'
RETURNING
data,
included
;

Manifest

# Description fields are for documentation purposes
- name: statuspage_maintenance_templates
props:
  - name: page_id
    value: "{{ page_id }}"
    description: Required parameter for the statuspage_maintenance_templates resource.
  - name: data
    description: |
      The data object for creating a maintenance template.
    value:
      attributes:
        completed_description: "{{ completed_description }}"
        component_ids:
          - "{{ component_ids }}"
        in_progress_description: "{{ in_progress_description }}"
        maintenance_title: "{{ maintenance_title }}"
        name: "{{ name }}"
        scheduled_description: "{{ scheduled_description }}"
      type: "{{ type }}"
  - name: include
    value: "{{ include }}"
    description: Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page.
    description: Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page.

UPDATE examples

update_maintenance_template

Updates an existing maintenance template's attributes.

UPDATE datadog.service_management.statuspage_maintenance_templates
SET 
data = '{{ data }}'
WHERE 
page_id = '{{ page_id }}' --required
AND template_id = '{{ template_id }}' --required
AND include = '{{ include}}'
RETURNING
data,
included;

DELETE examples

delete_maintenance_template

Deletes a maintenance template by its ID (soft delete).

DELETE FROM datadog.service_management.statuspage_maintenance_templates
WHERE page_id = '{{ page_id }}' --required
AND template_id = '{{ template_id }}' --required
;