data [required]
\n[object]
A list of degradation data objects.
attributes
\nobject
The attributes of a degradation.
components_affected
\n[object]
Components affected by the degradation.
id [required]
\nuuid
The ID of the component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
created_at
\ndate-time
Timestamp of when the degradation was created.
description
\nstring
Description of the degradation.
is_backfilled
\nboolean
Whether the degradation was backfilled.
modified_at
\ndate-time
Timestamp of when the degradation was last modified.
source
\nobject
The source of the degradation.
created_at [required]
\ndate-time
Timestamp of when the source was created.
source_id [required]
\nstring
The ID of the source.
type [required]
\nenum
The type of the source. \nAllowed enum values: incident
status
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
title
\nstring
Title of the degradation.
updates
\n[object]
Past updates made to the degradation.
components_affected
\n[object]
The components affected at the time of the update.
id [required]
\nuuid
Identifier of the component affected at the time of the update.
name
\nstring
The name of the component affected at the time of the update.
status [required]
\nenum
The status of the component affected at the time of the update. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
created_at
\ndate-time
Timestamp of when the update was created.
deleted_at
\nstring
The date and time the resource was deleted.
deleted_by_user_uuid
\nstring
UUID of the user who deleted the resource.
description
\nstring
Description of the update.
id
\nuuid
Identifier of the update.
last_modified_by_user_uuid
\nstring
UUID of the user who last modified the resource.
modified_at
\ndate-time
Timestamp of when the update was last modified.
started_at
\ndate-time
Timestamp of when the update started.
status
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
id
\nuuid
The ID of the degradation.
relationships
\nobject
The relationships of a degradation.
created_by_user
\nobject
The Datadog user who created the degradation.
data [required]
\nobject
The data object identifying the Datadog user who created the degradation.
id [required]
\nstring
The ID of the Datadog user who created the degradation.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the degradation.
data [required]
\nobject
The data object identifying the Datadog user who last modified the degradation.
id [required]
\nstring
The ID of the Datadog user who last modified the degradation.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
status_page
\nobject
The status page the degradation belongs to.
data [required]
\nobject
The data object identifying the status page the degradation belongs to.
id [required]
\nuuid
The ID of the status page.
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
type [required]
\nenum
Degradations resource type. \nAllowed enum values: degradations
default: degradations
included
\n[ <oneOf>]
The included related resources of a degradation. Client must explicitly request these resources by name in the include query parameter.
<type=users>
\nobject
The included Datadog user resource.
attributes
\nobject
Attributes of the Datadog user.
string
The email of the Datadog user.
handle
\nstring
The handle of the Datadog user.
icon
\nstring
The icon of the Datadog user.
name
\nstring
The name of the Datadog user.
uuid
\nstring
The UUID of the Datadog user.
id
\nuuid
The ID of the Datadog user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
<type=status_pages>
\nobject
The included status page resource.
attributes
\nobject
The attributes of a status page.
company_logo
\nstring
The base64-encoded image data displayed in the company logo.
components
\n[object]
Components displayed on the status page.
components
\n[object]
If the component is of type group, the components within the group.
id
\nuuid
The ID of the grouped component.
name
\nstring
The name of the grouped component.
position
\nint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component
id
\nuuid
The ID of the component.
name
\nstring
The name of the component.
position
\nint64
The zero-indexed position of the component.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component,group
created_at
\ndate-time
Timestamp of when the status page was created.
custom_domain
\nstring
If configured, the url that the status page is accessible at.
custom_domain_enabled
\nboolean
Whether the custom domain is configured.
domain_prefix
\nstring
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_image
\nstring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabled
\nboolean
Whether the status page is enabled.
favicon
\nstring
Base64-encoded image data displayed in the browser tab.
modified_at
\ndate-time
Timestamp of when the status page was last modified.
name
\nstring
The name of the status page.
page_url
\nstring
The url that the status page is accessible at.
slack_app_icon
\nstring
The Slack app icon URL for the status page.
slack_subscriptions_enabled
\nboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabled
\nboolean
Whether users can subscribe to the status page.
type
\nenum
The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal
visualization_type
\nenum
The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
id
\nuuid
The ID of the status page.
relationships
\nobject
The relationships of a status page.
created_by_user
\nobject
The Datadog user who created the status page.
data [required]
\nobject
The data object identifying the Datadog user who created the status page.
id [required]
\nstring
The ID of the Datadog user who created the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the status page.
data [required]
\nobject
The data object identifying the Datadog user who last modified the status page.
id [required]
\nstring
The ID of the Datadog user who last modified the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
meta
\nobject
Response metadata.
page
\nobject
Offset-based pagination schema.
first_offset
\nint64
Integer representing the offset to fetch the first page of results.
last_offset
\nint64
Integer representing the offset to fetch the last page of results.
limit
\nint64
Integer representing the number of elements to be returned in the results.
next_offset
\nint64
Integer representing the index of the first element in the next page of results. Equal to page size added to the current offset.
offset
\nint64
Integer representing the index of the first element in the results.
prev_offset
\nint64
Integer representing the index of the first element in the previous page of results.
total
\nint64
Integer representing the total number of elements available.
type
\nenum
The pagination type used for offset-based pagination. \nAllowed enum values: offset_limit
default: offset_limit
data [required]
\n[object]
A list of degradation data objects.
attributes
\nobject
The attributes of a degradation.
components_affected
\n[object]
Components affected by the degradation.
id [required]
\nuuid
The ID of the component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
created_at
\ndate-time
Timestamp of when the degradation was created.
description
\nstring
Description of the degradation.
is_backfilled
\nboolean
Whether the degradation was backfilled.
modified_at
\ndate-time
Timestamp of when the degradation was last modified.
source
\nobject
The source of the degradation.
created_at [required]
\ndate-time
Timestamp of when the source was created.
source_id [required]
\nstring
The ID of the source.
type [required]
\nenum
The type of the source. \nAllowed enum values: incident
status
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
title
\nstring
Title of the degradation.
updates
\n[object]
Past updates made to the degradation.
components_affected
\n[object]
The components affected at the time of the update.
id [required]
\nuuid
Identifier of the component affected at the time of the update.
name
\nstring
The name of the component affected at the time of the update.
status [required]
\nenum
The status of the component affected at the time of the update. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
created_at
\ndate-time
Timestamp of when the update was created.
deleted_at
\nstring
The date and time the resource was deleted.
deleted_by_user_uuid
\nstring
UUID of the user who deleted the resource.
description
\nstring
Description of the update.
id
\nuuid
Identifier of the update.
last_modified_by_user_uuid
\nstring
UUID of the user who last modified the resource.
modified_at
\ndate-time
Timestamp of when the update was last modified.
started_at
\ndate-time
Timestamp of when the update started.
status
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
id
\nuuid
The ID of the degradation.
relationships
\nobject
The relationships of a degradation.
created_by_user
\nobject
The Datadog user who created the degradation.
data [required]
\nobject
The data object identifying the Datadog user who created the degradation.
id [required]
\nstring
The ID of the Datadog user who created the degradation.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the degradation.
data [required]
\nobject
The data object identifying the Datadog user who last modified the degradation.
id [required]
\nstring
The ID of the Datadog user who last modified the degradation.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
status_page
\nobject
The status page the degradation belongs to.
data [required]
\nobject
The data object identifying the status page the degradation belongs to.
id [required]
\nuuid
The ID of the status page.
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
template
\nobject
The template the degradation was created from.
data [required]
\nobject
The data object identifying the template the degradation was created from.
id [required]
\nstring
The ID of the degradation template.
type [required]
\nenum
Degradation templates resource type. \nAllowed enum values: degradation_templates
default: degradation_templates
type [required]
\nenum
Degradations resource type. \nAllowed enum values: degradations
default: degradations
included
\n[ <oneOf>]
The included related resources of a degradation. Client must explicitly request these resources by name in the include query parameter.
<type=users>
\nobject
The included Datadog user resource.
attributes
\nobject
Attributes of the Datadog user.
string
The email of the Datadog user.
handle
\nstring
The handle of the Datadog user.
icon
\nstring
The icon of the Datadog user.
name
\nstring
The name of the Datadog user.
uuid
\nstring
The UUID of the Datadog user.
id
\nuuid
The ID of the Datadog user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
<type=status_pages>
\nobject
The included status page resource.
attributes
\nobject
The attributes of a status page.
company_logo
\nstring
The base64-encoded image data displayed in the company logo.
components
\n[object]
Components displayed on the status page.
components
\n[object]
If the component is of type group, the components within the group.
id
\nuuid
The ID of the grouped component.
name
\nstring
The name of the grouped component.
position
\nint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component
id
\nuuid
The ID of the component.
name
\nstring
The name of the component.
position
\nint64
The zero-indexed position of the component.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component,group
created_at
\ndate-time
Timestamp of when the status page was created.
custom_domain
\nstring
If configured, the url that the status page is accessible at.
custom_domain_enabled
\nboolean
Whether the custom domain is configured.
domain_prefix
\nstring
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_image
\nstring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabled
\nboolean
Whether the status page is enabled.
favicon
\nstring
Base64-encoded image data displayed in the browser tab.
modified_at
\ndate-time
Timestamp of when the status page was last modified.
name
\nstring
The name of the status page.
page_url
\nstring
The url that the status page is accessible at.
slack_app_icon
\nstring
The Slack app icon URL for the status page.
slack_subscriptions_enabled
\nboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabled
\nboolean
Whether users can subscribe to the status page.
type
\nenum
The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal
visualization_type
\nenum
The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
id
\nuuid
The ID of the status page.
relationships
\nobject
The relationships of a status page.
created_by_user
\nobject
The Datadog user who created the status page.
data [required]
\nobject
The data object identifying the Datadog user who created the status page.
id [required]
\nstring
The ID of the Datadog user who created the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the status page.
data [required]
\nobject
The data object identifying the Datadog user who last modified the status page.
id [required]
\nstring
The ID of the Datadog user who last modified the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
meta
\nobject
Response metadata.
page
\nobject
Offset-based pagination schema.
first_offset
\nint64
Integer representing the offset to fetch the first page of results.
last_offset
\nint64
Integer representing the offset to fetch the last page of results.
limit
\nint64
Integer representing the number of elements to be returned in the results.
next_offset
\nint64
Integer representing the index of the first element in the next page of results. Equal to page size added to the current offset.
offset
\nint64
Integer representing the index of the first element in the results.
prev_offset
\nint64
Integer representing the index of the first element in the previous page of results.
total
\nint64
Integer representing the total number of elements available.
type
\nenum
The pagination type used for offset-based pagination. \nAllowed enum values: offset_limit
default: offset_limit
data [required]
\n[object]
A list of maintenance data objects.
attributes
\nobject
The attributes of a maintenance.
completed_date
\ndate-time
Timestamp of when the maintenance was completed.
completed_description
\nstring
The description shown when the maintenance is completed.
components_affected
\n[object]
Components affected by the maintenance.
id [required]
\nuuid
The ID of the component. Must be a component of type component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,maintenance
in_progress_description
\nstring
The description shown while the maintenance is in progress.
is_backfilled
\nboolean
Whether the maintenance was backfilled.
modified_at
\ndate-time
Timestamp of when the maintenance was last modified.
published_date
\ndate-time
Timestamp of when the maintenance was published.
scheduled_description
\nstring
The description shown when the maintenance is scheduled.
start_date
\ndate-time
Timestamp of when the maintenance is scheduled to start.
status
\nenum
The status of the maintenance. \nAllowed enum values: scheduled,in_progress,completed
title
\nstring
Title of the maintenance.
updates
\n[object]
Past updates made to the maintenance.
components_affected
\n[object]
The components affected at the time of the update.
id [required]
\nuuid
Identifier of the component affected at the time of the update.
name
\nstring
The name of the component affected at the time of the update.
status [required]
\nenum
The status of the component affected at the time of the update. \nAllowed enum values: operational,maintenance
created_at
\ndate-time
Timestamp of when the update was created.
description
\nstring
Description of the update.
id
\nuuid
Identifier of the update.
manual_transition
\nboolean
Whether the update was applied manually by a user (true) or automatically by the system (false).
modified_at
\ndate-time
Timestamp of when the update was last modified.
started_at
\ndate-time
Timestamp of when the update started.
status
\nstring
The status of the update.
id
\nuuid
The ID of the maintenance.
relationships
\nobject
The relationships of a maintenance.
created_by_user
\nobject
The Datadog user who created the maintenance.
data [required]
\nobject
The data object identifying the Datadog user who created the maintenance.
id [required]
\nuuid
The ID of the Datadog user who created the maintenance.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the maintenance.
data [required]
\nobject
The data object identifying the Datadog user who last modified the maintenance.
id [required]
\nuuid
The ID of the Datadog user who last modified the maintenance.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
status_page
\nobject
The status page the maintenance belongs to.
data [required]
\nobject
The data object identifying the status page associated with a maintenance.
id [required]
\nuuid
The ID of the status page.
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
type [required]
\nenum
Maintenances resource type. \nAllowed enum values: maintenances
default: maintenances
included
\n[ <oneOf>]
The included related resources of a maintenance. Client must explicitly request these resources by name in the include query parameter.
<type=users>
\nobject
The included Datadog user resource.
attributes
\nobject
Attributes of the Datadog user.
string
The email of the Datadog user.
handle
\nstring
The handle of the Datadog user.
icon
\nstring
The icon of the Datadog user.
name
\nstring
The name of the Datadog user.
uuid
\nstring
The UUID of the Datadog user.
id
\nuuid
The ID of the Datadog user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
<type=status_pages>
\nobject
The included status page resource.
attributes
\nobject
The attributes of a status page.
company_logo
\nstring
The base64-encoded image data displayed in the company logo.
components
\n[object]
Components displayed on the status page.
components
\n[object]
If the component is of type group, the components within the group.
id
\nuuid
The ID of the grouped component.
name
\nstring
The name of the grouped component.
position
\nint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component
id
\nuuid
The ID of the component.
name
\nstring
The name of the component.
position
\nint64
The zero-indexed position of the component.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component,group
created_at
\ndate-time
Timestamp of when the status page was created.
custom_domain
\nstring
If configured, the url that the status page is accessible at.
custom_domain_enabled
\nboolean
Whether the custom domain is configured.
domain_prefix
\nstring
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_image
\nstring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabled
\nboolean
Whether the status page is enabled.
favicon
\nstring
Base64-encoded image data displayed in the browser tab.
modified_at
\ndate-time
Timestamp of when the status page was last modified.
name
\nstring
The name of the status page.
page_url
\nstring
The url that the status page is accessible at.
slack_app_icon
\nstring
The Slack app icon URL for the status page.
slack_subscriptions_enabled
\nboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabled
\nboolean
Whether users can subscribe to the status page.
type
\nenum
The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal
visualization_type
\nenum
The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
id
\nuuid
The ID of the status page.
relationships
\nobject
The relationships of a status page.
created_by_user
\nobject
The Datadog user who created the status page.
data [required]
\nobject
The data object identifying the Datadog user who created the status page.
id [required]
\nstring
The ID of the Datadog user who created the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the status page.
data [required]
\nobject
The data object identifying the Datadog user who last modified the status page.
id [required]
\nstring
The ID of the Datadog user who last modified the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
meta
\nobject
Response metadata.
page
\nobject
Offset-based pagination schema.
first_offset
\nint64
Integer representing the offset to fetch the first page of results.
last_offset
\nint64
Integer representing the offset to fetch the last page of results.
limit
\nint64
Integer representing the number of elements to be returned in the results.
next_offset
\nint64
Integer representing the index of the first element in the next page of results. Equal to page size added to the current offset.
offset
\nint64
Integer representing the index of the first element in the results.
prev_offset
\nint64
Integer representing the index of the first element in the previous page of results.
total
\nint64
Integer representing the total number of elements available.
type
\nenum
The pagination type used for offset-based pagination. \nAllowed enum values: offset_limit
default: offset_limit
data [required]
\n[object]
A list of maintenance data objects.
attributes
\nobject
The attributes of a maintenance.
completed_date
\ndate-time
Timestamp of when the maintenance was completed.
completed_description
\nstring
The description shown when the maintenance is completed.
components_affected
\n[object]
Components affected by the maintenance.
id [required]
\nuuid
The ID of the component. Must be a component of type component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,maintenance
in_progress_description
\nstring
The description shown while the maintenance is in progress.
is_backfilled
\nboolean
Whether the maintenance was backfilled.
modified_at
\ndate-time
Timestamp of when the maintenance was last modified.
published_date
\ndate-time
Timestamp of when the maintenance was published.
scheduled_description
\nstring
The description shown when the maintenance is scheduled.
start_date
\ndate-time
Timestamp of when the maintenance is scheduled to start.
status
\nenum
The status of the maintenance. \nAllowed enum values: scheduled,in_progress,completed
title
\nstring
Title of the maintenance.
updates
\n[object]
Past updates made to the maintenance.
components_affected
\n[object]
The components affected at the time of the update.
id [required]
\nuuid
Identifier of the component affected at the time of the update.
name
\nstring
The name of the component affected at the time of the update.
status [required]
\nenum
The status of the component affected at the time of the update. \nAllowed enum values: operational,maintenance
created_at
\ndate-time
Timestamp of when the update was created.
description
\nstring
Description of the update.
id
\nuuid
Identifier of the update.
manual_transition
\nboolean
Whether the update was applied manually by a user (true) or automatically by the system (false).
modified_at
\ndate-time
Timestamp of when the update was last modified.
started_at
\ndate-time
Timestamp of when the update started.
status
\nstring
The status of the update.
id
\nuuid
The ID of the maintenance.
relationships
\nobject
The relationships of a maintenance.
created_by_user
\nobject
The Datadog user who created the maintenance.
data [required]
\nobject
The data object identifying the Datadog user who created the maintenance.
id [required]
\nuuid
The ID of the Datadog user who created the maintenance.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the maintenance.
data [required]
\nobject
The data object identifying the Datadog user who last modified the maintenance.
id [required]
\nuuid
The ID of the Datadog user who last modified the maintenance.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
status_page
\nobject
The status page the maintenance belongs to.
data [required]
\nobject
The data object identifying the status page associated with a maintenance.
id [required]
\nuuid
The ID of the status page.
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
template
\nobject
The template the maintenance was created from.
data [required]
\nobject
The data object identifying the template the maintenance was created from.
id [required]
\nstring
The ID of the maintenance template.
type [required]
\nenum
Maintenance templates resource type. \nAllowed enum values: maintenance_templates
default: maintenance_templates
type [required]
\nenum
Maintenances resource type. \nAllowed enum values: maintenances
default: maintenances
included
\n[ <oneOf>]
The included related resources of a maintenance. Client must explicitly request these resources by name in the include query parameter.
<type=users>
\nobject
The included Datadog user resource.
attributes
\nobject
Attributes of the Datadog user.
string
The email of the Datadog user.
handle
\nstring
The handle of the Datadog user.
icon
\nstring
The icon of the Datadog user.
name
\nstring
The name of the Datadog user.
uuid
\nstring
The UUID of the Datadog user.
id
\nuuid
The ID of the Datadog user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
<type=status_pages>
\nobject
The included status page resource.
attributes
\nobject
The attributes of a status page.
company_logo
\nstring
The base64-encoded image data displayed in the company logo.
components
\n[object]
Components displayed on the status page.
components
\n[object]
If the component is of type group, the components within the group.
id
\nuuid
The ID of the grouped component.
name
\nstring
The name of the grouped component.
position
\nint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component
id
\nuuid
The ID of the component.
name
\nstring
The name of the component.
position
\nint64
The zero-indexed position of the component.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component,group
created_at
\ndate-time
Timestamp of when the status page was created.
custom_domain
\nstring
If configured, the url that the status page is accessible at.
custom_domain_enabled
\nboolean
Whether the custom domain is configured.
domain_prefix
\nstring
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_image
\nstring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabled
\nboolean
Whether the status page is enabled.
favicon
\nstring
Base64-encoded image data displayed in the browser tab.
modified_at
\ndate-time
Timestamp of when the status page was last modified.
name
\nstring
The name of the status page.
page_url
\nstring
The url that the status page is accessible at.
slack_app_icon
\nstring
The Slack app icon URL for the status page.
slack_subscriptions_enabled
\nboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabled
\nboolean
Whether users can subscribe to the status page.
type
\nenum
The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal
visualization_type
\nenum
The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
id
\nuuid
The ID of the status page.
relationships
\nobject
The relationships of a status page.
created_by_user
\nobject
The Datadog user who created the status page.
data [required]
\nobject
The data object identifying the Datadog user who created the status page.
id [required]
\nstring
The ID of the Datadog user who created the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the status page.
data [required]
\nobject
The data object identifying the Datadog user who last modified the status page.
id [required]
\nstring
The ID of the Datadog user who last modified the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
meta
\nobject
Response metadata.
page
\nobject
Offset-based pagination schema.
first_offset
\nint64
Integer representing the offset to fetch the first page of results.
last_offset
\nint64
Integer representing the offset to fetch the last page of results.
limit
\nint64
Integer representing the number of elements to be returned in the results.
next_offset
\nint64
Integer representing the index of the first element in the next page of results. Equal to page size added to the current offset.
offset
\nint64
Integer representing the index of the first element in the results.
prev_offset
\nint64
Integer representing the index of the first element in the previous page of results.
total
\nint64
Integer representing the total number of elements available.
type
\nenum
The pagination type used for offset-based pagination. \nAllowed enum values: offset_limit
default: offset_limit
data
\nobject
The data object for updating a component.
attributes [required]
\nobject
The supported attributes for updating a component.
name
\nstring
The name of the component.
position
\nint64
The position of the component. If the component belongs to a group, the position is relative to the other components in the group.
id [required]
\nuuid
The ID of the component.
type [required]
\nenum
Components resource type. \nAllowed enum values: components
default: components
data
\nobject
The data object for a degradation.
attributes
\nobject
The attributes of a degradation.
components_affected
\n[object]
Components affected by the degradation.
id [required]
\nuuid
The ID of the component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
created_at
\ndate-time
Timestamp of when the degradation was created.
description
\nstring
Description of the degradation.
is_backfilled
\nboolean
Whether the degradation was backfilled.
modified_at
\ndate-time
Timestamp of when the degradation was last modified.
source
\nobject
The source of the degradation.
created_at [required]
\ndate-time
Timestamp of when the source was created.
source_id [required]
\nstring
The ID of the source.
type [required]
\nenum
The type of the source. \nAllowed enum values: incident
status
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
title
\nstring
Title of the degradation.
updates
\n[object]
Past updates made to the degradation.
components_affected
\n[object]
The components affected at the time of the update.
id [required]
\nuuid
Identifier of the component affected at the time of the update.
name
\nstring
The name of the component affected at the time of the update.
status [required]
\nenum
The status of the component affected at the time of the update. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
created_at
\ndate-time
Timestamp of when the update was created.
deleted_at
\nstring
The date and time the resource was deleted.
deleted_by_user_uuid
\nstring
UUID of the user who deleted the resource.
description
\nstring
Description of the update.
id
\nuuid
Identifier of the update.
last_modified_by_user_uuid
\nstring
UUID of the user who last modified the resource.
modified_at
\ndate-time
Timestamp of when the update was last modified.
started_at
\ndate-time
Timestamp of when the update started.
status
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
id
\nuuid
The ID of the degradation.
relationships
\nobject
The relationships of a degradation.
created_by_user
\nobject
The Datadog user who created the degradation.
data [required]
\nobject
The data object identifying the Datadog user who created the degradation.
id [required]
\nstring
The ID of the Datadog user who created the degradation.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the degradation.
data [required]
\nobject
The data object identifying the Datadog user who last modified the degradation.
id [required]
\nstring
The ID of the Datadog user who last modified the degradation.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
status_page
\nobject
The status page the degradation belongs to.
data [required]
\nobject
The data object identifying the status page the degradation belongs to.
id [required]
\nuuid
The ID of the status page.
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
type [required]
\nenum
Degradations resource type. \nAllowed enum values: degradations
default: degradations
included
\n[ <oneOf>]
The included related resources of a degradation. Client must explicitly request these resources by name in the include query parameter.
<type=users>
\nobject
The included Datadog user resource.
attributes
\nobject
Attributes of the Datadog user.
string
The email of the Datadog user.
handle
\nstring
The handle of the Datadog user.
icon
\nstring
The icon of the Datadog user.
name
\nstring
The name of the Datadog user.
uuid
\nstring
The UUID of the Datadog user.
id
\nuuid
The ID of the Datadog user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
<type=status_pages>
\nobject
The included status page resource.
attributes
\nobject
The attributes of a status page.
company_logo
\nstring
The base64-encoded image data displayed in the company logo.
components
\n[object]
Components displayed on the status page.
components
\n[object]
If the component is of type group, the components within the group.
id
\nuuid
The ID of the grouped component.
name
\nstring
The name of the grouped component.
position
\nint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component
id
\nuuid
The ID of the component.
name
\nstring
The name of the component.
position
\nint64
The zero-indexed position of the component.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component,group
created_at
\ndate-time
Timestamp of when the status page was created.
custom_domain
\nstring
If configured, the url that the status page is accessible at.
custom_domain_enabled
\nboolean
Whether the custom domain is configured.
domain_prefix
\nstring
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_image
\nstring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabled
\nboolean
Whether the status page is enabled.
favicon
\nstring
Base64-encoded image data displayed in the browser tab.
modified_at
\ndate-time
Timestamp of when the status page was last modified.
name
\nstring
The name of the status page.
page_url
\nstring
The url that the status page is accessible at.
slack_app_icon
\nstring
The Slack app icon URL for the status page.
slack_subscriptions_enabled
\nboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabled
\nboolean
Whether users can subscribe to the status page.
type
\nenum
The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal
visualization_type
\nenum
The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
id
\nuuid
The ID of the status page.
relationships
\nobject
The relationships of a status page.
created_by_user
\nobject
The Datadog user who created the status page.
data [required]
\nobject
The data object identifying the Datadog user who created the status page.
id [required]
\nstring
The ID of the Datadog user who created the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the status page.
data [required]
\nobject
The data object identifying the Datadog user who last modified the status page.
id [required]
\nstring
The ID of the Datadog user who last modified the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
data [required]
\n[object]
A list of degradation template data objects.
attributes
\nobject
The attributes of a degradation template.
components_affected
\n[object]
The components affected by a degradation created from this template.
id [required]
\nstring
The ID of the component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage
created_at
\ndate-time
Timestamp of when the degradation template was created.
degradation_title
\nstring
The title used for a degradation created from this template.
modified_at
\ndate-time
Timestamp of when the degradation template was last modified.
name
\nstring
The name of the degradation template.
updates
\n[object]
The pre-filled updates for a degradation created from this template.
message
\nstring
The message of the update.
status [required]
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
id
\nstring
The ID of the degradation template.
relationships
\nobject
The relationships of a degradation template.
created_by_user
\nobject
The Datadog user who created the degradation template.
data [required]
\nobject
The data object identifying the Datadog user who created the degradation template.
id [required]
\nstring
The ID of the Datadog user who created the degradation template.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the degradation template.
data [required]
\nobject
The data object identifying the Datadog user who last modified the degradation template.
id [required]
\nstring
The ID of the Datadog user who last modified the degradation template.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
status_page
\nobject
The status page the degradation template belongs to.
data [required]
\nobject
The data object identifying the status page associated with a degradation template.
id [required]
\nstring
The ID of the status page.
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
type [required]
\nenum
Degradation templates resource type. \nAllowed enum values: degradation_templates
default: degradation_templates
included
\n[ <oneOf>]
The included related resources of a degradation template. Client must explicitly request these resources by name in the include query parameter.
<type=users>
\nobject
The included Datadog user resource.
attributes
\nobject
Attributes of the Datadog user.
string
The email of the Datadog user.
handle
\nstring
The handle of the Datadog user.
icon
\nstring
The icon of the Datadog user.
name
\nstring
The name of the Datadog user.
uuid
\nstring
The UUID of the Datadog user.
id
\nuuid
The ID of the Datadog user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
<type=status_pages>
\nobject
The included status page resource.
attributes
\nobject
The attributes of a status page.
company_logo
\nstring
The base64-encoded image data displayed in the company logo.
components
\n[object]
Components displayed on the status page.
components
\n[object]
If the component is of type group, the components within the group.
id
\nuuid
The ID of the grouped component.
name
\nstring
The name of the grouped component.
position
\nint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component
id
\nuuid
The ID of the component.
name
\nstring
The name of the component.
position
\nint64
The zero-indexed position of the component.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component,group
created_at
\ndate-time
Timestamp of when the status page was created.
custom_domain
\nstring
If configured, the url that the status page is accessible at.
custom_domain_enabled
\nboolean
Whether the custom domain is configured.
domain_prefix
\nstring
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_image
\nstring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabled
\nboolean
Whether the status page is enabled.
favicon
\nstring
Base64-encoded image data displayed in the browser tab.
modified_at
\ndate-time
Timestamp of when the status page was last modified.
name
\nstring
The name of the status page.
page_url
\nstring
The url that the status page is accessible at.
slack_app_icon
\nstring
The Slack app icon URL for the status page.
slack_subscriptions_enabled
\nboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabled
\nboolean
Whether users can subscribe to the status page.
type
\nenum
The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal
visualization_type
\nenum
The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
id
\nuuid
The ID of the status page.
relationships
\nobject
The relationships of a status page.
created_by_user
\nobject
The Datadog user who created the status page.
data [required]
\nobject
The data object identifying the Datadog user who created the status page.
id [required]
\nstring
The ID of the Datadog user who created the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the status page.
data [required]
\nobject
The data object identifying the Datadog user who last modified the status page.
id [required]
\nstring
The ID of the Datadog user who last modified the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
data
\nobject
The data object for creating a degradation.
attributes [required]
\nobject
The supported attributes for creating a degradation.
components_affected [required]
\n[object]
The components affected by the degradation.
id [required]
\nuuid
The ID of the component. Must be a component of type component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
description
\nstring
The description of the degradation.
status [required]
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
title [required]
\nstring
The title of the degradation.
type [required]
\nenum
Degradations resource type. \nAllowed enum values: degradations
default: degradations
data
\nobject
The data object for a degradation.
attributes
\nobject
The attributes of a degradation.
components_affected
\n[object]
Components affected by the degradation.
id [required]
\nuuid
The ID of the component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
created_at
\ndate-time
Timestamp of when the degradation was created.
description
\nstring
Description of the degradation.
is_backfilled
\nboolean
Whether the degradation was backfilled.
modified_at
\ndate-time
Timestamp of when the degradation was last modified.
source
\nobject
The source of the degradation.
created_at [required]
\ndate-time
Timestamp of when the source was created.
source_id [required]
\nstring
The ID of the source.
type [required]
\nenum
The type of the source. \nAllowed enum values: incident
status
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
title
\nstring
Title of the degradation.
updates
\n[object]
Past updates made to the degradation.
components_affected
\n[object]
The components affected at the time of the update.
id [required]
\nuuid
Identifier of the component affected at the time of the update.
name
\nstring
The name of the component affected at the time of the update.
status [required]
\nenum
The status of the component affected at the time of the update. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
created_at
\ndate-time
Timestamp of when the update was created.
deleted_at
\nstring
The date and time the resource was deleted.
deleted_by_user_uuid
\nstring
UUID of the user who deleted the resource.
description
\nstring
Description of the update.
id
\nuuid
Identifier of the update.
last_modified_by_user_uuid
\nstring
UUID of the user who last modified the resource.
modified_at
\ndate-time
Timestamp of when the update was last modified.
started_at
\ndate-time
Timestamp of when the update started.
status
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
id
\nuuid
The ID of the degradation.
relationships
\nobject
The relationships of a degradation.
created_by_user
\nobject
The Datadog user who created the degradation.
data [required]
\nobject
The data object identifying the Datadog user who created the degradation.
id [required]
\nstring
The ID of the Datadog user who created the degradation.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the degradation.
data [required]
\nobject
The data object identifying the Datadog user who last modified the degradation.
id [required]
\nstring
The ID of the Datadog user who last modified the degradation.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
status_page
\nobject
The status page the degradation belongs to.
data [required]
\nobject
The data object identifying the status page the degradation belongs to.
id [required]
\nuuid
The ID of the status page.
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
type [required]
\nenum
Degradations resource type. \nAllowed enum values: degradations
default: degradations
included
\n[ <oneOf>]
The included related resources of a degradation. Client must explicitly request these resources by name in the include query parameter.
<type=users>
\nobject
The included Datadog user resource.
attributes
\nobject
Attributes of the Datadog user.
string
The email of the Datadog user.
handle
\nstring
The handle of the Datadog user.
icon
\nstring
The icon of the Datadog user.
name
\nstring
The name of the Datadog user.
uuid
\nstring
The UUID of the Datadog user.
id
\nuuid
The ID of the Datadog user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
<type=status_pages>
\nobject
The included status page resource.
attributes
\nobject
The attributes of a status page.
company_logo
\nstring
The base64-encoded image data displayed in the company logo.
components
\n[object]
Components displayed on the status page.
components
\n[object]
If the component is of type group, the components within the group.
id
\nuuid
The ID of the grouped component.
name
\nstring
The name of the grouped component.
position
\nint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component
id
\nuuid
The ID of the component.
name
\nstring
The name of the component.
position
\nint64
The zero-indexed position of the component.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component,group
created_at
\ndate-time
Timestamp of when the status page was created.
custom_domain
\nstring
If configured, the url that the status page is accessible at.
custom_domain_enabled
\nboolean
Whether the custom domain is configured.
domain_prefix
\nstring
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_image
\nstring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabled
\nboolean
Whether the status page is enabled.
favicon
\nstring
Base64-encoded image data displayed in the browser tab.
modified_at
\ndate-time
Timestamp of when the status page was last modified.
name
\nstring
The name of the status page.
page_url
\nstring
The url that the status page is accessible at.
slack_app_icon
\nstring
The Slack app icon URL for the status page.
slack_subscriptions_enabled
\nboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabled
\nboolean
Whether users can subscribe to the status page.
type
\nenum
The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal
visualization_type
\nenum
The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
id
\nuuid
The ID of the status page.
relationships
\nobject
The relationships of a status page.
created_by_user
\nobject
The Datadog user who created the status page.
data [required]
\nobject
The data object identifying the Datadog user who created the status page.
id [required]
\nstring
The ID of the Datadog user who created the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the status page.
data [required]
\nobject
The data object identifying the Datadog user who last modified the status page.
id [required]
\nstring
The ID of the Datadog user who last modified the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
data
\nobject
The data object for a degradation template.
attributes
\nobject
The attributes of a degradation template.
components_affected
\n[object]
The components affected by a degradation created from this template.
id [required]
\nstring
The ID of the component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage
created_at
\ndate-time
Timestamp of when the degradation template was created.
degradation_title
\nstring
The title used for a degradation created from this template.
modified_at
\ndate-time
Timestamp of when the degradation template was last modified.
name
\nstring
The name of the degradation template.
updates
\n[object]
The pre-filled updates for a degradation created from this template.
message
\nstring
The message of the update.
status [required]
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
id
\nstring
The ID of the degradation template.
relationships
\nobject
The relationships of a degradation template.
created_by_user
\nobject
The Datadog user who created the degradation template.
data [required]
\nobject
The data object identifying the Datadog user who created the degradation template.
id [required]
\nstring
The ID of the Datadog user who created the degradation template.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the degradation template.
data [required]
\nobject
The data object identifying the Datadog user who last modified the degradation template.
id [required]
\nstring
The ID of the Datadog user who last modified the degradation template.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
status_page
\nobject
The status page the degradation template belongs to.
data [required]
\nobject
The data object identifying the status page associated with a degradation template.
id [required]
\nstring
The ID of the status page.
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
type [required]
\nenum
Degradation templates resource type. \nAllowed enum values: degradation_templates
default: degradation_templates
included
\n[ <oneOf>]
The included related resources of a degradation template. Client must explicitly request these resources by name in the include query parameter.
<type=users>
\nobject
The included Datadog user resource.
attributes
\nobject
Attributes of the Datadog user.
string
The email of the Datadog user.
handle
\nstring
The handle of the Datadog user.
icon
\nstring
The icon of the Datadog user.
name
\nstring
The name of the Datadog user.
uuid
\nstring
The UUID of the Datadog user.
id
\nuuid
The ID of the Datadog user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
<type=status_pages>
\nobject
The included status page resource.
attributes
\nobject
The attributes of a status page.
company_logo
\nstring
The base64-encoded image data displayed in the company logo.
components
\n[object]
Components displayed on the status page.
components
\n[object]
If the component is of type group, the components within the group.
id
\nuuid
The ID of the grouped component.
name
\nstring
The name of the grouped component.
position
\nint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component
id
\nuuid
The ID of the component.
name
\nstring
The name of the component.
position
\nint64
The zero-indexed position of the component.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component,group
created_at
\ndate-time
Timestamp of when the status page was created.
custom_domain
\nstring
If configured, the url that the status page is accessible at.
custom_domain_enabled
\nboolean
Whether the custom domain is configured.
domain_prefix
\nstring
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_image
\nstring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabled
\nboolean
Whether the status page is enabled.
favicon
\nstring
Base64-encoded image data displayed in the browser tab.
modified_at
\ndate-time
Timestamp of when the status page was last modified.
name
\nstring
The name of the status page.
page_url
\nstring
The url that the status page is accessible at.
slack_app_icon
\nstring
The Slack app icon URL for the status page.
slack_subscriptions_enabled
\nboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabled
\nboolean
Whether users can subscribe to the status page.
type
\nenum
The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal
visualization_type
\nenum
The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
id
\nuuid
The ID of the status page.
relationships
\nobject
The relationships of a status page.
created_by_user
\nobject
The Datadog user who created the status page.
data [required]
\nobject
The data object identifying the Datadog user who created the status page.
id [required]
\nstring
The ID of the Datadog user who created the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the status page.
data [required]
\nobject
The data object identifying the Datadog user who last modified the status page.
id [required]
\nstring
The ID of the Datadog user who last modified the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
data
\nobject
The data object for creating a backfilled degradation.
attributes
\nobject
The supported attributes for creating a backfilled degradation.
title [required]
\nstring
The title of the backfilled degradation.
updates [required]
\n[object]
The list of status updates describing the timeline of the degradation.
components_affected
\n[object]
The components affected.
id [required]
\nuuid
The ID of the component. Must be a component of type component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
description
\nstring
A description of the update.
started_at [required]
\ndate-time
Timestamp of when the update occurred.
status [required]
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
type [required]
\nenum
Degradations resource type. \nAllowed enum values: degradations
default: degradations
data
\nobject
The data object for creating a degradation template.
attributes
\nobject
The attributes for creating a degradation template.
components_affected
\n[object]
The components affected by a degradation created from this template.
id [required]
\nstring
The ID of the component. Must be a component of type component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage
degradation_title
\nstring
The title used for a degradation created from this template.
name [required]
\nstring
The name of the degradation template.
updates
\n[object]
The pre-filled updates for a degradation created from this template.
message
\nstring
The message of the update.
status [required]
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
type [required]
\nenum
Degradation templates resource type. \nAllowed enum values: degradation_templates
default: degradation_templates
data
\nobject
The data object for a degradation.
attributes
\nobject
The attributes of a degradation.
components_affected
\n[object]
Components affected by the degradation.
id [required]
\nuuid
The ID of the component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
created_at
\ndate-time
Timestamp of when the degradation was created.
description
\nstring
Description of the degradation.
is_backfilled
\nboolean
Whether the degradation was backfilled.
modified_at
\ndate-time
Timestamp of when the degradation was last modified.
source
\nobject
The source of the degradation.
created_at [required]
\ndate-time
Timestamp of when the source was created.
source_id [required]
\nstring
The ID of the source.
type [required]
\nenum
The type of the source. \nAllowed enum values: incident
status
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
title
\nstring
Title of the degradation.
updates
\n[object]
Past updates made to the degradation.
components_affected
\n[object]
The components affected at the time of the update.
id [required]
\nuuid
Identifier of the component affected at the time of the update.
name
\nstring
The name of the component affected at the time of the update.
status [required]
\nenum
The status of the component affected at the time of the update. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
created_at
\ndate-time
Timestamp of when the update was created.
deleted_at
\nstring
The date and time the resource was deleted.
deleted_by_user_uuid
\nstring
UUID of the user who deleted the resource.
description
\nstring
Description of the update.
id
\nuuid
Identifier of the update.
last_modified_by_user_uuid
\nstring
UUID of the user who last modified the resource.
modified_at
\ndate-time
Timestamp of when the update was last modified.
started_at
\ndate-time
Timestamp of when the update started.
status
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
id
\nuuid
The ID of the degradation.
relationships
\nobject
The relationships of a degradation.
created_by_user
\nobject
The Datadog user who created the degradation.
data [required]
\nobject
The data object identifying the Datadog user who created the degradation.
id [required]
\nstring
The ID of the Datadog user who created the degradation.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the degradation.
data [required]
\nobject
The data object identifying the Datadog user who last modified the degradation.
id [required]
\nstring
The ID of the Datadog user who last modified the degradation.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
status_page
\nobject
The status page the degradation belongs to.
data [required]
\nobject
The data object identifying the status page the degradation belongs to.
id [required]
\nuuid
The ID of the status page.
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
type [required]
\nenum
Degradations resource type. \nAllowed enum values: degradations
default: degradations
included
\n[ <oneOf>]
The included related resources of a degradation. Client must explicitly request these resources by name in the include query parameter.
<type=users>
\nobject
The included Datadog user resource.
attributes
\nobject
Attributes of the Datadog user.
string
The email of the Datadog user.
handle
\nstring
The handle of the Datadog user.
icon
\nstring
The icon of the Datadog user.
name
\nstring
The name of the Datadog user.
uuid
\nstring
The UUID of the Datadog user.
id
\nuuid
The ID of the Datadog user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
<type=status_pages>
\nobject
The included status page resource.
attributes
\nobject
The attributes of a status page.
company_logo
\nstring
The base64-encoded image data displayed in the company logo.
components
\n[object]
Components displayed on the status page.
components
\n[object]
If the component is of type group, the components within the group.
id
\nuuid
The ID of the grouped component.
name
\nstring
The name of the grouped component.
position
\nint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component
id
\nuuid
The ID of the component.
name
\nstring
The name of the component.
position
\nint64
The zero-indexed position of the component.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component,group
created_at
\ndate-time
Timestamp of when the status page was created.
custom_domain
\nstring
If configured, the url that the status page is accessible at.
custom_domain_enabled
\nboolean
Whether the custom domain is configured.
domain_prefix
\nstring
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_image
\nstring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabled
\nboolean
Whether the status page is enabled.
favicon
\nstring
Base64-encoded image data displayed in the browser tab.
modified_at
\ndate-time
Timestamp of when the status page was last modified.
name
\nstring
The name of the status page.
page_url
\nstring
The url that the status page is accessible at.
slack_app_icon
\nstring
The Slack app icon URL for the status page.
slack_subscriptions_enabled
\nboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabled
\nboolean
Whether users can subscribe to the status page.
type
\nenum
The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal
visualization_type
\nenum
The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
id
\nuuid
The ID of the status page.
relationships
\nobject
The relationships of a status page.
created_by_user
\nobject
The Datadog user who created the status page.
data [required]
\nobject
The data object identifying the Datadog user who created the status page.
id [required]
\nstring
The ID of the Datadog user who created the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the status page.
data [required]
\nobject
The data object identifying the Datadog user who last modified the status page.
id [required]
\nstring
The ID of the Datadog user who last modified the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
data
\nobject
The data object for a degradation template.
attributes
\nobject
The attributes of a degradation template.
components_affected
\n[object]
The components affected by a degradation created from this template.
id [required]
\nstring
The ID of the component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage
created_at
\ndate-time
Timestamp of when the degradation template was created.
degradation_title
\nstring
The title used for a degradation created from this template.
modified_at
\ndate-time
Timestamp of when the degradation template was last modified.
name
\nstring
The name of the degradation template.
updates
\n[object]
The pre-filled updates for a degradation created from this template.
message
\nstring
The message of the update.
status [required]
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
id
\nstring
The ID of the degradation template.
relationships
\nobject
The relationships of a degradation template.
created_by_user
\nobject
The Datadog user who created the degradation template.
data [required]
\nobject
The data object identifying the Datadog user who created the degradation template.
id [required]
\nstring
The ID of the Datadog user who created the degradation template.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the degradation template.
data [required]
\nobject
The data object identifying the Datadog user who last modified the degradation template.
id [required]
\nstring
The ID of the Datadog user who last modified the degradation template.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
status_page
\nobject
The status page the degradation template belongs to.
data [required]
\nobject
The data object identifying the status page associated with a degradation template.
id [required]
\nstring
The ID of the status page.
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
type [required]
\nenum
Degradation templates resource type. \nAllowed enum values: degradation_templates
default: degradation_templates
included
\n[ <oneOf>]
The included related resources of a degradation template. Client must explicitly request these resources by name in the include query parameter.
<type=users>
\nobject
The included Datadog user resource.
attributes
\nobject
Attributes of the Datadog user.
string
The email of the Datadog user.
handle
\nstring
The handle of the Datadog user.
icon
\nstring
The icon of the Datadog user.
name
\nstring
The name of the Datadog user.
uuid
\nstring
The UUID of the Datadog user.
id
\nuuid
The ID of the Datadog user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
<type=status_pages>
\nobject
The included status page resource.
attributes
\nobject
The attributes of a status page.
company_logo
\nstring
The base64-encoded image data displayed in the company logo.
components
\n[object]
Components displayed on the status page.
components
\n[object]
If the component is of type group, the components within the group.
id
\nuuid
The ID of the grouped component.
name
\nstring
The name of the grouped component.
position
\nint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component
id
\nuuid
The ID of the component.
name
\nstring
The name of the component.
position
\nint64
The zero-indexed position of the component.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component,group
created_at
\ndate-time
Timestamp of when the status page was created.
custom_domain
\nstring
If configured, the url that the status page is accessible at.
custom_domain_enabled
\nboolean
Whether the custom domain is configured.
domain_prefix
\nstring
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_image
\nstring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabled
\nboolean
Whether the status page is enabled.
favicon
\nstring
Base64-encoded image data displayed in the browser tab.
modified_at
\ndate-time
Timestamp of when the status page was last modified.
name
\nstring
The name of the status page.
page_url
\nstring
The url that the status page is accessible at.
slack_app_icon
\nstring
The Slack app icon URL for the status page.
slack_subscriptions_enabled
\nboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabled
\nboolean
Whether users can subscribe to the status page.
type
\nenum
The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal
visualization_type
\nenum
The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
id
\nuuid
The ID of the status page.
relationships
\nobject
The relationships of a status page.
created_by_user
\nobject
The Datadog user who created the status page.
data [required]
\nobject
The data object identifying the Datadog user who created the status page.
id [required]
\nstring
The ID of the Datadog user who created the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the status page.
data [required]
\nobject
The data object identifying the Datadog user who last modified the status page.
id [required]
\nstring
The ID of the Datadog user who last modified the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
data
\nobject
The data object for a degradation template.
attributes
\nobject
The attributes of a degradation template.
components_affected
\n[object]
The components affected by a degradation created from this template.
id [required]
\nstring
The ID of the component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage
created_at
\ndate-time
Timestamp of when the degradation template was created.
degradation_title
\nstring
The title used for a degradation created from this template.
modified_at
\ndate-time
Timestamp of when the degradation template was last modified.
name
\nstring
The name of the degradation template.
updates
\n[object]
The pre-filled updates for a degradation created from this template.
message
\nstring
The message of the update.
status [required]
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
id
\nstring
The ID of the degradation template.
relationships
\nobject
The relationships of a degradation template.
created_by_user
\nobject
The Datadog user who created the degradation template.
data [required]
\nobject
The data object identifying the Datadog user who created the degradation template.
id [required]
\nstring
The ID of the Datadog user who created the degradation template.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the degradation template.
data [required]
\nobject
The data object identifying the Datadog user who last modified the degradation template.
id [required]
\nstring
The ID of the Datadog user who last modified the degradation template.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
status_page
\nobject
The status page the degradation template belongs to.
data [required]
\nobject
The data object identifying the status page associated with a degradation template.
id [required]
\nstring
The ID of the status page.
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
type [required]
\nenum
Degradation templates resource type. \nAllowed enum values: degradation_templates
default: degradation_templates
included
\n[ <oneOf>]
The included related resources of a degradation template. Client must explicitly request these resources by name in the include query parameter.
<type=users>
\nobject
The included Datadog user resource.
attributes
\nobject
Attributes of the Datadog user.
string
The email of the Datadog user.
handle
\nstring
The handle of the Datadog user.
icon
\nstring
The icon of the Datadog user.
name
\nstring
The name of the Datadog user.
uuid
\nstring
The UUID of the Datadog user.
id
\nuuid
The ID of the Datadog user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
<type=status_pages>
\nobject
The included status page resource.
attributes
\nobject
The attributes of a status page.
company_logo
\nstring
The base64-encoded image data displayed in the company logo.
components
\n[object]
Components displayed on the status page.
components
\n[object]
If the component is of type group, the components within the group.
id
\nuuid
The ID of the grouped component.
name
\nstring
The name of the grouped component.
position
\nint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component
id
\nuuid
The ID of the component.
name
\nstring
The name of the component.
position
\nint64
The zero-indexed position of the component.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component,group
created_at
\ndate-time
Timestamp of when the status page was created.
custom_domain
\nstring
If configured, the url that the status page is accessible at.
custom_domain_enabled
\nboolean
Whether the custom domain is configured.
domain_prefix
\nstring
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_image
\nstring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabled
\nboolean
Whether the status page is enabled.
favicon
\nstring
Base64-encoded image data displayed in the browser tab.
modified_at
\ndate-time
Timestamp of when the status page was last modified.
name
\nstring
The name of the status page.
page_url
\nstring
The url that the status page is accessible at.
slack_app_icon
\nstring
The Slack app icon URL for the status page.
slack_subscriptions_enabled
\nboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabled
\nboolean
Whether users can subscribe to the status page.
type
\nenum
The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal
visualization_type
\nenum
The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
id
\nuuid
The ID of the status page.
relationships
\nobject
The relationships of a status page.
created_by_user
\nobject
The Datadog user who created the status page.
data [required]
\nobject
The data object identifying the Datadog user who created the status page.
id [required]
\nstring
The ID of the Datadog user who created the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the status page.
data [required]
\nobject
The data object identifying the Datadog user who last modified the status page.
id [required]
\nstring
The ID of the Datadog user who last modified the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
errors [required]
\n[string]
A list of errors.
data
\nobject
The data object for updating a degradation template.
attributes
\nobject
The supported attributes for updating a degradation template.
components_affected
\n[object]
The components affected by a degradation created from this template.
id [required]
\nstring
The ID of the component. Must be a component of type component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage
degradation_title
\nstring
The title used for a degradation created from this template.
name
\nstring
The name of the degradation template.
updates
\n[object]
The pre-filled updates for a degradation created from this template.
message
\nstring
The message of the update.
status [required]
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
id [required]
\nstring
The ID of the degradation template.
type [required]
\nenum
Degradation templates resource type. \nAllowed enum values: degradation_templates
default: degradation_templates
data
\nobject
The data object for a degradation.
attributes
\nobject
The attributes of a degradation.
components_affected
\n[object]
Components affected by the degradation.
id [required]
\nuuid
The ID of the component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
created_at
\ndate-time
Timestamp of when the degradation was created.
description
\nstring
Description of the degradation.
is_backfilled
\nboolean
Whether the degradation was backfilled.
modified_at
\ndate-time
Timestamp of when the degradation was last modified.
source
\nobject
The source of the degradation.
created_at [required]
\ndate-time
Timestamp of when the source was created.
source_id [required]
\nstring
The ID of the source.
type [required]
\nenum
The type of the source. \nAllowed enum values: incident
status
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
title
\nstring
Title of the degradation.
updates
\n[object]
Past updates made to the degradation.
components_affected
\n[object]
The components affected at the time of the update.
id [required]
\nuuid
Identifier of the component affected at the time of the update.
name
\nstring
The name of the component affected at the time of the update.
status [required]
\nenum
The status of the component affected at the time of the update. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
created_at
\ndate-time
Timestamp of when the update was created.
deleted_at
\nstring
The date and time the resource was deleted.
deleted_by_user_uuid
\nstring
UUID of the user who deleted the resource.
description
\nstring
Description of the update.
id
\nuuid
Identifier of the update.
last_modified_by_user_uuid
\nstring
UUID of the user who last modified the resource.
modified_at
\ndate-time
Timestamp of when the update was last modified.
started_at
\ndate-time
Timestamp of when the update started.
status
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
id
\nuuid
The ID of the degradation.
relationships
\nobject
The relationships of a degradation.
created_by_user
\nobject
The Datadog user who created the degradation.
data [required]
\nobject
The data object identifying the Datadog user who created the degradation.
id [required]
\nstring
The ID of the Datadog user who created the degradation.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the degradation.
data [required]
\nobject
The data object identifying the Datadog user who last modified the degradation.
id [required]
\nstring
The ID of the Datadog user who last modified the degradation.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
status_page
\nobject
The status page the degradation belongs to.
data [required]
\nobject
The data object identifying the status page the degradation belongs to.
id [required]
\nuuid
The ID of the status page.
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
template
\nobject
The template the degradation was created from.
data [required]
\nobject
The data object identifying the template the degradation was created from.
id [required]
\nstring
The ID of the degradation template.
type [required]
\nenum
Degradation templates resource type. \nAllowed enum values: degradation_templates
default: degradation_templates
type [required]
\nenum
Degradations resource type. \nAllowed enum values: degradations
default: degradations
included
\n[ <oneOf>]
The included related resources of a degradation. Client must explicitly request these resources by name in the include query parameter.
<type=users>
\nobject
The included Datadog user resource.
attributes
\nobject
Attributes of the Datadog user.
string
The email of the Datadog user.
handle
\nstring
The handle of the Datadog user.
icon
\nstring
The icon of the Datadog user.
name
\nstring
The name of the Datadog user.
uuid
\nstring
The UUID of the Datadog user.
id
\nuuid
The ID of the Datadog user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
<type=status_pages>
\nobject
The included status page resource.
attributes
\nobject
The attributes of a status page.
company_logo
\nstring
The base64-encoded image data displayed in the company logo.
components
\n[object]
Components displayed on the status page.
components
\n[object]
If the component is of type group, the components within the group.
id
\nuuid
The ID of the grouped component.
name
\nstring
The name of the grouped component.
position
\nint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component
id
\nuuid
The ID of the component.
name
\nstring
The name of the component.
position
\nint64
The zero-indexed position of the component.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component,group
created_at
\ndate-time
Timestamp of when the status page was created.
custom_domain
\nstring
If configured, the url that the status page is accessible at.
custom_domain_enabled
\nboolean
Whether the custom domain is configured.
domain_prefix
\nstring
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_image
\nstring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabled
\nboolean
Whether the status page is enabled.
favicon
\nstring
Base64-encoded image data displayed in the browser tab.
modified_at
\ndate-time
Timestamp of when the status page was last modified.
name
\nstring
The name of the status page.
page_url
\nstring
The url that the status page is accessible at.
slack_app_icon
\nstring
The Slack app icon URL for the status page.
slack_subscriptions_enabled
\nboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabled
\nboolean
Whether users can subscribe to the status page.
type
\nenum
The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal
visualization_type
\nenum
The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
id
\nuuid
The ID of the status page.
relationships
\nobject
The relationships of a status page.
created_by_user
\nobject
The Datadog user who created the status page.
data [required]
\nobject
The data object identifying the Datadog user who created the status page.
id [required]
\nstring
The ID of the Datadog user who created the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the status page.
data [required]
\nobject
The data object identifying the Datadog user who last modified the status page.
id [required]
\nstring
The ID of the Datadog user who last modified the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
errors [required]
\n[string]
A list of errors.
data
\nobject
The data object for creating a degradation.
attributes [required]
\nobject
The supported attributes for creating a degradation.
components_affected [required]
\n[object]
The components affected by the degradation.
id [required]
\nuuid
The ID of the component. Must be a component of type component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
description
\nstring
The description of the degradation.
status [required]
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
title [required]
\nstring
The title of the degradation.
relationships
\nobject
The supported relationships for creating a degradation.
template
\nobject
The template used to create the degradation.
data [required]
\nobject
The data object identifying the template used to create the degradation.
id [required]
\nstring
The ID of the degradation template.
type [required]
\nenum
Degradation templates resource type. \nAllowed enum values: degradation_templates
default: degradation_templates
type [required]
\nenum
Degradations resource type. \nAllowed enum values: degradations
default: degradations
data
\nobject
The data object for a degradation.
attributes
\nobject
The attributes of a degradation.
components_affected
\n[object]
Components affected by the degradation.
id [required]
\nuuid
The ID of the component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
created_at
\ndate-time
Timestamp of when the degradation was created.
description
\nstring
Description of the degradation.
is_backfilled
\nboolean
Whether the degradation was backfilled.
modified_at
\ndate-time
Timestamp of when the degradation was last modified.
source
\nobject
The source of the degradation.
created_at [required]
\ndate-time
Timestamp of when the source was created.
source_id [required]
\nstring
The ID of the source.
type [required]
\nenum
The type of the source. \nAllowed enum values: incident
status
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
title
\nstring
Title of the degradation.
updates
\n[object]
Past updates made to the degradation.
components_affected
\n[object]
The components affected at the time of the update.
id [required]
\nuuid
Identifier of the component affected at the time of the update.
name
\nstring
The name of the component affected at the time of the update.
status [required]
\nenum
The status of the component affected at the time of the update. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
created_at
\ndate-time
Timestamp of when the update was created.
deleted_at
\nstring
The date and time the resource was deleted.
deleted_by_user_uuid
\nstring
UUID of the user who deleted the resource.
description
\nstring
Description of the update.
id
\nuuid
Identifier of the update.
last_modified_by_user_uuid
\nstring
UUID of the user who last modified the resource.
modified_at
\ndate-time
Timestamp of when the update was last modified.
started_at
\ndate-time
Timestamp of when the update started.
status
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
id
\nuuid
The ID of the degradation.
relationships
\nobject
The relationships of a degradation.
created_by_user
\nobject
The Datadog user who created the degradation.
data [required]
\nobject
The data object identifying the Datadog user who created the degradation.
id [required]
\nstring
The ID of the Datadog user who created the degradation.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the degradation.
data [required]
\nobject
The data object identifying the Datadog user who last modified the degradation.
id [required]
\nstring
The ID of the Datadog user who last modified the degradation.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
status_page
\nobject
The status page the degradation belongs to.
data [required]
\nobject
The data object identifying the status page the degradation belongs to.
id [required]
\nuuid
The ID of the status page.
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
template
\nobject
The template the degradation was created from.
data [required]
\nobject
The data object identifying the template the degradation was created from.
id [required]
\nstring
The ID of the degradation template.
type [required]
\nenum
Degradation templates resource type. \nAllowed enum values: degradation_templates
default: degradation_templates
type [required]
\nenum
Degradations resource type. \nAllowed enum values: degradations
default: degradations
included
\n[ <oneOf>]
The included related resources of a degradation. Client must explicitly request these resources by name in the include query parameter.
<type=users>
\nobject
The included Datadog user resource.
attributes
\nobject
Attributes of the Datadog user.
string
The email of the Datadog user.
handle
\nstring
The handle of the Datadog user.
icon
\nstring
The icon of the Datadog user.
name
\nstring
The name of the Datadog user.
uuid
\nstring
The UUID of the Datadog user.
id
\nuuid
The ID of the Datadog user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
<type=status_pages>
\nobject
The included status page resource.
attributes
\nobject
The attributes of a status page.
company_logo
\nstring
The base64-encoded image data displayed in the company logo.
components
\n[object]
Components displayed on the status page.
components
\n[object]
If the component is of type group, the components within the group.
id
\nuuid
The ID of the grouped component.
name
\nstring
The name of the grouped component.
position
\nint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component
id
\nuuid
The ID of the component.
name
\nstring
The name of the component.
position
\nint64
The zero-indexed position of the component.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component,group
created_at
\ndate-time
Timestamp of when the status page was created.
custom_domain
\nstring
If configured, the url that the status page is accessible at.
custom_domain_enabled
\nboolean
Whether the custom domain is configured.
domain_prefix
\nstring
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_image
\nstring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabled
\nboolean
Whether the status page is enabled.
favicon
\nstring
Base64-encoded image data displayed in the browser tab.
modified_at
\ndate-time
Timestamp of when the status page was last modified.
name
\nstring
The name of the status page.
page_url
\nstring
The url that the status page is accessible at.
slack_app_icon
\nstring
The Slack app icon URL for the status page.
slack_subscriptions_enabled
\nboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabled
\nboolean
Whether users can subscribe to the status page.
type
\nenum
The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal
visualization_type
\nenum
The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
id
\nuuid
The ID of the status page.
relationships
\nobject
The relationships of a status page.
created_by_user
\nobject
The Datadog user who created the status page.
data [required]
\nobject
The data object identifying the Datadog user who created the status page.
id [required]
\nstring
The ID of the Datadog user who created the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the status page.
data [required]
\nobject
The data object identifying the Datadog user who last modified the status page.
id [required]
\nstring
The ID of the Datadog user who last modified the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
errors [required]
\n[string]
A list of errors.
data
\nobject
The data object for creating a backfilled degradation.
attributes
\nobject
The supported attributes for creating a backfilled degradation.
title [required]
\nstring
The title of the backfilled degradation.
updates [required]
\n[object]
The list of status updates describing the timeline of the degradation.
components_affected
\n[object]
The components affected.
id [required]
\nuuid
The ID of the component. Must be a component of type component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
description
\nstring
A description of the update.
started_at [required]
\ndate-time
Timestamp of when the update occurred.
status [required]
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
relationships
\nobject
The supported relationships for creating a backfilled degradation.
template
\nobject
The template used to create the backfilled degradation.
data [required]
\nobject
The data object identifying the template used to create the backfilled degradation.
id [required]
\nstring
The ID of the degradation template.
type [required]
\nenum
Degradation templates resource type. \nAllowed enum values: degradation_templates
default: degradation_templates
type [required]
\nenum
Degradations resource type. \nAllowed enum values: degradations
default: degradations
errors [required]
\n[string]
A list of errors.
data
\nobject
The data object for a degradation.
attributes
\nobject
The attributes of a degradation.
components_affected
\n[object]
Components affected by the degradation.
id [required]
\nuuid
The ID of the component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
created_at
\ndate-time
Timestamp of when the degradation was created.
description
\nstring
Description of the degradation.
is_backfilled
\nboolean
Whether the degradation was backfilled.
modified_at
\ndate-time
Timestamp of when the degradation was last modified.
source
\nobject
The source of the degradation.
created_at [required]
\ndate-time
Timestamp of when the source was created.
source_id [required]
\nstring
The ID of the source.
type [required]
\nenum
The type of the source. \nAllowed enum values: incident
status
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
title
\nstring
Title of the degradation.
updates
\n[object]
Past updates made to the degradation.
components_affected
\n[object]
The components affected at the time of the update.
id [required]
\nuuid
Identifier of the component affected at the time of the update.
name
\nstring
The name of the component affected at the time of the update.
status [required]
\nenum
The status of the component affected at the time of the update. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
created_at
\ndate-time
Timestamp of when the update was created.
deleted_at
\nstring
The date and time the resource was deleted.
deleted_by_user_uuid
\nstring
UUID of the user who deleted the resource.
description
\nstring
Description of the update.
id
\nuuid
Identifier of the update.
last_modified_by_user_uuid
\nstring
UUID of the user who last modified the resource.
modified_at
\ndate-time
Timestamp of when the update was last modified.
started_at
\ndate-time
Timestamp of when the update started.
status
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
id
\nuuid
The ID of the degradation.
relationships
\nobject
The relationships of a degradation.
created_by_user
\nobject
The Datadog user who created the degradation.
data [required]
\nobject
The data object identifying the Datadog user who created the degradation.
id [required]
\nstring
The ID of the Datadog user who created the degradation.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the degradation.
data [required]
\nobject
The data object identifying the Datadog user who last modified the degradation.
id [required]
\nstring
The ID of the Datadog user who last modified the degradation.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
status_page
\nobject
The status page the degradation belongs to.
data [required]
\nobject
The data object identifying the status page the degradation belongs to.
id [required]
\nuuid
The ID of the status page.
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
template
\nobject
The template the degradation was created from.
data [required]
\nobject
The data object identifying the template the degradation was created from.
id [required]
\nstring
The ID of the degradation template.
type [required]
\nenum
Degradation templates resource type. \nAllowed enum values: degradation_templates
default: degradation_templates
type [required]
\nenum
Degradations resource type. \nAllowed enum values: degradations
default: degradations
included
\n[ <oneOf>]
The included related resources of a degradation. Client must explicitly request these resources by name in the include query parameter.
<type=users>
\nobject
The included Datadog user resource.
attributes
\nobject
Attributes of the Datadog user.
string
The email of the Datadog user.
handle
\nstring
The handle of the Datadog user.
icon
\nstring
The icon of the Datadog user.
name
\nstring
The name of the Datadog user.
uuid
\nstring
The UUID of the Datadog user.
id
\nuuid
The ID of the Datadog user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
<type=status_pages>
\nobject
The included status page resource.
attributes
\nobject
The attributes of a status page.
company_logo
\nstring
The base64-encoded image data displayed in the company logo.
components
\n[object]
Components displayed on the status page.
components
\n[object]
If the component is of type group, the components within the group.
id
\nuuid
The ID of the grouped component.
name
\nstring
The name of the grouped component.
position
\nint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component
id
\nuuid
The ID of the component.
name
\nstring
The name of the component.
position
\nint64
The zero-indexed position of the component.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component,group
created_at
\ndate-time
Timestamp of when the status page was created.
custom_domain
\nstring
If configured, the url that the status page is accessible at.
custom_domain_enabled
\nboolean
Whether the custom domain is configured.
domain_prefix
\nstring
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_image
\nstring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabled
\nboolean
Whether the status page is enabled.
favicon
\nstring
Base64-encoded image data displayed in the browser tab.
modified_at
\ndate-time
Timestamp of when the status page was last modified.
name
\nstring
The name of the status page.
page_url
\nstring
The url that the status page is accessible at.
slack_app_icon
\nstring
The Slack app icon URL for the status page.
slack_subscriptions_enabled
\nboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabled
\nboolean
Whether users can subscribe to the status page.
type
\nenum
The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal
visualization_type
\nenum
The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
id
\nuuid
The ID of the status page.
relationships
\nobject
The relationships of a status page.
created_by_user
\nobject
The Datadog user who created the status page.
data [required]
\nobject
The data object identifying the Datadog user who created the status page.
id [required]
\nstring
The ID of the Datadog user who created the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the status page.
data [required]
\nobject
The data object identifying the Datadog user who last modified the status page.
id [required]
\nstring
The ID of the Datadog user who last modified the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
errors [required]
\n[string]
A list of errors.
data
\nobject
The data object for a degradation.
attributes
\nobject
The attributes of a degradation.
components_affected
\n[object]
Components affected by the degradation.
id [required]
\nuuid
The ID of the component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
created_at
\ndate-time
Timestamp of when the degradation was created.
description
\nstring
Description of the degradation.
is_backfilled
\nboolean
Whether the degradation was backfilled.
modified_at
\ndate-time
Timestamp of when the degradation was last modified.
source
\nobject
The source of the degradation.
created_at [required]
\ndate-time
Timestamp of when the source was created.
source_id [required]
\nstring
The ID of the source.
type [required]
\nenum
The type of the source. \nAllowed enum values: incident
status
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
title
\nstring
Title of the degradation.
updates
\n[object]
Past updates made to the degradation.
components_affected
\n[object]
The components affected at the time of the update.
id [required]
\nuuid
Identifier of the component affected at the time of the update.
name
\nstring
The name of the component affected at the time of the update.
status [required]
\nenum
The status of the component affected at the time of the update. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
created_at
\ndate-time
Timestamp of when the update was created.
deleted_at
\nstring
The date and time the resource was deleted.
deleted_by_user_uuid
\nstring
UUID of the user who deleted the resource.
description
\nstring
Description of the update.
id
\nuuid
Identifier of the update.
last_modified_by_user_uuid
\nstring
UUID of the user who last modified the resource.
modified_at
\ndate-time
Timestamp of when the update was last modified.
started_at
\ndate-time
Timestamp of when the update started.
status
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
id
\nuuid
The ID of the degradation.
relationships
\nobject
The relationships of a degradation.
created_by_user
\nobject
The Datadog user who created the degradation.
data [required]
\nobject
The data object identifying the Datadog user who created the degradation.
id [required]
\nstring
The ID of the Datadog user who created the degradation.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the degradation.
data [required]
\nobject
The data object identifying the Datadog user who last modified the degradation.
id [required]
\nstring
The ID of the Datadog user who last modified the degradation.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
status_page
\nobject
The status page the degradation belongs to.
data [required]
\nobject
The data object identifying the status page the degradation belongs to.
id [required]
\nuuid
The ID of the status page.
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
template
\nobject
The template the degradation was created from.
data [required]
\nobject
The data object identifying the template the degradation was created from.
id [required]
\nstring
The ID of the degradation template.
type [required]
\nenum
Degradation templates resource type. \nAllowed enum values: degradation_templates
default: degradation_templates
type [required]
\nenum
Degradations resource type. \nAllowed enum values: degradations
default: degradations
included
\n[ <oneOf>]
The included related resources of a degradation. Client must explicitly request these resources by name in the include query parameter.
<type=users>
\nobject
The included Datadog user resource.
attributes
\nobject
Attributes of the Datadog user.
string
The email of the Datadog user.
handle
\nstring
The handle of the Datadog user.
icon
\nstring
The icon of the Datadog user.
name
\nstring
The name of the Datadog user.
uuid
\nstring
The UUID of the Datadog user.
id
\nuuid
The ID of the Datadog user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
<type=status_pages>
\nobject
The included status page resource.
attributes
\nobject
The attributes of a status page.
company_logo
\nstring
The base64-encoded image data displayed in the company logo.
components
\n[object]
Components displayed on the status page.
components
\n[object]
If the component is of type group, the components within the group.
id
\nuuid
The ID of the grouped component.
name
\nstring
The name of the grouped component.
position
\nint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component
id
\nuuid
The ID of the component.
name
\nstring
The name of the component.
position
\nint64
The zero-indexed position of the component.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component,group
created_at
\ndate-time
Timestamp of when the status page was created.
custom_domain
\nstring
If configured, the url that the status page is accessible at.
custom_domain_enabled
\nboolean
Whether the custom domain is configured.
domain_prefix
\nstring
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_image
\nstring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabled
\nboolean
Whether the status page is enabled.
favicon
\nstring
Base64-encoded image data displayed in the browser tab.
modified_at
\ndate-time
Timestamp of when the status page was last modified.
name
\nstring
The name of the status page.
page_url
\nstring
The url that the status page is accessible at.
slack_app_icon
\nstring
The Slack app icon URL for the status page.
slack_subscriptions_enabled
\nboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabled
\nboolean
Whether users can subscribe to the status page.
type
\nenum
The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal
visualization_type
\nenum
The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
id
\nuuid
The ID of the status page.
relationships
\nobject
The relationships of a status page.
created_by_user
\nobject
The Datadog user who created the status page.
data [required]
\nobject
The data object identifying the Datadog user who created the status page.
id [required]
\nstring
The ID of the Datadog user who created the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the status page.
data [required]
\nobject
The data object identifying the Datadog user who last modified the status page.
id [required]
\nstring
The ID of the Datadog user who last modified the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
errors [required]
\n[string]
A list of errors.
data
\nobject
The data object for updating a degradation.
attributes [required]
\nobject
The supported attributes for updating a degradation.
components_affected
\n[object]
The components affected by the degradation.
id [required]
\nuuid
The ID of the component. Must be a component of type component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
description
\nstring
The description of the degradation.
status
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
title
\nstring
The title of the degradation.
id [required]
\nuuid
The ID of the degradation.
relationships
\nobject
The supported relationships for updating a degradation.
template
\nobject
The template used to create the degradation.
data [required]
\nobject
The data object identifying the template used to create the degradation.
id [required]
\nstring
The ID of the degradation template.
type [required]
\nenum
Degradation templates resource type. \nAllowed enum values: degradation_templates
default: degradation_templates
type [required]
\nenum
Degradations resource type. \nAllowed enum values: degradations
default: degradations
errors [required]
\n[string]
A list of errors.
data
\nobject
The data object for a degradation update.
attributes
\nobject
Attributes of a degradation update resource.
components_affected
\n[object]
Components affected by this update.
id [required]
\nstring
The ID of the affected component.
name
\nstring
The name of the affected component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
created_at
\ndate-time
The date and time the update was created.
deleted_at
\ndate-time
The date and time the update was soft-deleted.
description
\nstring
The message body of the update.
modified_at
\ndate-time
The date and time the update was last modified.
started_at
\ndate-time
The date and time the update started.
status
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
id
\nstring
The ID of the degradation update.
relationships
\nobject
Relationships of a degradation update resource.
created_by_user
\nobject
A user relationship of a degradation update.
data [required]
\nobject
A Datadog user linked to a degradation update.
id [required]
\nstring
The ID of the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
degradation
\nobject
The degradation relationship of a degradation update.
data [required]
\nobject
The degradation linked to a degradation update.
id [required]
\nstring
The ID of the degradation.
type [required]
\nenum
Degradations resource type. \nAllowed enum values: degradations
default: degradations
deleted_by_user
\nobject
A user relationship of a degradation update.
data [required]
\nobject
A Datadog user linked to a degradation update.
id [required]
\nstring
The ID of the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
A user relationship of a degradation update.
data [required]
\nobject
A Datadog user linked to a degradation update.
id [required]
\nstring
The ID of the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
status_page
\nobject
The status page relationship of a degradation update.
data [required]
\nobject
The status page linked to a degradation update.
id [required]
\nstring
The ID of the status page.
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
type [required]
\nenum
Degradation updates resource type. \nAllowed enum values: degradation_updates
default: degradation_updates
included
\n[ <oneOf>]
Resources related to the degradation update.
<type=users>
\nobject
The included Datadog user resource.
attributes
\nobject
Attributes of the Datadog user.
string
The email of the Datadog user.
handle
\nstring
The handle of the Datadog user.
icon
\nstring
The icon of the Datadog user.
name
\nstring
The name of the Datadog user.
uuid
\nstring
The UUID of the Datadog user.
id
\nuuid
The ID of the Datadog user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
Object 2
\nobject
Response object for a single degradation.
data
\nobject
The data object for a degradation.
attributes
\nobject
The attributes of a degradation.
components_affected
\n[object]
Components affected by the degradation.
id [required]
\nuuid
The ID of the component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
created_at
\ndate-time
Timestamp of when the degradation was created.
description
\nstring
Description of the degradation.
is_backfilled
\nboolean
Whether the degradation was backfilled.
modified_at
\ndate-time
Timestamp of when the degradation was last modified.
source
\nobject
The source of the degradation.
created_at [required]
\ndate-time
Timestamp of when the source was created.
source_id [required]
\nstring
The ID of the source.
type [required]
\nenum
The type of the source. \nAllowed enum values: incident
status
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
title
\nstring
Title of the degradation.
updates
\n[object]
Past updates made to the degradation.
components_affected
\n[object]
The components affected at the time of the update.
id [required]
\nuuid
Identifier of the component affected at the time of the update.
name
\nstring
The name of the component affected at the time of the update.
status [required]
\nenum
The status of the component affected at the time of the update. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
created_at
\ndate-time
Timestamp of when the update was created.
deleted_at
\nstring
The date and time the resource was deleted.
deleted_by_user_uuid
\nstring
UUID of the user who deleted the resource.
description
\nstring
Description of the update.
id
\nuuid
Identifier of the update.
last_modified_by_user_uuid
\nstring
UUID of the user who last modified the resource.
modified_at
\ndate-time
Timestamp of when the update was last modified.
started_at
\ndate-time
Timestamp of when the update started.
status
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
id
\nuuid
The ID of the degradation.
relationships
\nobject
The relationships of a degradation.
created_by_user
\nobject
The Datadog user who created the degradation.
data [required]
\nobject
The data object identifying the Datadog user who created the degradation.
id [required]
\nstring
The ID of the Datadog user who created the degradation.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the degradation.
data [required]
\nobject
The data object identifying the Datadog user who last modified the degradation.
id [required]
\nstring
The ID of the Datadog user who last modified the degradation.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
status_page
\nobject
The status page the degradation belongs to.
data [required]
\nobject
The data object identifying the status page the degradation belongs to.
id [required]
\nuuid
The ID of the status page.
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
template
\nobject
The template the degradation was created from.
data [required]
\nobject
The data object identifying the template the degradation was created from.
id [required]
\nstring
The ID of the degradation template.
type [required]
\nenum
Degradation templates resource type. \nAllowed enum values: degradation_templates
default: degradation_templates
type [required]
\nenum
Degradations resource type. \nAllowed enum values: degradations
default: degradations
included
\n[ <oneOf>]
The included related resources of a degradation. Client must explicitly request these resources by name in the include query parameter.
<type=users>
\nobject
The included Datadog user resource.
attributes
\nobject
Attributes of the Datadog user.
string
The email of the Datadog user.
handle
\nstring
The handle of the Datadog user.
icon
\nstring
The icon of the Datadog user.
name
\nstring
The name of the Datadog user.
uuid
\nstring
The UUID of the Datadog user.
id
\nuuid
The ID of the Datadog user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
<type=status_pages>
\nobject
The included status page resource.
attributes
\nobject
The attributes of a status page.
company_logo
\nstring
The base64-encoded image data displayed in the company logo.
components
\n[object]
Components displayed on the status page.
components
\n[object]
If the component is of type group, the components within the group.
id
\nuuid
The ID of the grouped component.
name
\nstring
The name of the grouped component.
position
\nint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component
id
\nuuid
The ID of the component.
name
\nstring
The name of the component.
position
\nint64
The zero-indexed position of the component.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component,group
created_at
\ndate-time
Timestamp of when the status page was created.
custom_domain
\nstring
If configured, the url that the status page is accessible at.
custom_domain_enabled
\nboolean
Whether the custom domain is configured.
domain_prefix
\nstring
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_image
\nstring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabled
\nboolean
Whether the status page is enabled.
favicon
\nstring
Base64-encoded image data displayed in the browser tab.
modified_at
\ndate-time
Timestamp of when the status page was last modified.
name
\nstring
The name of the status page.
page_url
\nstring
The url that the status page is accessible at.
slack_app_icon
\nstring
The Slack app icon URL for the status page.
slack_subscriptions_enabled
\nboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabled
\nboolean
Whether users can subscribe to the status page.
type
\nenum
The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal
visualization_type
\nenum
The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
id
\nuuid
The ID of the status page.
relationships
\nobject
The relationships of a status page.
created_by_user
\nobject
The Datadog user who created the status page.
data [required]
\nobject
The data object identifying the Datadog user who created the status page.
id [required]
\nstring
The ID of the Datadog user who created the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the status page.
data [required]
\nobject
The data object identifying the Datadog user who last modified the status page.
id [required]
\nstring
The ID of the Datadog user who last modified the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
<type=status_pages>
\nobject
The included status page resource.
attributes
\nobject
The attributes of a status page.
company_logo
\nstring
The base64-encoded image data displayed in the company logo.
components
\n[object]
Components displayed on the status page.
components
\n[object]
If the component is of type group, the components within the group.
id
\nuuid
The ID of the grouped component.
name
\nstring
The name of the grouped component.
position
\nint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component
id
\nuuid
The ID of the component.
name
\nstring
The name of the component.
position
\nint64
The zero-indexed position of the component.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component,group
created_at
\ndate-time
Timestamp of when the status page was created.
custom_domain
\nstring
If configured, the url that the status page is accessible at.
custom_domain_enabled
\nboolean
Whether the custom domain is configured.
domain_prefix
\nstring
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_image
\nstring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabled
\nboolean
Whether the status page is enabled.
favicon
\nstring
Base64-encoded image data displayed in the browser tab.
modified_at
\ndate-time
Timestamp of when the status page was last modified.
name
\nstring
The name of the status page.
page_url
\nstring
The url that the status page is accessible at.
slack_app_icon
\nstring
The Slack app icon URL for the status page.
slack_subscriptions_enabled
\nboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabled
\nboolean
Whether users can subscribe to the status page.
type
\nenum
The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal
visualization_type
\nenum
The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
id
\nuuid
The ID of the status page.
relationships
\nobject
The relationships of a status page.
created_by_user
\nobject
The Datadog user who created the status page.
data [required]
\nobject
The data object identifying the Datadog user who created the status page.
id [required]
\nstring
The ID of the Datadog user who created the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the status page.
data [required]
\nobject
The data object identifying the Datadog user who last modified the status page.
id [required]
\nstring
The ID of the Datadog user who last modified the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
errors [required]
\n[string]
A list of errors.
data
\nobject
The data object for editing a degradation update.
attributes
\nobject
Attributes for editing a degradation update.
description
\nstring
The message body of the update.
status
\nenum
The status of the degradation update. \nAllowed enum values: investigating,identified,monitoring
id
\nstring
The ID of the degradation update to edit.
type [required]
\nenum
Degradation updates resource type. \nAllowed enum values: degradation_updates
default: degradation_updates
data [required]
\n[object]
A list of maintenance template data objects.
attributes
\nobject
The attributes of a maintenance template.
completed_description
\nstring
The description shown when a maintenance created from this template is completed.
component_ids
\n[string]
The IDs of the components affected by a maintenance created from this template.
created_at
\ndate-time
Timestamp of when the maintenance template was created.
in_progress_description
\nstring
The description shown while a maintenance created from this template is in progress.
maintenance_title
\nstring
The title used for a maintenance created from this template.
modified_at
\ndate-time
Timestamp of when the maintenance template was last modified.
name
\nstring
The name of the maintenance template.
scheduled_description
\nstring
The description shown when a maintenance created from this template is scheduled.
id
\nstring
The ID of the maintenance template.
relationships
\nobject
The relationships of a maintenance template.
created_by_user
\nobject
The Datadog user who created the maintenance template.
data [required]
\nobject
The data object identifying the Datadog user who created the maintenance template.
id [required]
\nstring
The ID of the Datadog user who created the maintenance template.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the maintenance template.
data [required]
\nobject
The data object identifying the Datadog user who last modified the maintenance template.
id [required]
\nstring
The ID of the Datadog user who last modified the maintenance template.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
status_page
\nobject
The status page the maintenance template belongs to.
data [required]
\nobject
The data object identifying the status page associated with a maintenance template.
id [required]
\nstring
The ID of the status page.
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
type [required]
\nenum
Maintenance templates resource type. \nAllowed enum values: maintenance_templates
default: maintenance_templates
included
\n[ <oneOf>]
The included related resources of a maintenance template. Client must explicitly request these resources by name in the include query parameter.
<type=users>
\nobject
The included Datadog user resource.
attributes
\nobject
Attributes of the Datadog user.
string
The email of the Datadog user.
handle
\nstring
The handle of the Datadog user.
icon
\nstring
The icon of the Datadog user.
name
\nstring
The name of the Datadog user.
uuid
\nstring
The UUID of the Datadog user.
id
\nuuid
The ID of the Datadog user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
<type=status_pages>
\nobject
The included status page resource.
attributes
\nobject
The attributes of a status page.
company_logo
\nstring
The base64-encoded image data displayed in the company logo.
components
\n[object]
Components displayed on the status page.
components
\n[object]
If the component is of type group, the components within the group.
id
\nuuid
The ID of the grouped component.
name
\nstring
The name of the grouped component.
position
\nint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component
id
\nuuid
The ID of the component.
name
\nstring
The name of the component.
position
\nint64
The zero-indexed position of the component.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component,group
created_at
\ndate-time
Timestamp of when the status page was created.
custom_domain
\nstring
If configured, the url that the status page is accessible at.
custom_domain_enabled
\nboolean
Whether the custom domain is configured.
domain_prefix
\nstring
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_image
\nstring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabled
\nboolean
Whether the status page is enabled.
favicon
\nstring
Base64-encoded image data displayed in the browser tab.
modified_at
\ndate-time
Timestamp of when the status page was last modified.
name
\nstring
The name of the status page.
page_url
\nstring
The url that the status page is accessible at.
slack_app_icon
\nstring
The Slack app icon URL for the status page.
slack_subscriptions_enabled
\nboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabled
\nboolean
Whether users can subscribe to the status page.
type
\nenum
The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal
visualization_type
\nenum
The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
id
\nuuid
The ID of the status page.
relationships
\nobject
The relationships of a status page.
created_by_user
\nobject
The Datadog user who created the status page.
data [required]
\nobject
The data object identifying the Datadog user who created the status page.
id [required]
\nstring
The ID of the Datadog user who created the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the status page.
data [required]
\nobject
The data object identifying the Datadog user who last modified the status page.
id [required]
\nstring
The ID of the Datadog user who last modified the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
errors [required]
\n[string]
A list of errors.
data
\nobject
The data object for a degradation.
attributes
\nobject
The attributes of a degradation.
components_affected
\n[object]
Components affected by the degradation.
id [required]
\nuuid
The ID of the component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
created_at
\ndate-time
Timestamp of when the degradation was created.
description
\nstring
Description of the degradation.
is_backfilled
\nboolean
Whether the degradation was backfilled.
modified_at
\ndate-time
Timestamp of when the degradation was last modified.
source
\nobject
The source of the degradation.
created_at [required]
\ndate-time
Timestamp of when the source was created.
source_id [required]
\nstring
The ID of the source.
type [required]
\nenum
The type of the source. \nAllowed enum values: incident
status
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
title
\nstring
Title of the degradation.
updates
\n[object]
Past updates made to the degradation.
components_affected
\n[object]
The components affected at the time of the update.
id [required]
\nuuid
Identifier of the component affected at the time of the update.
name
\nstring
The name of the component affected at the time of the update.
status [required]
\nenum
The status of the component affected at the time of the update. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
created_at
\ndate-time
Timestamp of when the update was created.
deleted_at
\nstring
The date and time the resource was deleted.
deleted_by_user_uuid
\nstring
UUID of the user who deleted the resource.
description
\nstring
Description of the update.
id
\nuuid
Identifier of the update.
last_modified_by_user_uuid
\nstring
UUID of the user who last modified the resource.
modified_at
\ndate-time
Timestamp of when the update was last modified.
started_at
\ndate-time
Timestamp of when the update started.
status
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
id
\nuuid
The ID of the degradation.
relationships
\nobject
The relationships of a degradation.
created_by_user
\nobject
The Datadog user who created the degradation.
data [required]
\nobject
The data object identifying the Datadog user who created the degradation.
id [required]
\nstring
The ID of the Datadog user who created the degradation.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the degradation.
data [required]
\nobject
The data object identifying the Datadog user who last modified the degradation.
id [required]
\nstring
The ID of the Datadog user who last modified the degradation.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
status_page
\nobject
The status page the degradation belongs to.
data [required]
\nobject
The data object identifying the status page the degradation belongs to.
id [required]
\nuuid
The ID of the status page.
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
type [required]
\nenum
Degradations resource type. \nAllowed enum values: degradations
default: degradations
included
\n[ <oneOf>]
The included related resources of a degradation. Client must explicitly request these resources by name in the include query parameter.
<type=users>
\nobject
The included Datadog user resource.
attributes
\nobject
Attributes of the Datadog user.
string
The email of the Datadog user.
handle
\nstring
The handle of the Datadog user.
icon
\nstring
The icon of the Datadog user.
name
\nstring
The name of the Datadog user.
uuid
\nstring
The UUID of the Datadog user.
id
\nuuid
The ID of the Datadog user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
<type=status_pages>
\nobject
The included status page resource.
attributes
\nobject
The attributes of a status page.
company_logo
\nstring
The base64-encoded image data displayed in the company logo.
components
\n[object]
Components displayed on the status page.
components
\n[object]
If the component is of type group, the components within the group.
id
\nuuid
The ID of the grouped component.
name
\nstring
The name of the grouped component.
position
\nint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component
id
\nuuid
The ID of the component.
name
\nstring
The name of the component.
position
\nint64
The zero-indexed position of the component.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component,group
created_at
\ndate-time
Timestamp of when the status page was created.
custom_domain
\nstring
If configured, the url that the status page is accessible at.
custom_domain_enabled
\nboolean
Whether the custom domain is configured.
domain_prefix
\nstring
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_image
\nstring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabled
\nboolean
Whether the status page is enabled.
favicon
\nstring
Base64-encoded image data displayed in the browser tab.
modified_at
\ndate-time
Timestamp of when the status page was last modified.
name
\nstring
The name of the status page.
page_url
\nstring
The url that the status page is accessible at.
slack_app_icon
\nstring
The Slack app icon URL for the status page.
slack_subscriptions_enabled
\nboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabled
\nboolean
Whether users can subscribe to the status page.
type
\nenum
The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal
visualization_type
\nenum
The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
id
\nuuid
The ID of the status page.
relationships
\nobject
The relationships of a status page.
created_by_user
\nobject
The Datadog user who created the status page.
data [required]
\nobject
The data object identifying the Datadog user who created the status page.
id [required]
\nstring
The ID of the Datadog user who created the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the status page.
data [required]
\nobject
The data object identifying the Datadog user who last modified the status page.
id [required]
\nstring
The ID of the Datadog user who last modified the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
data
\nobject
The data object for a maintenance template.
attributes
\nobject
The attributes of a maintenance template.
completed_description
\nstring
The description shown when a maintenance created from this template is completed.
component_ids
\n[string]
The IDs of the components affected by a maintenance created from this template.
created_at
\ndate-time
Timestamp of when the maintenance template was created.
in_progress_description
\nstring
The description shown while a maintenance created from this template is in progress.
maintenance_title
\nstring
The title used for a maintenance created from this template.
modified_at
\ndate-time
Timestamp of when the maintenance template was last modified.
name
\nstring
The name of the maintenance template.
scheduled_description
\nstring
The description shown when a maintenance created from this template is scheduled.
id
\nstring
The ID of the maintenance template.
relationships
\nobject
The relationships of a maintenance template.
created_by_user
\nobject
The Datadog user who created the maintenance template.
data [required]
\nobject
The data object identifying the Datadog user who created the maintenance template.
id [required]
\nstring
The ID of the Datadog user who created the maintenance template.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the maintenance template.
data [required]
\nobject
The data object identifying the Datadog user who last modified the maintenance template.
id [required]
\nstring
The ID of the Datadog user who last modified the maintenance template.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
status_page
\nobject
The status page the maintenance template belongs to.
data [required]
\nobject
The data object identifying the status page associated with a maintenance template.
id [required]
\nstring
The ID of the status page.
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
type [required]
\nenum
Maintenance templates resource type. \nAllowed enum values: maintenance_templates
default: maintenance_templates
included
\n[ <oneOf>]
The included related resources of a maintenance template. Client must explicitly request these resources by name in the include query parameter.
<type=users>
\nobject
The included Datadog user resource.
attributes
\nobject
Attributes of the Datadog user.
string
The email of the Datadog user.
handle
\nstring
The handle of the Datadog user.
icon
\nstring
The icon of the Datadog user.
name
\nstring
The name of the Datadog user.
uuid
\nstring
The UUID of the Datadog user.
id
\nuuid
The ID of the Datadog user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
<type=status_pages>
\nobject
The included status page resource.
attributes
\nobject
The attributes of a status page.
company_logo
\nstring
The base64-encoded image data displayed in the company logo.
components
\n[object]
Components displayed on the status page.
components
\n[object]
If the component is of type group, the components within the group.
id
\nuuid
The ID of the grouped component.
name
\nstring
The name of the grouped component.
position
\nint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component
id
\nuuid
The ID of the component.
name
\nstring
The name of the component.
position
\nint64
The zero-indexed position of the component.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component,group
created_at
\ndate-time
Timestamp of when the status page was created.
custom_domain
\nstring
If configured, the url that the status page is accessible at.
custom_domain_enabled
\nboolean
Whether the custom domain is configured.
domain_prefix
\nstring
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_image
\nstring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabled
\nboolean
Whether the status page is enabled.
favicon
\nstring
Base64-encoded image data displayed in the browser tab.
modified_at
\ndate-time
Timestamp of when the status page was last modified.
name
\nstring
The name of the status page.
page_url
\nstring
The url that the status page is accessible at.
slack_app_icon
\nstring
The Slack app icon URL for the status page.
slack_subscriptions_enabled
\nboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabled
\nboolean
Whether users can subscribe to the status page.
type
\nenum
The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal
visualization_type
\nenum
The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
id
\nuuid
The ID of the status page.
relationships
\nobject
The relationships of a status page.
created_by_user
\nobject
The Datadog user who created the status page.
data [required]
\nobject
The data object identifying the Datadog user who created the status page.
id [required]
\nstring
The ID of the Datadog user who created the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the status page.
data [required]
\nobject
The data object identifying the Datadog user who last modified the status page.
id [required]
\nstring
The ID of the Datadog user who last modified the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
data
\nobject
The data object for updating a degradation.
attributes [required]
\nobject
The supported attributes for updating a degradation.
components_affected
\n[object]
The components affected by the degradation.
id [required]
\nuuid
The ID of the component. Must be a component of type component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
description
\nstring
The description of the degradation.
status
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
title
\nstring
The title of the degradation.
id [required]
\nuuid
The ID of the degradation.
type [required]
\nenum
Degradations resource type. \nAllowed enum values: degradations
default: degradations
data
\nobject
The data object for creating a maintenance template.
attributes
\nobject
The attributes for creating a maintenance template.
completed_description
\nstring
The description shown when a maintenance created from this template is completed.
component_ids
\n[string]
The IDs of the components affected by a maintenance created from this template.
in_progress_description
\nstring
The description shown while a maintenance created from this template is in progress.
maintenance_title
\nstring
The title used for a maintenance created from this template.
name [required]
\nstring
The name of the maintenance template.
scheduled_description
\nstring
The description shown when a maintenance created from this template is scheduled.
type [required]
\nenum
Maintenance templates resource type. \nAllowed enum values: maintenance_templates
default: maintenance_templates
data
\nobject
The data object for a maintenance template.
attributes
\nobject
The attributes of a maintenance template.
completed_description
\nstring
The description shown when a maintenance created from this template is completed.
component_ids
\n[string]
The IDs of the components affected by a maintenance created from this template.
created_at
\ndate-time
Timestamp of when the maintenance template was created.
in_progress_description
\nstring
The description shown while a maintenance created from this template is in progress.
maintenance_title
\nstring
The title used for a maintenance created from this template.
modified_at
\ndate-time
Timestamp of when the maintenance template was last modified.
name
\nstring
The name of the maintenance template.
scheduled_description
\nstring
The description shown when a maintenance created from this template is scheduled.
id
\nstring
The ID of the maintenance template.
relationships
\nobject
The relationships of a maintenance template.
created_by_user
\nobject
The Datadog user who created the maintenance template.
data [required]
\nobject
The data object identifying the Datadog user who created the maintenance template.
id [required]
\nstring
The ID of the Datadog user who created the maintenance template.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the maintenance template.
data [required]
\nobject
The data object identifying the Datadog user who last modified the maintenance template.
id [required]
\nstring
The ID of the Datadog user who last modified the maintenance template.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
status_page
\nobject
The status page the maintenance template belongs to.
data [required]
\nobject
The data object identifying the status page associated with a maintenance template.
id [required]
\nstring
The ID of the status page.
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
type [required]
\nenum
Maintenance templates resource type. \nAllowed enum values: maintenance_templates
default: maintenance_templates
included
\n[ <oneOf>]
The included related resources of a maintenance template. Client must explicitly request these resources by name in the include query parameter.
<type=users>
\nobject
The included Datadog user resource.
attributes
\nobject
Attributes of the Datadog user.
string
The email of the Datadog user.
handle
\nstring
The handle of the Datadog user.
icon
\nstring
The icon of the Datadog user.
name
\nstring
The name of the Datadog user.
uuid
\nstring
The UUID of the Datadog user.
id
\nuuid
The ID of the Datadog user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
<type=status_pages>
\nobject
The included status page resource.
attributes
\nobject
The attributes of a status page.
company_logo
\nstring
The base64-encoded image data displayed in the company logo.
components
\n[object]
Components displayed on the status page.
components
\n[object]
If the component is of type group, the components within the group.
id
\nuuid
The ID of the grouped component.
name
\nstring
The name of the grouped component.
position
\nint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component
id
\nuuid
The ID of the component.
name
\nstring
The name of the component.
position
\nint64
The zero-indexed position of the component.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component,group
created_at
\ndate-time
Timestamp of when the status page was created.
custom_domain
\nstring
If configured, the url that the status page is accessible at.
custom_domain_enabled
\nboolean
Whether the custom domain is configured.
domain_prefix
\nstring
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_image
\nstring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabled
\nboolean
Whether the status page is enabled.
favicon
\nstring
Base64-encoded image data displayed in the browser tab.
modified_at
\ndate-time
Timestamp of when the status page was last modified.
name
\nstring
The name of the status page.
page_url
\nstring
The url that the status page is accessible at.
slack_app_icon
\nstring
The Slack app icon URL for the status page.
slack_subscriptions_enabled
\nboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabled
\nboolean
Whether users can subscribe to the status page.
type
\nenum
The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal
visualization_type
\nenum
The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
id
\nuuid
The ID of the status page.
relationships
\nobject
The relationships of a status page.
created_by_user
\nobject
The Datadog user who created the status page.
data [required]
\nobject
The data object identifying the Datadog user who created the status page.
id [required]
\nstring
The ID of the Datadog user who created the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the status page.
data [required]
\nobject
The data object identifying the Datadog user who last modified the status page.
id [required]
\nstring
The ID of the Datadog user who last modified the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
errors [required]
\n[string]
A list of errors.
data
\nobject
The data object for a degradation update.
attributes
\nobject
Attributes of a degradation update resource.
components_affected
\n[object]
Components affected by this update.
id [required]
\nstring
The ID of the affected component.
name
\nstring
The name of the affected component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
created_at
\ndate-time
The date and time the update was created.
deleted_at
\ndate-time
The date and time the update was soft-deleted.
description
\nstring
The message body of the update.
modified_at
\ndate-time
The date and time the update was last modified.
started_at
\ndate-time
The date and time the update started.
status
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
id
\nstring
The ID of the degradation update.
relationships
\nobject
Relationships of a degradation update resource.
created_by_user
\nobject
A user relationship of a degradation update.
data [required]
\nobject
A Datadog user linked to a degradation update.
id [required]
\nstring
The ID of the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
degradation
\nobject
The degradation relationship of a degradation update.
data [required]
\nobject
The degradation linked to a degradation update.
id [required]
\nstring
The ID of the degradation.
type [required]
\nenum
Degradations resource type. \nAllowed enum values: degradations
default: degradations
deleted_by_user
\nobject
A user relationship of a degradation update.
data [required]
\nobject
A Datadog user linked to a degradation update.
id [required]
\nstring
The ID of the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
A user relationship of a degradation update.
data [required]
\nobject
A Datadog user linked to a degradation update.
id [required]
\nstring
The ID of the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
status_page
\nobject
The status page relationship of a degradation update.
data [required]
\nobject
The status page linked to a degradation update.
id [required]
\nstring
The ID of the status page.
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
type [required]
\nenum
Degradation updates resource type. \nAllowed enum values: degradation_updates
default: degradation_updates
included
\n[ <oneOf>]
Resources related to the degradation update.
<type=users>
\nobject
The included Datadog user resource.
attributes
\nobject
Attributes of the Datadog user.
string
The email of the Datadog user.
handle
\nstring
The handle of the Datadog user.
icon
\nstring
The icon of the Datadog user.
name
\nstring
The name of the Datadog user.
uuid
\nstring
The UUID of the Datadog user.
id
\nuuid
The ID of the Datadog user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
Object 2
\nobject
Response object for a single degradation.
data
\nobject
The data object for a degradation.
attributes
\nobject
The attributes of a degradation.
components_affected
\n[object]
Components affected by the degradation.
id [required]
\nuuid
The ID of the component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
created_at
\ndate-time
Timestamp of when the degradation was created.
description
\nstring
Description of the degradation.
is_backfilled
\nboolean
Whether the degradation was backfilled.
modified_at
\ndate-time
Timestamp of when the degradation was last modified.
source
\nobject
The source of the degradation.
created_at [required]
\ndate-time
Timestamp of when the source was created.
source_id [required]
\nstring
The ID of the source.
type [required]
\nenum
The type of the source. \nAllowed enum values: incident
status
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
title
\nstring
Title of the degradation.
updates
\n[object]
Past updates made to the degradation.
components_affected
\n[object]
The components affected at the time of the update.
id [required]
\nuuid
Identifier of the component affected at the time of the update.
name
\nstring
The name of the component affected at the time of the update.
status [required]
\nenum
The status of the component affected at the time of the update. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
created_at
\ndate-time
Timestamp of when the update was created.
deleted_at
\nstring
The date and time the resource was deleted.
deleted_by_user_uuid
\nstring
UUID of the user who deleted the resource.
description
\nstring
Description of the update.
id
\nuuid
Identifier of the update.
last_modified_by_user_uuid
\nstring
UUID of the user who last modified the resource.
modified_at
\ndate-time
Timestamp of when the update was last modified.
started_at
\ndate-time
Timestamp of when the update started.
status
\nenum
The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved
id
\nuuid
The ID of the degradation.
relationships
\nobject
The relationships of a degradation.
created_by_user
\nobject
The Datadog user who created the degradation.
data [required]
\nobject
The data object identifying the Datadog user who created the degradation.
id [required]
\nstring
The ID of the Datadog user who created the degradation.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the degradation.
data [required]
\nobject
The data object identifying the Datadog user who last modified the degradation.
id [required]
\nstring
The ID of the Datadog user who last modified the degradation.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
status_page
\nobject
The status page the degradation belongs to.
data [required]
\nobject
The data object identifying the status page the degradation belongs to.
id [required]
\nuuid
The ID of the status page.
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
type [required]
\nenum
Degradations resource type. \nAllowed enum values: degradations
default: degradations
included
\n[ <oneOf>]
The included related resources of a degradation. Client must explicitly request these resources by name in the include query parameter.
<type=users>
\nobject
The included Datadog user resource.
attributes
\nobject
Attributes of the Datadog user.
string
The email of the Datadog user.
handle
\nstring
The handle of the Datadog user.
icon
\nstring
The icon of the Datadog user.
name
\nstring
The name of the Datadog user.
uuid
\nstring
The UUID of the Datadog user.
id
\nuuid
The ID of the Datadog user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
<type=status_pages>
\nobject
The included status page resource.
attributes
\nobject
The attributes of a status page.
company_logo
\nstring
The base64-encoded image data displayed in the company logo.
components
\n[object]
Components displayed on the status page.
components
\n[object]
If the component is of type group, the components within the group.
id
\nuuid
The ID of the grouped component.
name
\nstring
The name of the grouped component.
position
\nint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component
id
\nuuid
The ID of the component.
name
\nstring
The name of the component.
position
\nint64
The zero-indexed position of the component.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component,group
created_at
\ndate-time
Timestamp of when the status page was created.
custom_domain
\nstring
If configured, the url that the status page is accessible at.
custom_domain_enabled
\nboolean
Whether the custom domain is configured.
domain_prefix
\nstring
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_image
\nstring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabled
\nboolean
Whether the status page is enabled.
favicon
\nstring
Base64-encoded image data displayed in the browser tab.
modified_at
\ndate-time
Timestamp of when the status page was last modified.
name
\nstring
The name of the status page.
page_url
\nstring
The url that the status page is accessible at.
slack_app_icon
\nstring
The Slack app icon URL for the status page.
slack_subscriptions_enabled
\nboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabled
\nboolean
Whether users can subscribe to the status page.
type
\nenum
The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal
visualization_type
\nenum
The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
id
\nuuid
The ID of the status page.
relationships
\nobject
The relationships of a status page.
created_by_user
\nobject
The Datadog user who created the status page.
data [required]
\nobject
The data object identifying the Datadog user who created the status page.
id [required]
\nstring
The ID of the Datadog user who created the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the status page.
data [required]
\nobject
The data object identifying the Datadog user who last modified the status page.
id [required]
\nstring
The ID of the Datadog user who last modified the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
<type=status_pages>
\nobject
The included status page resource.
attributes
\nobject
The attributes of a status page.
company_logo
\nstring
The base64-encoded image data displayed in the company logo.
components
\n[object]
Components displayed on the status page.
components
\n[object]
If the component is of type group, the components within the group.
id
\nuuid
The ID of the grouped component.
name
\nstring
The name of the grouped component.
position
\nint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component
id
\nuuid
The ID of the component.
name
\nstring
The name of the component.
position
\nint64
The zero-indexed position of the component.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component,group
created_at
\ndate-time
Timestamp of when the status page was created.
custom_domain
\nstring
If configured, the url that the status page is accessible at.
custom_domain_enabled
\nboolean
Whether the custom domain is configured.
domain_prefix
\nstring
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_image
\nstring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabled
\nboolean
Whether the status page is enabled.
favicon
\nstring
Base64-encoded image data displayed in the browser tab.
modified_at
\ndate-time
Timestamp of when the status page was last modified.
name
\nstring
The name of the status page.
page_url
\nstring
The url that the status page is accessible at.
slack_app_icon
\nstring
The Slack app icon URL for the status page.
slack_subscriptions_enabled
\nboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabled
\nboolean
Whether users can subscribe to the status page.
type
\nenum
The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal
visualization_type
\nenum
The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
id
\nuuid
The ID of the status page.
relationships
\nobject
The relationships of a status page.
created_by_user
\nobject
The Datadog user who created the status page.
data [required]
\nobject
The data object identifying the Datadog user who created the status page.
id [required]
\nstring
The ID of the Datadog user who created the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the status page.
data [required]
\nobject
The data object identifying the Datadog user who last modified the status page.
id [required]
\nstring
The ID of the Datadog user who last modified the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
data
\nobject
The data object for a maintenance template.
attributes
\nobject
The attributes of a maintenance template.
completed_description
\nstring
The description shown when a maintenance created from this template is completed.
component_ids
\n[string]
The IDs of the components affected by a maintenance created from this template.
created_at
\ndate-time
Timestamp of when the maintenance template was created.
in_progress_description
\nstring
The description shown while a maintenance created from this template is in progress.
maintenance_title
\nstring
The title used for a maintenance created from this template.
modified_at
\ndate-time
Timestamp of when the maintenance template was last modified.
name
\nstring
The name of the maintenance template.
scheduled_description
\nstring
The description shown when a maintenance created from this template is scheduled.
id
\nstring
The ID of the maintenance template.
relationships
\nobject
The relationships of a maintenance template.
created_by_user
\nobject
The Datadog user who created the maintenance template.
data [required]
\nobject
The data object identifying the Datadog user who created the maintenance template.
id [required]
\nstring
The ID of the Datadog user who created the maintenance template.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the maintenance template.
data [required]
\nobject
The data object identifying the Datadog user who last modified the maintenance template.
id [required]
\nstring
The ID of the Datadog user who last modified the maintenance template.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
status_page
\nobject
The status page the maintenance template belongs to.
data [required]
\nobject
The data object identifying the status page associated with a maintenance template.
id [required]
\nstring
The ID of the status page.
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
type [required]
\nenum
Maintenance templates resource type. \nAllowed enum values: maintenance_templates
default: maintenance_templates
included
\n[ <oneOf>]
The included related resources of a maintenance template. Client must explicitly request these resources by name in the include query parameter.
<type=users>
\nobject
The included Datadog user resource.
attributes
\nobject
Attributes of the Datadog user.
string
The email of the Datadog user.
handle
\nstring
The handle of the Datadog user.
icon
\nstring
The icon of the Datadog user.
name
\nstring
The name of the Datadog user.
uuid
\nstring
The UUID of the Datadog user.
id
\nuuid
The ID of the Datadog user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
<type=status_pages>
\nobject
The included status page resource.
attributes
\nobject
The attributes of a status page.
company_logo
\nstring
The base64-encoded image data displayed in the company logo.
components
\n[object]
Components displayed on the status page.
components
\n[object]
If the component is of type group, the components within the group.
id
\nuuid
The ID of the grouped component.
name
\nstring
The name of the grouped component.
position
\nint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component
id
\nuuid
The ID of the component.
name
\nstring
The name of the component.
position
\nint64
The zero-indexed position of the component.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component,group
created_at
\ndate-time
Timestamp of when the status page was created.
custom_domain
\nstring
If configured, the url that the status page is accessible at.
custom_domain_enabled
\nboolean
Whether the custom domain is configured.
domain_prefix
\nstring
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_image
\nstring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabled
\nboolean
Whether the status page is enabled.
favicon
\nstring
Base64-encoded image data displayed in the browser tab.
modified_at
\ndate-time
Timestamp of when the status page was last modified.
name
\nstring
The name of the status page.
page_url
\nstring
The url that the status page is accessible at.
slack_app_icon
\nstring
The Slack app icon URL for the status page.
slack_subscriptions_enabled
\nboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabled
\nboolean
Whether users can subscribe to the status page.
type
\nenum
The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal
visualization_type
\nenum
The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
id
\nuuid
The ID of the status page.
relationships
\nobject
The relationships of a status page.
created_by_user
\nobject
The Datadog user who created the status page.
data [required]
\nobject
The data object identifying the Datadog user who created the status page.
id [required]
\nstring
The ID of the Datadog user who created the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the status page.
data [required]
\nobject
The data object identifying the Datadog user who last modified the status page.
id [required]
\nstring
The ID of the Datadog user who last modified the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
data
\nobject
The data object for editing a degradation update.
attributes
\nobject
Attributes for editing a degradation update.
description
\nstring
The message body of the update.
status
\nenum
The status of the degradation update. \nAllowed enum values: investigating,identified,monitoring
id
\nstring
The ID of the degradation update to edit.
type [required]
\nenum
Degradation updates resource type. \nAllowed enum values: degradation_updates
default: degradation_updates
data
\nobject
The data object for updating a maintenance template.
attributes
\nobject
The supported attributes for updating a maintenance template.
completed_description
\nstring
The description shown when a maintenance created from this template is completed.
component_ids
\n[string]
The IDs of the components affected by a maintenance created from this template.
in_progress_description
\nstring
The description shown while a maintenance created from this template is in progress.
maintenance_title
\nstring
The title used for a maintenance created from this template.
name
\nstring
The name of the maintenance template.
scheduled_description
\nstring
The description shown when a maintenance created from this template is scheduled.
id [required]
\nstring
The ID of the maintenance template.
type [required]
\nenum
Maintenance templates resource type. \nAllowed enum values: maintenance_templates
default: maintenance_templates
data
\nobject
The data object for a maintenance.
attributes
\nobject
The attributes of a maintenance.
completed_date
\ndate-time
Timestamp of when the maintenance was completed.
completed_description
\nstring
The description shown when the maintenance is completed.
components_affected
\n[object]
Components affected by the maintenance.
id [required]
\nuuid
The ID of the component. Must be a component of type component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,maintenance
in_progress_description
\nstring
The description shown while the maintenance is in progress.
is_backfilled
\nboolean
Whether the maintenance was backfilled.
modified_at
\ndate-time
Timestamp of when the maintenance was last modified.
published_date
\ndate-time
Timestamp of when the maintenance was published.
scheduled_description
\nstring
The description shown when the maintenance is scheduled.
start_date
\ndate-time
Timestamp of when the maintenance is scheduled to start.
status
\nenum
The status of the maintenance. \nAllowed enum values: scheduled,in_progress,completed
title
\nstring
Title of the maintenance.
updates
\n[object]
Past updates made to the maintenance.
components_affected
\n[object]
The components affected at the time of the update.
id [required]
\nuuid
Identifier of the component affected at the time of the update.
name
\nstring
The name of the component affected at the time of the update.
status [required]
\nenum
The status of the component affected at the time of the update. \nAllowed enum values: operational,maintenance
created_at
\ndate-time
Timestamp of when the update was created.
description
\nstring
Description of the update.
id
\nuuid
Identifier of the update.
manual_transition
\nboolean
Whether the update was applied manually by a user (true) or automatically by the system (false).
modified_at
\ndate-time
Timestamp of when the update was last modified.
started_at
\ndate-time
Timestamp of when the update started.
status
\nstring
The status of the update.
id
\nuuid
The ID of the maintenance.
relationships
\nobject
The relationships of a maintenance.
created_by_user
\nobject
The Datadog user who created the maintenance.
data [required]
\nobject
The data object identifying the Datadog user who created the maintenance.
id [required]
\nuuid
The ID of the Datadog user who created the maintenance.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the maintenance.
data [required]
\nobject
The data object identifying the Datadog user who last modified the maintenance.
id [required]
\nuuid
The ID of the Datadog user who last modified the maintenance.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
status_page
\nobject
The status page the maintenance belongs to.
data [required]
\nobject
The data object identifying the status page associated with a maintenance.
id [required]
\nuuid
The ID of the status page.
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
type [required]
\nenum
Maintenances resource type. \nAllowed enum values: maintenances
default: maintenances
included
\n[ <oneOf>]
The included related resources of a maintenance. Client must explicitly request these resources by name in the include query parameter.
<type=users>
\nobject
The included Datadog user resource.
attributes
\nobject
Attributes of the Datadog user.
string
The email of the Datadog user.
handle
\nstring
The handle of the Datadog user.
icon
\nstring
The icon of the Datadog user.
name
\nstring
The name of the Datadog user.
uuid
\nstring
The UUID of the Datadog user.
id
\nuuid
The ID of the Datadog user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
<type=status_pages>
\nobject
The included status page resource.
attributes
\nobject
The attributes of a status page.
company_logo
\nstring
The base64-encoded image data displayed in the company logo.
components
\n[object]
Components displayed on the status page.
components
\n[object]
If the component is of type group, the components within the group.
id
\nuuid
The ID of the grouped component.
name
\nstring
The name of the grouped component.
position
\nint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component
id
\nuuid
The ID of the component.
name
\nstring
The name of the component.
position
\nint64
The zero-indexed position of the component.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component,group
created_at
\ndate-time
Timestamp of when the status page was created.
custom_domain
\nstring
If configured, the url that the status page is accessible at.
custom_domain_enabled
\nboolean
Whether the custom domain is configured.
domain_prefix
\nstring
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_image
\nstring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabled
\nboolean
Whether the status page is enabled.
favicon
\nstring
Base64-encoded image data displayed in the browser tab.
modified_at
\ndate-time
Timestamp of when the status page was last modified.
name
\nstring
The name of the status page.
page_url
\nstring
The url that the status page is accessible at.
slack_app_icon
\nstring
The Slack app icon URL for the status page.
slack_subscriptions_enabled
\nboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabled
\nboolean
Whether users can subscribe to the status page.
type
\nenum
The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal
visualization_type
\nenum
The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
id
\nuuid
The ID of the status page.
relationships
\nobject
The relationships of a status page.
created_by_user
\nobject
The Datadog user who created the status page.
data [required]
\nobject
The data object identifying the Datadog user who created the status page.
id [required]
\nstring
The ID of the Datadog user who created the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the status page.
data [required]
\nobject
The data object identifying the Datadog user who last modified the status page.
id [required]
\nstring
The ID of the Datadog user who last modified the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
data
\nobject
The data object for a maintenance.
attributes
\nobject
The attributes of a maintenance.
completed_date
\ndate-time
Timestamp of when the maintenance was completed.
completed_description
\nstring
The description shown when the maintenance is completed.
components_affected
\n[object]
Components affected by the maintenance.
id [required]
\nuuid
The ID of the component. Must be a component of type component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,maintenance
in_progress_description
\nstring
The description shown while the maintenance is in progress.
is_backfilled
\nboolean
Whether the maintenance was backfilled.
modified_at
\ndate-time
Timestamp of when the maintenance was last modified.
published_date
\ndate-time
Timestamp of when the maintenance was published.
scheduled_description
\nstring
The description shown when the maintenance is scheduled.
start_date
\ndate-time
Timestamp of when the maintenance is scheduled to start.
status
\nenum
The status of the maintenance. \nAllowed enum values: scheduled,in_progress,completed
title
\nstring
Title of the maintenance.
updates
\n[object]
Past updates made to the maintenance.
components_affected
\n[object]
The components affected at the time of the update.
id [required]
\nuuid
Identifier of the component affected at the time of the update.
name
\nstring
The name of the component affected at the time of the update.
status [required]
\nenum
The status of the component affected at the time of the update. \nAllowed enum values: operational,maintenance
created_at
\ndate-time
Timestamp of when the update was created.
description
\nstring
Description of the update.
id
\nuuid
Identifier of the update.
manual_transition
\nboolean
Whether the update was applied manually by a user (true) or automatically by the system (false).
modified_at
\ndate-time
Timestamp of when the update was last modified.
started_at
\ndate-time
Timestamp of when the update started.
status
\nstring
The status of the update.
id
\nuuid
The ID of the maintenance.
relationships
\nobject
The relationships of a maintenance.
created_by_user
\nobject
The Datadog user who created the maintenance.
data [required]
\nobject
The data object identifying the Datadog user who created the maintenance.
id [required]
\nuuid
The ID of the Datadog user who created the maintenance.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the maintenance.
data [required]
\nobject
The data object identifying the Datadog user who last modified the maintenance.
id [required]
\nuuid
The ID of the Datadog user who last modified the maintenance.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
status_page
\nobject
The status page the maintenance belongs to.
data [required]
\nobject
The data object identifying the status page associated with a maintenance.
id [required]
\nuuid
The ID of the status page.
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
template
\nobject
The template the maintenance was created from.
data [required]
\nobject
The data object identifying the template the maintenance was created from.
id [required]
\nstring
The ID of the maintenance template.
type [required]
\nenum
Maintenance templates resource type. \nAllowed enum values: maintenance_templates
default: maintenance_templates
type [required]
\nenum
Maintenances resource type. \nAllowed enum values: maintenances
default: maintenances
included
\n[ <oneOf>]
The included related resources of a maintenance. Client must explicitly request these resources by name in the include query parameter.
<type=users>
\nobject
The included Datadog user resource.
attributes
\nobject
Attributes of the Datadog user.
string
The email of the Datadog user.
handle
\nstring
The handle of the Datadog user.
icon
\nstring
The icon of the Datadog user.
name
\nstring
The name of the Datadog user.
uuid
\nstring
The UUID of the Datadog user.
id
\nuuid
The ID of the Datadog user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
<type=status_pages>
\nobject
The included status page resource.
attributes
\nobject
The attributes of a status page.
company_logo
\nstring
The base64-encoded image data displayed in the company logo.
components
\n[object]
Components displayed on the status page.
components
\n[object]
If the component is of type group, the components within the group.
id
\nuuid
The ID of the grouped component.
name
\nstring
The name of the grouped component.
position
\nint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component
id
\nuuid
The ID of the component.
name
\nstring
The name of the component.
position
\nint64
The zero-indexed position of the component.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component,group
created_at
\ndate-time
Timestamp of when the status page was created.
custom_domain
\nstring
If configured, the url that the status page is accessible at.
custom_domain_enabled
\nboolean
Whether the custom domain is configured.
domain_prefix
\nstring
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_image
\nstring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabled
\nboolean
Whether the status page is enabled.
favicon
\nstring
Base64-encoded image data displayed in the browser tab.
modified_at
\ndate-time
Timestamp of when the status page was last modified.
name
\nstring
The name of the status page.
page_url
\nstring
The url that the status page is accessible at.
slack_app_icon
\nstring
The Slack app icon URL for the status page.
slack_subscriptions_enabled
\nboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabled
\nboolean
Whether users can subscribe to the status page.
type
\nenum
The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal
visualization_type
\nenum
The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
id
\nuuid
The ID of the status page.
relationships
\nobject
The relationships of a status page.
created_by_user
\nobject
The Datadog user who created the status page.
data [required]
\nobject
The data object identifying the Datadog user who created the status page.
id [required]
\nstring
The ID of the Datadog user who created the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the status page.
data [required]
\nobject
The data object identifying the Datadog user who last modified the status page.
id [required]
\nstring
The ID of the Datadog user who last modified the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
data
\nobject
The data object for creating a maintenance.
attributes [required]
\nobject
The supported attributes for creating a maintenance.
completed_date [required]
\ndate-time
Timestamp of when the maintenance was completed.
completed_description [required]
\nstring
The description shown when the maintenance is completed.
components_affected
\n[object]
The components affected by the maintenance.
id [required]
\nuuid
The ID of the component. Must be a component of type component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,maintenance
in_progress_description [required]
\nstring
The description shown while the maintenance is in progress.
scheduled_description [required]
\nstring
The description shown when the maintenance is scheduled.
start_date [required]
\ndate-time
Timestamp of when the maintenance is scheduled to start.
title [required]
\nstring
The title of the maintenance.
type [required]
\nenum
Maintenances resource type. \nAllowed enum values: maintenances
default: maintenances
data
\nobject
The data object for creating a maintenance.
attributes [required]
\nobject
The supported attributes for creating a maintenance.
completed_date [required]
\ndate-time
Timestamp of when the maintenance was completed.
completed_description [required]
\nstring
The description shown when the maintenance is completed.
components_affected
\n[object]
The components affected by the maintenance.
id [required]
\nuuid
The ID of the component. Must be a component of type component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,maintenance
in_progress_description [required]
\nstring
The description shown while the maintenance is in progress.
scheduled_description [required]
\nstring
The description shown when the maintenance is scheduled.
start_date [required]
\ndate-time
Timestamp of when the maintenance is scheduled to start.
title [required]
\nstring
The title of the maintenance.
relationships
\nobject
The supported relationships for creating a maintenance.
template
\nobject
The template used to create the maintenance.
data [required]
\nobject
The data object identifying the template used to create the maintenance.
id [required]
\nstring
The ID of the maintenance template.
type [required]
\nenum
Maintenance templates resource type. \nAllowed enum values: maintenance_templates
default: maintenance_templates
type [required]
\nenum
Maintenances resource type. \nAllowed enum values: maintenances
default: maintenances
data
\nobject
The data object for a maintenance.
attributes
\nobject
The attributes of a maintenance.
completed_date
\ndate-time
Timestamp of when the maintenance was completed.
completed_description
\nstring
The description shown when the maintenance is completed.
components_affected
\n[object]
Components affected by the maintenance.
id [required]
\nuuid
The ID of the component. Must be a component of type component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,maintenance
in_progress_description
\nstring
The description shown while the maintenance is in progress.
is_backfilled
\nboolean
Whether the maintenance was backfilled.
modified_at
\ndate-time
Timestamp of when the maintenance was last modified.
published_date
\ndate-time
Timestamp of when the maintenance was published.
scheduled_description
\nstring
The description shown when the maintenance is scheduled.
start_date
\ndate-time
Timestamp of when the maintenance is scheduled to start.
status
\nenum
The status of the maintenance. \nAllowed enum values: scheduled,in_progress,completed
title
\nstring
Title of the maintenance.
updates
\n[object]
Past updates made to the maintenance.
components_affected
\n[object]
The components affected at the time of the update.
id [required]
\nuuid
Identifier of the component affected at the time of the update.
name
\nstring
The name of the component affected at the time of the update.
status [required]
\nenum
The status of the component affected at the time of the update. \nAllowed enum values: operational,maintenance
created_at
\ndate-time
Timestamp of when the update was created.
description
\nstring
Description of the update.
id
\nuuid
Identifier of the update.
manual_transition
\nboolean
Whether the update was applied manually by a user (true) or automatically by the system (false).
modified_at
\ndate-time
Timestamp of when the update was last modified.
started_at
\ndate-time
Timestamp of when the update started.
status
\nstring
The status of the update.
id
\nuuid
The ID of the maintenance.
relationships
\nobject
The relationships of a maintenance.
created_by_user
\nobject
The Datadog user who created the maintenance.
data [required]
\nobject
The data object identifying the Datadog user who created the maintenance.
id [required]
\nuuid
The ID of the Datadog user who created the maintenance.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the maintenance.
data [required]
\nobject
The data object identifying the Datadog user who last modified the maintenance.
id [required]
\nuuid
The ID of the Datadog user who last modified the maintenance.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
status_page
\nobject
The status page the maintenance belongs to.
data [required]
\nobject
The data object identifying the status page associated with a maintenance.
id [required]
\nuuid
The ID of the status page.
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
type [required]
\nenum
Maintenances resource type. \nAllowed enum values: maintenances
default: maintenances
included
\n[ <oneOf>]
The included related resources of a maintenance. Client must explicitly request these resources by name in the include query parameter.
<type=users>
\nobject
The included Datadog user resource.
attributes
\nobject
Attributes of the Datadog user.
string
The email of the Datadog user.
handle
\nstring
The handle of the Datadog user.
icon
\nstring
The icon of the Datadog user.
name
\nstring
The name of the Datadog user.
uuid
\nstring
The UUID of the Datadog user.
id
\nuuid
The ID of the Datadog user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
<type=status_pages>
\nobject
The included status page resource.
attributes
\nobject
The attributes of a status page.
company_logo
\nstring
The base64-encoded image data displayed in the company logo.
components
\n[object]
Components displayed on the status page.
components
\n[object]
If the component is of type group, the components within the group.
id
\nuuid
The ID of the grouped component.
name
\nstring
The name of the grouped component.
position
\nint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component
id
\nuuid
The ID of the component.
name
\nstring
The name of the component.
position
\nint64
The zero-indexed position of the component.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component,group
created_at
\ndate-time
Timestamp of when the status page was created.
custom_domain
\nstring
If configured, the url that the status page is accessible at.
custom_domain_enabled
\nboolean
Whether the custom domain is configured.
domain_prefix
\nstring
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_image
\nstring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabled
\nboolean
Whether the status page is enabled.
favicon
\nstring
Base64-encoded image data displayed in the browser tab.
modified_at
\ndate-time
Timestamp of when the status page was last modified.
name
\nstring
The name of the status page.
page_url
\nstring
The url that the status page is accessible at.
slack_app_icon
\nstring
The Slack app icon URL for the status page.
slack_subscriptions_enabled
\nboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabled
\nboolean
Whether users can subscribe to the status page.
type
\nenum
The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal
visualization_type
\nenum
The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
id
\nuuid
The ID of the status page.
relationships
\nobject
The relationships of a status page.
created_by_user
\nobject
The Datadog user who created the status page.
data [required]
\nobject
The data object identifying the Datadog user who created the status page.
id [required]
\nstring
The ID of the Datadog user who created the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the status page.
data [required]
\nobject
The data object identifying the Datadog user who last modified the status page.
id [required]
\nstring
The ID of the Datadog user who last modified the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
data
\nobject
The data object for a maintenance.
attributes
\nobject
The attributes of a maintenance.
completed_date
\ndate-time
Timestamp of when the maintenance was completed.
completed_description
\nstring
The description shown when the maintenance is completed.
components_affected
\n[object]
Components affected by the maintenance.
id [required]
\nuuid
The ID of the component. Must be a component of type component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,maintenance
in_progress_description
\nstring
The description shown while the maintenance is in progress.
is_backfilled
\nboolean
Whether the maintenance was backfilled.
modified_at
\ndate-time
Timestamp of when the maintenance was last modified.
published_date
\ndate-time
Timestamp of when the maintenance was published.
scheduled_description
\nstring
The description shown when the maintenance is scheduled.
start_date
\ndate-time
Timestamp of when the maintenance is scheduled to start.
status
\nenum
The status of the maintenance. \nAllowed enum values: scheduled,in_progress,completed
title
\nstring
Title of the maintenance.
updates
\n[object]
Past updates made to the maintenance.
components_affected
\n[object]
The components affected at the time of the update.
id [required]
\nuuid
Identifier of the component affected at the time of the update.
name
\nstring
The name of the component affected at the time of the update.
status [required]
\nenum
The status of the component affected at the time of the update. \nAllowed enum values: operational,maintenance
created_at
\ndate-time
Timestamp of when the update was created.
description
\nstring
Description of the update.
id
\nuuid
Identifier of the update.
manual_transition
\nboolean
Whether the update was applied manually by a user (true) or automatically by the system (false).
modified_at
\ndate-time
Timestamp of when the update was last modified.
started_at
\ndate-time
Timestamp of when the update started.
status
\nstring
The status of the update.
id
\nuuid
The ID of the maintenance.
relationships
\nobject
The relationships of a maintenance.
created_by_user
\nobject
The Datadog user who created the maintenance.
data [required]
\nobject
The data object identifying the Datadog user who created the maintenance.
id [required]
\nuuid
The ID of the Datadog user who created the maintenance.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the maintenance.
data [required]
\nobject
The data object identifying the Datadog user who last modified the maintenance.
id [required]
\nuuid
The ID of the Datadog user who last modified the maintenance.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
status_page
\nobject
The status page the maintenance belongs to.
data [required]
\nobject
The data object identifying the status page associated with a maintenance.
id [required]
\nuuid
The ID of the status page.
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
template
\nobject
The template the maintenance was created from.
data [required]
\nobject
The data object identifying the template the maintenance was created from.
id [required]
\nstring
The ID of the maintenance template.
type [required]
\nenum
Maintenance templates resource type. \nAllowed enum values: maintenance_templates
default: maintenance_templates
type [required]
\nenum
Maintenances resource type. \nAllowed enum values: maintenances
default: maintenances
included
\n[ <oneOf>]
The included related resources of a maintenance. Client must explicitly request these resources by name in the include query parameter.
<type=users>
\nobject
The included Datadog user resource.
attributes
\nobject
Attributes of the Datadog user.
string
The email of the Datadog user.
handle
\nstring
The handle of the Datadog user.
icon
\nstring
The icon of the Datadog user.
name
\nstring
The name of the Datadog user.
uuid
\nstring
The UUID of the Datadog user.
id
\nuuid
The ID of the Datadog user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
<type=status_pages>
\nobject
The included status page resource.
attributes
\nobject
The attributes of a status page.
company_logo
\nstring
The base64-encoded image data displayed in the company logo.
components
\n[object]
Components displayed on the status page.
components
\n[object]
If the component is of type group, the components within the group.
id
\nuuid
The ID of the grouped component.
name
\nstring
The name of the grouped component.
position
\nint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component
id
\nuuid
The ID of the component.
name
\nstring
The name of the component.
position
\nint64
The zero-indexed position of the component.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component,group
created_at
\ndate-time
Timestamp of when the status page was created.
custom_domain
\nstring
If configured, the url that the status page is accessible at.
custom_domain_enabled
\nboolean
Whether the custom domain is configured.
domain_prefix
\nstring
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_image
\nstring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabled
\nboolean
Whether the status page is enabled.
favicon
\nstring
Base64-encoded image data displayed in the browser tab.
modified_at
\ndate-time
Timestamp of when the status page was last modified.
name
\nstring
The name of the status page.
page_url
\nstring
The url that the status page is accessible at.
slack_app_icon
\nstring
The Slack app icon URL for the status page.
slack_subscriptions_enabled
\nboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabled
\nboolean
Whether users can subscribe to the status page.
type
\nenum
The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal
visualization_type
\nenum
The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
id
\nuuid
The ID of the status page.
relationships
\nobject
The relationships of a status page.
created_by_user
\nobject
The Datadog user who created the status page.
data [required]
\nobject
The data object identifying the Datadog user who created the status page.
id [required]
\nstring
The ID of the Datadog user who created the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the status page.
data [required]
\nobject
The data object identifying the Datadog user who last modified the status page.
id [required]
\nstring
The ID of the Datadog user who last modified the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
data
\nobject
The data object for creating a backfilled maintenance.
attributes
\nobject
The supported attributes for creating a backfilled maintenance.
title [required]
\nstring
The title of the backfilled maintenance.
updates [required]
\n[object]
The list of updates. Exactly two updates are required: the start (in_progress) and the end (completed).
components_affected
\n[object]
The components affected.
id [required]
\nuuid
The ID of the component. Must be a component of type component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,maintenance
description [required]
\nstring
A description of the update.
started_at [required]
\ndate-time
Timestamp of when the update occurred.
status [required]
\nenum
The status of a maintenance update. \nAllowed enum values: in_progress,completed
type [required]
\nenum
Maintenances resource type. \nAllowed enum values: maintenances
default: maintenances
data
\nobject
The data object for creating a backfilled maintenance.
attributes
\nobject
The supported attributes for creating a backfilled maintenance.
title [required]
\nstring
The title of the backfilled maintenance.
updates [required]
\n[object]
The list of updates. Exactly two updates are required: the start (in_progress) and the end (completed).
components_affected
\n[object]
The components affected.
id [required]
\nuuid
The ID of the component. Must be a component of type component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,maintenance
description [required]
\nstring
A description of the update.
started_at [required]
\ndate-time
Timestamp of when the update occurred.
status [required]
\nenum
The status of a maintenance update. \nAllowed enum values: in_progress,completed
relationships
\nobject
The supported relationships for creating a backfilled maintenance.
template
\nobject
The template used to create the backfilled maintenance.
data [required]
\nobject
The data object identifying the template used to create the backfilled maintenance.
id [required]
\nstring
The ID of the maintenance template.
type [required]
\nenum
Maintenance templates resource type. \nAllowed enum values: maintenance_templates
default: maintenance_templates
type [required]
\nenum
Maintenances resource type. \nAllowed enum values: maintenances
default: maintenances
data
\nobject
The data object for a maintenance.
attributes
\nobject
The attributes of a maintenance.
completed_date
\ndate-time
Timestamp of when the maintenance was completed.
completed_description
\nstring
The description shown when the maintenance is completed.
components_affected
\n[object]
Components affected by the maintenance.
id [required]
\nuuid
The ID of the component. Must be a component of type component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,maintenance
in_progress_description
\nstring
The description shown while the maintenance is in progress.
is_backfilled
\nboolean
Whether the maintenance was backfilled.
modified_at
\ndate-time
Timestamp of when the maintenance was last modified.
published_date
\ndate-time
Timestamp of when the maintenance was published.
scheduled_description
\nstring
The description shown when the maintenance is scheduled.
start_date
\ndate-time
Timestamp of when the maintenance is scheduled to start.
status
\nenum
The status of the maintenance. \nAllowed enum values: scheduled,in_progress,completed
title
\nstring
Title of the maintenance.
updates
\n[object]
Past updates made to the maintenance.
components_affected
\n[object]
The components affected at the time of the update.
id [required]
\nuuid
Identifier of the component affected at the time of the update.
name
\nstring
The name of the component affected at the time of the update.
status [required]
\nenum
The status of the component affected at the time of the update. \nAllowed enum values: operational,maintenance
created_at
\ndate-time
Timestamp of when the update was created.
description
\nstring
Description of the update.
id
\nuuid
Identifier of the update.
manual_transition
\nboolean
Whether the update was applied manually by a user (true) or automatically by the system (false).
modified_at
\ndate-time
Timestamp of when the update was last modified.
started_at
\ndate-time
Timestamp of when the update started.
status
\nstring
The status of the update.
id
\nuuid
The ID of the maintenance.
relationships
\nobject
The relationships of a maintenance.
created_by_user
\nobject
The Datadog user who created the maintenance.
data [required]
\nobject
The data object identifying the Datadog user who created the maintenance.
id [required]
\nuuid
The ID of the Datadog user who created the maintenance.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the maintenance.
data [required]
\nobject
The data object identifying the Datadog user who last modified the maintenance.
id [required]
\nuuid
The ID of the Datadog user who last modified the maintenance.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
status_page
\nobject
The status page the maintenance belongs to.
data [required]
\nobject
The data object identifying the status page associated with a maintenance.
id [required]
\nuuid
The ID of the status page.
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
type [required]
\nenum
Maintenances resource type. \nAllowed enum values: maintenances
default: maintenances
included
\n[ <oneOf>]
The included related resources of a maintenance. Client must explicitly request these resources by name in the include query parameter.
<type=users>
\nobject
The included Datadog user resource.
attributes
\nobject
Attributes of the Datadog user.
string
The email of the Datadog user.
handle
\nstring
The handle of the Datadog user.
icon
\nstring
The icon of the Datadog user.
name
\nstring
The name of the Datadog user.
uuid
\nstring
The UUID of the Datadog user.
id
\nuuid
The ID of the Datadog user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
<type=status_pages>
\nobject
The included status page resource.
attributes
\nobject
The attributes of a status page.
company_logo
\nstring
The base64-encoded image data displayed in the company logo.
components
\n[object]
Components displayed on the status page.
components
\n[object]
If the component is of type group, the components within the group.
id
\nuuid
The ID of the grouped component.
name
\nstring
The name of the grouped component.
position
\nint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component
id
\nuuid
The ID of the component.
name
\nstring
The name of the component.
position
\nint64
The zero-indexed position of the component.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component,group
created_at
\ndate-time
Timestamp of when the status page was created.
custom_domain
\nstring
If configured, the url that the status page is accessible at.
custom_domain_enabled
\nboolean
Whether the custom domain is configured.
domain_prefix
\nstring
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_image
\nstring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabled
\nboolean
Whether the status page is enabled.
favicon
\nstring
Base64-encoded image data displayed in the browser tab.
modified_at
\ndate-time
Timestamp of when the status page was last modified.
name
\nstring
The name of the status page.
page_url
\nstring
The url that the status page is accessible at.
slack_app_icon
\nstring
The Slack app icon URL for the status page.
slack_subscriptions_enabled
\nboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabled
\nboolean
Whether users can subscribe to the status page.
type
\nenum
The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal
visualization_type
\nenum
The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
id
\nuuid
The ID of the status page.
relationships
\nobject
The relationships of a status page.
created_by_user
\nobject
The Datadog user who created the status page.
data [required]
\nobject
The data object identifying the Datadog user who created the status page.
id [required]
\nstring
The ID of the Datadog user who created the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the status page.
data [required]
\nobject
The data object identifying the Datadog user who last modified the status page.
id [required]
\nstring
The ID of the Datadog user who last modified the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
data
\nobject
The data object for a maintenance.
attributes
\nobject
The attributes of a maintenance.
completed_date
\ndate-time
Timestamp of when the maintenance was completed.
completed_description
\nstring
The description shown when the maintenance is completed.
components_affected
\n[object]
Components affected by the maintenance.
id [required]
\nuuid
The ID of the component. Must be a component of type component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,maintenance
in_progress_description
\nstring
The description shown while the maintenance is in progress.
is_backfilled
\nboolean
Whether the maintenance was backfilled.
modified_at
\ndate-time
Timestamp of when the maintenance was last modified.
published_date
\ndate-time
Timestamp of when the maintenance was published.
scheduled_description
\nstring
The description shown when the maintenance is scheduled.
start_date
\ndate-time
Timestamp of when the maintenance is scheduled to start.
status
\nenum
The status of the maintenance. \nAllowed enum values: scheduled,in_progress,completed
title
\nstring
Title of the maintenance.
updates
\n[object]
Past updates made to the maintenance.
components_affected
\n[object]
The components affected at the time of the update.
id [required]
\nuuid
Identifier of the component affected at the time of the update.
name
\nstring
The name of the component affected at the time of the update.
status [required]
\nenum
The status of the component affected at the time of the update. \nAllowed enum values: operational,maintenance
created_at
\ndate-time
Timestamp of when the update was created.
description
\nstring
Description of the update.
id
\nuuid
Identifier of the update.
manual_transition
\nboolean
Whether the update was applied manually by a user (true) or automatically by the system (false).
modified_at
\ndate-time
Timestamp of when the update was last modified.
started_at
\ndate-time
Timestamp of when the update started.
status
\nstring
The status of the update.
id
\nuuid
The ID of the maintenance.
relationships
\nobject
The relationships of a maintenance.
created_by_user
\nobject
The Datadog user who created the maintenance.
data [required]
\nobject
The data object identifying the Datadog user who created the maintenance.
id [required]
\nuuid
The ID of the Datadog user who created the maintenance.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the maintenance.
data [required]
\nobject
The data object identifying the Datadog user who last modified the maintenance.
id [required]
\nuuid
The ID of the Datadog user who last modified the maintenance.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
status_page
\nobject
The status page the maintenance belongs to.
data [required]
\nobject
The data object identifying the status page associated with a maintenance.
id [required]
\nuuid
The ID of the status page.
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
template
\nobject
The template the maintenance was created from.
data [required]
\nobject
The data object identifying the template the maintenance was created from.
id [required]
\nstring
The ID of the maintenance template.
type [required]
\nenum
Maintenance templates resource type. \nAllowed enum values: maintenance_templates
default: maintenance_templates
type [required]
\nenum
Maintenances resource type. \nAllowed enum values: maintenances
default: maintenances
included
\n[ <oneOf>]
The included related resources of a maintenance. Client must explicitly request these resources by name in the include query parameter.
<type=users>
\nobject
The included Datadog user resource.
attributes
\nobject
Attributes of the Datadog user.
string
The email of the Datadog user.
handle
\nstring
The handle of the Datadog user.
icon
\nstring
The icon of the Datadog user.
name
\nstring
The name of the Datadog user.
uuid
\nstring
The UUID of the Datadog user.
id
\nuuid
The ID of the Datadog user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
<type=status_pages>
\nobject
The included status page resource.
attributes
\nobject
The attributes of a status page.
company_logo
\nstring
The base64-encoded image data displayed in the company logo.
components
\n[object]
Components displayed on the status page.
components
\n[object]
If the component is of type group, the components within the group.
id
\nuuid
The ID of the grouped component.
name
\nstring
The name of the grouped component.
position
\nint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component
id
\nuuid
The ID of the component.
name
\nstring
The name of the component.
position
\nint64
The zero-indexed position of the component.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component,group
created_at
\ndate-time
Timestamp of when the status page was created.
custom_domain
\nstring
If configured, the url that the status page is accessible at.
custom_domain_enabled
\nboolean
Whether the custom domain is configured.
domain_prefix
\nstring
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_image
\nstring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabled
\nboolean
Whether the status page is enabled.
favicon
\nstring
Base64-encoded image data displayed in the browser tab.
modified_at
\ndate-time
Timestamp of when the status page was last modified.
name
\nstring
The name of the status page.
page_url
\nstring
The url that the status page is accessible at.
slack_app_icon
\nstring
The Slack app icon URL for the status page.
slack_subscriptions_enabled
\nboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabled
\nboolean
Whether users can subscribe to the status page.
type
\nenum
The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal
visualization_type
\nenum
The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
id
\nuuid
The ID of the status page.
relationships
\nobject
The relationships of a status page.
created_by_user
\nobject
The Datadog user who created the status page.
data [required]
\nobject
The data object identifying the Datadog user who created the status page.
id [required]
\nstring
The ID of the Datadog user who created the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the status page.
data [required]
\nobject
The data object identifying the Datadog user who last modified the status page.
id [required]
\nstring
The ID of the Datadog user who last modified the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
data
\nobject
The data object for a maintenance.
attributes
\nobject
The attributes of a maintenance.
completed_date
\ndate-time
Timestamp of when the maintenance was completed.
completed_description
\nstring
The description shown when the maintenance is completed.
components_affected
\n[object]
Components affected by the maintenance.
id [required]
\nuuid
The ID of the component. Must be a component of type component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,maintenance
in_progress_description
\nstring
The description shown while the maintenance is in progress.
is_backfilled
\nboolean
Whether the maintenance was backfilled.
modified_at
\ndate-time
Timestamp of when the maintenance was last modified.
published_date
\ndate-time
Timestamp of when the maintenance was published.
scheduled_description
\nstring
The description shown when the maintenance is scheduled.
start_date
\ndate-time
Timestamp of when the maintenance is scheduled to start.
status
\nenum
The status of the maintenance. \nAllowed enum values: scheduled,in_progress,completed
title
\nstring
Title of the maintenance.
updates
\n[object]
Past updates made to the maintenance.
components_affected
\n[object]
The components affected at the time of the update.
id [required]
\nuuid
Identifier of the component affected at the time of the update.
name
\nstring
The name of the component affected at the time of the update.
status [required]
\nenum
The status of the component affected at the time of the update. \nAllowed enum values: operational,maintenance
created_at
\ndate-time
Timestamp of when the update was created.
description
\nstring
Description of the update.
id
\nuuid
Identifier of the update.
manual_transition
\nboolean
Whether the update was applied manually by a user (true) or automatically by the system (false).
modified_at
\ndate-time
Timestamp of when the update was last modified.
started_at
\ndate-time
Timestamp of when the update started.
status
\nstring
The status of the update.
id
\nuuid
The ID of the maintenance.
relationships
\nobject
The relationships of a maintenance.
created_by_user
\nobject
The Datadog user who created the maintenance.
data [required]
\nobject
The data object identifying the Datadog user who created the maintenance.
id [required]
\nuuid
The ID of the Datadog user who created the maintenance.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the maintenance.
data [required]
\nobject
The data object identifying the Datadog user who last modified the maintenance.
id [required]
\nuuid
The ID of the Datadog user who last modified the maintenance.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
status_page
\nobject
The status page the maintenance belongs to.
data [required]
\nobject
The data object identifying the status page associated with a maintenance.
id [required]
\nuuid
The ID of the status page.
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
type [required]
\nenum
Maintenances resource type. \nAllowed enum values: maintenances
default: maintenances
included
\n[ <oneOf>]
The included related resources of a maintenance. Client must explicitly request these resources by name in the include query parameter.
<type=users>
\nobject
The included Datadog user resource.
attributes
\nobject
Attributes of the Datadog user.
string
The email of the Datadog user.
handle
\nstring
The handle of the Datadog user.
icon
\nstring
The icon of the Datadog user.
name
\nstring
The name of the Datadog user.
uuid
\nstring
The UUID of the Datadog user.
id
\nuuid
The ID of the Datadog user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
<type=status_pages>
\nobject
The included status page resource.
attributes
\nobject
The attributes of a status page.
company_logo
\nstring
The base64-encoded image data displayed in the company logo.
components
\n[object]
Components displayed on the status page.
components
\n[object]
If the component is of type group, the components within the group.
id
\nuuid
The ID of the grouped component.
name
\nstring
The name of the grouped component.
position
\nint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component
id
\nuuid
The ID of the component.
name
\nstring
The name of the component.
position
\nint64
The zero-indexed position of the component.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component,group
created_at
\ndate-time
Timestamp of when the status page was created.
custom_domain
\nstring
If configured, the url that the status page is accessible at.
custom_domain_enabled
\nboolean
Whether the custom domain is configured.
domain_prefix
\nstring
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_image
\nstring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabled
\nboolean
Whether the status page is enabled.
favicon
\nstring
Base64-encoded image data displayed in the browser tab.
modified_at
\ndate-time
Timestamp of when the status page was last modified.
name
\nstring
The name of the status page.
page_url
\nstring
The url that the status page is accessible at.
slack_app_icon
\nstring
The Slack app icon URL for the status page.
slack_subscriptions_enabled
\nboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabled
\nboolean
Whether users can subscribe to the status page.
type
\nenum
The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal
visualization_type
\nenum
The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
id
\nuuid
The ID of the status page.
relationships
\nobject
The relationships of a status page.
created_by_user
\nobject
The Datadog user who created the status page.
data [required]
\nobject
The data object identifying the Datadog user who created the status page.
id [required]
\nstring
The ID of the Datadog user who created the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the status page.
data [required]
\nobject
The data object identifying the Datadog user who last modified the status page.
id [required]
\nstring
The ID of the Datadog user who last modified the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
data
\nobject
The data object for a maintenance.
attributes
\nobject
The attributes of a maintenance.
completed_date
\ndate-time
Timestamp of when the maintenance was completed.
completed_description
\nstring
The description shown when the maintenance is completed.
components_affected
\n[object]
Components affected by the maintenance.
id [required]
\nuuid
The ID of the component. Must be a component of type component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,maintenance
in_progress_description
\nstring
The description shown while the maintenance is in progress.
is_backfilled
\nboolean
Whether the maintenance was backfilled.
modified_at
\ndate-time
Timestamp of when the maintenance was last modified.
published_date
\ndate-time
Timestamp of when the maintenance was published.
scheduled_description
\nstring
The description shown when the maintenance is scheduled.
start_date
\ndate-time
Timestamp of when the maintenance is scheduled to start.
status
\nenum
The status of the maintenance. \nAllowed enum values: scheduled,in_progress,completed
title
\nstring
Title of the maintenance.
updates
\n[object]
Past updates made to the maintenance.
components_affected
\n[object]
The components affected at the time of the update.
id [required]
\nuuid
Identifier of the component affected at the time of the update.
name
\nstring
The name of the component affected at the time of the update.
status [required]
\nenum
The status of the component affected at the time of the update. \nAllowed enum values: operational,maintenance
created_at
\ndate-time
Timestamp of when the update was created.
description
\nstring
Description of the update.
id
\nuuid
Identifier of the update.
manual_transition
\nboolean
Whether the update was applied manually by a user (true) or automatically by the system (false).
modified_at
\ndate-time
Timestamp of when the update was last modified.
started_at
\ndate-time
Timestamp of when the update started.
status
\nstring
The status of the update.
id
\nuuid
The ID of the maintenance.
relationships
\nobject
The relationships of a maintenance.
created_by_user
\nobject
The Datadog user who created the maintenance.
data [required]
\nobject
The data object identifying the Datadog user who created the maintenance.
id [required]
\nuuid
The ID of the Datadog user who created the maintenance.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the maintenance.
data [required]
\nobject
The data object identifying the Datadog user who last modified the maintenance.
id [required]
\nuuid
The ID of the Datadog user who last modified the maintenance.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
status_page
\nobject
The status page the maintenance belongs to.
data [required]
\nobject
The data object identifying the status page associated with a maintenance.
id [required]
\nuuid
The ID of the status page.
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
template
\nobject
The template the maintenance was created from.
data [required]
\nobject
The data object identifying the template the maintenance was created from.
id [required]
\nstring
The ID of the maintenance template.
type [required]
\nenum
Maintenance templates resource type. \nAllowed enum values: maintenance_templates
default: maintenance_templates
type [required]
\nenum
Maintenances resource type. \nAllowed enum values: maintenances
default: maintenances
included
\n[ <oneOf>]
The included related resources of a maintenance. Client must explicitly request these resources by name in the include query parameter.
<type=users>
\nobject
The included Datadog user resource.
attributes
\nobject
Attributes of the Datadog user.
string
The email of the Datadog user.
handle
\nstring
The handle of the Datadog user.
icon
\nstring
The icon of the Datadog user.
name
\nstring
The name of the Datadog user.
uuid
\nstring
The UUID of the Datadog user.
id
\nuuid
The ID of the Datadog user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
<type=status_pages>
\nobject
The included status page resource.
attributes
\nobject
The attributes of a status page.
company_logo
\nstring
The base64-encoded image data displayed in the company logo.
components
\n[object]
Components displayed on the status page.
components
\n[object]
If the component is of type group, the components within the group.
id
\nuuid
The ID of the grouped component.
name
\nstring
The name of the grouped component.
position
\nint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component
id
\nuuid
The ID of the component.
name
\nstring
The name of the component.
position
\nint64
The zero-indexed position of the component.
status
\nenum
The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance
type
\nenum
The type of the component. \nAllowed enum values: component,group
created_at
\ndate-time
Timestamp of when the status page was created.
custom_domain
\nstring
If configured, the url that the status page is accessible at.
custom_domain_enabled
\nboolean
Whether the custom domain is configured.
domain_prefix
\nstring
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_image
\nstring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabled
\nboolean
Whether the status page is enabled.
favicon
\nstring
Base64-encoded image data displayed in the browser tab.
modified_at
\ndate-time
Timestamp of when the status page was last modified.
name
\nstring
The name of the status page.
page_url
\nstring
The url that the status page is accessible at.
slack_app_icon
\nstring
The Slack app icon URL for the status page.
slack_subscriptions_enabled
\nboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabled
\nboolean
Whether users can subscribe to the status page.
type
\nenum
The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal
visualization_type
\nenum
The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
id
\nuuid
The ID of the status page.
relationships
\nobject
The relationships of a status page.
created_by_user
\nobject
The Datadog user who created the status page.
data [required]
\nobject
The data object identifying the Datadog user who created the status page.
id [required]
\nstring
The ID of the Datadog user who created the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
The Datadog user who last modified the status page.
data [required]
\nobject
The data object identifying the Datadog user who last modified the status page.
id [required]
\nstring
The ID of the Datadog user who last modified the status page.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Status pages resource type. \nAllowed enum values: status_pages
default: status_pages
data
\nobject
The data object for updating a maintenance.
attributes [required]
\nobject
The supported attributes for updating a maintenance.
completed_date
\ndate-time
Timestamp of when the maintenance was completed.
completed_description
\nstring
The description shown when the maintenance is completed.
components_affected
\n[object]
The components affected by the maintenance.
id [required]
\nuuid
The ID of the component. Must be a component of type component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,maintenance
in_progress_description
\nstring
The description shown while the maintenance is in progress.
scheduled_description
\nstring
The description shown when the maintenance is scheduled.
start_date
\ndate-time
Timestamp of when the maintenance is scheduled to start.
status
\nenum
The status of the maintenance. \nAllowed enum values: scheduled,in_progress,completed
title
\nstring
The title of the maintenance.
id [required]
\nuuid
The ID of the maintenance.
type [required]
\nenum
Maintenances resource type. \nAllowed enum values: maintenances
default: maintenances
data
\nobject
The data object for updating a maintenance.
attributes [required]
\nobject
The supported attributes for updating a maintenance.
completed_date
\ndate-time
Timestamp of when the maintenance was completed.
completed_description
\nstring
The description shown when the maintenance is completed.
components_affected
\n[object]
The components affected by the maintenance.
id [required]
\nuuid
The ID of the component. Must be a component of type component.
name
\nstring
The name of the component.
status [required]
\nenum
The status of the component. \nAllowed enum values: operational,maintenance
in_progress_description
\nstring
The description shown while the maintenance is in progress.
scheduled_description
\nstring
The description shown when the maintenance is scheduled.
start_date
\ndate-time
Timestamp of when the maintenance is scheduled to start.
status
\nenum
The status of the maintenance. \nAllowed enum values: scheduled,in_progress,completed
title
\nstring
The title of the maintenance.
id [required]
\nuuid
The ID of the maintenance.
relationships
\nobject
The supported relationships for updating a maintenance.
template
\nobject
The template used to create the maintenance.
data [required]
\nobject
The data object identifying the template used to create the maintenance.
id [required]
\nstring
The ID of the maintenance template.
type [required]
\nenum
Maintenance templates resource type. \nAllowed enum values: maintenance_templates
default: maintenance_templates
type [required]
\nenum
Maintenances resource type. \nAllowed enum values: maintenances
default: maintenances