statuspages

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

Overview

Name	statuspages
Type	Resource
Id	datadog.service_management.statuspages

Fields

The following fields are returned by SELECT queries:

get_status_page

Name	Datatype	Description
id	string (uuid)	The ID of the status page.
attributes	object	The attributes of a status page.
relationships	object	The relationships of a status page.
type	string	Status pages resource type. (status_pages) (default: status_pages, example: status_pages)

list_status_pages

Name	Datatype	Description
id	string (uuid)	The ID of the status page.
attributes	object	The attributes of a status page.
relationships	object	The relationships of a status page.
type	string	Status pages resource type. (status_pages) (default: status_pages, example: status_pages)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_status_page	select	page_id	include	Retrieves a specific status page by its ID.
list_status_pages	select		page[offset], page[limit], filter[domain_prefix], include	Lists all status pages for the organization.
create_status_page	insert		include	Creates a new status page in an unpublished state. Use the dedicated [publish](#publish-status-page) status page endpoint to publish the page after creation.
update_status_page	update	page_id	delete_subscribers, include	Updates an existing status page's attributes. To publish and unpublish status pages, use the dedicated [publish](#publish-status-page) and [unpublish](#unpublish-status-page) status page endpoints.
delete_status_page	delete	page_id		Deletes a status page by its ID.
publish_status_page	exec	page_id		Publishes a status page. For pages of type public, makes the status page available on the public internet and requires the status_pages_public_page_publish permission. For pages of type internal, makes the status page available under the status-pages/$domain_prefix/view route within the Datadog organization and requires the status_pages_internal_page_publish permission.
unpublish_status_page	exec	page_id		Unpublishes a status page. For pages of type public, removes the status page from the public internet and requires the status_pages_public_page_publish permission. For pages of type internal, removes the status-pages/$domain_prefix/view route from the Datadog organization and requires the status_pages_internal_page_publish permission.

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.
delete_subscribers	boolean	Whether to delete existing subscribers when updating a status page's type.
filter[domain_prefix]	string	Filter status pages by exact domain prefix match. Returns at most one result.
include	string	Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user.
page[limit]	integer (int64)	The number of status pages to return per page.
page[offset]	integer (int64)	Offset to use as the start of the page.

SELECT examples

get_status_page

Retrieves a specific status page by its ID.

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

list_status_pages

Lists all status pages for the organization.

SELECT
id,
attributes,
relationships,
type
FROM datadog.service_management.statuspages
WHERE page[offset] = '{{ page[offset] }}'
AND page[limit] = '{{ page[limit] }}'
AND filter[domain_prefix] = '{{ filter[domain_prefix] }}'
AND include = '{{ include }}'
;

INSERT examples

create_status_page

Creates a new status page in an unpublished state. Use the dedicated publish status page endpoint to publish the page after creation.

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

Manifest

# Description fields are for documentation purposes
- name: statuspages
props:
  - name: data
    description: |
      The data object for creating a status page.
    value:
      attributes:
        company_logo: "{{ company_logo }}"
        components:
          - components: "{{ components }}"
            id: "{{ id }}"
            name: "{{ name }}"
            position: {{ position }}
            status: "{{ status }}"
            type: "{{ type }}"
        domain_prefix: "{{ domain_prefix }}"
        email_header_image: "{{ email_header_image }}"
        favicon: "{{ favicon }}"
        name: "{{ name }}"
        slack_app_icon: "{{ slack_app_icon }}"
        slack_subscriptions_enabled: {{ slack_subscriptions_enabled }}
        subscriptions_enabled: {{ subscriptions_enabled }}
        type: "{{ type }}"
        visualization_type: "{{ visualization_type }}"
      type: "{{ type }}"
  - name: include
    value: "{{ include }}"
    description: Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user.
    description: Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user.

UPDATE examples

update_status_page

Updates an existing status page's attributes. To publish and unpublish status pages, use the dedicated publish and unpublish status page endpoints.

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

DELETE examples

delete_status_page

Deletes a status page by its ID.

DELETE FROM datadog.service_management.statuspages
WHERE page_id = '{{ page_id }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

publish_status_page

Publishes a status page. For pages of type public, makes the status page available on the public internet and requires the status_pages_public_page_publish permission. For pages of type internal, makes the status page available under the status-pages/$domain_prefix/view route within the Datadog organization and requires the status_pages_internal_page_publish permission.

EXEC datadog.service_management.statuspages.publish_status_page 
@page_id='{{ page_id }}' --required 
;

unpublish_status_page

Unpublishes a status page. For pages of type public, removes the status page from the public internet and requires the status_pages_public_page_publish permission. For pages of type internal, removes the status-pages/$domain_prefix/view route from the Datadog organization and requires the status_pages_internal_page_publish permission.

EXEC datadog.service_management.statuspages.unpublish_status_page 
@page_id='{{ page_id }}' --required 
;