Language

English Français 日本語 한국어 Español

Datadog Site

Site help
US1 US3 US5 EU AP1 AP2 US1-FED

Status Pages

Manage your status pages and communicate service disruptions to stakeholders via Datadog’s API. See the Status Pages documentation for more information.

Create status page

POST https://api.ap1.datadoghq.com/api/v2/statuspageshttps://api.ap2.datadoghq.com/api/v2/statuspageshttps://api.datadoghq.eu/api/v2/statuspageshttps://api.ddog-gov.com/api/v2/statuspageshttps://api.datadoghq.com/api/v2/statuspageshttps://api.us3.datadoghq.com/api/v2/statuspageshttps://api.us5.datadoghq.com/api/v2/statuspages

Overview

Creates a new status page. This endpoint requires the status_pages_settings_write permission.

Arguments

Query Strings

Name

Type

Description

include

string

Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user.

Request

Body Data (required)

Expand All

Field

Type

Description

data

object

attributes

object

The supported attributes for creating a status page.

company_logo

string

The base64-encoded image data displayed on the status page.

components

[object]

The components displayed on the status page.

components

[object]

If creating a component of type group, the components to create within the group.

id

uuid

The ID of the grouped component.

name

string

The name of the grouped component.

position

int64

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

status

enum

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

type

enum

The type of the component. Allowed enum values: component

id

uuid

The ID of the component.

name

string

The name of the component.

position

int64

The zero-indexed position of the component.

status

enum

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

type

enum

The type of the component. Allowed enum values: component,group

domain_prefix [required]

string

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

email_header_image

string

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

enabled [required]

boolean

Whether the status page is enabled.

favicon

string

Base64-encoded image data displayed in the browser tab.

name [required]

string

The name of the status page.

subscriptions_enabled

boolean

Whether users can subscribe to the status page.

type [required]

enum

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

visualization_type [required]

enum

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

type [required]

enum

Status pages resource type. Allowed enum values: status_pages

default: status_pages

{
  "data": {
    "attributes": {
      "name": "A Status Page",
      "domain_prefix": "status-page-5e2fd69be33e79aa",
      "components": [
        {
          "name": "Login",
          "type": "component",
          "position": 0
        },
        {
          "name": "Settings",
          "type": "component",
          "position": 1
        }
      ],
      "enabled": true,
      "type": "internal",
      "visualization_type": "bars_and_uptime_percentage"
    },
    "type": "status_pages"
  }
}

Response

Created

Expand All

Field

Type

Description

data

object

attributes

object

The attributes of a status page.

company_logo

string

Base64-encoded image data displayed on the status page.

components

[object]

Components displayed on the status page.

components

[object]

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

id

uuid

The ID of the component.

name

string

The name of the component.

position

int64

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

status

enum

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

type

enum

The type of the component. Allowed enum values: component

id

uuid

The ID of the component.

name

string

The name of the component.

position

int64

The zero-indexed position of the component.

status

enum

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

type

enum

The type of the component. Allowed enum values: component,group

created_at

date-time

Timestamp of when the status page was created.

custom_domain

string

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

custom_domain_enabled

boolean

Whether the custom domain is configured.

domain_prefix

string

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

email_header_image

string

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

enabled

boolean

Whether the status page is enabled.

favicon

string

Base64-encoded image data displayed in the browser tab.

modified_at

date-time

Timestamp of when the status page was last modified.

name

string

The name of the status page.

page_url

string

The url that the status page is accessible at.

subscriptions_enabled

boolean

Whether users can subscribe to the status page.

type

enum

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

visualization_type

enum

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

id

uuid

The ID of the status page.

relationships

object

The relationships of a status page.

created_by_user

object

The Datadog user who created the status page.

data [required]

object

id [required]

string

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

type [required]

enum

Users resource type. Allowed enum values: users

default: users

last_modified_by_user

object

The Datadog user who last modified the status page.

data [required]

object

id [required]

string

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

type [required]

enum

Users resource type. Allowed enum values: users

default: users

type [required]

enum

Status pages resource type. Allowed enum values: status_pages

default: status_pages

included

[ <oneOf>]

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

Option 1

object

The included Datadog user resource.

attributes

object

Attributes of the Datadog user.

email

string

The email of the Datadog user.

handle

string

The handle of the Datadog user.

icon

string

The icon of the Datadog user.

name

string

The name of the Datadog user.

uuid

string

The UUID of the Datadog user.

id

uuid

The ID of the Datadog user.

type [required]

enum

Users resource type. Allowed enum values: users

default: users

{
  "data": {
    "attributes": {
      "company_logo": "string",
      "components": [
        {
          "components": [
            {
              "id": "string",
              "name": "string",
              "position": "integer",
              "status": "string",
              "type": "component"
            }
          ],
          "id": "string",
          "name": "string",
          "position": "integer",
          "status": "string",
          "type": "component"
        }
      ],
      "created_at": "2019-09-19T10:00:00.000Z",
      "custom_domain": "string",
      "custom_domain_enabled": false,
      "domain_prefix": "string",
      "email_header_image": "string",
      "enabled": false,
      "favicon": "string",
      "modified_at": "2019-09-19T10:00:00.000Z",
      "name": "string",
      "page_url": "string",
      "subscriptions_enabled": false,
      "type": "public",
      "visualization_type": "bars_and_uptime_percentage"
    },
    "id": "string",
    "relationships": {
      "created_by_user": {
        "data": {
          "id": "",
          "type": "users"
        }
      },
      "last_modified_by_user": {
        "data": {
          "id": "",
          "type": "users"
        }
      }
    },
    "type": "status_pages"
  },
  "included": [
    {
      "attributes": {
        "email": "string",
        "handle": "string",
        "icon": "string",
        "name": "string",
        "uuid": "string"
      },
      "id": "string",
      "type": "users"
    }
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                          # Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/statuspages" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "name": "A Status Page",
      "domain_prefix": "status-page-5e2fd69be33e79aa",
      "components": [
        {
          "name": "Login",
          "type": "component",
          "position": 0
        },
        {
          "name": "Settings",
          "type": "component",
          "position": 1
        }
      ],
      "enabled": true,
      "type": "internal",
      "visualization_type": "bars_and_uptime_percentage"
    },
    "type": "status_pages"
  }
}
EOF

Update status page

PATCH https://api.ap1.datadoghq.com/api/v2/statuspages/{page_id}https://api.ap2.datadoghq.com/api/v2/statuspages/{page_id}https://api.datadoghq.eu/api/v2/statuspages/{page_id}https://api.ddog-gov.com/api/v2/statuspages/{page_id}https://api.datadoghq.com/api/v2/statuspages/{page_id}https://api.us3.datadoghq.com/api/v2/statuspages/{page_id}https://api.us5.datadoghq.com/api/v2/statuspages/{page_id}

Overview

Updates an existing status page’s attributes. This endpoint requires the status_pages_settings_write permission.

Arguments

Path Parameters

Name

Type

Description

page_id [required]

string

The ID of the status page.

Query Strings

Name

Type

Description

delete_subscribers

boolean

Whether to delete existing subscribers when updating a status page’s type.

include

string

Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user.

Request

Body Data (required)

Expand All

Field

Type

Description

data

object

attributes

object

The supported attributes for updating a status page.

company_logo

string

The base64-encoded image data displayed on the status page.

domain_prefix

string

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

email_header_image

string

The base64-encoded image data displayed in email notifications sent to status page subscribers.

enabled

boolean

Whether the status page is enabled.

favicon

string

The base64-encoded image data displayed in the browser tab.

name

string

The name of the status page.

subscriptions_enabled

boolean

Whether users can subscribe to the status page.

type

enum

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

visualization_type

enum

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

id

uuid

The ID of the status page.

type [required]

enum

Status pages resource type. Allowed enum values: status_pages

default: status_pages

{
  "data": {
    "attributes": {
      "name": "A Status Page in US1"
    },
    "id": "string",
    "type": "status_pages"
  }
}

Response

OK

Expand All

Field

Type

Description

data

object

attributes

object

The attributes of a status page.

company_logo

string

Base64-encoded image data displayed on the status page.

components

[object]

Components displayed on the status page.

components

[object]

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

id

uuid

The ID of the component.

name

string

The name of the component.

position

int64

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

status

enum

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

type

enum

The type of the component. Allowed enum values: component

id

uuid

The ID of the component.

name

string

The name of the component.

position

int64

The zero-indexed position of the component.

status

enum

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

type

enum

The type of the component. Allowed enum values: component,group

created_at

date-time

Timestamp of when the status page was created.

custom_domain

string

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

custom_domain_enabled

boolean

Whether the custom domain is configured.

domain_prefix

string

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

email_header_image

string

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

enabled

boolean

Whether the status page is enabled.

favicon

string

Base64-encoded image data displayed in the browser tab.

modified_at

date-time

Timestamp of when the status page was last modified.

name

string

The name of the status page.

page_url

string

The url that the status page is accessible at.

subscriptions_enabled

boolean

Whether users can subscribe to the status page.

type

enum

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

visualization_type

enum

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

id

uuid

The ID of the status page.

relationships

object

The relationships of a status page.

created_by_user

object

The Datadog user who created the status page.

data [required]

object

id [required]

string

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

type [required]

enum

Users resource type. Allowed enum values: users

default: users

last_modified_by_user

object

The Datadog user who last modified the status page.

data [required]

object

id [required]

string

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

type [required]

enum

Users resource type. Allowed enum values: users

default: users

type [required]

enum

Status pages resource type. Allowed enum values: status_pages

default: status_pages

included

[ <oneOf>]

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

Option 1

object

The included Datadog user resource.

attributes

object

Attributes of the Datadog user.

email

string

The email of the Datadog user.

handle

string

The handle of the Datadog user.

icon

string

The icon of the Datadog user.

name

string

The name of the Datadog user.

uuid

string

The UUID of the Datadog user.

id

uuid

The ID of the Datadog user.

type [required]

enum

Users resource type. Allowed enum values: users

default: users

{
  "data": {
    "attributes": {
      "company_logo": "string",
      "components": [
        {
          "components": [
            {
              "id": "string",
              "name": "string",
              "position": "integer",
              "status": "string",
              "type": "component"
            }
          ],
          "id": "string",
          "name": "string",
          "position": "integer",
          "status": "string",
          "type": "component"
        }
      ],
      "created_at": "2019-09-19T10:00:00.000Z",
      "custom_domain": "string",
      "custom_domain_enabled": false,
      "domain_prefix": "string",
      "email_header_image": "string",
      "enabled": false,
      "favicon": "string",
      "modified_at": "2019-09-19T10:00:00.000Z",
      "name": "string",
      "page_url": "string",
      "subscriptions_enabled": false,
      "type": "public",
      "visualization_type": "bars_and_uptime_percentage"
    },
    "id": "string",
    "relationships": {
      "created_by_user": {
        "data": {
          "id": "",
          "type": "users"
        }
      },
      "last_modified_by_user": {
        "data": {
          "id": "",
          "type": "users"
        }
      }
    },
    "type": "status_pages"
  },
  "included": [
    {
      "attributes": {
        "email": "string",
        "handle": "string",
        "icon": "string",
        "name": "string",
        "uuid": "string"
      },
      "id": "string",
      "type": "users"
    }
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                          # Path parameters
export page_id="1234abcd-12ab-34cd-56ef-123456abcdef"
# Curl command
curl -X PATCH "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/statuspages/${page_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "name": "A Status Page in US1"
    },
    "id": "string",
    "type": "status_pages"
  }
}
EOF

List status pages

GET https://api.ap1.datadoghq.com/api/v2/statuspageshttps://api.ap2.datadoghq.com/api/v2/statuspageshttps://api.datadoghq.eu/api/v2/statuspageshttps://api.ddog-gov.com/api/v2/statuspageshttps://api.datadoghq.com/api/v2/statuspageshttps://api.us3.datadoghq.com/api/v2/statuspageshttps://api.us5.datadoghq.com/api/v2/statuspages

Overview

Lists all status pages for the organization. This endpoint requires the status_pages_settings_read permission.

Arguments

Query Strings

Name

Type

Description

page[offset]

integer

Offset to use as the start of the page.

page[limit]

integer

The number of status pages to return per page.

include

string

Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user.

Response

OK

Expand All

Field

Type

Description

data [required]

[object]

attributes

object

The attributes of a status page.

company_logo

string

Base64-encoded image data displayed on the status page.

components

[object]

Components displayed on the status page.

components

[object]

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

id

uuid

The ID of the component.

name

string

The name of the component.

position

int64

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

status

enum

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

type

enum

The type of the component. Allowed enum values: component

id

uuid

The ID of the component.

name

string

The name of the component.

position

int64

The zero-indexed position of the component.

status

enum

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

type

enum

The type of the component. Allowed enum values: component,group

created_at

date-time

Timestamp of when the status page was created.

custom_domain

string

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

custom_domain_enabled

boolean

Whether the custom domain is configured.

domain_prefix

string

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

email_header_image

string

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

enabled

boolean

Whether the status page is enabled.

favicon

string

Base64-encoded image data displayed in the browser tab.

modified_at

date-time

Timestamp of when the status page was last modified.

name

string

The name of the status page.

page_url

string

The url that the status page is accessible at.

subscriptions_enabled

boolean

Whether users can subscribe to the status page.

type

enum

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

visualization_type

enum

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

id

uuid

The ID of the status page.

relationships

object

The relationships of a status page.

created_by_user

object

The Datadog user who created the status page.

data [required]

object

id [required]

string

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

type [required]

enum

Users resource type. Allowed enum values: users

default: users

last_modified_by_user

object

The Datadog user who last modified the status page.

data [required]

object

id [required]

string

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

type [required]

enum

Users resource type. Allowed enum values: users

default: users

type [required]

enum

Status pages resource type. Allowed enum values: status_pages

default: status_pages

included

[ <oneOf>]

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

Option 1

object

The included Datadog user resource.

attributes

object

Attributes of the Datadog user.

email

string

The email of the Datadog user.

handle

string

The handle of the Datadog user.

icon

string

The icon of the Datadog user.

name

string

The name of the Datadog user.

uuid

string

The UUID of the Datadog user.

id

uuid

The ID of the Datadog user.

type [required]

enum

Users resource type. Allowed enum values: users

default: users

meta

object

Response metadata.

page

object

Offset-based pagination schema.

first_offset

int64

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

last_offset

int64

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

limit

int64

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

next_offset

int64

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

offset

int64

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

prev_offset

int64

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

total

int64

Integer representing the total number of elements available.

type

enum

default: offset_limit

{
  "data": [
    {
      "attributes": {
        "company_logo": "string",
        "components": [
          {
            "components": [
              {
                "id": "string",
                "name": "string",
                "position": "integer",
                "status": "string",
                "type": "component"
              }
            ],
            "id": "string",
            "name": "string",
            "position": "integer",
            "status": "string",
            "type": "component"
          }
        ],
        "created_at": "2019-09-19T10:00:00.000Z",
        "custom_domain": "string",
        "custom_domain_enabled": false,
        "domain_prefix": "string",
        "email_header_image": "string",
        "enabled": false,
        "favicon": "string",
        "modified_at": "2019-09-19T10:00:00.000Z",
        "name": "string",
        "page_url": "string",
        "subscriptions_enabled": false,
        "type": "public",
        "visualization_type": "bars_and_uptime_percentage"
      },
      "id": "string",
      "relationships": {
        "created_by_user": {
          "data": {
            "id": "",
            "type": "users"
          }
        },
        "last_modified_by_user": {
          "data": {
            "id": "",
            "type": "users"
          }
        }
      },
      "type": "status_pages"
    }
  ],
  "included": [
    {
      "attributes": {
        "email": "string",
        "handle": "string",
        "icon": "string",
        "name": "string",
        "uuid": "string"
      },
      "id": "string",
      "type": "users"
    }
  ],
  "meta": {
    "page": {
      "first_offset": 0,
      "last_offset": 900,
      "limit": 100,
      "next_offset": 100,
      "offset": 0,
      "prev_offset": 100,
      "total": 1000,
      "type": "offset_limit"
    }
  }
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/statuspages" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Get status page

GET https://api.ap1.datadoghq.com/api/v2/statuspages/{page_id}https://api.ap2.datadoghq.com/api/v2/statuspages/{page_id}https://api.datadoghq.eu/api/v2/statuspages/{page_id}https://api.ddog-gov.com/api/v2/statuspages/{page_id}https://api.datadoghq.com/api/v2/statuspages/{page_id}https://api.us3.datadoghq.com/api/v2/statuspages/{page_id}https://api.us5.datadoghq.com/api/v2/statuspages/{page_id}

Overview

Retrieves a specific status page by its ID. This endpoint requires the status_pages_settings_read permission.

Arguments

Path Parameters

Name

Type

Description

page_id [required]

string

The ID of the status page.

Query Strings

Name

Type

Description

include

string

Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user.

Response

OK

Expand All

Field

Type

Description

data

object

attributes

object

The attributes of a status page.

company_logo

string

Base64-encoded image data displayed on the status page.

components

[object]

Components displayed on the status page.

components

[object]

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

id

uuid

The ID of the component.

name

string

The name of the component.

position

int64

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

status

enum

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

type

enum

The type of the component. Allowed enum values: component

id

uuid

The ID of the component.

name

string

The name of the component.

position

int64

The zero-indexed position of the component.

status

enum

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

type

enum

The type of the component. Allowed enum values: component,group

created_at

date-time

Timestamp of when the status page was created.

custom_domain

string

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

custom_domain_enabled

boolean

Whether the custom domain is configured.

domain_prefix

string

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

email_header_image

string

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

enabled

boolean

Whether the status page is enabled.

favicon

string

Base64-encoded image data displayed in the browser tab.

modified_at

date-time

Timestamp of when the status page was last modified.

name

string

The name of the status page.

page_url

string

The url that the status page is accessible at.

subscriptions_enabled

boolean

Whether users can subscribe to the status page.

type

enum

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

visualization_type

enum

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

id

uuid

The ID of the status page.

relationships

object

The relationships of a status page.

created_by_user

object

The Datadog user who created the status page.

data [required]

object

id [required]

string

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

type [required]

enum

Users resource type. Allowed enum values: users

default: users

last_modified_by_user

object

The Datadog user who last modified the status page.

data [required]

object

id [required]

string

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

type [required]

enum

Users resource type. Allowed enum values: users

default: users

type [required]

enum

Status pages resource type. Allowed enum values: status_pages

default: status_pages

included

[ <oneOf>]

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

Option 1

object

The included Datadog user resource.

attributes

object

Attributes of the Datadog user.

email

string

The email of the Datadog user.

handle

string

The handle of the Datadog user.

icon

string

The icon of the Datadog user.

name

string

The name of the Datadog user.

uuid

string

The UUID of the Datadog user.

id

uuid

The ID of the Datadog user.

type [required]

enum

Users resource type. Allowed enum values: users

default: users

{
  "data": {
    "attributes": {
      "company_logo": "string",
      "components": [
        {
          "components": [
            {
              "id": "string",
              "name": "string",
              "position": "integer",
              "status": "string",
              "type": "component"
            }
          ],
          "id": "string",
          "name": "string",
          "position": "integer",
          "status": "string",
          "type": "component"
        }
      ],
      "created_at": "2019-09-19T10:00:00.000Z",
      "custom_domain": "string",
      "custom_domain_enabled": false,
      "domain_prefix": "string",
      "email_header_image": "string",
      "enabled": false,
      "favicon": "string",
      "modified_at": "2019-09-19T10:00:00.000Z",
      "name": "string",
      "page_url": "string",
      "subscriptions_enabled": false,
      "type": "public",
      "visualization_type": "bars_and_uptime_percentage"
    },
    "id": "string",
    "relationships": {
      "created_by_user": {
        "data": {
          "id": "",
          "type": "users"
        }
      },
      "last_modified_by_user": {
        "data": {
          "id": "",
          "type": "users"
        }
      }
    },
    "type": "status_pages"
  },
  "included": [
    {
      "attributes": {
        "email": "string",
        "handle": "string",
        "icon": "string",
        "name": "string",
        "uuid": "string"
      },
      "id": "string",
      "type": "users"
    }
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Path parameters
export page_id="1234abcd-12ab-34cd-56ef-123456abcdef"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/statuspages/${page_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Delete status page

DELETE https://api.ap1.datadoghq.com/api/v2/statuspages/{page_id}https://api.ap2.datadoghq.com/api/v2/statuspages/{page_id}https://api.datadoghq.eu/api/v2/statuspages/{page_id}https://api.ddog-gov.com/api/v2/statuspages/{page_id}https://api.datadoghq.com/api/v2/statuspages/{page_id}https://api.us3.datadoghq.com/api/v2/statuspages/{page_id}https://api.us5.datadoghq.com/api/v2/statuspages/{page_id}

Overview

Deletes a status page by its ID. This endpoint requires the status_pages_settings_write permission.

Arguments

Path Parameters

Name

Type

Description

page_id [required]

string

The ID of the status page.

Response

No Content

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Path parameters
export page_id="1234abcd-12ab-34cd-56ef-123456abcdef"
# Curl command
curl -X DELETE "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/statuspages/${page_id}" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Create component

POST https://api.ap1.datadoghq.com/api/v2/statuspages/{page_id}/componentshttps://api.ap2.datadoghq.com/api/v2/statuspages/{page_id}/componentshttps://api.datadoghq.eu/api/v2/statuspages/{page_id}/componentshttps://api.ddog-gov.com/api/v2/statuspages/{page_id}/componentshttps://api.datadoghq.com/api/v2/statuspages/{page_id}/componentshttps://api.us3.datadoghq.com/api/v2/statuspages/{page_id}/componentshttps://api.us5.datadoghq.com/api/v2/statuspages/{page_id}/components

Overview

Creates a new component. This endpoint requires the status_pages_settings_write permission.

Arguments

Path Parameters

Name

Type

Description

page_id [required]

string

The ID of the status page.

Query Strings

Name

Type

Description

include

string

Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page, group.

Request

Body Data (required)

Expand All

Field

Type

Description

data

object

attributes

object

The supported attributes for creating a component.

components

[object]

If creating a component of type group, the components to create within the group.

name [required]

string

The name of the grouped component.

position [required]

int64

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

type [required]

enum

The type of the component. Allowed enum values: component

name [required]

string

The name of the component.

position [required]

int64

The zero-indexed position of the component.

type [required]

enum

The type of the component. Allowed enum values: component,group

relationships

object

The supported relationships for creating a component.

group

object

The group to create the component within.

data [required]

object

id [required]

uuid

The ID of the group.

type [required]

enum

Components resource type. Allowed enum values: components

default: components

type [required]

enum

Components resource type. Allowed enum values: components

default: components

{
  "data": {
    "attributes": {
      "name": "Logs",
      "position": 0,
      "type": "component"
    },
    "type": "components"
  }
}

Response

Created

Expand All

Field

Type

Description

data

object

attributes

object

The attributes of a component.

components

[object]

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

id

uuid

name

string

position

int64

status

enum

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

type

enum

The type of the component. Allowed enum values: component

created_at

date-time

Timestamp of when the component was created.

modified_at

date-time

Timestamp of when the component was last modified.

name

string

The name of the component.

position

int64

The zero-indexed position of the component.

status

enum

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

type [required]

enum

The type of the component. Allowed enum values: component,group

id

uuid

The ID of the component.

relationships

object

The relationships of a component.

created_by_user

object

The Datadog user who created the component.

data [required]

object

id [required]

string

The ID of the Datadog user who created the component.

type [required]

enum

Users resource type. Allowed enum values: users

default: users

group

object

The group the component belongs to.

data [required]

object

id [required]

uuid

The ID of the group the component belongs to.

type [required]

enum

Components resource type. Allowed enum values: components

default: components

last_modified_by_user

object

The Datadog user who last modified the component.

data [required]

object

id [required]

string

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

type [required]

enum

Users resource type. Allowed enum values: users

default: users

status_page

object

The status page the component belongs to.

data [required]

object

id [required]

uuid

The ID of the status page the component belongs to.

type [required]

enum

Status pages resource type. Allowed enum values: status_pages

default: status_pages

type [required]

enum

Components resource type. Allowed enum values: components

default: components

included

[ <oneOf>]

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

Option 1

object

The included Datadog user resource.

attributes

object

Attributes of the Datadog user.

email

string

The email of the Datadog user.

handle

string

The handle of the Datadog user.

icon

string

The icon of the Datadog user.

name

string

The name of the Datadog user.

uuid

string

The UUID of the Datadog user.

id

uuid

The ID of the Datadog user.

type [required]

enum

Users resource type. Allowed enum values: users

default: users

Option 2

object

The included status page resource.

attributes

object

The attributes of a status page.

company_logo

string

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

components

[object]

Components displayed on the status page.

components

[object]

id

uuid

The ID of the grouped component.

name

string

The name of the grouped component.

position

int64

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

status

enum

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

type

enum

The type of the component. Allowed enum values: component

id

uuid

The ID of the component.

name

string

The name of the component.

position

int64

The zero-indexed position of the component.

status

enum

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

type

enum

The type of the component. Allowed enum values: component,group

created_at

date-time

Timestamp of when the status page was created.

custom_domain

string

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

custom_domain_enabled

boolean

Whether the custom domain is configured.

domain_prefix

string

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

email_header_image

string

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

enabled

boolean

Whether the status page is enabled.

favicon

string

Base64-encoded image data displayed in the browser tab.

modified_at

date-time

Timestamp of when the status page was last modified.

name

string

The name of the status page.

page_url

string

The url that the status page is accessible at.

subscriptions_enabled

boolean

Whether users can subscribe to the status page.

type

enum

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

visualization_type

enum

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

id

uuid

The ID of the status page.

relationships

object

The relationships of a status page.

created_by_user

object

The Datadog user who created the status page.

data [required]

object

id [required]

string

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

type [required]

enum

Users resource type. Allowed enum values: users

default: users

last_modified_by_user

object

The Datadog user who last modified the status page.

data [required]

object

id [required]

string

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

type [required]

enum

Users resource type. Allowed enum values: users

default: users

type [required]

enum

Status pages resource type. Allowed enum values: status_pages

default: status_pages

Option 3

object

The included component group resource.

attributes

object

The attributes of a component group.

components

[object]

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

id

uuid

The ID of the grouped component.

name

string

The name of the grouped component.

position

int64

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

status

enum

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

type

enum

The type of the component. Allowed enum values: component

created_at

date-time

Timestamp of when the component was created.

modified_at

date-time

Timestamp of when the component was last modified.

name

string

The name of the component.

position

int64

The zero-indexed position of the component.

status

enum

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

type [required]

enum

The type of the component. Allowed enum values: component,group

id

uuid

The ID of the component.

relationships

object

The relationships of a component group.

created_by_user

object

The Datadog user who created the component group.

data [required]

object

id [required]

string

The ID of the Datadog user who created the component group.

type [required]

enum

Users resource type. Allowed enum values: users

default: users

group

object

The group the component group belongs to.

data [required]

object

id [required]

uuid

type [required]

enum

Components resource type. Allowed enum values: components

default: components

last_modified_by_user

object

The Datadog user who last modified the component group.

data [required]

object

id [required]

string

The ID of the Datadog user who last modified the component group.

type [required]

enum

Users resource type. Allowed enum values: users

default: users

status_page

object

The status page the component group belongs to.

data [required]

object

id [required]

uuid

The ID of the status page.

type [required]

enum

Status pages resource type. Allowed enum values: status_pages

default: status_pages

type [required]

enum

Components resource type. Allowed enum values: components

default: components

{
  "data": {
    "attributes": {
      "components": [
        {
          "id": "string",
          "name": "string",
          "position": "integer",
          "status": "string",
          "type": "component"
        }
      ],
      "created_at": "2019-09-19T10:00:00.000Z",
      "modified_at": "2019-09-19T10:00:00.000Z",
      "name": "string",
      "position": "integer",
      "status": "operational",
      "type": "component"
    },
    "id": "string",
    "relationships": {
      "created_by_user": {
        "data": {
          "id": "",
          "type": "users"
        }
      },
      "group": {
        "data": {
          "id": "",
          "type": "components"
        }
      },
      "last_modified_by_user": {
        "data": {
          "id": "",
          "type": "users"
        }
      },
      "status_page": {
        "data": {
          "id": "",
          "type": "status_pages"
        }
      }
    },
    "type": "components"
  },
  "included": [
    {
      "attributes": {
        "email": "string",
        "handle": "string",
        "icon": "string",
        "name": "string",
        "uuid": "string"
      },
      "id": "string",
      "type": "users"
    }
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                          # Path parameters
export page_id="1234abcd-12ab-34cd-56ef-123456abcdef"
# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/statuspages/${page_id}/components" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "name": "Logs",
      "position": 0,
      "type": "component"
    },
    "type": "components"
  }
}
EOF

Update component

PATCH https://api.ap1.datadoghq.com/api/v2/statuspages/{page_id}/components/{component_id}https://api.ap2.datadoghq.com/api/v2/statuspages/{page_id}/components/{component_id}https://api.datadoghq.eu/api/v2/statuspages/{page_id}/components/{component_id}https://api.ddog-gov.com/api/v2/statuspages/{page_id}/components/{component_id}https://api.datadoghq.com/api/v2/statuspages/{page_id}/components/{component_id}https://api.us3.datadoghq.com/api/v2/statuspages/{page_id}/components/{component_id}https://api.us5.datadoghq.com/api/v2/statuspages/{page_id}/components/{component_id}

Overview

Updates an existing component’s attributes. This endpoint requires the status_pages_settings_write permission.

Arguments

Path Parameters

Name

Type

Description

page_id [required]

string

The ID of the status page.

component_id [required]

string

The ID of the component.

Query Strings

Name

Type

Description

include

string

Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page, group.

Request

Body Data (required)

Expand All

Field

Type

Description

data

object

attributes

object

The supported attributes for updating a component.

name

string

The name of the component.

position

int64

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

id

uuid

The ID of the component.

type [required]

enum

Components resource type. Allowed enum values: components

default: components

{
  "data": {
    "attributes": {
      "name": "Logs Indexing"
    },
    "id": "c34e5b83-90fe-4de2-087b-ea1f64387277",
    "type": "components"
  }
}

Response

OK

Expand All

Field

Type

Description

data

object

attributes

object

The attributes of a component.

components

[object]

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

id

uuid

name

string

position

int64

status

enum

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

type

enum

The type of the component. Allowed enum values: component

created_at

date-time

Timestamp of when the component was created.

modified_at

date-time

Timestamp of when the component was last modified.

name

string

The name of the component.

position

int64

The zero-indexed position of the component.

status

enum

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

type [required]

enum

The type of the component. Allowed enum values: component,group

id

uuid

The ID of the component.

relationships

object

The relationships of a component.

created_by_user

object

The Datadog user who created the component.

data [required]

object

id [required]

string

The ID of the Datadog user who created the component.

type [required]

enum

Users resource type. Allowed enum values: users

default: users

group

object

The group the component belongs to.

data [required]

object

id [required]

uuid

The ID of the group the component belongs to.

type [required]

enum

Components resource type. Allowed enum values: components

default: components

last_modified_by_user

object

The Datadog user who last modified the component.

data [required]

object

id [required]

string

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

type [required]

enum

Users resource type. Allowed enum values: users

default: users

status_page

object

The status page the component belongs to.

data [required]

object

id [required]

uuid

The ID of the status page the component belongs to.

type [required]

enum

Status pages resource type. Allowed enum values: status_pages

default: status_pages

type [required]

enum

Components resource type. Allowed enum values: components

default: components

included

[ <oneOf>]

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

Option 1

object

The included Datadog user resource.

attributes

object

Attributes of the Datadog user.

email

string

The email of the Datadog user.

handle

string

The handle of the Datadog user.

icon

string

The icon of the Datadog user.

name

string

The name of the Datadog user.

uuid

string

The UUID of the Datadog user.

id

uuid

The ID of the Datadog user.

type [required]

enum

Users resource type. Allowed enum values: users

default: users

Option 2

object

The included status page resource.

attributes

object

The attributes of a status page.

company_logo

string

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

components

[object]

Components displayed on the status page.

components

[object]

id

uuid

The ID of the grouped component.

name

string

The name of the grouped component.

position

int64

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

status

enum

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

type

enum

The type of the component. Allowed enum values: component

id

uuid

The ID of the component.

name

string

The name of the component.

position

int64

The zero-indexed position of the component.

status

enum

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

type

enum

The type of the component. Allowed enum values: component,group

created_at

date-time

Timestamp of when the status page was created.

custom_domain

string

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

custom_domain_enabled

boolean

Whether the custom domain is configured.

domain_prefix

string

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

email_header_image

string

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

enabled

boolean

Whether the status page is enabled.

favicon

string

Base64-encoded image data displayed in the browser tab.

modified_at

date-time

Timestamp of when the status page was last modified.

name

string

The name of the status page.

page_url

string

The url that the status page is accessible at.

subscriptions_enabled

boolean

Whether users can subscribe to the status page.

type

enum

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

visualization_type

enum

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

id

uuid

The ID of the status page.

relationships

object

The relationships of a status page.

created_by_user

object

The Datadog user who created the status page.

data [required]

object

id [required]

string

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

type [required]

enum

Users resource type. Allowed enum values: users

default: users

last_modified_by_user

object

The Datadog user who last modified the status page.

data [required]

object

id [required]

string

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

type [required]

enum

Users resource type. Allowed enum values: users

default: users

type [required]

enum

Status pages resource type. Allowed enum values: status_pages

default: status_pages

Option 3

object

The included component group resource.

attributes

object

The attributes of a component group.

components

[object]

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

id

uuid

The ID of the grouped component.

name

string

The name of the grouped component.

position

int64

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

status

enum

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

type

enum

The type of the component. Allowed enum values: component

created_at

date-time

Timestamp of when the component was created.

modified_at

date-time

Timestamp of when the component was last modified.

name

string

The name of the component.

position

int64

The zero-indexed position of the component.

status

enum

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

type [required]

enum

The type of the component. Allowed enum values: component,group

id

uuid

The ID of the component.

relationships

object

The relationships of a component group.

created_by_user

object

The Datadog user who created the component group.

data [required]

object

id [required]

string

The ID of the Datadog user who created the component group.

type [required]

enum

Users resource type. Allowed enum values: users

default: users

group

object

The group the component group belongs to.

data [required]

object

id [required]

uuid

type [required]

enum

Components resource type. Allowed enum values: components

default: components

last_modified_by_user

object

The Datadog user who last modified the component group.

data [required]

object

id [required]

string

The ID of the Datadog user who last modified the component group.

type [required]

enum

Users resource type. Allowed enum values: users

default: users

status_page

object

The status page the component group belongs to.

data [required]

object

id [required]

uuid

The ID of the status page.

type [required]

enum

Status pages resource type. Allowed enum values: status_pages

default: status_pages

type [required]

enum

Components resource type. Allowed enum values: components

default: components

{
  "data": {
    "attributes": {
      "components": [
        {
          "id": "string",
          "name": "string",
          "position": "integer",
          "status": "string",
          "type": "component"
        }
      ],
      "created_at": "2019-09-19T10:00:00.000Z",
      "modified_at": "2019-09-19T10:00:00.000Z",
      "name": "string",
      "position": "integer",
      "status": "operational",
      "type": "component"
    },
    "id": "string",
    "relationships": {
      "created_by_user": {
        "data": {
          "id": "",
          "type": "users"
        }
      },
      "group": {
        "data": {
          "id": "",
          "type": "components"
        }
      },
      "last_modified_by_user": {
        "data": {
          "id": "",
          "type": "users"
        }
      },
      "status_page": {
        "data": {
          "id": "",
          "type": "status_pages"
        }
      }
    },
    "type": "components"
  },
  "included": [
    {
      "attributes": {
        "email": "string",
        "handle": "string",
        "icon": "string",
        "name": "string",
        "uuid": "string"
      },
      "id": "string",
      "type": "users"
    }
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                          # Path parameters
export page_id="1234abcd-12ab-34cd-56ef-123456abcdef"
export component_id="1234abcd-12ab-34cd-56ef-123456abcdef"
# Curl command
curl -X PATCH "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/statuspages/${page_id}/components/${component_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "name": "Logs Indexing"
    },
    "id": "c34e5b83-90fe-4de2-087b-ea1f64387277",
    "type": "components"
  }
}
EOF

List components

GET https://api.ap1.datadoghq.com/api/v2/statuspages/{page_id}/componentshttps://api.ap2.datadoghq.com/api/v2/statuspages/{page_id}/componentshttps://api.datadoghq.eu/api/v2/statuspages/{page_id}/componentshttps://api.ddog-gov.com/api/v2/statuspages/{page_id}/componentshttps://api.datadoghq.com/api/v2/statuspages/{page_id}/componentshttps://api.us3.datadoghq.com/api/v2/statuspages/{page_id}/componentshttps://api.us5.datadoghq.com/api/v2/statuspages/{page_id}/components

Overview

Lists all components for a status page. This endpoint requires the status_pages_settings_read permission.

Arguments

Path Parameters

Name

Type

Description

page_id [required]

string

The ID of the status page.

Query Strings

Name

Type

Description

include

string

Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page, group.

Response

OK

Expand All

Field

Type

Description

data [required]

[object]

attributes

object

The attributes of a component.

components

[object]

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

id

uuid

name

string

position

int64

status

enum

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

type

enum

The type of the component. Allowed enum values: component

created_at

date-time

Timestamp of when the component was created.

modified_at

date-time

Timestamp of when the component was last modified.

name

string

The name of the component.

position

int64

The zero-indexed position of the component.

status

enum

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

type [required]

enum

The type of the component. Allowed enum values: component,group

id

uuid

The ID of the component.

relationships

object

The relationships of a component.

created_by_user

object

The Datadog user who created the component.

data [required]

object

id [required]

string

The ID of the Datadog user who created the component.

type [required]

enum

Users resource type. Allowed enum values: users

default: users

group

object

The group the component belongs to.

data [required]

object

id [required]

uuid

The ID of the group the component belongs to.

type [required]

enum

Components resource type. Allowed enum values: components

default: components

last_modified_by_user

object

The Datadog user who last modified the component.

data [required]

object

id [required]

string

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

type [required]

enum

Users resource type. Allowed enum values: users

default: users

status_page

object

The status page the component belongs to.

data [required]

object

id [required]

uuid

The ID of the status page the component belongs to.

type [required]

enum

Status pages resource type. Allowed enum values: status_pages

default: status_pages

type [required]

enum

Components resource type. Allowed enum values: components

default: components

included

[ <oneOf>]

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

Option 1

object

The included Datadog user resource.

attributes

object

Attributes of the Datadog user.

email

string

The email of the Datadog user.

handle

string

The handle of the Datadog user.

icon

string

The icon of the Datadog user.

name

string

The name of the Datadog user.

uuid

string

The UUID of the Datadog user.

id

uuid

The ID of the Datadog user.

type [required]

enum

Users resource type. Allowed enum values: users

default: users

Option 2

object

The included status page resource.

attributes

object

The attributes of a status page.

company_logo

string

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

components

[object]

Components displayed on the status page.

components

[object]

id

uuid

The ID of the grouped component.

name

string

The name of the grouped component.

position

int64

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

status

enum

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

type

enum

The type of the component. Allowed enum values: component

id

uuid

The ID of the component.

name

string

The name of the component.

position

int64

The zero-indexed position of the component.

status

enum

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

type

enum

The type of the component. Allowed enum values: component,group

created_at

date-time

Timestamp of when the status page was created.

custom_domain

string

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

custom_domain_enabled

boolean

Whether the custom domain is configured.

domain_prefix

string

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

email_header_image

string

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

enabled

boolean

Whether the status page is enabled.

favicon

string

Base64-encoded image data displayed in the browser tab.

modified_at

date-time

Timestamp of when the status page was last modified.

name

string

The name of the status page.

page_url

string

The url that the status page is accessible at.

subscriptions_enabled

boolean

Whether users can subscribe to the status page.

type

enum

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

visualization_type

enum

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

id

uuid

The ID of the status page.

relationships

object

The relationships of a status page.

created_by_user

object

The Datadog user who created the status page.

data [required]

object

id [required]

string

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

type [required]

enum

Users resource type. Allowed enum values: users

default: users

last_modified_by_user

object

The Datadog user who last modified the status page.

data [required]

object

id [required]

string

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

type [required]

enum

Users resource type. Allowed enum values: users

default: users

type [required]

enum

Status pages resource type. Allowed enum values: status_pages

default: status_pages

Option 3

object

The included component group resource.

attributes

object

The attributes of a component group.

components

[object]

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

id

uuid

The ID of the grouped component.

name

string

The name of the grouped component.

position

int64

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

status

enum

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

type

enum

The type of the component. Allowed enum values: component

created_at

date-time

Timestamp of when the component was created.

modified_at

date-time

Timestamp of when the component was last modified.

name

string

The name of the component.

position

int64

The zero-indexed position of the component.

status

enum

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

type [required]

enum

The type of the component. Allowed enum values: component,group

id

uuid

The ID of the component.

relationships

object

The relationships of a component group.

created_by_user

object

The Datadog user who created the component group.

data [required]

object

id [required]

string

The ID of the Datadog user who created the component group.

type [required]

enum

Users resource type. Allowed enum values: users

default: users

group

object

The group the component group belongs to.

data [required]

object

id [required]

uuid

type [required]

enum

Components resource type. Allowed enum values: components

default: components

last_modified_by_user

object

The Datadog user who last modified the component group.

data [required]

object

id [required]

string

The ID of the Datadog user who last modified the component group.

type [required]

enum

Users resource type. Allowed enum values: users

default: users

status_page

object

The status page the component group belongs to.

data [required]

object

id [required]

uuid

The ID of the status page.

type [required]

enum

Status pages resource type. Allowed enum values: status_pages

default: status_pages

type [required]

enum

Components resource type. Allowed enum values: components

default: components

{
  "data": [
    {
      "attributes": {
        "components": [
          {
            "id": "string",
            "name": "string",
            "position": "integer",
            "status": "string",
            "type": "component"
          }
        ],
        "created_at": "2019-09-19T10:00:00.000Z",
        "modified_at": "2019-09-19T10:00:00.000Z",
        "name": "string",
        "position": "integer",
        "status": "operational",
        "type": "component"
      },
      "id": "string",
      "relationships": {
        "created_by_user": {
          "data": {
            "id": "",
            "type": "users"
          }
        },
        "group": {
          "data": {
            "id": "",
            "type": "components"
          }
        },
        "last_modified_by_user": {
          "data": {
            "id": "",
            "type": "users"
          }
        },
        "status_page": {
          "data": {
            "id": "",
            "type": "status_pages"
          }
        }
      },
      "type": "components"
    }
  ],
  "included": [
    {
      "attributes": {
        "email": "string",
        "handle": "string",
        "icon": "string",
        "name": "string",
        "uuid": "string"
      },
      "id": "string",
      "type": "users"
    }
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Path parameters
export page_id="1234abcd-12ab-34cd-56ef-123456abcdef"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/statuspages/${page_id}/components" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Get component

GET https://api.ap1.datadoghq.com/api/v2/statuspages/{page_id}/components/{component_id}https://api.ap2.datadoghq.com/api/v2/statuspages/{page_id}/components/{component_id}https://api.datadoghq.eu/api/v2/statuspages/{page_id}/components/{component_id}https://api.ddog-gov.com/api/v2/statuspages/{page_id}/components/{component_id}https://api.datadoghq.com/api/v2/statuspages/{page_id}/components/{component_id}https://api.us3.datadoghq.com/api/v2/statuspages/{page_id}/components/{component_id}https://api.us5.datadoghq.com/api/v2/statuspages/{page_id}/components/{component_id}

Overview

Retrieves a specific component by its ID. This endpoint requires the status_pages_settings_read permission.

Arguments

Path Parameters

Name

Type

Description

page_id [required]

string

The ID of the status page.

component_id [required]

string

The ID of the component.

Query Strings

Name

Type

Description

include

string

Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page, group.

Response

OK

Expand All

Field

Type

Description

data

object

attributes

object

The attributes of a component.

components

[object]

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

id

uuid

name

string

position

int64

status

enum

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

type

enum

The type of the component. Allowed enum values: component

created_at

date-time

Timestamp of when the component was created.

modified_at

date-time

Timestamp of when the component was last modified.

name

string

The name of the component.

position

int64

The zero-indexed position of the component.

status

enum

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

type [required]

enum

The type of the component. Allowed enum values: component,group

id

uuid

The ID of the component.

relationships

object

The relationships of a component.

created_by_user

object

The Datadog user who created the component.

data [required]

object

id [required]

string

The ID of the Datadog user who created the component.

type [required]

enum

Users resource type. Allowed enum values: users

default: users

group

object

The group the component belongs to.

data [required]

object

id [required]

uuid

The ID of the group the component belongs to.

type [required]

enum

Components resource type. Allowed enum values: components

default: components

last_modified_by_user

object

The Datadog user who last modified the component.

data [required]

object

id [required]

string

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

type [required]

enum

Users resource type. Allowed enum values: users

default: users

status_page

object

The status page the component belongs to.

data [required]

object

id [required]

uuid

The ID of the status page the component belongs to.

type [required]

enum

Status pages resource type. Allowed enum values: status_pages

default: status_pages

type [required]

enum

Components resource type. Allowed enum values: components

default: components

included

[ <oneOf>]

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

Option 1

object

The included Datadog user resource.

attributes

object

Attributes of the Datadog user.

email

string

The email of the Datadog user.

handle

string

The handle of the Datadog user.

icon

string

The icon of the Datadog user.

name

string

The name of the Datadog user.

uuid

string

The UUID of the Datadog user.

id

uuid

The ID of the Datadog user.

type [required]

enum

Users resource type. Allowed enum values: users

default: users

Option 2

object

The included status page resource.

attributes

object

The attributes of a status page.

company_logo

string

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

components

[object]

Components displayed on the status page.

components

[object]

id

uuid

The ID of the grouped component.

name

string

The name of the grouped component.

position

int64

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

status

enum

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

type

enum

The type of the component. Allowed enum values: component

id

uuid

The ID of the component.

name

string

The name of the component.

position

int64

The zero-indexed position of the component.

status

enum

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

type

enum

The type of the component. Allowed enum values: component,group

created_at

date-time

Timestamp of when the status page was created.

custom_domain

string

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

custom_domain_enabled

boolean

Whether the custom domain is configured.

domain_prefix

string

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

email_header_image

string

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

enabled

boolean

Whether the status page is enabled.

favicon

string

Base64-encoded image data displayed in the browser tab.

modified_at

date-time

Timestamp of when the status page was last modified.

name

string

The name of the status page.

page_url

string

The url that the status page is accessible at.

subscriptions_enabled

boolean

Whether users can subscribe to the status page.

type

enum

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

visualization_type

enum

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

id

uuid

The ID of the status page.

relationships

object

The relationships of a status page.

created_by_user

object

The Datadog user who created the status page.

data [required]

object

id [required]

string

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

type [required]

enum

Users resource type. Allowed enum values: users

default: users

last_modified_by_user

object

The Datadog user who last modified the status page.

data [required]

object

id [required]

string

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

type [required]

enum

Users resource type. Allowed enum values: users

default: users

type [required]

enum

Status pages resource type. Allowed enum values: status_pages

default: status_pages

Option 3

object

The included component group resource.

attributes

object

The attributes of a component group.

components

[object]

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

id

uuid

The ID of the grouped component.

name

string

The name of the grouped component.

position

int64

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

status

enum

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

type

enum

The type of the component. Allowed enum values: component

created_at

date-time

Timestamp of when the component was created.

modified_at

date-time

Timestamp of when the component was last modified.

name

string

The name of the component.

position

int64

The zero-indexed position of the component.

status

enum

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

type [required]

enum

The type of the component. Allowed enum values: component,group

id

uuid

The ID of the component.

relationships

object

The relationships of a component group.

created_by_user

object

The Datadog user who created the component group.

data [required]

object

id [required]

string

The ID of the Datadog user who created the component group.

type [required]

enum

Users resource type. Allowed enum values: users

default: users

group

object

The group the component group belongs to.

data [required]

object

id [required]

uuid

type [required]

enum

Components resource type. Allowed enum values: components

default: components

last_modified_by_user

object

The Datadog user who last modified the component group.

data [required]

object

id [required]

string

The ID of the Datadog user who last modified the component group.

type [required]

enum

Users resource type. Allowed enum values: users

default: users

status_page

object

The status page the component group belongs to.

data [required]

object

id [required]

uuid

The ID of the status page.

type [required]

enum

Status pages resource type. Allowed enum values: status_pages

default: status_pages

type [required]

enum

Components resource type. Allowed enum values: components

default: components

{
  "data": {
    "attributes": {
      "components": [
        {
          "id": "string",
          "name": "string",
          "position": "integer",
          "status": "string",
          "type": "component"
        }
      ],
      "created_at": "2019-09-19T10:00:00.000Z",
      "modified_at": "2019-09-19T10:00:00.000Z",
      "name": "string",
      "position": "integer",
      "status": "operational",
      "type": "component"
    },
    "id": "string",
    "relationships": {
      "created_by_user": {
        "data": {
          "id": "",
          "type": "users"
        }
      },
      "group": {
        "data": {
          "id": "",
          "type": "components"
        }
      },
      "last_modified_by_user": {
        "data": {
          "id": "",
          "type": "users"
        }
      },
      "status_page": {
        "data": {
          "id": "",
          "type": "status_pages"
        }
      }
    },
    "type": "components"
  },
  "included": [
    {
      "attributes": {
        "email": "string",
        "handle": "string",
        "icon": "string",
        "name": "string",
        "uuid": "string"
      },
      "id": "string",
      "type": "users"
    }
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Path parameters
export page_id="1234abcd-12ab-34cd-56ef-123456abcdef"
export component_id="1234abcd-12ab-34cd-56ef-123456abcdef"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/statuspages/${page_id}/components/${component_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Delete component

DELETE https://api.ap1.datadoghq.com/api/v2/statuspages/{page_id}/components/{component_id}https://api.ap2.datadoghq.com/api/v2/statuspages/{page_id}/components/{component_id}https://api.datadoghq.eu/api/v2/statuspages/{page_id}/components/{component_id}https://api.ddog-gov.com/api/v2/statuspages/{page_id}/components/{component_id}https://api.datadoghq.com/api/v2/statuspages/{page_id}/components/{component_id}https://api.us3.datadoghq.com/api/v2/statuspages/{page_id}/components/{component_id}https://api.us5.datadoghq.com/api/v2/statuspages/{page_id}/components/{component_id}

Overview

Deletes a component by its ID. This endpoint requires the status_pages_settings_write permission.

Arguments

Path Parameters

Name

Type

Description

page_id [required]

string

The ID of the status page.

component_id [required]

string

The ID of the component.

Response

No Content

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Path parameters
export page_id="1234abcd-12ab-34cd-56ef-123456abcdef"
export component_id="1234abcd-12ab-34cd-56ef-123456abcdef"
# Curl command
curl -X DELETE "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/statuspages/${page_id}/components/${component_id}" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Create degradation

POST https://api.ap1.datadoghq.com/api/v2/statuspages/{page_id}/degradationshttps://api.ap2.datadoghq.com/api/v2/statuspages/{page_id}/degradationshttps://api.datadoghq.eu/api/v2/statuspages/{page_id}/degradationshttps://api.ddog-gov.com/api/v2/statuspages/{page_id}/degradationshttps://api.datadoghq.com/api/v2/statuspages/{page_id}/degradationshttps://api.us3.datadoghq.com/api/v2/statuspages/{page_id}/degradationshttps://api.us5.datadoghq.com/api/v2/statuspages/{page_id}/degradations

Overview

Creates a new degradation. This endpoint requires the status_pages_incident_write permission.

Arguments

Path Parameters

Name

Type

Description

page_id [required]

string

The ID of the status page.

Query Strings

Name

Type

Description

notify_subscribers

boolean

Whether to notify page subscribers of the degradation.

include

string

Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page.

Request

Body Data (required)

Expand All

Field

Type

Description

data

object

attributes

object

The supported attributes for creating a degradation.

components_affected [required]

[object]

The components affected by the degradation.

id [required]

uuid

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

name

string

status [required]

enum

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

description

string

The description of the degradation.

status [required]

enum

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

title [required]

string

The title of the degradation.

type [required]

enum

Degradations resource type. Allowed enum values: degradations

default: degradations

{
  "data": {
    "attributes": {
      "components_affected": [
        {
          "id": "4e9d3726-bdd7-0079-613c-e9aaba89eb01",
          "status": "major_outage"
        }
      ],
      "description": "Our API is experiencing elevated latency. We are investigating the issue.",
      "status": "investigating",
      "title": "Elevated API Latency"
    },
    "type": "degradations"
  }
}

Response

Created

Expand All

Field

Type

Description

data

object

attributes

object

The attributes of a degradation.

components_affected

[object]

Components affected by the degradation.

id [required]

uuid

The ID of the component.

name

string

The name of the component.

status [required]

enum

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

created_at

date-time

Timestamp of when the degradation was created.

description

string

Description of the degradation.

modified_at

date-time

Timestamp of when the degradation was last modified.

status

enum

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

title

string

Title of the degradation.

updates

[object]

Past updates made to the degradation.

components_affected

[object]

The components affected at the time of the update.

id [required]

uuid

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

name

string

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

status [required]

enum

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

created_at

date-time

Timestamp of when the update was created.

description

string

Description of the update.

id

uuid

Identifier of the update.

modified_at

date-time

Timestamp of when the update was last modified.

status

enum

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

id

uuid

The ID of the degradation.

relationships

object

The relationships of a degradation.

created_by_user

object

The Datadog user who created the degradation.

data [required]

object

id [required]

string

The ID of the Datadog user who created the degradation.

type [required]

enum

Users resource type. Allowed enum values: users

default: users

last_modified_by_user

object

The Datadog user who last modified the degradation.

data [required]

object

id [required]

string

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

type [required]

enum

Users resource type. Allowed enum values: users

default: users

status_page

object

The status page the degradation belongs to.

data [required]

object

id [required]

uuid

The ID of the status page.

type [required]

enum

Status pages resource type. Allowed enum values: status_pages

default: status_pages

type [required]

enum

Degradations resource type. Allowed enum values: degradations

default: degradations

included

[ <oneOf>]

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

Option 1

object

The included Datadog user resource.

attributes

object

Attributes of the Datadog user.

email

string

The email of the Datadog user.

handle

string

The handle of the Datadog user.

icon

string

The icon of the Datadog user.

name

string

The name of the Datadog user.

uuid

string

The UUID of the Datadog user.

id

uuid

The ID of the Datadog user.

type [required]

enum

Users resource type. Allowed enum values: users

default: users

Option 2

object

The included status page resource.

attributes

object

The attributes of a status page.

company_logo

string

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

components

[object]

Components displayed on the status page.

components

[object]

id

uuid

The ID of the grouped component.

name

string

The name of the grouped component.

position

int64

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

status

enum

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

type

enum

The type of the component. Allowed enum values: component

id

uuid

The ID of the component.

name

string

The name of the component.

position

int64

The zero-indexed position of the component.

status

enum

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

type

enum

The type of the component. Allowed enum values: component,group

created_at

date-time

Timestamp of when the status page was created.

custom_domain

string

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

custom_domain_enabled

boolean

Whether the custom domain is configured.

domain_prefix

string

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

email_header_image

string

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

enabled

boolean

Whether the status page is enabled.

favicon

string

Base64-encoded image data displayed in the browser tab.

modified_at

date-time

Timestamp of when the status page was last modified.

name

string

The name of the status page.

page_url

string

The url that the status page is accessible at.

subscriptions_enabled

boolean

Whether users can subscribe to the status page.

type

enum

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

visualization_type

enum

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

id

uuid

The ID of the status page.

relationships

object

The relationships of a status page.

created_by_user

object

The Datadog user who created the status page.

data [required]

object

id [required]

string

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

type [required]

enum

Users resource type. Allowed enum values: users

default: users

last_modified_by_user

object

The Datadog user who last modified the status page.

data [required]

object

id [required]

string

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

type [required]

enum

Users resource type. Allowed enum values: users

default: users

type [required]

enum

Status pages resource type. Allowed enum values: status_pages

default: status_pages

{
  "data": {
    "attributes": {
      "components_affected": [
        {
          "id": "",
          "name": "string",
          "status": "operational"
        }
      ],
      "created_at": "2019-09-19T10:00:00.000Z",
      "description": "string",
      "modified_at": "2019-09-19T10:00:00.000Z",
      "status": "investigating",
      "title": "string",
      "updates": [
        {
          "components_affected": [
            {
              "id": "",
              "name": "string",
              "status": "operational"
            }
          ],
          "created_at": "2019-09-19T10:00:00.000Z",
          "description": "string",
          "id": "string",
          "modified_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": "",
          "type": "status_pages"
        }
      }
    },
    "type": "degradations"
  },
  "included": [
    {
      "attributes": {
        "email": "string",
        "handle": "string",
        "icon": "string",
        "name": "string",
        "uuid": "string"
      },
      "id": "string",
      "type": "users"
    }
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                          # Path parameters
export page_id="1234abcd-12ab-34cd-56ef-123456abcdef"
# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/statuspages/${page_id}/degradations" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "components_affected": [
        {
          "id": "4e9d3726-bdd7-0079-613c-e9aaba89eb01",
          "status": "major_outage"
        }
      ],
      "description": "Our API is experiencing elevated latency. We are investigating the issue.",
      "status": "investigating",
      "title": "Elevated API Latency"
    },
    "type": "degradations"
  }
}
EOF

Update degradation

PATCH https://api.ap1.datadoghq.com/api/v2/statuspages/{page_id}/degradations/{degradation_id}https://api.ap2.datadoghq.com/api/v2/statuspages/{page_id}/degradations/{degradation_id}https://api.datadoghq.eu/api/v2/statuspages/{page_id}/degradations/{degradation_id}https://api.ddog-gov.com/api/v2/statuspages/{page_id}/degradations/{degradation_id}https://api.datadoghq.com/api/v2/statuspages/{page_id}/degradations/{degradation_id}https://api.us3.datadoghq.com/api/v2/statuspages/{page_id}/degradations/{degradation_id}https://api.us5.datadoghq.com/api/v2/statuspages/{page_id}/degradations/{degradation_id}

Overview

Updates an existing degradation’s attributes. This endpoint requires the status_pages_incident_write permission.

Arguments

Path Parameters

Name

Type

Description

page_id [required]

string

The ID of the status page.

degradation_id [required]

string

The ID of the degradation.

Query Strings

Name

Type

Description

notify_subscribers

boolean

Whether to notify page subscribers of the degradation.

include

string

Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page.

Request

Body Data (required)

Expand All

Field

Type

Description

data

object

attributes

object

The supported attributes for updating a degradation.

components_affected

[object]

The components affected by the degradation.

id [required]

uuid

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

name

string

status [required]

enum

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

description

string

The description of the degradation.

status

enum

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

title

string

The title of the degradation.

id

uuid

The ID of the degradation.

type [required]

enum

Degradations resource type. Allowed enum values: degradations

default: degradations

{
  "data": {
    "attributes": {
      "title": "Elevated API Latency in US1"
    },
    "id": "81335836-b858-2e64-43d6-5b27ba1e6d8e",
    "type": "degradations"
  }
}

Response

OK

Expand All

Field

Type

Description

data

object

attributes

object

The attributes of a degradation.

components_affected

[object]

Components affected by the degradation.

id [required]

uuid

The ID of the component.

name

string

The name of the component.

status [required]

enum

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

created_at

date-time

Timestamp of when the degradation was created.

description

string

Description of the degradation.

modified_at

date-time

Timestamp of when the degradation was last modified.

status

enum

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

title

string

Title of the degradation.

updates

[object]

Past updates made to the degradation.

components_affected

[object]

The components affected at the time of the update.

id [required]

uuid

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

name

string

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

status [required]

enum

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

created_at

date-time

Timestamp of when the update was created.

description

string

Description of the update.

id

uuid

Identifier of the update.

modified_at

date-time

Timestamp of when the update was last modified.

status

enum

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

id

uuid

The ID of the degradation.

relationships

object

The relationships of a degradation.

created_by_user

object

The Datadog user who created the degradation.

data [required]

object

id [required]

string

The ID of the Datadog user who created the degradation.

type [required]

enum

Users resource type. Allowed enum values: users

default: users

last_modified_by_user

object

The Datadog user who last modified the degradation.

data [required]

object

id [required]

string

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

type [required]

enum

Users resource type. Allowed enum values: users

default: users

status_page

object

The status page the degradation belongs to.

data [required]

object

id [required]

uuid

The ID of the status page.

type [required]

enum

Status pages resource type. Allowed enum values: status_pages

default: status_pages

type [required]

enum

Degradations resource type. Allowed enum values: degradations

default: degradations

included

[ <oneOf>]

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

Option 1

object

The included Datadog user resource.

attributes

object

Attributes of the Datadog user.

email

string

The email of the Datadog user.

handle

string

The handle of the Datadog user.

icon

string

The icon of the Datadog user.

name

string

The name of the Datadog user.

uuid

string

The UUID of the Datadog user.

id

uuid

The ID of the Datadog user.

type [required]

enum

Users resource type. Allowed enum values: users

default: users

Option 2

object

The included status page resource.

attributes

object

The attributes of a status page.

company_logo

string

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

components

[object]

Components displayed on the status page.

components

[object]

id

uuid

The ID of the grouped component.

name

string

The name of the grouped component.

position

int64

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

status

enum

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

type

enum

The type of the component. Allowed enum values: component

id

uuid

The ID of the component.

name

string

The name of the component.

position

int64

The zero-indexed position of the component.

status

enum

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

type

enum

The type of the component. Allowed enum values: component,group

created_at

date-time

Timestamp of when the status page was created.

custom_domain

string

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

custom_domain_enabled

boolean

Whether the custom domain is configured.

domain_prefix

string

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

email_header_image

string

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

enabled

boolean

Whether the status page is enabled.

favicon

string

Base64-encoded image data displayed in the browser tab.

modified_at

date-time

Timestamp of when the status page was last modified.

name

string

The name of the status page.

page_url

string

The url that the status page is accessible at.

subscriptions_enabled

boolean

Whether users can subscribe to the status page.

type

enum

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

visualization_type

enum

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

id

uuid

The ID of the status page.

relationships

object

The relationships of a status page.

created_by_user

object

The Datadog user who created the status page.

data [required]

object

id [required]

string

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

type [required]

enum

Users resource type. Allowed enum values: users

default: users

last_modified_by_user

object

The Datadog user who last modified the status page.

data [required]

object

id [required]

string

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

type [required]

enum

Users resource type. Allowed enum values: users

default: users

type [required]

enum

Status pages resource type. Allowed enum values: status_pages

default: status_pages

{
  "data": {
    "attributes": {
      "components_affected": [
        {
          "id": "",
          "name": "string",
          "status": "operational"
        }
      ],
      "created_at": "2019-09-19T10:00:00.000Z",
      "description": "string",
      "modified_at": "2019-09-19T10:00:00.000Z",
      "status": "investigating",
      "title": "string",
      "updates": [
        {
          "components_affected": [
            {
              "id": "",
              "name": "string",
              "status": "operational"
            }
          ],
          "created_at": "2019-09-19T10:00:00.000Z",
          "description": "string",
          "id": "string",
          "modified_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": "",
          "type": "status_pages"
        }
      }
    },
    "type": "degradations"
  },
  "included": [
    {
      "attributes": {
        "email": "string",
        "handle": "string",
        "icon": "string",
        "name": "string",
        "uuid": "string"
      },
      "id": "string",
      "type": "users"
    }
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                          # Path parameters
export page_id="1234abcd-12ab-34cd-56ef-123456abcdef"
export degradation_id="1234abcd-12ab-34cd-56ef-123456abcdef"
# Curl command
curl -X PATCH "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/statuspages/${page_id}/degradations/${degradation_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "title": "Elevated API Latency in US1"
    },
    "id": "81335836-b858-2e64-43d6-5b27ba1e6d8e",
    "type": "degradations"
  }
}
EOF

List degradations

GET https://api.ap1.datadoghq.com/api/v2/statuspages/degradationshttps://api.ap2.datadoghq.com/api/v2/statuspages/degradationshttps://api.datadoghq.eu/api/v2/statuspages/degradationshttps://api.ddog-gov.com/api/v2/statuspages/degradationshttps://api.datadoghq.com/api/v2/statuspages/degradationshttps://api.us3.datadoghq.com/api/v2/statuspages/degradationshttps://api.us5.datadoghq.com/api/v2/statuspages/degradations

Overview

Lists all degradations for the organization. Optionally filter by status and page. This endpoint requires the status_pages_settings_read permission.

Arguments

Query Strings

Name

Type

Description

filter[page_id]

string

Optional page id filter.

page[offset]

integer

Offset to use as the start of the page.

page[limit]

integer

The number of degradations to return per page.

include

string

Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page.

filter[status]

string

Optional degradation status filter. Supported values: investigating, identified, monitoring, resolved.

Response

OK

Expand All

Field

Type

Description

data [required]

[object]

attributes

object

The attributes of a degradation.

components_affected

[object]

Components affected by the degradation.

id [required]

uuid

The ID of the component.

name

string

The name of the component.

status [required]

enum

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

created_at

date-time

Timestamp of when the degradation was created.

description

string

Description of the degradation.

modified_at

date-time

Timestamp of when the degradation was last modified.

status

enum

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

title

string

Title of the degradation.

updates

[object]

Past updates made to the degradation.

components_affected

[object]

The components affected at the time of the update.

id [required]

uuid

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

name

string

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

status [required]

enum

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

created_at

date-time

Timestamp of when the update was created.

description

string

Description of the update.

id

uuid

Identifier of the update.

modified_at

date-time

Timestamp of when the update was last modified.

status

enum

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

id

uuid

The ID of the degradation.

relationships

object

The relationships of a degradation.

created_by_user

object

The Datadog user who created the degradation.

data [required]

object

id [required]

string

The ID of the Datadog user who created the degradation.

type [required]

enum

Users resource type. Allowed enum values: users

default: users

last_modified_by_user

object

The Datadog user who last modified the degradation.

data [required]

object

id [required]

string

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

type [required]

enum

Users resource type. Allowed enum values: users

default: users

status_page

object

The status page the degradation belongs to.

data [required]

object

id [required]

uuid

The ID of the status page.

type [required]

enum

Status pages resource type. Allowed enum values: status_pages

default: status_pages

type [required]

enum

Degradations resource type. Allowed enum values: degradations

default: degradations

included

[ <oneOf>]

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

Option 1

object

The included Datadog user resource.

attributes

object

Attributes of the Datadog user.

email

string

The email of the Datadog user.

handle

string

The handle of the Datadog user.

icon

string

The icon of the Datadog user.

name

string

The name of the Datadog user.

uuid

string

The UUID of the Datadog user.

id

uuid

The ID of the Datadog user.

type [required]

enum

Users resource type. Allowed enum values: users

default: users

Option 2

object

The included status page resource.

attributes

object

The attributes of a status page.

company_logo

string

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

components

[object]

Components displayed on the status page.

components

[object]

id

uuid

The ID of the grouped component.

name

string

The name of the grouped component.

position

int64

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

status

enum

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

type

enum

The type of the component. Allowed enum values: component

id

uuid

The ID of the component.

name

string

The name of the component.

position

int64

The zero-indexed position of the component.

status

enum

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

type

enum

The type of the component. Allowed enum values: component,group

created_at

date-time

Timestamp of when the status page was created.

custom_domain

string

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

custom_domain_enabled

boolean

Whether the custom domain is configured.

domain_prefix

string

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

email_header_image

string

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

enabled

boolean

Whether the status page is enabled.

favicon

string

Base64-encoded image data displayed in the browser tab.

modified_at

date-time

Timestamp of when the status page was last modified.

name

string

The name of the status page.

page_url

string

The url that the status page is accessible at.

subscriptions_enabled

boolean

Whether users can subscribe to the status page.

type

enum

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

visualization_type

enum

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

id

uuid

The ID of the status page.

relationships

object

The relationships of a status page.

created_by_user

object

The Datadog user who created the status page.

data [required]

object

id [required]

string

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

type [required]

enum

Users resource type. Allowed enum values: users

default: users

last_modified_by_user

object

The Datadog user who last modified the status page.

data [required]

object

id [required]

string

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

type [required]

enum

Users resource type. Allowed enum values: users

default: users

type [required]

enum

Status pages resource type. Allowed enum values: status_pages

default: status_pages

meta

object

Response metadata.

page

object

Offset-based pagination schema.

first_offset

int64

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

last_offset

int64

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

limit

int64

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

next_offset

int64

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

offset

int64

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

prev_offset

int64

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

total

int64

Integer representing the total number of elements available.

type

enum

default: offset_limit

{
  "data": [
    {
      "attributes": {
        "components_affected": [
          {
            "id": "",
            "name": "string",
            "status": "operational"
          }
        ],
        "created_at": "2019-09-19T10:00:00.000Z",
        "description": "string",
        "modified_at": "2019-09-19T10:00:00.000Z",
        "status": "investigating",
        "title": "string",
        "updates": [
          {
            "components_affected": [
              {
                "id": "",
                "name": "string",
                "status": "operational"
              }
            ],
            "created_at": "2019-09-19T10:00:00.000Z",
            "description": "string",
            "id": "string",
            "modified_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": "",
            "type": "status_pages"
          }
        }
      },
      "type": "degradations"
    }
  ],
  "included": [
    {
      "attributes": {
        "email": "string",
        "handle": "string",
        "icon": "string",
        "name": "string",
        "uuid": "string"
      },
      "id": "string",
      "type": "users"
    }
  ],
  "meta": {
    "page": {
      "first_offset": 0,
      "last_offset": 900,
      "limit": 100,
      "next_offset": 100,
      "offset": 0,
      "prev_offset": 100,
      "total": 1000,
      "type": "offset_limit"
    }
  }
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/statuspages/degradations" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Get degradation

GET https://api.ap1.datadoghq.com/api/v2/statuspages/{page_id}/degradations/{degradation_id}https://api.ap2.datadoghq.com/api/v2/statuspages/{page_id}/degradations/{degradation_id}https://api.datadoghq.eu/api/v2/statuspages/{page_id}/degradations/{degradation_id}https://api.ddog-gov.com/api/v2/statuspages/{page_id}/degradations/{degradation_id}https://api.datadoghq.com/api/v2/statuspages/{page_id}/degradations/{degradation_id}https://api.us3.datadoghq.com/api/v2/statuspages/{page_id}/degradations/{degradation_id}https://api.us5.datadoghq.com/api/v2/statuspages/{page_id}/degradations/{degradation_id}

Overview

Retrieves a specific degradation by its ID. This endpoint requires the status_pages_settings_read permission.

Arguments

Path Parameters

Name

Type

Description

page_id [required]

string

The ID of the status page.

degradation_id [required]

string

The ID of the degradation.

Query Strings

Name

Type

Description

include

string

Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page.

Response

OK

Expand All

Field

Type

Description

data

object

attributes

object

The attributes of a degradation.

components_affected

[object]

Components affected by the degradation.

id [required]

uuid

The ID of the component.

name

string

The name of the component.

status [required]

enum

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

created_at

date-time

Timestamp of when the degradation was created.

description

string

Description of the degradation.

modified_at

date-time

Timestamp of when the degradation was last modified.

status

enum

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

title

string

Title of the degradation.

updates

[object]

Past updates made to the degradation.

components_affected

[object]

The components affected at the time of the update.

id [required]

uuid

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

name

string

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

status [required]

enum

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

created_at

date-time

Timestamp of when the update was created.

description

string

Description of the update.

id

uuid

Identifier of the update.

modified_at

date-time

Timestamp of when the update was last modified.

status

enum

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

id

uuid

The ID of the degradation.

relationships

object

The relationships of a degradation.

created_by_user

object

The Datadog user who created the degradation.

data [required]

object

id [required]

string

The ID of the Datadog user who created the degradation.

type [required]

enum

Users resource type. Allowed enum values: users

default: users

last_modified_by_user

object

The Datadog user who last modified the degradation.

data [required]

object

id [required]

string

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

type [required]

enum

Users resource type. Allowed enum values: users

default: users

status_page

object

The status page the degradation belongs to.

data [required]

object

id [required]

uuid

The ID of the status page.

type [required]

enum

Status pages resource type. Allowed enum values: status_pages

default: status_pages

type [required]

enum

Degradations resource type. Allowed enum values: degradations

default: degradations

included

[ <oneOf>]

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

Option 1

object

The included Datadog user resource.

attributes

object

Attributes of the Datadog user.

email

string

The email of the Datadog user.

handle

string

The handle of the Datadog user.

icon

string

The icon of the Datadog user.

name

string

The name of the Datadog user.

uuid

string

The UUID of the Datadog user.

id

uuid

The ID of the Datadog user.

type [required]

enum

Users resource type. Allowed enum values: users

default: users

Option 2

object

The included status page resource.

attributes

object

The attributes of a status page.

company_logo

string

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

components

[object]

Components displayed on the status page.

components

[object]

id

uuid

The ID of the grouped component.

name

string

The name of the grouped component.

position

int64

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

status

enum

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

type

enum

The type of the component. Allowed enum values: component

id

uuid

The ID of the component.

name

string

The name of the component.

position

int64

The zero-indexed position of the component.

status

enum

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

type

enum

The type of the component. Allowed enum values: component,group

created_at

date-time

Timestamp of when the status page was created.

custom_domain

string

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

custom_domain_enabled

boolean

Whether the custom domain is configured.

domain_prefix

string

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

email_header_image

string

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

enabled

boolean

Whether the status page is enabled.

favicon

string

Base64-encoded image data displayed in the browser tab.

modified_at

date-time

Timestamp of when the status page was last modified.

name

string

The name of the status page.

page_url

string

The url that the status page is accessible at.

subscriptions_enabled

boolean

Whether users can subscribe to the status page.

type

enum

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

visualization_type

enum

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

id

uuid

The ID of the status page.

relationships

object

The relationships of a status page.

created_by_user

object

The Datadog user who created the status page.

data [required]

object

id [required]

string

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

type [required]

enum

Users resource type. Allowed enum values: users

default: users

last_modified_by_user

object

The Datadog user who last modified the status page.

data [required]

object

id [required]

string

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

type [required]

enum

Users resource type. Allowed enum values: users

default: users

type [required]

enum

Status pages resource type. Allowed enum values: status_pages

default: status_pages

{
  "data": {
    "attributes": {
      "components_affected": [
        {
          "id": "",
          "name": "string",
          "status": "operational"
        }
      ],
      "created_at": "2019-09-19T10:00:00.000Z",
      "description": "string",
      "modified_at": "2019-09-19T10:00:00.000Z",
      "status": "investigating",
      "title": "string",
      "updates": [
        {
          "components_affected": [
            {
              "id": "",
              "name": "string",
              "status": "operational"
            }
          ],
          "created_at": "2019-09-19T10:00:00.000Z",
          "description": "string",
          "id": "string",
          "modified_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": "",
          "type": "status_pages"
        }
      }
    },
    "type": "degradations"
  },
  "included": [
    {
      "attributes": {
        "email": "string",
        "handle": "string",
        "icon": "string",
        "name": "string",
        "uuid": "string"
      },
      "id": "string",
      "type": "users"
    }
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Path parameters
export page_id="1234abcd-12ab-34cd-56ef-123456abcdef"
export degradation_id="1234abcd-12ab-34cd-56ef-123456abcdef"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/statuspages/${page_id}/degradations/${degradation_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Delete degradation

DELETE https://api.ap1.datadoghq.com/api/v2/statuspages/{page_id}/degradations/{degradation_id}https://api.ap2.datadoghq.com/api/v2/statuspages/{page_id}/degradations/{degradation_id}https://api.datadoghq.eu/api/v2/statuspages/{page_id}/degradations/{degradation_id}https://api.ddog-gov.com/api/v2/statuspages/{page_id}/degradations/{degradation_id}https://api.datadoghq.com/api/v2/statuspages/{page_id}/degradations/{degradation_id}https://api.us3.datadoghq.com/api/v2/statuspages/{page_id}/degradations/{degradation_id}https://api.us5.datadoghq.com/api/v2/statuspages/{page_id}/degradations/{degradation_id}

Overview

Deletes a degradation by its ID. This endpoint requires the status_pages_incident_write permission.

Arguments

Path Parameters

Name

Type

Description

page_id [required]

string

The ID of the status page.

degradation_id [required]

string

The ID of the degradation.

Response

No Content

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Path parameters
export page_id="1234abcd-12ab-34cd-56ef-123456abcdef"
export degradation_id="1234abcd-12ab-34cd-56ef-123456abcdef"
# Curl command
curl -X DELETE "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/statuspages/${page_id}/degradations/${degradation_id}" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"