From 9f1f4a7a429d7d193c0085538f60abd1ee61d009 Mon Sep 17 00:00:00 2001 From: "ci.datadog-api-spec" Date: Fri, 31 Jul 2026 21:21:02 +0000 Subject: [PATCH] Regenerate client from commit b739f1a of spec repo --- config/_default/menus/api.en.yaml | 120 ++ content/en/api/v2/status-pages/examples.json | 1394 ++++++++++++++---- data/api/v2/full_spec.yaml | 1368 +++++++++++++++++ data/api/v2/translate_actions.json | 48 + 4 files changed, 2681 insertions(+), 249 deletions(-) diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index 8ace00e4a8b..bfdb723e893 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -20464,6 +20464,66 @@ menu: - CreateMaintenance unstable: [] order: 18 + - name: Update maintenance template + url: /api/latest/status-pages/update-maintenance-template/ + identifier: status-pages-update-maintenance-template + parent: status-pages + generated: true + params: + versions: + - v2 + operationids: + - UpdateMaintenanceTemplate + unstable: [] + order: 32 + - name: Get maintenance template + url: /api/latest/status-pages/get-maintenance-template/ + identifier: status-pages-get-maintenance-template + parent: status-pages + generated: true + params: + versions: + - v2 + operationids: + - GetMaintenanceTemplate + unstable: [] + order: 34 + - name: Delete maintenance template + url: /api/latest/status-pages/delete-maintenance-template/ + identifier: status-pages-delete-maintenance-template + parent: status-pages + generated: true + params: + versions: + - v2 + operationids: + - DeleteMaintenanceTemplate + unstable: [] + order: 35 + - name: Create maintenance template + url: /api/latest/status-pages/create-maintenance-template/ + identifier: status-pages-create-maintenance-template + parent: status-pages + generated: true + params: + versions: + - v2 + operationids: + - CreateMaintenanceTemplate + unstable: [] + order: 31 + - name: List maintenance templates + url: /api/latest/status-pages/list-maintenance-templates/ + identifier: status-pages-list-maintenance-templates + parent: status-pages + generated: true + params: + versions: + - v2 + operationids: + - ListMaintenanceTemplates + unstable: [] + order: 33 - name: Edit degradation update url: /api/latest/status-pages/edit-degradation-update/ identifier: status-pages-edit-degradation-update @@ -20548,6 +20608,66 @@ menu: - CreateDegradation unstable: [] order: 13 + - name: Update degradation template + url: /api/latest/status-pages/update-degradation-template/ + identifier: status-pages-update-degradation-template + parent: status-pages + generated: true + params: + versions: + - v2 + operationids: + - UpdateDegradationTemplate + unstable: [] + order: 27 + - name: Get degradation template + url: /api/latest/status-pages/get-degradation-template/ + identifier: status-pages-get-degradation-template + parent: status-pages + generated: true + params: + versions: + - v2 + operationids: + - GetDegradationTemplate + unstable: [] + order: 29 + - name: Delete degradation template + url: /api/latest/status-pages/delete-degradation-template/ + identifier: status-pages-delete-degradation-template + parent: status-pages + generated: true + params: + versions: + - v2 + operationids: + - DeleteDegradationTemplate + unstable: [] + order: 30 + - name: Create degradation template + url: /api/latest/status-pages/create-degradation-template/ + identifier: status-pages-create-degradation-template + parent: status-pages + generated: true + params: + versions: + - v2 + operationids: + - CreateDegradationTemplate + unstable: [] + order: 26 + - name: List degradation templates + url: /api/latest/status-pages/list-degradation-templates/ + identifier: status-pages-list-degradation-templates + parent: status-pages + generated: true + params: + versions: + - v2 + operationids: + - ListDegradationTemplates + unstable: [] + order: 28 - name: Update component url: /api/latest/status-pages/update-component/ identifier: status-pages-update-component diff --git a/content/en/api/v2/status-pages/examples.json b/content/en/api/v2/status-pages/examples.json index e20b342e920..9fbb9acbfab 100644 --- a/content/en/api/v2/status-pages/examples.json +++ b/content/en/api/v2/status-pages/examples.json @@ -297,6 +297,12 @@ "id": "1234abcd-12ab-34cd-56ef-123456abcdef", "type": "status_pages" } + }, + "template": { + "data": { + "id": "", + "type": "degradation_templates" + } } }, "type": "degradations" @@ -328,7 +334,7 @@ } } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

A list of degradation data objects.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a degradation.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

Components affected by the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the degradation was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

is_backfilled

\n
\n

boolean

\n

Whether the degradation was backfilled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the degradation was last modified.

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

The source of the degradation.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp of when the source was created.

\n
\n \n
\n
\n
\n
\n
\n

source_id [required]

\n
\n

string

\n

The ID of the source.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the source. \nAllowed enum values: incident

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

updates

\n
\n

[object]

\n

Past updates made to the degradation.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected at the time of the update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

Identifier of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component affected at the time of the update. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the update was created.

\n
\n \n
\n
\n
\n
\n
\n

deleted_at

\n
\n

string

\n

The date and time the resource was deleted.

\n
\n \n
\n
\n
\n
\n
\n

deleted_by_user_uuid

\n
\n

string

\n

UUID of the user who deleted the resource.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the update.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Identifier of the update.

\n
\n \n
\n
\n
\n
\n
\n

last_modified_by_user_uuid

\n
\n

string

\n

UUID of the user who last modified the resource.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the update was last modified.

\n
\n \n
\n
\n
\n
\n
\n

started_at

\n
\n

date-time

\n

Timestamp of when the update started.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a degradation.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the degradation.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the degradation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the degradation.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the degradation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the degradation belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the status page the degradation belongs to.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradations resource type. \nAllowed enum values: degradations

default: degradations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a degradation. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

<type=users>

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=status_pages>

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

If the component is of type group, the components within the group.

\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

slack_app_icon

\n
\n

string

\n

The Slack app icon URL for the status page.

\n
\n \n
\n
\n
\n
\n
\n

slack_subscriptions_enabled

\n
\n

boolean

\n

Whether Slack subscriptions are enabled for the status page.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Response metadata.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Offset-based pagination schema.

\n
\n
\n
\n
\n
\n

first_offset

\n
\n

int64

\n

Integer representing the offset to fetch the first page of results.

\n
\n \n
\n
\n
\n
\n
\n

last_offset

\n
\n

int64

\n

Integer representing the offset to fetch the last page of results.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Integer representing the number of elements to be returned in the results.

\n
\n \n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

Integer representing the index of the first element in the next page of results. Equal to page size added to the current offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

Integer representing the index of the first element in the results.

\n
\n \n
\n
\n
\n
\n
\n

prev_offset

\n
\n

int64

\n

Integer representing the index of the first element in the previous page of results.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Integer representing the total number of elements available.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The pagination type used for offset-based pagination. \nAllowed enum values: offset_limit

default: offset_limit

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

A list of degradation data objects.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a degradation.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

Components affected by the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the degradation was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

is_backfilled

\n
\n

boolean

\n

Whether the degradation was backfilled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the degradation was last modified.

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

The source of the degradation.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp of when the source was created.

\n
\n \n
\n
\n
\n
\n
\n

source_id [required]

\n
\n

string

\n

The ID of the source.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the source. \nAllowed enum values: incident

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

updates

\n
\n

[object]

\n

Past updates made to the degradation.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected at the time of the update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

Identifier of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component affected at the time of the update. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the update was created.

\n
\n \n
\n
\n
\n
\n
\n

deleted_at

\n
\n

string

\n

The date and time the resource was deleted.

\n
\n \n
\n
\n
\n
\n
\n

deleted_by_user_uuid

\n
\n

string

\n

UUID of the user who deleted the resource.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the update.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Identifier of the update.

\n
\n \n
\n
\n
\n
\n
\n

last_modified_by_user_uuid

\n
\n

string

\n

UUID of the user who last modified the resource.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the update was last modified.

\n
\n \n
\n
\n
\n
\n
\n

started_at

\n
\n

date-time

\n

Timestamp of when the update started.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a degradation.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the degradation.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the degradation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the degradation.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the degradation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the degradation belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the status page the degradation belongs to.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

template

\n
\n

object

\n

The template the degradation was created from.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the template the degradation was created from.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the degradation template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradation templates resource type. \nAllowed enum values: degradation_templates

default: degradation_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradations resource type. \nAllowed enum values: degradations

default: degradations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a degradation. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

<type=users>

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=status_pages>

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

If the component is of type group, the components within the group.

\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

slack_app_icon

\n
\n

string

\n

The Slack app icon URL for the status page.

\n
\n \n
\n
\n
\n
\n
\n

slack_subscriptions_enabled

\n
\n

boolean

\n

Whether Slack subscriptions are enabled for the status page.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Response metadata.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Offset-based pagination schema.

\n
\n
\n
\n
\n
\n

first_offset

\n
\n

int64

\n

Integer representing the offset to fetch the first page of results.

\n
\n \n
\n
\n
\n
\n
\n

last_offset

\n
\n

int64

\n

Integer representing the offset to fetch the last page of results.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Integer representing the number of elements to be returned in the results.

\n
\n \n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

Integer representing the index of the first element in the next page of results. Equal to page size added to the current offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

Integer representing the index of the first element in the results.

\n
\n \n
\n
\n
\n
\n
\n

prev_offset

\n
\n

int64

\n

Integer representing the index of the first element in the previous page of results.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Integer representing the total number of elements available.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The pagination type used for offset-based pagination. \nAllowed enum values: offset_limit

default: offset_limit

\n
\n \n
\n
\n
\n
\n
\n
" }, "429": { "json": { @@ -407,6 +413,12 @@ "id": "", "type": "status_pages" } + }, + "template": { + "data": { + "id": "", + "type": "maintenance_templates" + } } }, "type": "maintenances" @@ -438,7 +450,7 @@ } } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

A list of maintenance data objects.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a maintenance.

\n
\n
\n
\n
\n
\n

completed_date

\n
\n

date-time

\n

Timestamp of when the maintenance was completed.

\n
\n \n
\n
\n
\n
\n
\n

completed_description

\n
\n

string

\n

The description shown when the maintenance is completed.

\n
\n \n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

Components affected by the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component. Must be a component of type component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

in_progress_description

\n
\n

string

\n

The description shown while the maintenance is in progress.

\n
\n \n
\n
\n
\n
\n
\n

is_backfilled

\n
\n

boolean

\n

Whether the maintenance was backfilled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the maintenance was last modified.

\n
\n \n
\n
\n
\n
\n
\n

published_date

\n
\n

date-time

\n

Timestamp of when the maintenance was published.

\n
\n \n
\n
\n
\n
\n
\n

scheduled_description

\n
\n

string

\n

The description shown when the maintenance is scheduled.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

date-time

\n

Timestamp of when the maintenance is scheduled to start.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the maintenance. \nAllowed enum values: scheduled,in_progress,completed

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

updates

\n
\n

[object]

\n

Past updates made to the maintenance.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected at the time of the update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

Identifier of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component affected at the time of the update. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the update was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the update.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Identifier of the update.

\n
\n \n
\n
\n
\n
\n
\n

manual_transition

\n
\n

boolean

\n

Whether the update was applied manually by a user (true) or automatically by the system (false).

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the update was last modified.

\n
\n \n
\n
\n
\n
\n
\n

started_at

\n
\n

date-time

\n

Timestamp of when the update started.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The status of the update.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a maintenance.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the maintenance.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the Datadog user who created the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the maintenance.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the Datadog user who last modified the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the maintenance belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the status page associated with a maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenances resource type. \nAllowed enum values: maintenances

default: maintenances

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a maintenance. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

<type=users>

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=status_pages>

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

If the component is of type group, the components within the group.

\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

slack_app_icon

\n
\n

string

\n

The Slack app icon URL for the status page.

\n
\n \n
\n
\n
\n
\n
\n

slack_subscriptions_enabled

\n
\n

boolean

\n

Whether Slack subscriptions are enabled for the status page.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Response metadata.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Offset-based pagination schema.

\n
\n
\n
\n
\n
\n

first_offset

\n
\n

int64

\n

Integer representing the offset to fetch the first page of results.

\n
\n \n
\n
\n
\n
\n
\n

last_offset

\n
\n

int64

\n

Integer representing the offset to fetch the last page of results.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Integer representing the number of elements to be returned in the results.

\n
\n \n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

Integer representing the index of the first element in the next page of results. Equal to page size added to the current offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

Integer representing the index of the first element in the results.

\n
\n \n
\n
\n
\n
\n
\n

prev_offset

\n
\n

int64

\n

Integer representing the index of the first element in the previous page of results.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Integer representing the total number of elements available.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The pagination type used for offset-based pagination. \nAllowed enum values: offset_limit

default: offset_limit

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

A list of maintenance data objects.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a maintenance.

\n
\n
\n
\n
\n
\n

completed_date

\n
\n

date-time

\n

Timestamp of when the maintenance was completed.

\n
\n \n
\n
\n
\n
\n
\n

completed_description

\n
\n

string

\n

The description shown when the maintenance is completed.

\n
\n \n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

Components affected by the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component. Must be a component of type component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

in_progress_description

\n
\n

string

\n

The description shown while the maintenance is in progress.

\n
\n \n
\n
\n
\n
\n
\n

is_backfilled

\n
\n

boolean

\n

Whether the maintenance was backfilled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the maintenance was last modified.

\n
\n \n
\n
\n
\n
\n
\n

published_date

\n
\n

date-time

\n

Timestamp of when the maintenance was published.

\n
\n \n
\n
\n
\n
\n
\n

scheduled_description

\n
\n

string

\n

The description shown when the maintenance is scheduled.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

date-time

\n

Timestamp of when the maintenance is scheduled to start.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the maintenance. \nAllowed enum values: scheduled,in_progress,completed

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

updates

\n
\n

[object]

\n

Past updates made to the maintenance.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected at the time of the update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

Identifier of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component affected at the time of the update. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the update was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the update.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Identifier of the update.

\n
\n \n
\n
\n
\n
\n
\n

manual_transition

\n
\n

boolean

\n

Whether the update was applied manually by a user (true) or automatically by the system (false).

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the update was last modified.

\n
\n \n
\n
\n
\n
\n
\n

started_at

\n
\n

date-time

\n

Timestamp of when the update started.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The status of the update.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a maintenance.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the maintenance.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the Datadog user who created the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the maintenance.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the Datadog user who last modified the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the maintenance belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the status page associated with a maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

template

\n
\n

object

\n

The template the maintenance was created from.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the template the maintenance was created from.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the maintenance template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenance templates resource type. \nAllowed enum values: maintenance_templates

default: maintenance_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenances resource type. \nAllowed enum values: maintenances

default: maintenances

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a maintenance. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

<type=users>

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=status_pages>

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

If the component is of type group, the components within the group.

\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

slack_app_icon

\n
\n

string

\n

The Slack app icon URL for the status page.

\n
\n \n
\n
\n
\n
\n
\n

slack_subscriptions_enabled

\n
\n

boolean

\n

Whether Slack subscriptions are enabled for the status page.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Response metadata.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Offset-based pagination schema.

\n
\n
\n
\n
\n
\n

first_offset

\n
\n

int64

\n

Integer representing the offset to fetch the first page of results.

\n
\n \n
\n
\n
\n
\n
\n

last_offset

\n
\n

int64

\n

Integer representing the offset to fetch the last page of results.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int64

\n

Integer representing the number of elements to be returned in the results.

\n
\n \n
\n
\n
\n
\n
\n

next_offset

\n
\n

int64

\n

Integer representing the index of the first element in the next page of results. Equal to page size added to the current offset.

\n
\n \n
\n
\n
\n
\n
\n

offset

\n
\n

int64

\n

Integer representing the index of the first element in the results.

\n
\n \n
\n
\n
\n
\n
\n

prev_offset

\n
\n

int64

\n

Integer representing the index of the first element in the previous page of results.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Integer representing the total number of elements available.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The pagination type used for offset-based pagination. \nAllowed enum values: offset_limit

default: offset_limit

\n
\n \n
\n
\n
\n
\n
\n
" }, "429": { "json": { @@ -1084,74 +1096,55 @@ "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for updating a component.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The supported attributes for updating a component.

\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The position of the component. If the component belongs to a group, the position is relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Components resource type. \nAllowed enum values: components

default: components

\n
\n \n
\n
\n
\n
" } }, - "CreateDegradation": { + "ListDegradationTemplates": { "responses": { - "201": { + "200": { "json": { - "data": { - "attributes": { - "components_affected": [ - { - "id": "1234abcd-12ab-34cd-56ef-123456abcdef", - "name": "string", - "status": "operational" - } - ], - "created_at": "2019-09-19T10:00:00.000Z", - "description": "string", - "is_backfilled": false, - "modified_at": "2019-09-19T10:00:00.000Z", - "source": { - "created_at": "", - "source_id": "", - "type": "incident" - }, - "status": "investigating", - "title": "string", - "updates": [ - { - "components_affected": [ - { - "id": "1234abcd-12ab-34cd-56ef-123456abcdef", - "name": "string", - "status": "operational" - } - ], - "created_at": "2019-09-19T10:00:00.000Z", - "deleted_at": "string", - "deleted_by_user_uuid": "string", - "description": "string", - "id": "string", - "last_modified_by_user_uuid": "string", - "modified_at": "2019-09-19T10:00:00.000Z", - "started_at": "2019-09-19T10:00:00.000Z", - "status": "investigating" - } - ] - }, - "id": "string", - "relationships": { - "created_by_user": { - "data": { - "id": "", - "type": "users" - } + "data": [ + { + "attributes": { + "components_affected": [ + { + "id": "", + "name": "string", + "status": "operational" + } + ], + "created_at": "2019-09-19T10:00:00.000Z", + "degradation_title": "string", + "modified_at": "2019-09-19T10:00:00.000Z", + "name": "string", + "updates": [ + { + "message": "string", + "status": "investigating" + } + ] }, - "last_modified_by_user": { - "data": { - "id": "", - "type": "users" + "id": "string", + "relationships": { + "created_by_user": { + "data": { + "id": "", + "type": "users" + } + }, + "last_modified_by_user": { + "data": { + "id": "", + "type": "users" + } + }, + "status_page": { + "data": { + "id": "", + "type": "status_pages" + } } }, - "status_page": { - "data": { - "id": "1234abcd-12ab-34cd-56ef-123456abcdef", - "type": "status_pages" - } - } - }, - "type": "degradations" - }, + "type": "degradation_templates" + } + ], "included": [ { "attributes": { @@ -1166,7 +1159,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for a degradation.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a degradation.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

Components affected by the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the degradation was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

is_backfilled

\n
\n

boolean

\n

Whether the degradation was backfilled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the degradation was last modified.

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

The source of the degradation.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp of when the source was created.

\n
\n \n
\n
\n
\n
\n
\n

source_id [required]

\n
\n

string

\n

The ID of the source.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the source. \nAllowed enum values: incident

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

updates

\n
\n

[object]

\n

Past updates made to the degradation.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected at the time of the update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

Identifier of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component affected at the time of the update. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the update was created.

\n
\n \n
\n
\n
\n
\n
\n

deleted_at

\n
\n

string

\n

The date and time the resource was deleted.

\n
\n \n
\n
\n
\n
\n
\n

deleted_by_user_uuid

\n
\n

string

\n

UUID of the user who deleted the resource.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the update.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Identifier of the update.

\n
\n \n
\n
\n
\n
\n
\n

last_modified_by_user_uuid

\n
\n

string

\n

UUID of the user who last modified the resource.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the update was last modified.

\n
\n \n
\n
\n
\n
\n
\n

started_at

\n
\n

date-time

\n

Timestamp of when the update started.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a degradation.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the degradation.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the degradation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the degradation.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the degradation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the degradation belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the status page the degradation belongs to.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradations resource type. \nAllowed enum values: degradations

default: degradations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a degradation. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

<type=users>

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=status_pages>

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

If the component is of type group, the components within the group.

\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

slack_app_icon

\n
\n

string

\n

The Slack app icon URL for the status page.

\n
\n \n
\n
\n
\n
\n
\n

slack_subscriptions_enabled

\n
\n

boolean

\n

Whether Slack subscriptions are enabled for the status page.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

A list of degradation template data objects.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a degradation template.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected by a degradation created from this template.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the degradation template was created.

\n
\n \n
\n
\n
\n
\n
\n

degradation_title

\n
\n

string

\n

The title used for a degradation created from this template.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the degradation template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the degradation template.

\n
\n \n
\n
\n
\n
\n
\n

updates

\n
\n

[object]

\n

The pre-filled updates for a degradation created from this template.

\n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

The message of the update.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the degradation template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a degradation template.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the degradation template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the degradation template.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the degradation template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the degradation template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the degradation template.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the degradation template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the degradation template belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the status page associated with a degradation template.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradation templates resource type. \nAllowed enum values: degradation_templates

default: degradation_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a degradation template. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

<type=users>

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=status_pages>

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

If the component is of type group, the components within the group.

\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

slack_app_icon

\n
\n

string

\n

The Slack app icon URL for the status page.

\n
\n \n
\n
\n
\n
\n
\n

slack_subscriptions_enabled

\n
\n

boolean

\n

Whether Slack subscriptions are enabled for the status page.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
" }, "429": { "json": { @@ -1178,41 +1171,12 @@ } }, "request": { - "json_curl": { - "data": { - "attributes": { - "components_affected": [ - { - "id": "1234abcd-12ab-34cd-56ef-123456abcdef", - "status": "operational" - } - ], - "status": "investigating", - "title": "Elevated API Latency" - }, - "type": "degradations" - } - }, - "json": { - "data": { - "attributes": { - "components_affected": [ - { - "id": "1234abcd-12ab-34cd-56ef-123456abcdef", - "status": "operational" - } - ], - "description": "Our API is experiencing elevated latency. We are investigating the issue.", - "status": "investigating", - "title": "Elevated API Latency" - }, - "type": "degradations" - } - }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for creating a degradation.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The supported attributes for creating a degradation.

\n
\n
\n
\n
\n
\n

components_affected [required]

\n
\n

[object]

\n

The components affected by the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component. Must be a component of type component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the degradation.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradations resource type. \nAllowed enum values: degradations

default: degradations

\n
\n \n
\n
\n
\n
" + "json_curl": {}, + "json": {}, + "html": "" } }, - "CreateBackfilledDegradation": { + "CreateDegradationTemplate": { "responses": { "201": { "json": { @@ -1220,39 +1184,18 @@ "attributes": { "components_affected": [ { - "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "id": "", "name": "string", "status": "operational" } ], "created_at": "2019-09-19T10:00:00.000Z", - "description": "string", - "is_backfilled": false, + "degradation_title": "string", "modified_at": "2019-09-19T10:00:00.000Z", - "source": { - "created_at": "", - "source_id": "", - "type": "incident" - }, - "status": "investigating", - "title": "string", + "name": "string", "updates": [ { - "components_affected": [ - { - "id": "1234abcd-12ab-34cd-56ef-123456abcdef", - "name": "string", - "status": "operational" - } - ], - "created_at": "2019-09-19T10:00:00.000Z", - "deleted_at": "string", - "deleted_by_user_uuid": "string", - "description": "string", - "id": "string", - "last_modified_by_user_uuid": "string", - "modified_at": "2019-09-19T10:00:00.000Z", - "started_at": "2019-09-19T10:00:00.000Z", + "message": "string", "status": "investigating" } ] @@ -1273,12 +1216,12 @@ }, "status_page": { "data": { - "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "id": "", "type": "status_pages" } } }, - "type": "degradations" + "type": "degradation_templates" }, "included": [ { @@ -1294,7 +1237,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for a degradation.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a degradation.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

Components affected by the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the degradation was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

is_backfilled

\n
\n

boolean

\n

Whether the degradation was backfilled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the degradation was last modified.

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

The source of the degradation.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp of when the source was created.

\n
\n \n
\n
\n
\n
\n
\n

source_id [required]

\n
\n

string

\n

The ID of the source.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the source. \nAllowed enum values: incident

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

updates

\n
\n

[object]

\n

Past updates made to the degradation.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected at the time of the update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

Identifier of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component affected at the time of the update. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the update was created.

\n
\n \n
\n
\n
\n
\n
\n

deleted_at

\n
\n

string

\n

The date and time the resource was deleted.

\n
\n \n
\n
\n
\n
\n
\n

deleted_by_user_uuid

\n
\n

string

\n

UUID of the user who deleted the resource.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the update.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Identifier of the update.

\n
\n \n
\n
\n
\n
\n
\n

last_modified_by_user_uuid

\n
\n

string

\n

UUID of the user who last modified the resource.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the update was last modified.

\n
\n \n
\n
\n
\n
\n
\n

started_at

\n
\n

date-time

\n

Timestamp of when the update started.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a degradation.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the degradation.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the degradation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the degradation.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the degradation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the degradation belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the status page the degradation belongs to.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradations resource type. \nAllowed enum values: degradations

default: degradations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a degradation. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

<type=users>

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=status_pages>

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

If the component is of type group, the components within the group.

\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

slack_app_icon

\n
\n

string

\n

The Slack app icon URL for the status page.

\n
\n \n
\n
\n
\n
\n
\n

slack_subscriptions_enabled

\n
\n

boolean

\n

Whether Slack subscriptions are enabled for the status page.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for a degradation template.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a degradation template.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected by a degradation created from this template.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the degradation template was created.

\n
\n \n
\n
\n
\n
\n
\n

degradation_title

\n
\n

string

\n

The title used for a degradation created from this template.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the degradation template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the degradation template.

\n
\n \n
\n
\n
\n
\n
\n

updates

\n
\n

[object]

\n

The pre-filled updates for a degradation created from this template.

\n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

The message of the update.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the degradation template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a degradation template.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the degradation template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the degradation template.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the degradation template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the degradation template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the degradation template.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the degradation template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the degradation template belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the status page associated with a degradation template.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradation templates resource type. \nAllowed enum values: degradation_templates

default: degradation_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a degradation template. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

<type=users>

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=status_pages>

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

If the component is of type group, the components within the group.

\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

slack_app_icon

\n
\n

string

\n

The Slack app icon URL for the status page.

\n
\n \n
\n
\n
\n
\n
\n

slack_subscriptions_enabled

\n
\n

boolean

\n

Whether Slack subscriptions are enabled for the status page.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
" }, "429": { "json": { @@ -1309,48 +1252,47 @@ "json_curl": { "data": { "attributes": { - "title": "", + "components_affected": [ + { + "id": "", + "status": "operational" + } + ], + "name": "", "updates": [ { - "components_affected": [ - { - "id": "1234abcd-12ab-34cd-56ef-123456abcdef", - "status": "operational" - } - ], - "started_at": "", "status": "investigating" } ] }, - "type": "degradations" + "type": "degradation_templates" } }, "json": { "data": { "attributes": { - "title": "", + "components_affected": [ + { + "id": "", + "status": "operational" + } + ], + "degradation_title": "string", + "name": "", "updates": [ { - "components_affected": [ - { - "id": "1234abcd-12ab-34cd-56ef-123456abcdef", - "status": "operational" - } - ], - "description": "string", - "started_at": "", + "message": "string", "status": "investigating" } ] }, - "type": "degradations" + "type": "degradation_templates" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for creating a backfilled degradation.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The supported attributes for creating a backfilled degradation.

\n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the backfilled degradation.

\n
\n \n
\n
\n
\n
\n
\n

updates [required]

\n
\n

[object]

\n

The list of status updates describing the timeline of the degradation.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component. Must be a component of type component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description of the update.

\n
\n \n
\n
\n
\n
\n
\n

started_at [required]

\n
\n

date-time

\n

Timestamp of when the update occurred.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradations resource type. \nAllowed enum values: degradations

default: degradations

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for creating a degradation template.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes for creating a degradation template.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected by a degradation created from this template.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the component. Must be a component of type component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

degradation_title

\n
\n

string

\n

The title used for a degradation created from this template.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the degradation template.

\n
\n \n
\n
\n
\n
\n
\n

updates

\n
\n

[object]

\n

The pre-filled updates for a degradation created from this template.

\n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

The message of the update.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradation templates resource type. \nAllowed enum values: degradation_templates

default: degradation_templates

\n
\n \n
\n
\n
\n
" } }, - "DeleteDegradation": { + "DeleteDegradationTemplate": { "responses": { "429": { "json": { @@ -1367,7 +1309,7 @@ "html": "" } }, - "GetDegradation": { + "GetDegradationTemplate": { "responses": { "200": { "json": { @@ -1375,39 +1317,18 @@ "attributes": { "components_affected": [ { - "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "id": "", "name": "string", "status": "operational" } ], "created_at": "2019-09-19T10:00:00.000Z", - "description": "string", - "is_backfilled": false, + "degradation_title": "string", "modified_at": "2019-09-19T10:00:00.000Z", - "source": { - "created_at": "", - "source_id": "", - "type": "incident" - }, - "status": "investigating", - "title": "string", + "name": "string", "updates": [ { - "components_affected": [ - { - "id": "1234abcd-12ab-34cd-56ef-123456abcdef", - "name": "string", - "status": "operational" - } - ], - "created_at": "2019-09-19T10:00:00.000Z", - "deleted_at": "string", - "deleted_by_user_uuid": "string", - "description": "string", - "id": "string", - "last_modified_by_user_uuid": "string", - "modified_at": "2019-09-19T10:00:00.000Z", - "started_at": "2019-09-19T10:00:00.000Z", + "message": "string", "status": "investigating" } ] @@ -1428,12 +1349,12 @@ }, "status_page": { "data": { - "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "id": "", "type": "status_pages" } } }, - "type": "degradations" + "type": "degradation_templates" }, "included": [ { @@ -1449,7 +1370,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for a degradation.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a degradation.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

Components affected by the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the degradation was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

is_backfilled

\n
\n

boolean

\n

Whether the degradation was backfilled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the degradation was last modified.

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

The source of the degradation.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp of when the source was created.

\n
\n \n
\n
\n
\n
\n
\n

source_id [required]

\n
\n

string

\n

The ID of the source.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the source. \nAllowed enum values: incident

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

updates

\n
\n

[object]

\n

Past updates made to the degradation.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected at the time of the update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

Identifier of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component affected at the time of the update. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the update was created.

\n
\n \n
\n
\n
\n
\n
\n

deleted_at

\n
\n

string

\n

The date and time the resource was deleted.

\n
\n \n
\n
\n
\n
\n
\n

deleted_by_user_uuid

\n
\n

string

\n

UUID of the user who deleted the resource.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the update.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Identifier of the update.

\n
\n \n
\n
\n
\n
\n
\n

last_modified_by_user_uuid

\n
\n

string

\n

UUID of the user who last modified the resource.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the update was last modified.

\n
\n \n
\n
\n
\n
\n
\n

started_at

\n
\n

date-time

\n

Timestamp of when the update started.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a degradation.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the degradation.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the degradation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the degradation.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the degradation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the degradation belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the status page the degradation belongs to.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradations resource type. \nAllowed enum values: degradations

default: degradations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a degradation. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

<type=users>

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=status_pages>

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

If the component is of type group, the components within the group.

\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

slack_app_icon

\n
\n

string

\n

The Slack app icon URL for the status page.

\n
\n \n
\n
\n
\n
\n
\n

slack_subscriptions_enabled

\n
\n

boolean

\n

Whether Slack subscriptions are enabled for the status page.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for a degradation template.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a degradation template.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected by a degradation created from this template.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the degradation template was created.

\n
\n \n
\n
\n
\n
\n
\n

degradation_title

\n
\n

string

\n

The title used for a degradation created from this template.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the degradation template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the degradation template.

\n
\n \n
\n
\n
\n
\n
\n

updates

\n
\n

[object]

\n

The pre-filled updates for a degradation created from this template.

\n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

The message of the update.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the degradation template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a degradation template.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the degradation template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the degradation template.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the degradation template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the degradation template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the degradation template.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the degradation template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the degradation template belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the status page associated with a degradation template.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradation templates resource type. \nAllowed enum values: degradation_templates

default: degradation_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a degradation template. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

<type=users>

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=status_pages>

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

If the component is of type group, the components within the group.

\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

slack_app_icon

\n
\n

string

\n

The Slack app icon URL for the status page.

\n
\n \n
\n
\n
\n
\n
\n

slack_subscriptions_enabled

\n
\n

boolean

\n

Whether Slack subscriptions are enabled for the status page.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
" }, "429": { "json": { @@ -1466,7 +1387,7 @@ "html": "" } }, - "UpdateDegradation": { + "UpdateDegradationTemplate": { "responses": { "200": { "json": { @@ -1474,30 +1395,579 @@ "attributes": { "components_affected": [ { - "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "id": "", "name": "string", "status": "operational" } ], "created_at": "2019-09-19T10:00:00.000Z", - "description": "string", - "is_backfilled": false, + "degradation_title": "string", "modified_at": "2019-09-19T10:00:00.000Z", - "source": { - "created_at": "", - "source_id": "", - "type": "incident" - }, - "status": "investigating", - "title": "string", + "name": "string", "updates": [ { - "components_affected": [ - { - "id": "1234abcd-12ab-34cd-56ef-123456abcdef", - "name": "string", - "status": "operational" - } + "message": "string", + "status": "investigating" + } + ] + }, + "id": "string", + "relationships": { + "created_by_user": { + "data": { + "id": "", + "type": "users" + } + }, + "last_modified_by_user": { + "data": { + "id": "", + "type": "users" + } + }, + "status_page": { + "data": { + "id": "", + "type": "status_pages" + } + } + }, + "type": "degradation_templates" + }, + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for a degradation template.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a degradation template.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected by a degradation created from this template.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the degradation template was created.

\n
\n \n
\n
\n
\n
\n
\n

degradation_title

\n
\n

string

\n

The title used for a degradation created from this template.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the degradation template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the degradation template.

\n
\n \n
\n
\n
\n
\n
\n

updates

\n
\n

[object]

\n

The pre-filled updates for a degradation created from this template.

\n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

The message of the update.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the degradation template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a degradation template.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the degradation template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the degradation template.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the degradation template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the degradation template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the degradation template.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the degradation template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the degradation template belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the status page associated with a degradation template.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradation templates resource type. \nAllowed enum values: degradation_templates

default: degradation_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a degradation template. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

<type=users>

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=status_pages>

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

If the component is of type group, the components within the group.

\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

slack_app_icon

\n
\n

string

\n

The Slack app icon URL for the status page.

\n
\n \n
\n
\n
\n
\n
\n

slack_subscriptions_enabled

\n
\n

boolean

\n

Whether Slack subscriptions are enabled for the status page.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "components_affected": [ + { + "id": "", + "status": "operational" + } + ], + "updates": [ + { + "status": "investigating" + } + ] + }, + "id": "", + "type": "degradation_templates" + } + }, + "json": { + "data": { + "attributes": { + "components_affected": [ + { + "id": "", + "status": "operational" + } + ], + "degradation_title": "string", + "name": "string", + "updates": [ + { + "message": "string", + "status": "investigating" + } + ] + }, + "id": "", + "type": "degradation_templates" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for updating a degradation template.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The supported attributes for updating a degradation template.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected by a degradation created from this template.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the component. Must be a component of type component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

degradation_title

\n
\n

string

\n

The title used for a degradation created from this template.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the degradation template.

\n
\n \n
\n
\n
\n
\n
\n

updates

\n
\n

[object]

\n

The pre-filled updates for a degradation created from this template.

\n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

The message of the update.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the degradation template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradation templates resource type. \nAllowed enum values: degradation_templates

default: degradation_templates

\n
\n \n
\n
\n
\n
" + } + }, + "CreateDegradation": { + "responses": { + "201": { + "json": { + "data": { + "attributes": { + "components_affected": [ + { + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "name": "string", + "status": "operational" + } + ], + "created_at": "2019-09-19T10:00:00.000Z", + "description": "string", + "is_backfilled": false, + "modified_at": "2019-09-19T10:00:00.000Z", + "source": { + "created_at": "", + "source_id": "", + "type": "incident" + }, + "status": "investigating", + "title": "string", + "updates": [ + { + "components_affected": [ + { + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "name": "string", + "status": "operational" + } + ], + "created_at": "2019-09-19T10:00:00.000Z", + "deleted_at": "string", + "deleted_by_user_uuid": "string", + "description": "string", + "id": "string", + "last_modified_by_user_uuid": "string", + "modified_at": "2019-09-19T10:00:00.000Z", + "started_at": "2019-09-19T10:00:00.000Z", + "status": "investigating" + } + ] + }, + "id": "string", + "relationships": { + "created_by_user": { + "data": { + "id": "", + "type": "users" + } + }, + "last_modified_by_user": { + "data": { + "id": "", + "type": "users" + } + }, + "status_page": { + "data": { + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "type": "status_pages" + } + }, + "template": { + "data": { + "id": "", + "type": "degradation_templates" + } + } + }, + "type": "degradations" + }, + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for a degradation.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a degradation.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

Components affected by the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the degradation was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

is_backfilled

\n
\n

boolean

\n

Whether the degradation was backfilled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the degradation was last modified.

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

The source of the degradation.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp of when the source was created.

\n
\n \n
\n
\n
\n
\n
\n

source_id [required]

\n
\n

string

\n

The ID of the source.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the source. \nAllowed enum values: incident

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

updates

\n
\n

[object]

\n

Past updates made to the degradation.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected at the time of the update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

Identifier of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component affected at the time of the update. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the update was created.

\n
\n \n
\n
\n
\n
\n
\n

deleted_at

\n
\n

string

\n

The date and time the resource was deleted.

\n
\n \n
\n
\n
\n
\n
\n

deleted_by_user_uuid

\n
\n

string

\n

UUID of the user who deleted the resource.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the update.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Identifier of the update.

\n
\n \n
\n
\n
\n
\n
\n

last_modified_by_user_uuid

\n
\n

string

\n

UUID of the user who last modified the resource.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the update was last modified.

\n
\n \n
\n
\n
\n
\n
\n

started_at

\n
\n

date-time

\n

Timestamp of when the update started.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a degradation.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the degradation.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the degradation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the degradation.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the degradation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the degradation belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the status page the degradation belongs to.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

template

\n
\n

object

\n

The template the degradation was created from.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the template the degradation was created from.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the degradation template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradation templates resource type. \nAllowed enum values: degradation_templates

default: degradation_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradations resource type. \nAllowed enum values: degradations

default: degradations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a degradation. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

<type=users>

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=status_pages>

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

If the component is of type group, the components within the group.

\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

slack_app_icon

\n
\n

string

\n

The Slack app icon URL for the status page.

\n
\n \n
\n
\n
\n
\n
\n

slack_subscriptions_enabled

\n
\n

boolean

\n

Whether Slack subscriptions are enabled for the status page.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "components_affected": [ + { + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "status": "operational" + } + ], + "status": "investigating", + "title": "Elevated API Latency" + }, + "relationships": { + "template": { + "data": { + "id": "", + "type": "degradation_templates" + } + } + }, + "type": "degradations" + } + }, + "json": { + "data": { + "attributes": { + "components_affected": [ + { + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "status": "operational" + } + ], + "description": "Our API is experiencing elevated latency. We are investigating the issue.", + "status": "investigating", + "title": "Elevated API Latency" + }, + "relationships": { + "template": { + "data": { + "id": "", + "type": "degradation_templates" + } + } + }, + "type": "degradations" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for creating a degradation.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The supported attributes for creating a degradation.

\n
\n
\n
\n
\n
\n

components_affected [required]

\n
\n

[object]

\n

The components affected by the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component. Must be a component of type component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the degradation.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The supported relationships for creating a degradation.

\n
\n
\n
\n
\n
\n

template

\n
\n

object

\n

The template used to create the degradation.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the template used to create the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the degradation template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradation templates resource type. \nAllowed enum values: degradation_templates

default: degradation_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradations resource type. \nAllowed enum values: degradations

default: degradations

\n
\n \n
\n
\n
\n
" + } + }, + "CreateBackfilledDegradation": { + "responses": { + "201": { + "json": { + "data": { + "attributes": { + "components_affected": [ + { + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "name": "string", + "status": "operational" + } + ], + "created_at": "2019-09-19T10:00:00.000Z", + "description": "string", + "is_backfilled": false, + "modified_at": "2019-09-19T10:00:00.000Z", + "source": { + "created_at": "", + "source_id": "", + "type": "incident" + }, + "status": "investigating", + "title": "string", + "updates": [ + { + "components_affected": [ + { + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "name": "string", + "status": "operational" + } + ], + "created_at": "2019-09-19T10:00:00.000Z", + "deleted_at": "string", + "deleted_by_user_uuid": "string", + "description": "string", + "id": "string", + "last_modified_by_user_uuid": "string", + "modified_at": "2019-09-19T10:00:00.000Z", + "started_at": "2019-09-19T10:00:00.000Z", + "status": "investigating" + } + ] + }, + "id": "string", + "relationships": { + "created_by_user": { + "data": { + "id": "", + "type": "users" + } + }, + "last_modified_by_user": { + "data": { + "id": "", + "type": "users" + } + }, + "status_page": { + "data": { + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "type": "status_pages" + } + }, + "template": { + "data": { + "id": "", + "type": "degradation_templates" + } + } + }, + "type": "degradations" + }, + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for a degradation.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a degradation.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

Components affected by the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the degradation was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

is_backfilled

\n
\n

boolean

\n

Whether the degradation was backfilled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the degradation was last modified.

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

The source of the degradation.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp of when the source was created.

\n
\n \n
\n
\n
\n
\n
\n

source_id [required]

\n
\n

string

\n

The ID of the source.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the source. \nAllowed enum values: incident

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

updates

\n
\n

[object]

\n

Past updates made to the degradation.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected at the time of the update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

Identifier of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component affected at the time of the update. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the update was created.

\n
\n \n
\n
\n
\n
\n
\n

deleted_at

\n
\n

string

\n

The date and time the resource was deleted.

\n
\n \n
\n
\n
\n
\n
\n

deleted_by_user_uuid

\n
\n

string

\n

UUID of the user who deleted the resource.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the update.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Identifier of the update.

\n
\n \n
\n
\n
\n
\n
\n

last_modified_by_user_uuid

\n
\n

string

\n

UUID of the user who last modified the resource.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the update was last modified.

\n
\n \n
\n
\n
\n
\n
\n

started_at

\n
\n

date-time

\n

Timestamp of when the update started.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a degradation.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the degradation.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the degradation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the degradation.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the degradation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the degradation belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the status page the degradation belongs to.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

template

\n
\n

object

\n

The template the degradation was created from.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the template the degradation was created from.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the degradation template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradation templates resource type. \nAllowed enum values: degradation_templates

default: degradation_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradations resource type. \nAllowed enum values: degradations

default: degradations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a degradation. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

<type=users>

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=status_pages>

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

If the component is of type group, the components within the group.

\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

slack_app_icon

\n
\n

string

\n

The Slack app icon URL for the status page.

\n
\n \n
\n
\n
\n
\n
\n

slack_subscriptions_enabled

\n
\n

boolean

\n

Whether Slack subscriptions are enabled for the status page.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "title": "", + "updates": [ + { + "components_affected": [ + { + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "status": "operational" + } + ], + "started_at": "", + "status": "investigating" + } + ] + }, + "relationships": { + "template": { + "data": { + "id": "", + "type": "degradation_templates" + } + } + }, + "type": "degradations" + } + }, + "json": { + "data": { + "attributes": { + "title": "", + "updates": [ + { + "components_affected": [ + { + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "status": "operational" + } + ], + "description": "string", + "started_at": "", + "status": "investigating" + } + ] + }, + "relationships": { + "template": { + "data": { + "id": "", + "type": "degradation_templates" + } + } + }, + "type": "degradations" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for creating a backfilled degradation.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The supported attributes for creating a backfilled degradation.

\n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the backfilled degradation.

\n
\n \n
\n
\n
\n
\n
\n

updates [required]

\n
\n

[object]

\n

The list of status updates describing the timeline of the degradation.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component. Must be a component of type component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description of the update.

\n
\n \n
\n
\n
\n
\n
\n

started_at [required]

\n
\n

date-time

\n

Timestamp of when the update occurred.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The supported relationships for creating a backfilled degradation.

\n
\n
\n
\n
\n
\n

template

\n
\n

object

\n

The template used to create the backfilled degradation.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the template used to create the backfilled degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the degradation template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradation templates resource type. \nAllowed enum values: degradation_templates

default: degradation_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradations resource type. \nAllowed enum values: degradations

default: degradations

\n
\n \n
\n
\n
\n
" + } + }, + "DeleteDegradation": { + "responses": { + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "GetDegradation": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "components_affected": [ + { + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "name": "string", + "status": "operational" + } + ], + "created_at": "2019-09-19T10:00:00.000Z", + "description": "string", + "is_backfilled": false, + "modified_at": "2019-09-19T10:00:00.000Z", + "source": { + "created_at": "", + "source_id": "", + "type": "incident" + }, + "status": "investigating", + "title": "string", + "updates": [ + { + "components_affected": [ + { + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "name": "string", + "status": "operational" + } + ], + "created_at": "2019-09-19T10:00:00.000Z", + "deleted_at": "string", + "deleted_by_user_uuid": "string", + "description": "string", + "id": "string", + "last_modified_by_user_uuid": "string", + "modified_at": "2019-09-19T10:00:00.000Z", + "started_at": "2019-09-19T10:00:00.000Z", + "status": "investigating" + } + ] + }, + "id": "string", + "relationships": { + "created_by_user": { + "data": { + "id": "", + "type": "users" + } + }, + "last_modified_by_user": { + "data": { + "id": "", + "type": "users" + } + }, + "status_page": { + "data": { + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "type": "status_pages" + } + }, + "template": { + "data": { + "id": "", + "type": "degradation_templates" + } + } + }, + "type": "degradations" + }, + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for a degradation.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a degradation.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

Components affected by the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the degradation was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

is_backfilled

\n
\n

boolean

\n

Whether the degradation was backfilled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the degradation was last modified.

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

The source of the degradation.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp of when the source was created.

\n
\n \n
\n
\n
\n
\n
\n

source_id [required]

\n
\n

string

\n

The ID of the source.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the source. \nAllowed enum values: incident

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

updates

\n
\n

[object]

\n

Past updates made to the degradation.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected at the time of the update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

Identifier of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component affected at the time of the update. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the update was created.

\n
\n \n
\n
\n
\n
\n
\n

deleted_at

\n
\n

string

\n

The date and time the resource was deleted.

\n
\n \n
\n
\n
\n
\n
\n

deleted_by_user_uuid

\n
\n

string

\n

UUID of the user who deleted the resource.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the update.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Identifier of the update.

\n
\n \n
\n
\n
\n
\n
\n

last_modified_by_user_uuid

\n
\n

string

\n

UUID of the user who last modified the resource.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the update was last modified.

\n
\n \n
\n
\n
\n
\n
\n

started_at

\n
\n

date-time

\n

Timestamp of when the update started.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a degradation.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the degradation.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the degradation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the degradation.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the degradation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the degradation belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the status page the degradation belongs to.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

template

\n
\n

object

\n

The template the degradation was created from.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the template the degradation was created from.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the degradation template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradation templates resource type. \nAllowed enum values: degradation_templates

default: degradation_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradations resource type. \nAllowed enum values: degradations

default: degradations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a degradation. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

<type=users>

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=status_pages>

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

If the component is of type group, the components within the group.

\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

slack_app_icon

\n
\n

string

\n

The Slack app icon URL for the status page.

\n
\n \n
\n
\n
\n
\n
\n

slack_subscriptions_enabled

\n
\n

boolean

\n

Whether Slack subscriptions are enabled for the status page.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "UpdateDegradation": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "components_affected": [ + { + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "name": "string", + "status": "operational" + } + ], + "created_at": "2019-09-19T10:00:00.000Z", + "description": "string", + "is_backfilled": false, + "modified_at": "2019-09-19T10:00:00.000Z", + "source": { + "created_at": "", + "source_id": "", + "type": "incident" + }, + "status": "investigating", + "title": "string", + "updates": [ + { + "components_affected": [ + { + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "name": "string", + "status": "operational" + } ], "created_at": "2019-09-19T10:00:00.000Z", "deleted_at": "string", @@ -1509,7 +1979,314 @@ "started_at": "2019-09-19T10:00:00.000Z", "status": "investigating" } - ] + ] + }, + "id": "string", + "relationships": { + "created_by_user": { + "data": { + "id": "", + "type": "users" + } + }, + "last_modified_by_user": { + "data": { + "id": "", + "type": "users" + } + }, + "status_page": { + "data": { + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "type": "status_pages" + } + }, + "template": { + "data": { + "id": "", + "type": "degradation_templates" + } + } + }, + "type": "degradations" + }, + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for a degradation.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a degradation.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

Components affected by the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the degradation was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

is_backfilled

\n
\n

boolean

\n

Whether the degradation was backfilled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the degradation was last modified.

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

The source of the degradation.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp of when the source was created.

\n
\n \n
\n
\n
\n
\n
\n

source_id [required]

\n
\n

string

\n

The ID of the source.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the source. \nAllowed enum values: incident

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

updates

\n
\n

[object]

\n

Past updates made to the degradation.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected at the time of the update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

Identifier of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component affected at the time of the update. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the update was created.

\n
\n \n
\n
\n
\n
\n
\n

deleted_at

\n
\n

string

\n

The date and time the resource was deleted.

\n
\n \n
\n
\n
\n
\n
\n

deleted_by_user_uuid

\n
\n

string

\n

UUID of the user who deleted the resource.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the update.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Identifier of the update.

\n
\n \n
\n
\n
\n
\n
\n

last_modified_by_user_uuid

\n
\n

string

\n

UUID of the user who last modified the resource.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the update was last modified.

\n
\n \n
\n
\n
\n
\n
\n

started_at

\n
\n

date-time

\n

Timestamp of when the update started.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a degradation.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the degradation.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the degradation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the degradation.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the degradation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the degradation belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the status page the degradation belongs to.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

template

\n
\n

object

\n

The template the degradation was created from.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the template the degradation was created from.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the degradation template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradation templates resource type. \nAllowed enum values: degradation_templates

default: degradation_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradations resource type. \nAllowed enum values: degradations

default: degradations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a degradation. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

<type=users>

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=status_pages>

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

If the component is of type group, the components within the group.

\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

slack_app_icon

\n
\n

string

\n

The Slack app icon URL for the status page.

\n
\n \n
\n
\n
\n
\n
\n

slack_subscriptions_enabled

\n
\n

boolean

\n

Whether Slack subscriptions are enabled for the status page.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "components_affected": [ + { + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "status": "operational" + } + ] + }, + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "relationships": { + "template": { + "data": { + "id": "", + "type": "degradation_templates" + } + } + }, + "type": "degradations" + } + }, + "json": { + "data": { + "attributes": { + "components_affected": [ + { + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "status": "operational" + } + ], + "description": "We've deployed a fix and latency has returned to normal. This issue has been resolved.", + "status": "resolved", + "title": "Elevated API Latency" + }, + "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "relationships": { + "template": { + "data": { + "id": "", + "type": "degradation_templates" + } + } + }, + "type": "degradations" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for updating a degradation.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The supported attributes for updating a degradation.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected by the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component. Must be a component of type component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the degradation.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The supported relationships for updating a degradation.

\n
\n
\n
\n
\n
\n

template

\n
\n

object

\n

The template used to create the degradation.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the template used to create the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the degradation template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradation templates resource type. \nAllowed enum values: degradation_templates

default: degradation_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradations resource type. \nAllowed enum values: degradations

default: degradations

\n
\n \n
\n
\n
\n
" + } + }, + "SoftDeleteDegradationUpdate": { + "responses": { + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "EditDegradationUpdate": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "components_affected": [ + { + "id": "", + "name": "string", + "status": "operational" + } + ], + "created_at": "2019-09-19T10:00:00.000Z", + "deleted_at": "2019-09-19T10:00:00.000Z", + "description": "string", + "modified_at": "2019-09-19T10:00:00.000Z", + "started_at": "2019-09-19T10:00:00.000Z", + "status": "investigating" + }, + "id": "string", + "relationships": { + "created_by_user": { + "data": { + "id": "", + "type": "users" + } + }, + "degradation": { + "data": { + "id": "", + "type": "degradations" + } + }, + "deleted_by_user": { + "data": { + "id": "", + "type": "users" + } + }, + "last_modified_by_user": { + "data": { + "id": "", + "type": "users" + } + }, + "status_page": { + "data": { + "id": "", + "type": "status_pages" + } + } + }, + "type": "degradation_updates" + }, + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for a degradation update.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a degradation update resource.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

Components affected by this update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the affected component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the affected component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The date and time the update was created.

\n
\n \n
\n
\n
\n
\n
\n

deleted_at

\n
\n

date-time

\n

The date and time the update was soft-deleted.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The message body of the update.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The date and time the update was last modified.

\n
\n \n
\n
\n
\n
\n
\n

started_at

\n
\n

date-time

\n

The date and time the update started.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the degradation update.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of a degradation update resource.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

A user relationship of a degradation update.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A Datadog user linked to a degradation update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

degradation

\n
\n

object

\n

The degradation relationship of a degradation update.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The degradation linked to a degradation update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradations resource type. \nAllowed enum values: degradations

default: degradations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

deleted_by_user

\n
\n

object

\n

A user relationship of a degradation update.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A Datadog user linked to a degradation update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

A user relationship of a degradation update.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A Datadog user linked to a degradation update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page relationship of a degradation update.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The status page linked to a degradation update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradation updates resource type. \nAllowed enum values: degradation_updates

default: degradation_updates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Resources related to the degradation update.

\n
\n
\n
\n
\n
\n

<type=users>

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Response object for a single degradation.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for a degradation.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a degradation.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

Components affected by the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the degradation was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

is_backfilled

\n
\n

boolean

\n

Whether the degradation was backfilled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the degradation was last modified.

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

The source of the degradation.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp of when the source was created.

\n
\n \n
\n
\n
\n
\n
\n

source_id [required]

\n
\n

string

\n

The ID of the source.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the source. \nAllowed enum values: incident

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

updates

\n
\n

[object]

\n

Past updates made to the degradation.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected at the time of the update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

Identifier of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component affected at the time of the update. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the update was created.

\n
\n \n
\n
\n
\n
\n
\n

deleted_at

\n
\n

string

\n

The date and time the resource was deleted.

\n
\n \n
\n
\n
\n
\n
\n

deleted_by_user_uuid

\n
\n

string

\n

UUID of the user who deleted the resource.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the update.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Identifier of the update.

\n
\n \n
\n
\n
\n
\n
\n

last_modified_by_user_uuid

\n
\n

string

\n

UUID of the user who last modified the resource.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the update was last modified.

\n
\n \n
\n
\n
\n
\n
\n

started_at

\n
\n

date-time

\n

Timestamp of when the update started.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a degradation.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the degradation.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the degradation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the degradation.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the degradation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the degradation belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the status page the degradation belongs to.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

template

\n
\n

object

\n

The template the degradation was created from.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the template the degradation was created from.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the degradation template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradation templates resource type. \nAllowed enum values: degradation_templates

default: degradation_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradations resource type. \nAllowed enum values: degradations

default: degradations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a degradation. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

<type=users>

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=status_pages>

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

If the component is of type group, the components within the group.

\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

slack_app_icon

\n
\n

string

\n

The Slack app icon URL for the status page.

\n
\n \n
\n
\n
\n
\n
\n

slack_subscriptions_enabled

\n
\n

boolean

\n

Whether Slack subscriptions are enabled for the status page.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

<type=status_pages>

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

If the component is of type group, the components within the group.

\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

slack_app_icon

\n
\n

string

\n

The Slack app icon URL for the status page.

\n
\n \n
\n
\n
\n
\n
\n

slack_subscriptions_enabled

\n
\n

boolean

\n

Whether Slack subscriptions are enabled for the status page.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "type": "degradation_updates" + } + }, + "json": { + "data": { + "attributes": { + "description": "string", + "status": "string" + }, + "id": "string", + "type": "degradation_updates" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for editing a degradation update.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes for editing a degradation update.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The message body of the update.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the degradation update. \nAllowed enum values: investigating,identified,monitoring

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the degradation update to edit.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradation updates resource type. \nAllowed enum values: degradation_updates

default: degradation_updates

\n
\n \n
\n
\n
\n
" + } + }, + "ListMaintenanceTemplates": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "completed_description": "string", + "component_ids": [], + "created_at": "2019-09-19T10:00:00.000Z", + "in_progress_description": "string", + "maintenance_title": "string", + "modified_at": "2019-09-19T10:00:00.000Z", + "name": "string", + "scheduled_description": "string" + }, + "id": "string", + "relationships": { + "created_by_user": { + "data": { + "id": "", + "type": "users" + } + }, + "last_modified_by_user": { + "data": { + "id": "", + "type": "users" + } + }, + "status_page": { + "data": { + "id": "", + "type": "status_pages" + } + } + }, + "type": "maintenance_templates" + } + ], + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

A list of maintenance template data objects.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a maintenance template.

\n
\n
\n
\n
\n
\n

completed_description

\n
\n

string

\n

The description shown when a maintenance created from this template is completed.

\n
\n \n
\n
\n
\n
\n
\n

component_ids

\n
\n

[string]

\n

The IDs of the components affected by a maintenance created from this template.

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the maintenance template was created.

\n
\n \n
\n
\n
\n
\n
\n

in_progress_description

\n
\n

string

\n

The description shown while a maintenance created from this template is in progress.

\n
\n \n
\n
\n
\n
\n
\n

maintenance_title

\n
\n

string

\n

The title used for a maintenance created from this template.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the maintenance template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the maintenance template.

\n
\n \n
\n
\n
\n
\n
\n

scheduled_description

\n
\n

string

\n

The description shown when a maintenance created from this template is scheduled.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the maintenance template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a maintenance template.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the maintenance template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the maintenance template.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the maintenance template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the maintenance template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the maintenance template.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the maintenance template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the maintenance template belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the status page associated with a maintenance template.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenance templates resource type. \nAllowed enum values: maintenance_templates

default: maintenance_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a maintenance template. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

<type=users>

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=status_pages>

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

If the component is of type group, the components within the group.

\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

slack_app_icon

\n
\n

string

\n

The Slack app icon URL for the status page.

\n
\n \n
\n
\n
\n
\n
\n

slack_subscriptions_enabled

\n
\n

boolean

\n

Whether Slack subscriptions are enabled for the status page.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "CreateMaintenanceTemplate": { + "responses": { + "201": { + "json": { + "data": { + "attributes": { + "completed_description": "string", + "component_ids": [], + "created_at": "2019-09-19T10:00:00.000Z", + "in_progress_description": "string", + "maintenance_title": "string", + "modified_at": "2019-09-19T10:00:00.000Z", + "name": "string", + "scheduled_description": "string" }, "id": "string", "relationships": { @@ -1527,12 +2304,12 @@ }, "status_page": { "data": { - "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "id": "", "type": "status_pages" } } }, - "type": "degradations" + "type": "maintenance_templates" }, "included": [ { @@ -1548,7 +2325,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for a degradation.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a degradation.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

Components affected by the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the degradation was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

is_backfilled

\n
\n

boolean

\n

Whether the degradation was backfilled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the degradation was last modified.

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

The source of the degradation.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp of when the source was created.

\n
\n \n
\n
\n
\n
\n
\n

source_id [required]

\n
\n

string

\n

The ID of the source.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the source. \nAllowed enum values: incident

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

updates

\n
\n

[object]

\n

Past updates made to the degradation.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected at the time of the update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

Identifier of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component affected at the time of the update. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the update was created.

\n
\n \n
\n
\n
\n
\n
\n

deleted_at

\n
\n

string

\n

The date and time the resource was deleted.

\n
\n \n
\n
\n
\n
\n
\n

deleted_by_user_uuid

\n
\n

string

\n

UUID of the user who deleted the resource.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the update.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Identifier of the update.

\n
\n \n
\n
\n
\n
\n
\n

last_modified_by_user_uuid

\n
\n

string

\n

UUID of the user who last modified the resource.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the update was last modified.

\n
\n \n
\n
\n
\n
\n
\n

started_at

\n
\n

date-time

\n

Timestamp of when the update started.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a degradation.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the degradation.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the degradation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the degradation.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the degradation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the degradation belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the status page the degradation belongs to.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradations resource type. \nAllowed enum values: degradations

default: degradations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a degradation. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

<type=users>

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=status_pages>

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

If the component is of type group, the components within the group.

\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

slack_app_icon

\n
\n

string

\n

The Slack app icon URL for the status page.

\n
\n \n
\n
\n
\n
\n
\n

slack_subscriptions_enabled

\n
\n

boolean

\n

Whether Slack subscriptions are enabled for the status page.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for a maintenance template.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a maintenance template.

\n
\n
\n
\n
\n
\n

completed_description

\n
\n

string

\n

The description shown when a maintenance created from this template is completed.

\n
\n \n
\n
\n
\n
\n
\n

component_ids

\n
\n

[string]

\n

The IDs of the components affected by a maintenance created from this template.

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the maintenance template was created.

\n
\n \n
\n
\n
\n
\n
\n

in_progress_description

\n
\n

string

\n

The description shown while a maintenance created from this template is in progress.

\n
\n \n
\n
\n
\n
\n
\n

maintenance_title

\n
\n

string

\n

The title used for a maintenance created from this template.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the maintenance template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the maintenance template.

\n
\n \n
\n
\n
\n
\n
\n

scheduled_description

\n
\n

string

\n

The description shown when a maintenance created from this template is scheduled.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the maintenance template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a maintenance template.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the maintenance template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the maintenance template.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the maintenance template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the maintenance template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the maintenance template.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the maintenance template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the maintenance template belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the status page associated with a maintenance template.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenance templates resource type. \nAllowed enum values: maintenance_templates

default: maintenance_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a maintenance template. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

<type=users>

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=status_pages>

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

If the component is of type group, the components within the group.

\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

slack_app_icon

\n
\n

string

\n

The Slack app icon URL for the status page.

\n
\n \n
\n
\n
\n
\n
\n

slack_subscriptions_enabled

\n
\n

boolean

\n

Whether Slack subscriptions are enabled for the status page.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
" }, "429": { "json": { @@ -1563,38 +2340,28 @@ "json_curl": { "data": { "attributes": { - "components_affected": [ - { - "id": "1234abcd-12ab-34cd-56ef-123456abcdef", - "status": "operational" - } - ] + "name": "" }, - "id": "1234abcd-12ab-34cd-56ef-123456abcdef", - "type": "degradations" + "type": "maintenance_templates" } }, "json": { "data": { "attributes": { - "components_affected": [ - { - "id": "1234abcd-12ab-34cd-56ef-123456abcdef", - "status": "operational" - } - ], - "description": "We've deployed a fix and latency has returned to normal. This issue has been resolved.", - "status": "resolved", - "title": "Elevated API Latency" + "completed_description": "string", + "component_ids": [], + "in_progress_description": "string", + "maintenance_title": "string", + "name": "", + "scheduled_description": "string" }, - "id": "1234abcd-12ab-34cd-56ef-123456abcdef", - "type": "degradations" + "type": "maintenance_templates" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for updating a degradation.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The supported attributes for updating a degradation.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected by the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component. Must be a component of type component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the degradation.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradations resource type. \nAllowed enum values: degradations

default: degradations

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for creating a maintenance template.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes for creating a maintenance template.

\n
\n
\n
\n
\n
\n

completed_description

\n
\n

string

\n

The description shown when a maintenance created from this template is completed.

\n
\n \n
\n
\n
\n
\n
\n

component_ids

\n
\n

[string]

\n

The IDs of the components affected by a maintenance created from this template.

\n
\n \n
\n
\n
\n
\n
\n

in_progress_description

\n
\n

string

\n

The description shown while a maintenance created from this template is in progress.

\n
\n \n
\n
\n
\n
\n
\n

maintenance_title

\n
\n

string

\n

The title used for a maintenance created from this template.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the maintenance template.

\n
\n \n
\n
\n
\n
\n
\n

scheduled_description

\n
\n

string

\n

The description shown when a maintenance created from this template is scheduled.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenance templates resource type. \nAllowed enum values: maintenance_templates

default: maintenance_templates

\n
\n \n
\n
\n
\n
" } }, - "SoftDeleteDegradationUpdate": { + "DeleteMaintenanceTemplate": { "responses": { "429": { "json": { @@ -1611,25 +2378,20 @@ "html": "" } }, - "EditDegradationUpdate": { + "GetMaintenanceTemplate": { "responses": { "200": { "json": { "data": { "attributes": { - "components_affected": [ - { - "id": "", - "name": "string", - "status": "operational" - } - ], + "completed_description": "string", + "component_ids": [], "created_at": "2019-09-19T10:00:00.000Z", - "deleted_at": "2019-09-19T10:00:00.000Z", - "description": "string", + "in_progress_description": "string", + "maintenance_title": "string", "modified_at": "2019-09-19T10:00:00.000Z", - "started_at": "2019-09-19T10:00:00.000Z", - "status": "investigating" + "name": "string", + "scheduled_description": "string" }, "id": "string", "relationships": { @@ -1639,13 +2401,70 @@ "type": "users" } }, - "degradation": { + "last_modified_by_user": { "data": { "id": "", - "type": "degradations" + "type": "users" } }, - "deleted_by_user": { + "status_page": { + "data": { + "id": "", + "type": "status_pages" + } + } + }, + "type": "maintenance_templates" + }, + "included": [ + { + "attributes": { + "email": "string", + "handle": "string", + "icon": "string", + "name": "string", + "uuid": "string" + }, + "id": "string", + "type": "users" + } + ] + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for a maintenance template.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a maintenance template.

\n
\n
\n
\n
\n
\n

completed_description

\n
\n

string

\n

The description shown when a maintenance created from this template is completed.

\n
\n \n
\n
\n
\n
\n
\n

component_ids

\n
\n

[string]

\n

The IDs of the components affected by a maintenance created from this template.

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the maintenance template was created.

\n
\n \n
\n
\n
\n
\n
\n

in_progress_description

\n
\n

string

\n

The description shown while a maintenance created from this template is in progress.

\n
\n \n
\n
\n
\n
\n
\n

maintenance_title

\n
\n

string

\n

The title used for a maintenance created from this template.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the maintenance template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the maintenance template.

\n
\n \n
\n
\n
\n
\n
\n

scheduled_description

\n
\n

string

\n

The description shown when a maintenance created from this template is scheduled.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the maintenance template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a maintenance template.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the maintenance template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the maintenance template.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the maintenance template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the maintenance template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the maintenance template.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the maintenance template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the maintenance template belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the status page associated with a maintenance template.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenance templates resource type. \nAllowed enum values: maintenance_templates

default: maintenance_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a maintenance template. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

<type=users>

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=status_pages>

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

If the component is of type group, the components within the group.

\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

slack_app_icon

\n
\n

string

\n

The Slack app icon URL for the status page.

\n
\n \n
\n
\n
\n
\n
\n

slack_subscriptions_enabled

\n
\n

boolean

\n

Whether Slack subscriptions are enabled for the status page.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "UpdateMaintenanceTemplate": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "completed_description": "string", + "component_ids": [], + "created_at": "2019-09-19T10:00:00.000Z", + "in_progress_description": "string", + "maintenance_title": "string", + "modified_at": "2019-09-19T10:00:00.000Z", + "name": "string", + "scheduled_description": "string" + }, + "id": "string", + "relationships": { + "created_by_user": { "data": { "id": "", "type": "users" @@ -1664,7 +2483,7 @@ } } }, - "type": "degradation_updates" + "type": "maintenance_templates" }, "included": [ { @@ -1680,7 +2499,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for a degradation update.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of a degradation update resource.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

Components affected by this update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the affected component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the affected component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

The date and time the update was created.

\n
\n \n
\n
\n
\n
\n
\n

deleted_at

\n
\n

date-time

\n

The date and time the update was soft-deleted.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The message body of the update.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

The date and time the update was last modified.

\n
\n \n
\n
\n
\n
\n
\n

started_at

\n
\n

date-time

\n

The date and time the update started.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the degradation update.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of a degradation update resource.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

A user relationship of a degradation update.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A Datadog user linked to a degradation update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

degradation

\n
\n

object

\n

The degradation relationship of a degradation update.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The degradation linked to a degradation update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradations resource type. \nAllowed enum values: degradations

default: degradations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

deleted_by_user

\n
\n

object

\n

A user relationship of a degradation update.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A Datadog user linked to a degradation update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

A user relationship of a degradation update.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A Datadog user linked to a degradation update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page relationship of a degradation update.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The status page linked to a degradation update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradation updates resource type. \nAllowed enum values: degradation_updates

default: degradation_updates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Resources related to the degradation update.

\n
\n
\n
\n
\n
\n

<type=users>

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Response object for a single degradation.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for a degradation.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a degradation.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

Components affected by the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the degradation was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

is_backfilled

\n
\n

boolean

\n

Whether the degradation was backfilled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the degradation was last modified.

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

The source of the degradation.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp of when the source was created.

\n
\n \n
\n
\n
\n
\n
\n

source_id [required]

\n
\n

string

\n

The ID of the source.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the source. \nAllowed enum values: incident

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

updates

\n
\n

[object]

\n

Past updates made to the degradation.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected at the time of the update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

Identifier of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component affected at the time of the update. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the update was created.

\n
\n \n
\n
\n
\n
\n
\n

deleted_at

\n
\n

string

\n

The date and time the resource was deleted.

\n
\n \n
\n
\n
\n
\n
\n

deleted_by_user_uuid

\n
\n

string

\n

UUID of the user who deleted the resource.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the update.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Identifier of the update.

\n
\n \n
\n
\n
\n
\n
\n

last_modified_by_user_uuid

\n
\n

string

\n

UUID of the user who last modified the resource.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the update was last modified.

\n
\n \n
\n
\n
\n
\n
\n

started_at

\n
\n

date-time

\n

Timestamp of when the update started.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the degradation. \nAllowed enum values: investigating,identified,monitoring,resolved

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the degradation.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a degradation.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the degradation.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the degradation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the degradation.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the degradation.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the degradation.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the degradation belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the status page the degradation belongs to.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradations resource type. \nAllowed enum values: degradations

default: degradations

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a degradation. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

<type=users>

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=status_pages>

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

If the component is of type group, the components within the group.

\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

slack_app_icon

\n
\n

string

\n

The Slack app icon URL for the status page.

\n
\n \n
\n
\n
\n
\n
\n

slack_subscriptions_enabled

\n
\n

boolean

\n

Whether Slack subscriptions are enabled for the status page.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

<type=status_pages>

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

If the component is of type group, the components within the group.

\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

slack_app_icon

\n
\n

string

\n

The Slack app icon URL for the status page.

\n
\n \n
\n
\n
\n
\n
\n

slack_subscriptions_enabled

\n
\n

boolean

\n

Whether Slack subscriptions are enabled for the status page.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for a maintenance template.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a maintenance template.

\n
\n
\n
\n
\n
\n

completed_description

\n
\n

string

\n

The description shown when a maintenance created from this template is completed.

\n
\n \n
\n
\n
\n
\n
\n

component_ids

\n
\n

[string]

\n

The IDs of the components affected by a maintenance created from this template.

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the maintenance template was created.

\n
\n \n
\n
\n
\n
\n
\n

in_progress_description

\n
\n

string

\n

The description shown while a maintenance created from this template is in progress.

\n
\n \n
\n
\n
\n
\n
\n

maintenance_title

\n
\n

string

\n

The title used for a maintenance created from this template.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the maintenance template was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the maintenance template.

\n
\n \n
\n
\n
\n
\n
\n

scheduled_description

\n
\n

string

\n

The description shown when a maintenance created from this template is scheduled.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the maintenance template.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a maintenance template.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the maintenance template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the maintenance template.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the maintenance template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the maintenance template.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the maintenance template.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the maintenance template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the maintenance template belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the status page associated with a maintenance template.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenance templates resource type. \nAllowed enum values: maintenance_templates

default: maintenance_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a maintenance template. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

<type=users>

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=status_pages>

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

If the component is of type group, the components within the group.

\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

slack_app_icon

\n
\n

string

\n

The Slack app icon URL for the status page.

\n
\n \n
\n
\n
\n
\n
\n

slack_subscriptions_enabled

\n
\n

boolean

\n

Whether Slack subscriptions are enabled for the status page.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
" }, "429": { "json": { @@ -1694,20 +2513,25 @@ "request": { "json_curl": { "data": { - "type": "degradation_updates" + "id": "", + "type": "maintenance_templates" } }, "json": { "data": { "attributes": { - "description": "string", - "status": "string" + "completed_description": "string", + "component_ids": [], + "in_progress_description": "string", + "maintenance_title": "string", + "name": "string", + "scheduled_description": "string" }, - "id": "string", - "type": "degradation_updates" + "id": "", + "type": "maintenance_templates" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for editing a degradation update.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes for editing a degradation update.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The message body of the update.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the degradation update. \nAllowed enum values: investigating,identified,monitoring

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the degradation update to edit.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Degradation updates resource type. \nAllowed enum values: degradation_updates

default: degradation_updates

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for updating a maintenance template.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The supported attributes for updating a maintenance template.

\n
\n
\n
\n
\n
\n

completed_description

\n
\n

string

\n

The description shown when a maintenance created from this template is completed.

\n
\n \n
\n
\n
\n
\n
\n

component_ids

\n
\n

[string]

\n

The IDs of the components affected by a maintenance created from this template.

\n
\n \n
\n
\n
\n
\n
\n

in_progress_description

\n
\n

string

\n

The description shown while a maintenance created from this template is in progress.

\n
\n \n
\n
\n
\n
\n
\n

maintenance_title

\n
\n

string

\n

The title used for a maintenance created from this template.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the maintenance template.

\n
\n \n
\n
\n
\n
\n
\n

scheduled_description

\n
\n

string

\n

The description shown when a maintenance created from this template is scheduled.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the maintenance template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenance templates resource type. \nAllowed enum values: maintenance_templates

default: maintenance_templates

\n
\n \n
\n
\n
\n
" } }, "CreateMaintenance": { @@ -1771,6 +2595,12 @@ "id": "", "type": "status_pages" } + }, + "template": { + "data": { + "id": "", + "type": "maintenance_templates" + } } }, "type": "maintenances" @@ -1789,7 +2619,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for a maintenance.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a maintenance.

\n
\n
\n
\n
\n
\n

completed_date

\n
\n

date-time

\n

Timestamp of when the maintenance was completed.

\n
\n \n
\n
\n
\n
\n
\n

completed_description

\n
\n

string

\n

The description shown when the maintenance is completed.

\n
\n \n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

Components affected by the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component. Must be a component of type component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

in_progress_description

\n
\n

string

\n

The description shown while the maintenance is in progress.

\n
\n \n
\n
\n
\n
\n
\n

is_backfilled

\n
\n

boolean

\n

Whether the maintenance was backfilled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the maintenance was last modified.

\n
\n \n
\n
\n
\n
\n
\n

published_date

\n
\n

date-time

\n

Timestamp of when the maintenance was published.

\n
\n \n
\n
\n
\n
\n
\n

scheduled_description

\n
\n

string

\n

The description shown when the maintenance is scheduled.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

date-time

\n

Timestamp of when the maintenance is scheduled to start.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the maintenance. \nAllowed enum values: scheduled,in_progress,completed

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

updates

\n
\n

[object]

\n

Past updates made to the maintenance.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected at the time of the update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

Identifier of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component affected at the time of the update. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the update was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the update.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Identifier of the update.

\n
\n \n
\n
\n
\n
\n
\n

manual_transition

\n
\n

boolean

\n

Whether the update was applied manually by a user (true) or automatically by the system (false).

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the update was last modified.

\n
\n \n
\n
\n
\n
\n
\n

started_at

\n
\n

date-time

\n

Timestamp of when the update started.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The status of the update.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a maintenance.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the maintenance.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the Datadog user who created the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the maintenance.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the Datadog user who last modified the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the maintenance belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the status page associated with a maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenances resource type. \nAllowed enum values: maintenances

default: maintenances

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a maintenance. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

<type=users>

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=status_pages>

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

If the component is of type group, the components within the group.

\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

slack_app_icon

\n
\n

string

\n

The Slack app icon URL for the status page.

\n
\n \n
\n
\n
\n
\n
\n

slack_subscriptions_enabled

\n
\n

boolean

\n

Whether Slack subscriptions are enabled for the status page.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for a maintenance.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a maintenance.

\n
\n
\n
\n
\n
\n

completed_date

\n
\n

date-time

\n

Timestamp of when the maintenance was completed.

\n
\n \n
\n
\n
\n
\n
\n

completed_description

\n
\n

string

\n

The description shown when the maintenance is completed.

\n
\n \n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

Components affected by the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component. Must be a component of type component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

in_progress_description

\n
\n

string

\n

The description shown while the maintenance is in progress.

\n
\n \n
\n
\n
\n
\n
\n

is_backfilled

\n
\n

boolean

\n

Whether the maintenance was backfilled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the maintenance was last modified.

\n
\n \n
\n
\n
\n
\n
\n

published_date

\n
\n

date-time

\n

Timestamp of when the maintenance was published.

\n
\n \n
\n
\n
\n
\n
\n

scheduled_description

\n
\n

string

\n

The description shown when the maintenance is scheduled.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

date-time

\n

Timestamp of when the maintenance is scheduled to start.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the maintenance. \nAllowed enum values: scheduled,in_progress,completed

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

updates

\n
\n

[object]

\n

Past updates made to the maintenance.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected at the time of the update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

Identifier of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component affected at the time of the update. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the update was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the update.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Identifier of the update.

\n
\n \n
\n
\n
\n
\n
\n

manual_transition

\n
\n

boolean

\n

Whether the update was applied manually by a user (true) or automatically by the system (false).

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the update was last modified.

\n
\n \n
\n
\n
\n
\n
\n

started_at

\n
\n

date-time

\n

Timestamp of when the update started.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The status of the update.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a maintenance.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the maintenance.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the Datadog user who created the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the maintenance.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the Datadog user who last modified the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the maintenance belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the status page associated with a maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

template

\n
\n

object

\n

The template the maintenance was created from.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the template the maintenance was created from.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the maintenance template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenance templates resource type. \nAllowed enum values: maintenance_templates

default: maintenance_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenances resource type. \nAllowed enum values: maintenances

default: maintenances

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a maintenance. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

<type=users>

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=status_pages>

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

If the component is of type group, the components within the group.

\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

slack_app_icon

\n
\n

string

\n

The Slack app icon URL for the status page.

\n
\n \n
\n
\n
\n
\n
\n

slack_subscriptions_enabled

\n
\n

boolean

\n

Whether Slack subscriptions are enabled for the status page.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
" }, "429": { "json": { @@ -1817,6 +2647,14 @@ "start_date": "2026-02-18T19:21:13.332360075Z", "title": "API Maintenance" }, + "relationships": { + "template": { + "data": { + "id": "", + "type": "maintenance_templates" + } + } + }, "type": "maintenances" } }, @@ -1836,10 +2674,18 @@ "start_date": "2026-02-18T19:21:13.332360075Z", "title": "API Maintenance" }, + "relationships": { + "template": { + "data": { + "id": "", + "type": "maintenance_templates" + } + } + }, "type": "maintenances" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for creating a maintenance.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The supported attributes for creating a maintenance.

\n
\n
\n
\n
\n
\n

completed_date [required]

\n
\n

date-time

\n

Timestamp of when the maintenance was completed.

\n
\n \n
\n
\n
\n
\n
\n

completed_description [required]

\n
\n

string

\n

The description shown when the maintenance is completed.

\n
\n \n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected by the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component. Must be a component of type component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

in_progress_description [required]

\n
\n

string

\n

The description shown while the maintenance is in progress.

\n
\n \n
\n
\n
\n
\n
\n

scheduled_description [required]

\n
\n

string

\n

The description shown when the maintenance is scheduled.

\n
\n \n
\n
\n
\n
\n
\n

start_date [required]

\n
\n

date-time

\n

Timestamp of when the maintenance is scheduled to start.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenances resource type. \nAllowed enum values: maintenances

default: maintenances

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for creating a maintenance.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The supported attributes for creating a maintenance.

\n
\n
\n
\n
\n
\n

completed_date [required]

\n
\n

date-time

\n

Timestamp of when the maintenance was completed.

\n
\n \n
\n
\n
\n
\n
\n

completed_description [required]

\n
\n

string

\n

The description shown when the maintenance is completed.

\n
\n \n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected by the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component. Must be a component of type component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

in_progress_description [required]

\n
\n

string

\n

The description shown while the maintenance is in progress.

\n
\n \n
\n
\n
\n
\n
\n

scheduled_description [required]

\n
\n

string

\n

The description shown when the maintenance is scheduled.

\n
\n \n
\n
\n
\n
\n
\n

start_date [required]

\n
\n

date-time

\n

Timestamp of when the maintenance is scheduled to start.

\n
\n \n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The supported relationships for creating a maintenance.

\n
\n
\n
\n
\n
\n

template

\n
\n

object

\n

The template used to create the maintenance.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the template used to create the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the maintenance template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenance templates resource type. \nAllowed enum values: maintenance_templates

default: maintenance_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenances resource type. \nAllowed enum values: maintenances

default: maintenances

\n
\n \n
\n
\n
\n
" } }, "CreateBackfilledMaintenance": { @@ -1903,6 +2749,12 @@ "id": "", "type": "status_pages" } + }, + "template": { + "data": { + "id": "", + "type": "maintenance_templates" + } } }, "type": "maintenances" @@ -1921,7 +2773,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for a maintenance.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a maintenance.

\n
\n
\n
\n
\n
\n

completed_date

\n
\n

date-time

\n

Timestamp of when the maintenance was completed.

\n
\n \n
\n
\n
\n
\n
\n

completed_description

\n
\n

string

\n

The description shown when the maintenance is completed.

\n
\n \n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

Components affected by the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component. Must be a component of type component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

in_progress_description

\n
\n

string

\n

The description shown while the maintenance is in progress.

\n
\n \n
\n
\n
\n
\n
\n

is_backfilled

\n
\n

boolean

\n

Whether the maintenance was backfilled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the maintenance was last modified.

\n
\n \n
\n
\n
\n
\n
\n

published_date

\n
\n

date-time

\n

Timestamp of when the maintenance was published.

\n
\n \n
\n
\n
\n
\n
\n

scheduled_description

\n
\n

string

\n

The description shown when the maintenance is scheduled.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

date-time

\n

Timestamp of when the maintenance is scheduled to start.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the maintenance. \nAllowed enum values: scheduled,in_progress,completed

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

updates

\n
\n

[object]

\n

Past updates made to the maintenance.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected at the time of the update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

Identifier of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component affected at the time of the update. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the update was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the update.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Identifier of the update.

\n
\n \n
\n
\n
\n
\n
\n

manual_transition

\n
\n

boolean

\n

Whether the update was applied manually by a user (true) or automatically by the system (false).

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the update was last modified.

\n
\n \n
\n
\n
\n
\n
\n

started_at

\n
\n

date-time

\n

Timestamp of when the update started.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The status of the update.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a maintenance.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the maintenance.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the Datadog user who created the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the maintenance.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the Datadog user who last modified the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the maintenance belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the status page associated with a maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenances resource type. \nAllowed enum values: maintenances

default: maintenances

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a maintenance. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

<type=users>

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=status_pages>

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

If the component is of type group, the components within the group.

\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

slack_app_icon

\n
\n

string

\n

The Slack app icon URL for the status page.

\n
\n \n
\n
\n
\n
\n
\n

slack_subscriptions_enabled

\n
\n

boolean

\n

Whether Slack subscriptions are enabled for the status page.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for a maintenance.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a maintenance.

\n
\n
\n
\n
\n
\n

completed_date

\n
\n

date-time

\n

Timestamp of when the maintenance was completed.

\n
\n \n
\n
\n
\n
\n
\n

completed_description

\n
\n

string

\n

The description shown when the maintenance is completed.

\n
\n \n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

Components affected by the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component. Must be a component of type component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

in_progress_description

\n
\n

string

\n

The description shown while the maintenance is in progress.

\n
\n \n
\n
\n
\n
\n
\n

is_backfilled

\n
\n

boolean

\n

Whether the maintenance was backfilled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the maintenance was last modified.

\n
\n \n
\n
\n
\n
\n
\n

published_date

\n
\n

date-time

\n

Timestamp of when the maintenance was published.

\n
\n \n
\n
\n
\n
\n
\n

scheduled_description

\n
\n

string

\n

The description shown when the maintenance is scheduled.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

date-time

\n

Timestamp of when the maintenance is scheduled to start.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the maintenance. \nAllowed enum values: scheduled,in_progress,completed

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

updates

\n
\n

[object]

\n

Past updates made to the maintenance.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected at the time of the update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

Identifier of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component affected at the time of the update. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the update was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the update.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Identifier of the update.

\n
\n \n
\n
\n
\n
\n
\n

manual_transition

\n
\n

boolean

\n

Whether the update was applied manually by a user (true) or automatically by the system (false).

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the update was last modified.

\n
\n \n
\n
\n
\n
\n
\n

started_at

\n
\n

date-time

\n

Timestamp of when the update started.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The status of the update.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a maintenance.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the maintenance.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the Datadog user who created the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the maintenance.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the Datadog user who last modified the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the maintenance belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the status page associated with a maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

template

\n
\n

object

\n

The template the maintenance was created from.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the template the maintenance was created from.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the maintenance template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenance templates resource type. \nAllowed enum values: maintenance_templates

default: maintenance_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenances resource type. \nAllowed enum values: maintenances

default: maintenances

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a maintenance. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

<type=users>

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=status_pages>

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

If the component is of type group, the components within the group.

\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

slack_app_icon

\n
\n

string

\n

The Slack app icon URL for the status page.

\n
\n \n
\n
\n
\n
\n
\n

slack_subscriptions_enabled

\n
\n

boolean

\n

Whether Slack subscriptions are enabled for the status page.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
" }, "429": { "json": { @@ -1951,6 +2803,14 @@ } ] }, + "relationships": { + "template": { + "data": { + "id": "", + "type": "maintenance_templates" + } + } + }, "type": "maintenances" } }, @@ -1972,10 +2832,18 @@ } ] }, + "relationships": { + "template": { + "data": { + "id": "", + "type": "maintenance_templates" + } + } + }, "type": "maintenances" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for creating a backfilled maintenance.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The supported attributes for creating a backfilled maintenance.

\n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the backfilled maintenance.

\n
\n \n
\n
\n
\n
\n
\n

updates [required]

\n
\n

[object]

\n

The list of updates. Exactly two updates are required: the start (in_progress) and the end (completed).

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component. Must be a component of type component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

A description of the update.

\n
\n \n
\n
\n
\n
\n
\n

started_at [required]

\n
\n

date-time

\n

Timestamp of when the update occurred.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of a maintenance update. \nAllowed enum values: in_progress,completed

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenances resource type. \nAllowed enum values: maintenances

default: maintenances

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for creating a backfilled maintenance.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The supported attributes for creating a backfilled maintenance.

\n
\n
\n
\n
\n
\n

title [required]

\n
\n

string

\n

The title of the backfilled maintenance.

\n
\n \n
\n
\n
\n
\n
\n

updates [required]

\n
\n

[object]

\n

The list of updates. Exactly two updates are required: the start (in_progress) and the end (completed).

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component. Must be a component of type component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

A description of the update.

\n
\n \n
\n
\n
\n
\n
\n

started_at [required]

\n
\n

date-time

\n

Timestamp of when the update occurred.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of a maintenance update. \nAllowed enum values: in_progress,completed

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The supported relationships for creating a backfilled maintenance.

\n
\n
\n
\n
\n
\n

template

\n
\n

object

\n

The template used to create the backfilled maintenance.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the template used to create the backfilled maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the maintenance template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenance templates resource type. \nAllowed enum values: maintenance_templates

default: maintenance_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenances resource type. \nAllowed enum values: maintenances

default: maintenances

\n
\n \n
\n
\n
\n
" } }, "GetMaintenance": { @@ -2039,6 +2907,12 @@ "id": "", "type": "status_pages" } + }, + "template": { + "data": { + "id": "", + "type": "maintenance_templates" + } } }, "type": "maintenances" @@ -2057,7 +2931,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for a maintenance.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a maintenance.

\n
\n
\n
\n
\n
\n

completed_date

\n
\n

date-time

\n

Timestamp of when the maintenance was completed.

\n
\n \n
\n
\n
\n
\n
\n

completed_description

\n
\n

string

\n

The description shown when the maintenance is completed.

\n
\n \n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

Components affected by the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component. Must be a component of type component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

in_progress_description

\n
\n

string

\n

The description shown while the maintenance is in progress.

\n
\n \n
\n
\n
\n
\n
\n

is_backfilled

\n
\n

boolean

\n

Whether the maintenance was backfilled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the maintenance was last modified.

\n
\n \n
\n
\n
\n
\n
\n

published_date

\n
\n

date-time

\n

Timestamp of when the maintenance was published.

\n
\n \n
\n
\n
\n
\n
\n

scheduled_description

\n
\n

string

\n

The description shown when the maintenance is scheduled.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

date-time

\n

Timestamp of when the maintenance is scheduled to start.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the maintenance. \nAllowed enum values: scheduled,in_progress,completed

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

updates

\n
\n

[object]

\n

Past updates made to the maintenance.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected at the time of the update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

Identifier of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component affected at the time of the update. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the update was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the update.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Identifier of the update.

\n
\n \n
\n
\n
\n
\n
\n

manual_transition

\n
\n

boolean

\n

Whether the update was applied manually by a user (true) or automatically by the system (false).

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the update was last modified.

\n
\n \n
\n
\n
\n
\n
\n

started_at

\n
\n

date-time

\n

Timestamp of when the update started.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The status of the update.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a maintenance.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the maintenance.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the Datadog user who created the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the maintenance.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the Datadog user who last modified the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the maintenance belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the status page associated with a maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenances resource type. \nAllowed enum values: maintenances

default: maintenances

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a maintenance. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

<type=users>

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=status_pages>

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

If the component is of type group, the components within the group.

\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

slack_app_icon

\n
\n

string

\n

The Slack app icon URL for the status page.

\n
\n \n
\n
\n
\n
\n
\n

slack_subscriptions_enabled

\n
\n

boolean

\n

Whether Slack subscriptions are enabled for the status page.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for a maintenance.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a maintenance.

\n
\n
\n
\n
\n
\n

completed_date

\n
\n

date-time

\n

Timestamp of when the maintenance was completed.

\n
\n \n
\n
\n
\n
\n
\n

completed_description

\n
\n

string

\n

The description shown when the maintenance is completed.

\n
\n \n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

Components affected by the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component. Must be a component of type component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

in_progress_description

\n
\n

string

\n

The description shown while the maintenance is in progress.

\n
\n \n
\n
\n
\n
\n
\n

is_backfilled

\n
\n

boolean

\n

Whether the maintenance was backfilled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the maintenance was last modified.

\n
\n \n
\n
\n
\n
\n
\n

published_date

\n
\n

date-time

\n

Timestamp of when the maintenance was published.

\n
\n \n
\n
\n
\n
\n
\n

scheduled_description

\n
\n

string

\n

The description shown when the maintenance is scheduled.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

date-time

\n

Timestamp of when the maintenance is scheduled to start.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the maintenance. \nAllowed enum values: scheduled,in_progress,completed

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

updates

\n
\n

[object]

\n

Past updates made to the maintenance.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected at the time of the update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

Identifier of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component affected at the time of the update. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the update was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the update.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Identifier of the update.

\n
\n \n
\n
\n
\n
\n
\n

manual_transition

\n
\n

boolean

\n

Whether the update was applied manually by a user (true) or automatically by the system (false).

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the update was last modified.

\n
\n \n
\n
\n
\n
\n
\n

started_at

\n
\n

date-time

\n

Timestamp of when the update started.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The status of the update.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a maintenance.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the maintenance.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the Datadog user who created the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the maintenance.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the Datadog user who last modified the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the maintenance belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the status page associated with a maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

template

\n
\n

object

\n

The template the maintenance was created from.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the template the maintenance was created from.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the maintenance template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenance templates resource type. \nAllowed enum values: maintenance_templates

default: maintenance_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenances resource type. \nAllowed enum values: maintenances

default: maintenances

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a maintenance. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

<type=users>

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=status_pages>

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

If the component is of type group, the components within the group.

\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

slack_app_icon

\n
\n

string

\n

The Slack app icon URL for the status page.

\n
\n \n
\n
\n
\n
\n
\n

slack_subscriptions_enabled

\n
\n

boolean

\n

Whether Slack subscriptions are enabled for the status page.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
" }, "429": { "json": { @@ -2135,6 +3009,12 @@ "id": "", "type": "status_pages" } + }, + "template": { + "data": { + "id": "", + "type": "maintenance_templates" + } } }, "type": "maintenances" @@ -2153,7 +3033,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for a maintenance.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a maintenance.

\n
\n
\n
\n
\n
\n

completed_date

\n
\n

date-time

\n

Timestamp of when the maintenance was completed.

\n
\n \n
\n
\n
\n
\n
\n

completed_description

\n
\n

string

\n

The description shown when the maintenance is completed.

\n
\n \n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

Components affected by the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component. Must be a component of type component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

in_progress_description

\n
\n

string

\n

The description shown while the maintenance is in progress.

\n
\n \n
\n
\n
\n
\n
\n

is_backfilled

\n
\n

boolean

\n

Whether the maintenance was backfilled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the maintenance was last modified.

\n
\n \n
\n
\n
\n
\n
\n

published_date

\n
\n

date-time

\n

Timestamp of when the maintenance was published.

\n
\n \n
\n
\n
\n
\n
\n

scheduled_description

\n
\n

string

\n

The description shown when the maintenance is scheduled.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

date-time

\n

Timestamp of when the maintenance is scheduled to start.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the maintenance. \nAllowed enum values: scheduled,in_progress,completed

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

updates

\n
\n

[object]

\n

Past updates made to the maintenance.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected at the time of the update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

Identifier of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component affected at the time of the update. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the update was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the update.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Identifier of the update.

\n
\n \n
\n
\n
\n
\n
\n

manual_transition

\n
\n

boolean

\n

Whether the update was applied manually by a user (true) or automatically by the system (false).

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the update was last modified.

\n
\n \n
\n
\n
\n
\n
\n

started_at

\n
\n

date-time

\n

Timestamp of when the update started.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The status of the update.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a maintenance.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the maintenance.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the Datadog user who created the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the maintenance.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the Datadog user who last modified the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the maintenance belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the status page associated with a maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenances resource type. \nAllowed enum values: maintenances

default: maintenances

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a maintenance. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

<type=users>

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=status_pages>

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

If the component is of type group, the components within the group.

\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

slack_app_icon

\n
\n

string

\n

The Slack app icon URL for the status page.

\n
\n \n
\n
\n
\n
\n
\n

slack_subscriptions_enabled

\n
\n

boolean

\n

Whether Slack subscriptions are enabled for the status page.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for a maintenance.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a maintenance.

\n
\n
\n
\n
\n
\n

completed_date

\n
\n

date-time

\n

Timestamp of when the maintenance was completed.

\n
\n \n
\n
\n
\n
\n
\n

completed_description

\n
\n

string

\n

The description shown when the maintenance is completed.

\n
\n \n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

Components affected by the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component. Must be a component of type component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

in_progress_description

\n
\n

string

\n

The description shown while the maintenance is in progress.

\n
\n \n
\n
\n
\n
\n
\n

is_backfilled

\n
\n

boolean

\n

Whether the maintenance was backfilled.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the maintenance was last modified.

\n
\n \n
\n
\n
\n
\n
\n

published_date

\n
\n

date-time

\n

Timestamp of when the maintenance was published.

\n
\n \n
\n
\n
\n
\n
\n

scheduled_description

\n
\n

string

\n

The description shown when the maintenance is scheduled.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

date-time

\n

Timestamp of when the maintenance is scheduled to start.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the maintenance. \nAllowed enum values: scheduled,in_progress,completed

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

updates

\n
\n

[object]

\n

Past updates made to the maintenance.

\n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected at the time of the update.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

Identifier of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component affected at the time of the update.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component affected at the time of the update. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the update was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the update.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

Identifier of the update.

\n
\n \n
\n
\n
\n
\n
\n

manual_transition

\n
\n

boolean

\n

Whether the update was applied manually by a user (true) or automatically by the system (false).

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the update was last modified.

\n
\n \n
\n
\n
\n
\n
\n

started_at

\n
\n

date-time

\n

Timestamp of when the update started.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The status of the update.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a maintenance.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the maintenance.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the Datadog user who created the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the maintenance.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the Datadog user who last modified the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

status_page

\n
\n

object

\n

The status page the maintenance belongs to.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the status page associated with a maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

template

\n
\n

object

\n

The template the maintenance was created from.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the template the maintenance was created from.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the maintenance template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenance templates resource type. \nAllowed enum values: maintenance_templates

default: maintenance_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenances resource type. \nAllowed enum values: maintenances

default: maintenances

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

The included related resources of a maintenance. Client must explicitly request these resources by name in the include query parameter.

\n
\n
\n
\n
\n
\n

<type=users>

\n
\n

object

\n

The included Datadog user resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Datadog user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

The email of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The handle of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

icon

\n
\n

string

\n

The icon of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

uuid

\n
\n

string

\n

The UUID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the Datadog user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=status_pages>

\n
\n

object

\n

The included status page resource.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of a status page.

\n
\n
\n
\n
\n
\n

company_logo

\n
\n

string

\n

The base64-encoded image data displayed in the company logo.

\n
\n \n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

Components displayed on the status page.

\n
\n
\n
\n
\n
\n

components

\n
\n

[object]

\n

If the component is of type group, the components within the group.

\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the grouped component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the grouped component. Relative to the other components in the group.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

position

\n
\n

int64

\n

The zero-indexed position of the component.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,degraded,partial_outage,major_outage,maintenance

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the component. \nAllowed enum values: component,group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the status page was created.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain

\n
\n

string

\n

If configured, the url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

custom_domain_enabled

\n
\n

boolean

\n

Whether the custom domain is configured.

\n
\n \n
\n
\n
\n
\n
\n

domain_prefix

\n
\n

string

\n

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

\n
\n \n
\n
\n
\n
\n
\n

email_header_image

\n
\n

string

\n

Base64-encoded image data included in email notifications sent to status page subscribers.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether the status page is enabled.

\n
\n \n
\n
\n
\n
\n
\n

favicon

\n
\n

string

\n

Base64-encoded image data displayed in the browser tab.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the status page was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the status page.

\n
\n \n
\n
\n
\n
\n
\n

page_url

\n
\n

string

\n

The url that the status page is accessible at.

\n
\n \n
\n
\n
\n
\n
\n

slack_app_icon

\n
\n

string

\n

The Slack app icon URL for the status page.

\n
\n \n
\n
\n
\n
\n
\n

slack_subscriptions_enabled

\n
\n

boolean

\n

Whether Slack subscriptions are enabled for the status page.

\n
\n \n
\n
\n
\n
\n
\n

subscriptions_enabled

\n
\n

boolean

\n

Whether users can subscribe to the status page.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the status page controlling how the status page is accessed. \nAllowed enum values: public,internal

\n
\n \n
\n
\n
\n
\n
\n

visualization_type

\n
\n

enum

\n

The visualization type of the status page. \nAllowed enum values: bars_and_uptime_percentage,bars_only,component_name_only

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

uuid

\n

The ID of the status page.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The relationships of a status page.

\n
\n
\n
\n
\n
\n

created_by_user

\n
\n

object

\n

The Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who created the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who created the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_modified_by_user

\n
\n

object

\n

The Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the Datadog user who last modified the status page.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Datadog user who last modified the status page.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Status pages resource type. \nAllowed enum values: status_pages

default: status_pages

\n
\n \n
\n
\n
\n
\n
\n
" }, "429": { "json": { @@ -2176,6 +3056,14 @@ ] }, "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "relationships": { + "template": { + "data": { + "id": "", + "type": "maintenance_templates" + } + } + }, "type": "maintenances" } }, @@ -2197,10 +3085,18 @@ "title": "string" }, "id": "1234abcd-12ab-34cd-56ef-123456abcdef", + "relationships": { + "template": { + "data": { + "id": "", + "type": "maintenance_templates" + } + } + }, "type": "maintenances" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for updating a maintenance.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The supported attributes for updating a maintenance.

\n
\n
\n
\n
\n
\n

completed_date

\n
\n

date-time

\n

Timestamp of when the maintenance was completed.

\n
\n \n
\n
\n
\n
\n
\n

completed_description

\n
\n

string

\n

The description shown when the maintenance is completed.

\n
\n \n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected by the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component. Must be a component of type component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

in_progress_description

\n
\n

string

\n

The description shown while the maintenance is in progress.

\n
\n \n
\n
\n
\n
\n
\n

scheduled_description

\n
\n

string

\n

The description shown when the maintenance is scheduled.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

date-time

\n

Timestamp of when the maintenance is scheduled to start.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the maintenance. \nAllowed enum values: scheduled,in_progress,completed

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenances resource type. \nAllowed enum values: maintenances

default: maintenances

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object for updating a maintenance.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The supported attributes for updating a maintenance.

\n
\n
\n
\n
\n
\n

completed_date

\n
\n

date-time

\n

Timestamp of when the maintenance was completed.

\n
\n \n
\n
\n
\n
\n
\n

completed_description

\n
\n

string

\n

The description shown when the maintenance is completed.

\n
\n \n
\n
\n
\n
\n
\n

components_affected

\n
\n

[object]

\n

The components affected by the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the component. Must be a component of type component.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the component.

\n
\n \n
\n
\n
\n
\n
\n

status [required]

\n
\n

enum

\n

The status of the component. \nAllowed enum values: operational,maintenance

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

in_progress_description

\n
\n

string

\n

The description shown while the maintenance is in progress.

\n
\n \n
\n
\n
\n
\n
\n

scheduled_description

\n
\n

string

\n

The description shown when the maintenance is scheduled.

\n
\n \n
\n
\n
\n
\n
\n

start_date

\n
\n

date-time

\n

Timestamp of when the maintenance is scheduled to start.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

The status of the maintenance. \nAllowed enum values: scheduled,in_progress,completed

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the maintenance.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The supported relationships for updating a maintenance.

\n
\n
\n
\n
\n
\n

template

\n
\n

object

\n

The template used to create the maintenance.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object identifying the template used to create the maintenance.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the maintenance template.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenance templates resource type. \nAllowed enum values: maintenance_templates

default: maintenance_templates

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Maintenances resource type. \nAllowed enum values: maintenances

default: maintenances

\n
\n \n
\n
\n
\n
" } }, "PublishStatusPage": { diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index a129635d679..78ef0df2178 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -23461,6 +23461,8 @@ components: properties: attributes: $ref: "#/components/schemas/CreateBackfilledDegradationRequestDataAttributes" + relationships: + $ref: "#/components/schemas/CreateBackfilledDegradationRequestDataRelationships" type: $ref: "#/components/schemas/PatchDegradationRequestDataType" required: @@ -23504,6 +23506,34 @@ components: - started_at - status type: object + CreateBackfilledDegradationRequestDataRelationships: + description: The supported relationships for creating a backfilled degradation. + properties: + template: + $ref: "#/components/schemas/CreateBackfilledDegradationRequestDataRelationshipsTemplate" + description: The template used to create the backfilled degradation. + type: object + CreateBackfilledDegradationRequestDataRelationshipsTemplate: + description: The template used to create the backfilled degradation. + properties: + data: + $ref: "#/components/schemas/CreateBackfilledDegradationRequestDataRelationshipsTemplateData" + required: + - data + type: object + CreateBackfilledDegradationRequestDataRelationshipsTemplateData: + description: The data object identifying the template used to create the backfilled degradation. + properties: + id: + description: The ID of the degradation template. + example: "" + type: string + type: + $ref: "#/components/schemas/PatchDegradationTemplateRequestDataType" + required: + - type + - id + type: object CreateBackfilledMaintenanceRequest: description: Request object for creating a backfilled maintenance. example: @@ -23533,6 +23563,8 @@ components: properties: attributes: $ref: "#/components/schemas/CreateBackfilledMaintenanceRequestDataAttributes" + relationships: + $ref: "#/components/schemas/CreateBackfilledMaintenanceRequestDataRelationships" type: $ref: "#/components/schemas/PatchMaintenanceRequestDataType" required: @@ -23580,6 +23612,34 @@ components: - started_at - status type: object + CreateBackfilledMaintenanceRequestDataRelationships: + description: The supported relationships for creating a backfilled maintenance. + properties: + template: + $ref: "#/components/schemas/CreateBackfilledMaintenanceRequestDataRelationshipsTemplate" + description: The template used to create the backfilled maintenance. + type: object + CreateBackfilledMaintenanceRequestDataRelationshipsTemplate: + description: The template used to create the backfilled maintenance. + properties: + data: + $ref: "#/components/schemas/CreateBackfilledMaintenanceRequestDataRelationshipsTemplateData" + required: + - data + type: object + CreateBackfilledMaintenanceRequestDataRelationshipsTemplateData: + description: The data object identifying the template used to create the backfilled maintenance. + properties: + id: + description: The ID of the maintenance template. + example: "" + type: string + type: + $ref: "#/components/schemas/PatchMaintenanceTemplateRequestDataType" + required: + - type + - id + type: object CreateCampaignRequest: description: Request to create a new campaign. properties: @@ -23966,6 +24026,8 @@ components: properties: attributes: $ref: "#/components/schemas/CreateDegradationRequestDataAttributes" + relationships: + $ref: "#/components/schemas/CreateDegradationRequestDataRelationships" type: $ref: "#/components/schemas/PatchDegradationRequestDataType" required: @@ -24032,6 +24094,101 @@ components: - IDENTIFIED - MONITORING - RESOLVED + CreateDegradationRequestDataRelationships: + description: The supported relationships for creating a degradation. + properties: + template: + $ref: "#/components/schemas/CreateDegradationRequestDataRelationshipsTemplate" + description: The template used to create the degradation. + type: object + CreateDegradationRequestDataRelationshipsTemplate: + description: The template used to create the degradation. + properties: + data: + $ref: "#/components/schemas/CreateDegradationRequestDataRelationshipsTemplateData" + required: + - data + type: object + CreateDegradationRequestDataRelationshipsTemplateData: + description: The data object identifying the template used to create the degradation. + properties: + id: + description: The ID of the degradation template. + example: "" + type: string + type: + $ref: "#/components/schemas/PatchDegradationTemplateRequestDataType" + required: + - type + - id + type: object + CreateDegradationTemplateRequest: + description: Request object for creating a degradation template. + properties: + data: + $ref: "#/components/schemas/CreateDegradationTemplateRequestData" + type: object + CreateDegradationTemplateRequestData: + description: The data object for creating a degradation template. + properties: + attributes: + $ref: "#/components/schemas/CreateDegradationTemplateRequestDataAttributes" + type: + $ref: "#/components/schemas/PatchDegradationTemplateRequestDataType" + required: + - type + type: object + CreateDegradationTemplateRequestDataAttributes: + description: The attributes for creating a degradation template. + properties: + components_affected: + description: The components affected by a degradation created from this template. + items: + $ref: "#/components/schemas/CreateDegradationTemplateRequestDataAttributesComponentsAffectedItems" + type: array + degradation_title: + description: The title used for a degradation created from this template. + type: string + name: + description: The name of the degradation template. + example: "" + type: string + updates: + description: The pre-filled updates for a degradation created from this template. + items: + $ref: "#/components/schemas/CreateDegradationTemplateRequestDataAttributesUpdatesItems" + type: array + required: + - name + type: object + CreateDegradationTemplateRequestDataAttributesComponentsAffectedItems: + description: A component affected by a degradation created from this template. + properties: + id: + description: The ID of the component. Must be a component of type `component`. + example: "" + type: string + name: + description: The name of the component. + readOnly: true + type: string + status: + $ref: "#/components/schemas/PatchDegradationTemplateRequestDataAttributesComponentsAffectedItemsStatus" + required: + - id + - status + type: object + CreateDegradationTemplateRequestDataAttributesUpdatesItems: + description: A pre-filled update for a degradation created from this template. + properties: + message: + description: The message of the update. + type: string + status: + $ref: "#/components/schemas/CreateDegradationRequestDataAttributesStatus" + required: + - status + type: object CreateDeploymentGateParams: description: Parameters for creating a deployment gate. properties: @@ -24482,6 +24639,8 @@ components: properties: attributes: $ref: "#/components/schemas/CreateMaintenanceRequestDataAttributes" + relationships: + $ref: "#/components/schemas/CreateMaintenanceRequestDataRelationships" type: $ref: "#/components/schemas/PatchMaintenanceRequestDataType" required: @@ -24558,6 +24717,77 @@ components: x-enum-varnames: - IN_PROGRESS - COMPLETED + CreateMaintenanceRequestDataRelationships: + description: The supported relationships for creating a maintenance. + properties: + template: + $ref: "#/components/schemas/CreateMaintenanceRequestDataRelationshipsTemplate" + description: The template used to create the maintenance. + type: object + CreateMaintenanceRequestDataRelationshipsTemplate: + description: The template used to create the maintenance. + properties: + data: + $ref: "#/components/schemas/CreateMaintenanceRequestDataRelationshipsTemplateData" + required: + - data + type: object + CreateMaintenanceRequestDataRelationshipsTemplateData: + description: The data object identifying the template used to create the maintenance. + properties: + id: + description: The ID of the maintenance template. + example: "" + type: string + type: + $ref: "#/components/schemas/PatchMaintenanceTemplateRequestDataType" + required: + - type + - id + type: object + CreateMaintenanceTemplateRequest: + description: Request object for creating a maintenance template. + properties: + data: + $ref: "#/components/schemas/CreateMaintenanceTemplateRequestData" + type: object + CreateMaintenanceTemplateRequestData: + description: The data object for creating a maintenance template. + properties: + attributes: + $ref: "#/components/schemas/CreateMaintenanceTemplateRequestDataAttributes" + type: + $ref: "#/components/schemas/PatchMaintenanceTemplateRequestDataType" + required: + - type + type: object + CreateMaintenanceTemplateRequestDataAttributes: + description: The attributes for creating a maintenance template. + properties: + completed_description: + description: The description shown when a maintenance created from this template is completed. + type: string + component_ids: + description: The IDs of the components affected by a maintenance created from this template. + items: + type: string + type: array + in_progress_description: + description: The description shown while a maintenance created from this template is in progress. + type: string + maintenance_title: + description: The title used for a maintenance created from this template. + type: string + name: + description: The name of the maintenance template. + example: "" + type: string + scheduled_description: + description: The description shown when a maintenance created from this template is scheduled. + type: string + required: + - name + type: object CreateNotificationChannelAttributes: description: Attributes for creating an on-call notification channel. properties: @@ -31392,6 +31622,9 @@ components: status_page: $ref: "#/components/schemas/DegradationDataRelationshipsStatusPage" description: The status page the degradation belongs to. + template: + $ref: "#/components/schemas/DegradationDataRelationshipsTemplate" + description: The template the degradation was created from. type: object DegradationDataRelationshipsCreatedByUser: description: The Datadog user who created the degradation. @@ -31457,11 +31690,206 @@ components: - type - id type: object + DegradationDataRelationshipsTemplate: + description: The template the degradation was created from. + properties: + data: + $ref: "#/components/schemas/DegradationDataRelationshipsTemplateData" + required: + - data + type: object + DegradationDataRelationshipsTemplateData: + description: The data object identifying the template the degradation was created from. + properties: + id: + description: The ID of the degradation template. + example: "" + type: string + type: + $ref: "#/components/schemas/PatchDegradationTemplateRequestDataType" + required: + - type + - id + type: object DegradationIncluded: description: An included resource related to a degradation or maintenance. oneOf: - $ref: "#/components/schemas/StatusPagesUser" - $ref: "#/components/schemas/StatusPageAsIncluded" + DegradationTemplate: + description: Response object for a single degradation template. + properties: + data: + $ref: "#/components/schemas/DegradationTemplateData" + included: + description: The included related resources of a degradation template. Client must explicitly request these resources by name in the `include` query parameter. + items: + $ref: "#/components/schemas/DegradationIncluded" + type: array + type: object + DegradationTemplateArray: + description: Response object for a list of degradation templates. + properties: + data: + description: A list of degradation template data objects. + items: + $ref: "#/components/schemas/DegradationTemplateData" + type: array + included: + description: The included related resources of a degradation template. Client must explicitly request these resources by name in the `include` query parameter. + items: + $ref: "#/components/schemas/DegradationIncluded" + type: array + required: + - data + type: object + DegradationTemplateData: + description: The data object for a degradation template. + properties: + attributes: + $ref: "#/components/schemas/DegradationTemplateDataAttributes" + id: + description: The ID of the degradation template. + type: string + relationships: + $ref: "#/components/schemas/DegradationTemplateDataRelationships" + type: + $ref: "#/components/schemas/PatchDegradationTemplateRequestDataType" + required: + - type + type: object + DegradationTemplateDataAttributes: + description: The attributes of a degradation template. + properties: + components_affected: + description: The components affected by a degradation created from this template. + items: + $ref: "#/components/schemas/DegradationTemplateDataAttributesComponentsAffectedItems" + type: array + created_at: + description: Timestamp of when the degradation template was created. + format: date-time + type: string + degradation_title: + description: The title used for a degradation created from this template. + type: string + modified_at: + description: Timestamp of when the degradation template was last modified. + format: date-time + type: string + name: + description: The name of the degradation template. + type: string + updates: + description: The pre-filled updates for a degradation created from this template. + items: + $ref: "#/components/schemas/DegradationTemplateDataAttributesUpdatesItems" + type: array + type: object + DegradationTemplateDataAttributesComponentsAffectedItems: + description: A component affected by a degradation created from this template. + properties: + id: + description: The ID of the component. + example: "" + type: string + name: + description: The name of the component. + readOnly: true + type: string + status: + $ref: "#/components/schemas/PatchDegradationTemplateRequestDataAttributesComponentsAffectedItemsStatus" + required: + - id + - status + type: object + DegradationTemplateDataAttributesUpdatesItems: + description: A pre-filled update for a degradation created from this template. + properties: + message: + description: The message of the update. + type: string + status: + $ref: "#/components/schemas/CreateDegradationRequestDataAttributesStatus" + required: + - status + type: object + DegradationTemplateDataRelationships: + description: The relationships of a degradation template. + properties: + created_by_user: + $ref: "#/components/schemas/DegradationTemplateDataRelationshipsCreatedByUser" + description: The Datadog user who created the degradation template. + last_modified_by_user: + $ref: "#/components/schemas/DegradationTemplateDataRelationshipsLastModifiedByUser" + description: The Datadog user who last modified the degradation template. + status_page: + $ref: "#/components/schemas/DegradationTemplateDataRelationshipsStatusPage" + description: The status page the degradation template belongs to. + type: object + DegradationTemplateDataRelationshipsCreatedByUser: + description: The Datadog user who created the degradation template. + properties: + data: + $ref: "#/components/schemas/DegradationTemplateDataRelationshipsCreatedByUserData" + required: + - data + type: object + DegradationTemplateDataRelationshipsCreatedByUserData: + description: The data object identifying the Datadog user who created the degradation template. + properties: + id: + description: The ID of the Datadog user who created the degradation template. + example: "" + type: string + type: + $ref: "#/components/schemas/StatusPagesUserType" + required: + - type + - id + type: object + DegradationTemplateDataRelationshipsLastModifiedByUser: + description: The Datadog user who last modified the degradation template. + properties: + data: + $ref: "#/components/schemas/DegradationTemplateDataRelationshipsLastModifiedByUserData" + required: + - data + type: object + DegradationTemplateDataRelationshipsLastModifiedByUserData: + description: The data object identifying the Datadog user who last modified the degradation template. + properties: + id: + description: The ID of the Datadog user who last modified the degradation template. + example: "" + type: string + type: + $ref: "#/components/schemas/StatusPagesUserType" + required: + - type + - id + type: object + DegradationTemplateDataRelationshipsStatusPage: + description: The status page the degradation template belongs to. + properties: + data: + $ref: "#/components/schemas/DegradationTemplateDataRelationshipsStatusPageData" + required: + - data + type: object + DegradationTemplateDataRelationshipsStatusPageData: + description: The data object identifying the status page associated with a degradation template. + properties: + id: + description: The ID of the status page. + example: "" + type: string + type: + $ref: "#/components/schemas/StatusPageDataType" + required: + - type + - id + type: object DegradationUpdate: description: Response object for a degradation update. properties: @@ -63765,6 +64193,9 @@ components: status_page: $ref: "#/components/schemas/MaintenanceDataRelationshipsStatusPage" description: The status page the maintenance belongs to. + template: + $ref: "#/components/schemas/MaintenanceDataRelationshipsTemplate" + description: The template the maintenance was created from. type: object MaintenanceDataRelationshipsCreatedByUser: description: The Datadog user who created the maintenance. @@ -63832,6 +64263,177 @@ components: - type - id type: object + MaintenanceDataRelationshipsTemplate: + description: The template the maintenance was created from. + properties: + data: + $ref: "#/components/schemas/MaintenanceDataRelationshipsTemplateData" + required: + - data + type: object + MaintenanceDataRelationshipsTemplateData: + description: The data object identifying the template the maintenance was created from. + properties: + id: + description: The ID of the maintenance template. + example: "" + type: string + type: + $ref: "#/components/schemas/PatchMaintenanceTemplateRequestDataType" + required: + - type + - id + type: object + MaintenanceTemplate: + description: Response object for a single maintenance template. + properties: + data: + $ref: "#/components/schemas/MaintenanceTemplateData" + included: + description: The included related resources of a maintenance template. Client must explicitly request these resources by name in the `include` query parameter. + items: + $ref: "#/components/schemas/DegradationIncluded" + type: array + type: object + MaintenanceTemplateArray: + description: Response object for a list of maintenance templates. + properties: + data: + description: A list of maintenance template data objects. + items: + $ref: "#/components/schemas/MaintenanceTemplateData" + type: array + included: + description: The included related resources of a maintenance template. Client must explicitly request these resources by name in the `include` query parameter. + items: + $ref: "#/components/schemas/DegradationIncluded" + type: array + required: + - data + type: object + MaintenanceTemplateData: + description: The data object for a maintenance template. + properties: + attributes: + $ref: "#/components/schemas/MaintenanceTemplateDataAttributes" + id: + description: The ID of the maintenance template. + type: string + relationships: + $ref: "#/components/schemas/MaintenanceTemplateDataRelationships" + type: + $ref: "#/components/schemas/PatchMaintenanceTemplateRequestDataType" + required: + - type + type: object + MaintenanceTemplateDataAttributes: + description: The attributes of a maintenance template. + properties: + completed_description: + description: The description shown when a maintenance created from this template is completed. + type: string + component_ids: + description: The IDs of the components affected by a maintenance created from this template. + items: + type: string + type: array + created_at: + description: Timestamp of when the maintenance template was created. + format: date-time + type: string + in_progress_description: + description: The description shown while a maintenance created from this template is in progress. + type: string + maintenance_title: + description: The title used for a maintenance created from this template. + type: string + modified_at: + description: Timestamp of when the maintenance template was last modified. + format: date-time + type: string + name: + description: The name of the maintenance template. + type: string + scheduled_description: + description: The description shown when a maintenance created from this template is scheduled. + type: string + type: object + MaintenanceTemplateDataRelationships: + description: The relationships of a maintenance template. + properties: + created_by_user: + $ref: "#/components/schemas/MaintenanceTemplateDataRelationshipsCreatedByUser" + description: The Datadog user who created the maintenance template. + last_modified_by_user: + $ref: "#/components/schemas/MaintenanceTemplateDataRelationshipsLastModifiedByUser" + description: The Datadog user who last modified the maintenance template. + status_page: + $ref: "#/components/schemas/MaintenanceTemplateDataRelationshipsStatusPage" + description: The status page the maintenance template belongs to. + type: object + MaintenanceTemplateDataRelationshipsCreatedByUser: + description: The Datadog user who created the maintenance template. + properties: + data: + $ref: "#/components/schemas/MaintenanceTemplateDataRelationshipsCreatedByUserData" + required: + - data + type: object + MaintenanceTemplateDataRelationshipsCreatedByUserData: + description: The data object identifying the Datadog user who created the maintenance template. + properties: + id: + description: The ID of the Datadog user who created the maintenance template. + example: "" + type: string + type: + $ref: "#/components/schemas/StatusPagesUserType" + required: + - type + - id + type: object + MaintenanceTemplateDataRelationshipsLastModifiedByUser: + description: The Datadog user who last modified the maintenance template. + properties: + data: + $ref: "#/components/schemas/MaintenanceTemplateDataRelationshipsLastModifiedByUserData" + required: + - data + type: object + MaintenanceTemplateDataRelationshipsLastModifiedByUserData: + description: The data object identifying the Datadog user who last modified the maintenance template. + properties: + id: + description: The ID of the Datadog user who last modified the maintenance template. + example: "" + type: string + type: + $ref: "#/components/schemas/StatusPagesUserType" + required: + - type + - id + type: object + MaintenanceTemplateDataRelationshipsStatusPage: + description: The status page the maintenance template belongs to. + properties: + data: + $ref: "#/components/schemas/MaintenanceTemplateDataRelationshipsStatusPageData" + required: + - data + type: object + MaintenanceTemplateDataRelationshipsStatusPageData: + description: The data object identifying the status page associated with a maintenance template. + properties: + id: + description: The ID of the status page. + example: "" + type: string + type: + $ref: "#/components/schemas/StatusPageDataType" + required: + - type + - id + type: object MaintenanceWindow: description: A maintenance window that defines a scheduled time period during which case-related notifications and automation rules are suppressed. Each maintenance window applies to cases matching a specified query. properties: @@ -79219,6 +79821,8 @@ components: example: "1234abcd-12ab-34cd-56ef-123456abcdef" format: uuid type: string + relationships: + $ref: "#/components/schemas/PatchDegradationRequestDataRelationships" type: $ref: "#/components/schemas/PatchDegradationRequestDataType" required: @@ -79280,6 +79884,34 @@ components: - IDENTIFIED - MONITORING - RESOLVED + PatchDegradationRequestDataRelationships: + description: The supported relationships for updating a degradation. + properties: + template: + $ref: "#/components/schemas/PatchDegradationRequestDataRelationshipsTemplate" + description: The template used to create the degradation. + type: object + PatchDegradationRequestDataRelationshipsTemplate: + description: The template used to create the degradation. + properties: + data: + $ref: "#/components/schemas/PatchDegradationRequestDataRelationshipsTemplateData" + required: + - data + type: object + PatchDegradationRequestDataRelationshipsTemplateData: + description: The data object identifying the template used to create the degradation. + properties: + id: + description: The ID of the degradation template. + example: "" + type: string + type: + $ref: "#/components/schemas/PatchDegradationTemplateRequestDataType" + required: + - type + - id + type: object PatchDegradationRequestDataType: default: degradations description: Degradations resource type. @@ -79289,6 +79921,98 @@ components: type: string x-enum-varnames: - DEGRADATIONS + PatchDegradationTemplateRequest: + description: Request object for updating a degradation template. + properties: + data: + $ref: "#/components/schemas/PatchDegradationTemplateRequestData" + type: object + PatchDegradationTemplateRequestData: + description: The data object for updating a degradation template. + properties: + attributes: + $ref: "#/components/schemas/PatchDegradationTemplateRequestDataAttributes" + id: + description: The ID of the degradation template. + example: "" + type: string + type: + $ref: "#/components/schemas/PatchDegradationTemplateRequestDataType" + required: + - type + - id + type: object + PatchDegradationTemplateRequestDataAttributes: + description: The supported attributes for updating a degradation template. + properties: + components_affected: + description: The components affected by a degradation created from this template. + items: + $ref: "#/components/schemas/PatchDegradationTemplateRequestDataAttributesComponentsAffectedItems" + type: array + degradation_title: + description: The title used for a degradation created from this template. + type: string + name: + description: The name of the degradation template. + type: string + updates: + description: The pre-filled updates for a degradation created from this template. + items: + $ref: "#/components/schemas/PatchDegradationTemplateRequestDataAttributesUpdatesItems" + type: array + type: object + PatchDegradationTemplateRequestDataAttributesComponentsAffectedItems: + description: A component affected by a degradation created from this template. + properties: + id: + description: The ID of the component. Must be a component of type `component`. + example: "" + type: string + name: + description: The name of the component. + readOnly: true + type: string + status: + $ref: "#/components/schemas/PatchDegradationTemplateRequestDataAttributesComponentsAffectedItemsStatus" + required: + - id + - status + type: object + PatchDegradationTemplateRequestDataAttributesComponentsAffectedItemsStatus: + description: The status of the component. + enum: + - operational + - degraded + - partial_outage + - major_outage + example: operational + type: string + x-enum-varnames: + - OPERATIONAL + - DEGRADED + - PARTIAL_OUTAGE + - MAJOR_OUTAGE + PatchDegradationTemplateRequestDataAttributesUpdatesItems: + description: A pre-filled update for a degradation created from this template. + properties: + message: + description: The message of the update. + type: string + status: + $ref: "#/components/schemas/CreateDegradationRequestDataAttributesStatus" + required: + - status + type: object + PatchDegradationTemplateRequestDataType: + default: degradation_templates + description: Degradation templates resource type. + enum: + - degradation_templates + example: degradation_templates + type: string + x-enum-varnames: + - DEGRADATION_TEMPLATES PatchDegradationUpdateRequest: description: Request object for editing a degradation update. example: @@ -79378,6 +80102,8 @@ components: example: "1234abcd-12ab-34cd-56ef-123456abcdef" format: uuid type: string + relationships: + $ref: "#/components/schemas/PatchMaintenanceRequestDataRelationships" type: $ref: "#/components/schemas/PatchMaintenanceRequestDataType" required: @@ -79445,6 +80171,34 @@ components: x-enum-varnames: - OPERATIONAL - MAINTENANCE + PatchMaintenanceRequestDataRelationships: + description: The supported relationships for updating a maintenance. + properties: + template: + $ref: "#/components/schemas/PatchMaintenanceRequestDataRelationshipsTemplate" + description: The template used to create the maintenance. + type: object + PatchMaintenanceRequestDataRelationshipsTemplate: + description: The template used to create the maintenance. + properties: + data: + $ref: "#/components/schemas/PatchMaintenanceRequestDataRelationshipsTemplateData" + required: + - data + type: object + PatchMaintenanceRequestDataRelationshipsTemplateData: + description: The data object identifying the template used to create the maintenance. + properties: + id: + description: The ID of the maintenance template. + example: "" + type: string + type: + $ref: "#/components/schemas/PatchMaintenanceTemplateRequestDataType" + required: + - type + - id + type: object PatchMaintenanceRequestDataType: default: maintenances description: Maintenances resource type. @@ -79454,6 +80208,60 @@ components: type: string x-enum-varnames: - MAINTENANCES + PatchMaintenanceTemplateRequest: + description: Request object for updating a maintenance template. + properties: + data: + $ref: "#/components/schemas/PatchMaintenanceTemplateRequestData" + type: object + PatchMaintenanceTemplateRequestData: + description: The data object for updating a maintenance template. + properties: + attributes: + $ref: "#/components/schemas/PatchMaintenanceTemplateRequestDataAttributes" + id: + description: The ID of the maintenance template. + example: "" + type: string + type: + $ref: "#/components/schemas/PatchMaintenanceTemplateRequestDataType" + required: + - type + - id + type: object + PatchMaintenanceTemplateRequestDataAttributes: + description: The supported attributes for updating a maintenance template. + properties: + completed_description: + description: The description shown when a maintenance created from this template is completed. + type: string + component_ids: + description: The IDs of the components affected by a maintenance created from this template. + items: + type: string + type: array + in_progress_description: + description: The description shown while a maintenance created from this template is in progress. + type: string + maintenance_title: + description: The title used for a maintenance created from this template. + type: string + name: + description: The name of the maintenance template. + type: string + scheduled_description: + description: The description shown when a maintenance created from this template is scheduled. + type: string + type: object + PatchMaintenanceTemplateRequestDataType: + default: maintenance_templates + description: Maintenance templates resource type. + enum: + - maintenance_templates + example: maintenance_templates + type: string + x-enum-varnames: + - MAINTENANCE_TEMPLATES PatchNotificationRuleParameters: description: Body of the notification rule patch request. properties: @@ -203085,6 +203893,11 @@ paths: name: sort schema: type: string + - description: Optional source ID filter. Returns only degradations whose source matches this ID (for example, an incident ID). + in: query + name: filter[source_id] + schema: + type: string responses: "200": content: @@ -203651,6 +204464,285 @@ paths: operator: AND permissions: - status_pages_settings_write + /api/v2/statuspages/{page_id}/degradation_templates: + get: + description: Lists all degradation templates for a status page. + operationId: ListDegradationTemplates + parameters: + - description: "Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page." + in: query + name: include + schema: + type: string + - description: The ID of the status page. + in: path + name: page_id + required: true + schema: + format: uuid + type: string + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + - attributes: + components_affected: + - id: 1234abcd-12ab-34cd-56ef-123456abcdef + status: degraded + degradation_title: Elevated API Latency + name: Elevated API Latency + updates: + - message: We are investigating the issue. + status: investigating + id: 00000000-0000-0000-0000-000000000003 + type: degradation_templates + schema: + $ref: "#/components/schemas/DegradationTemplateArray" + description: OK + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - status_pages_settings_read + summary: List degradation templates + tags: + - Status Pages + x-menu-order: 28 + post: + description: Creates a new degradation template. + operationId: CreateDegradationTemplate + parameters: + - description: The ID of the status page. + in: path + name: page_id + required: true + schema: + format: uuid + type: string + - description: "Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page." + in: query + name: include + schema: + type: string + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + components_affected: + - id: 1234abcd-12ab-34cd-56ef-123456abcdef + status: degraded + degradation_title: Elevated API Latency + name: Elevated API Latency + updates: + - message: We are investigating the issue. + status: investigating + type: degradation_templates + schema: + $ref: "#/components/schemas/CreateDegradationTemplateRequest" + required: true + responses: + "201": + content: + application/json: + examples: + default: + value: + data: + attributes: + components_affected: + - id: 1234abcd-12ab-34cd-56ef-123456abcdef + status: degraded + degradation_title: Elevated API Latency + name: Elevated API Latency + updates: + - message: We are investigating the issue. + status: investigating + id: 00000000-0000-0000-0000-000000000003 + type: degradation_templates + schema: + $ref: "#/components/schemas/DegradationTemplate" + description: Created + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - status_pages_settings_write + summary: Create degradation template + tags: + - Status Pages + x-menu-order: 26 + /api/v2/statuspages/{page_id}/degradation_templates/{template_id}: + delete: + description: Deletes a degradation template by its ID (soft delete). + operationId: DeleteDegradationTemplate + parameters: + - description: The ID of the status page. + in: path + name: page_id + required: true + schema: + format: uuid + type: string + - description: The ID of the degradation or maintenance template. + in: path + name: template_id + required: true + schema: + format: uuid + type: string + responses: + "204": + description: No Content + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - status_pages_settings_write + summary: Delete degradation template + tags: + - Status Pages + x-menu-order: 30 + get: + description: Retrieves a specific degradation template by its ID. + operationId: GetDegradationTemplate + parameters: + - description: The ID of the status page. + in: path + name: page_id + required: true + schema: + format: uuid + type: string + - description: The ID of the degradation or maintenance template. + in: path + name: template_id + required: true + schema: + format: uuid + type: string + - description: "Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page." + in: query + name: include + schema: + type: string + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + components_affected: + - id: 1234abcd-12ab-34cd-56ef-123456abcdef + status: degraded + degradation_title: Elevated API Latency + name: Elevated API Latency + updates: + - message: We are investigating the issue. + status: investigating + id: 00000000-0000-0000-0000-000000000003 + type: degradation_templates + schema: + $ref: "#/components/schemas/DegradationTemplate" + description: OK + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - status_pages_settings_read + summary: Get degradation template + tags: + - Status Pages + x-menu-order: 29 + patch: + description: Updates an existing degradation template's attributes. + operationId: UpdateDegradationTemplate + parameters: + - description: The ID of the degradation or maintenance template. + in: path + name: template_id + required: true + schema: + format: uuid + type: string + - description: "Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page." + in: query + name: include + schema: + type: string + - description: The ID of the status page. + in: path + name: page_id + required: true + schema: + format: uuid + type: string + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + degradation_title: Elevated API Latency for 40 minutes + name: Elevated API Latency + id: 00000000-0000-0000-0000-000000000003 + type: degradation_templates + schema: + $ref: "#/components/schemas/PatchDegradationTemplateRequest" + required: true + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + components_affected: + - id: 1234abcd-12ab-34cd-56ef-123456abcdef + status: degraded + degradation_title: Elevated API Latency for 40 minutes + name: Elevated API Latency + updates: + - message: We are investigating the issue. + status: investigating + id: 00000000-0000-0000-0000-000000000003 + type: degradation_templates + schema: + $ref: "#/components/schemas/DegradationTemplate" + description: OK + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - status_pages_settings_write + summary: Update degradation template + tags: + - Status Pages + x-menu-order: 27 /api/v2/statuspages/{page_id}/degradations: post: description: Creates a new degradation. @@ -204114,6 +205206,282 @@ paths: tags: - Status Pages x-menu-order: 25 + /api/v2/statuspages/{page_id}/maintenance_templates: + get: + description: Lists all maintenance templates for a status page. + operationId: ListMaintenanceTemplates + parameters: + - description: The ID of the status page. + in: path + name: page_id + required: true + schema: + format: uuid + type: string + - description: "Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page." + in: query + name: include + schema: + type: string + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + - attributes: + completed_description: We have completed maintenance on the API to improve performance. + component_ids: + - 1234abcd-12ab-34cd-56ef-123456abcdef + in_progress_description: We are currently performing maintenance on the API to improve performance. + maintenance_title: API Maintenance + name: API Maintenance + scheduled_description: We will be performing maintenance on the API to improve performance. + id: 00000000-0000-0000-0000-000000000004 + type: maintenance_templates + schema: + $ref: "#/components/schemas/MaintenanceTemplateArray" + description: OK + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - status_pages_settings_read + summary: List maintenance templates + tags: + - Status Pages + x-menu-order: 33 + post: + description: Creates a new maintenance template. + operationId: CreateMaintenanceTemplate + parameters: + - description: The ID of the status page. + in: path + name: page_id + required: true + schema: + format: uuid + type: string + - description: "Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page." + in: query + name: include + schema: + type: string + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + completed_description: We have completed maintenance on the API to improve performance. + component_ids: + - 1234abcd-12ab-34cd-56ef-123456abcdef + in_progress_description: We are currently performing maintenance on the API to improve performance. + maintenance_title: API Maintenance + name: API Maintenance + scheduled_description: We will be performing maintenance on the API to improve performance. + type: maintenance_templates + schema: + $ref: "#/components/schemas/CreateMaintenanceTemplateRequest" + required: true + responses: + "201": + content: + application/json: + examples: + default: + value: + data: + attributes: + completed_description: We have completed maintenance on the API to improve performance. + component_ids: + - 1234abcd-12ab-34cd-56ef-123456abcdef + in_progress_description: We are currently performing maintenance on the API to improve performance. + maintenance_title: API Maintenance + name: API Maintenance + scheduled_description: We will be performing maintenance on the API to improve performance. + id: 00000000-0000-0000-0000-000000000004 + type: maintenance_templates + schema: + $ref: "#/components/schemas/MaintenanceTemplate" + description: Created + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - status_pages_settings_write + summary: Create maintenance template + tags: + - Status Pages + x-menu-order: 31 + /api/v2/statuspages/{page_id}/maintenance_templates/{template_id}: + delete: + description: Deletes a maintenance template by its ID (soft delete). + operationId: DeleteMaintenanceTemplate + parameters: + - description: The ID of the status page. + in: path + name: page_id + required: true + schema: + format: uuid + type: string + - description: The ID of the degradation or maintenance template. + in: path + name: template_id + required: true + schema: + format: uuid + type: string + responses: + "204": + description: No Content + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - status_pages_settings_write + summary: Delete maintenance template + tags: + - Status Pages + x-menu-order: 35 + get: + description: Retrieves a specific maintenance template by its ID. + operationId: GetMaintenanceTemplate + parameters: + - description: The ID of the status page. + in: path + name: page_id + required: true + schema: + format: uuid + type: string + - description: The ID of the degradation or maintenance template. + in: path + name: template_id + required: true + schema: + format: uuid + type: string + - description: "Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page." + in: query + name: include + schema: + type: string + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + completed_description: We have completed maintenance on the API to improve performance. + component_ids: + - 1234abcd-12ab-34cd-56ef-123456abcdef + in_progress_description: We are currently performing maintenance on the API to improve performance. + maintenance_title: API Maintenance + name: API Maintenance + scheduled_description: We will be performing maintenance on the API to improve performance. + id: 00000000-0000-0000-0000-000000000004 + type: maintenance_templates + schema: + $ref: "#/components/schemas/MaintenanceTemplate" + description: OK + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - status_pages_settings_read + summary: Get maintenance template + tags: + - Status Pages + x-menu-order: 34 + patch: + description: Updates an existing maintenance template's attributes. + operationId: UpdateMaintenanceTemplate + parameters: + - description: The ID of the status page. + in: path + name: page_id + required: true + schema: + format: uuid + type: string + - description: The ID of the degradation or maintenance template. + in: path + name: template_id + required: true + schema: + format: uuid + type: string + - description: "Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page." + in: query + name: include + schema: + type: string + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + completed_description: We have completed maintenance on the API to improve performance. + in_progress_description: We are currently performing maintenance on the API to improve performance for 40 minutes. + maintenance_title: API Maintenance + scheduled_description: We will be performing maintenance on the API to improve performance for 40 minutes. + id: 00000000-0000-0000-0000-000000000004 + type: maintenance_templates + schema: + $ref: "#/components/schemas/PatchMaintenanceTemplateRequest" + required: true + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + completed_description: We have completed maintenance on the API to improve performance. + component_ids: + - 1234abcd-12ab-34cd-56ef-123456abcdef + in_progress_description: We are currently performing maintenance on the API to improve performance for 40 minutes. + maintenance_title: API Maintenance + name: API Maintenance + scheduled_description: We will be performing maintenance on the API to improve performance for 40 minutes. + id: 00000000-0000-0000-0000-000000000004 + type: maintenance_templates + schema: + $ref: "#/components/schemas/MaintenanceTemplate" + description: OK + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - status_pages_settings_write + summary: Update maintenance template + tags: + - Status Pages + x-menu-order: 32 /api/v2/statuspages/{page_id}/maintenances: post: description: Schedules a new maintenance. diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index ad9370dc751..215eef05728 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -6508,6 +6508,30 @@ "request_description": "", "request_schema_description": "Request object for updating a component." }, + "ListDegradationTemplates": { + "description": "Lists all degradation templates for a status page.", + "summary": "List degradation templates" + }, + "CreateDegradationTemplate": { + "description": "Creates a new degradation template.", + "summary": "Create degradation template", + "request_description": "", + "request_schema_description": "Request object for creating a degradation template." + }, + "DeleteDegradationTemplate": { + "description": "Deletes a degradation template by its ID (soft delete).", + "summary": "Delete degradation template" + }, + "GetDegradationTemplate": { + "description": "Retrieves a specific degradation template by its ID.", + "summary": "Get degradation template" + }, + "UpdateDegradationTemplate": { + "description": "Updates an existing degradation template's attributes.", + "summary": "Update degradation template", + "request_description": "", + "request_schema_description": "Request object for updating a degradation template." + }, "CreateDegradation": { "description": "Creates a new degradation.", "summary": "Create degradation", @@ -6544,6 +6568,30 @@ "request_description": "", "request_schema_description": "Request object for editing a degradation update." }, + "ListMaintenanceTemplates": { + "description": "Lists all maintenance templates for a status page.", + "summary": "List maintenance templates" + }, + "CreateMaintenanceTemplate": { + "description": "Creates a new maintenance template.", + "summary": "Create maintenance template", + "request_description": "", + "request_schema_description": "Request object for creating a maintenance template." + }, + "DeleteMaintenanceTemplate": { + "description": "Deletes a maintenance template by its ID (soft delete).", + "summary": "Delete maintenance template" + }, + "GetMaintenanceTemplate": { + "description": "Retrieves a specific maintenance template by its ID.", + "summary": "Get maintenance template" + }, + "UpdateMaintenanceTemplate": { + "description": "Updates an existing maintenance template's attributes.", + "summary": "Update maintenance template", + "request_description": "", + "request_schema_description": "Request object for updating a maintenance template." + }, "CreateMaintenance": { "description": "Schedules a new maintenance.", "summary": "Schedule maintenance",