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.us2.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

The data object for updating a degradation.

attributes [required]

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

The name of the component.

status [required]

enum

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

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 [required]

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

Response object for a single degradation.

Expand All

Field

Type

Description

data

object

The data object for a degradation.

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,maintenance

created_at

date-time

Timestamp of when the degradation was created.

description

string

Description of the degradation.

is_backfilled

boolean

Whether the degradation was backfilled.

modified_at

date-time

Timestamp of when the degradation was last modified.

source

object

The source of the degradation.

created_at [required]

date-time

Timestamp of when the source was created.

source_id [required]

string

The ID of the source.

type [required]

enum

The type of the source. Allowed enum values: incident

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,maintenance

created_at

date-time

Timestamp of when the update was created.

description

string

Description of the update.

id

uuid

Identifier of the update.

last_modified_by_user_uuid

string

UUID of the user who last modified the resource.

modified_at

date-time

Timestamp of when the update was last modified.

started_at

date-time

Timestamp of when the update started.

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

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

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

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

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

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

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]

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,maintenance

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,maintenance

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

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

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

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

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": "1234abcd-12ab-34cd-56ef-123456abcdef",
          "name": "string",
          "status": "operational"
        }
      ],
      "created_at": "2019-09-19T10:00:00.000Z",
      "description": "string",
      "is_backfilled": false,
      "modified_at": "2019-09-19T10:00:00.000Z",
      "source": {
        "created_at": "",
        "source_id": "",
        "type": "incident"
      },
      "status": "investigating",
      "title": "string",
      "updates": [
        {
          "components_affected": [
            {
              "id": "1234abcd-12ab-34cd-56ef-123456abcdef",
              "name": "string",
              "status": "operational"
            }
          ],
          "created_at": "2019-09-19T10:00:00.000Z",
          "description": "string",
          "id": "string",
          "last_modified_by_user_uuid": "string",
          "modified_at": "2019-09-19T10:00:00.000Z",
          "started_at": "2019-09-19T10:00:00.000Z",
          "status": "investigating"
        }
      ]
    },
    "id": "string",
    "relationships": {
      "created_by_user": {
        "data": {
          "id": "",
          "type": "users"
        }
      },
      "last_modified_by_user": {
        "data": {
          "id": "",
          "type": "users"
        }
      },
      "status_page": {
        "data": {
          "id": "1234abcd-12ab-34cd-56ef-123456abcdef",
          "type": "status_pages"
        }
      }
    },
    "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

                          ## default
# 

# 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.us2.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": { "components_affected": [ { "id": "1234abcd-12ab-34cd-56ef-123456abcdef", "status": "operational" } ], "description": "We've deployed a fix and latency has returned to normal. This issue has been resolved.", "status": "resolved", "title": "Elevated API Latency in US1" }, "id": "1234abcd-12ab-34cd-56ef-123456abcdef", "type": "degradations" } } EOF
// Update degradation returns "OK" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
	"github.com/google/uuid"
)

func main() {
	// there is a valid "status_page" in the system
	StatusPageDataID := uuid.MustParse(os.Getenv("STATUS_PAGE_DATA_ID"))

	// there is a valid "degradation" in the system
	DegradationDataID := uuid.MustParse(os.Getenv("DEGRADATION_DATA_ID"))

	body := datadogV2.PatchDegradationRequest{
		Data: &datadogV2.PatchDegradationRequestData{
			Attributes: datadogV2.PatchDegradationRequestDataAttributes{
				Title: datadog.PtrString("Elevated API Latency in US1"),
			},
			Id:   DegradationDataID,
			Type: datadogV2.PATCHDEGRADATIONREQUESTDATATYPE_DEGRADATIONS,
		},
	}
	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewStatusPagesApi(apiClient)
	resp, r, err := api.UpdateDegradation(ctx, StatusPageDataID, DegradationDataID, body, *datadogV2.NewUpdateDegradationOptionalParameters())

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `StatusPagesApi.UpdateDegradation`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `StatusPagesApi.UpdateDegradation`:\n%s\n", responseContent)
}

Instructions

First install the library and its dependencies and then save the example to main.go and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"
// Update degradation returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.StatusPagesApi;
import com.datadog.api.client.v2.model.Degradation;
import com.datadog.api.client.v2.model.PatchDegradationRequest;
import com.datadog.api.client.v2.model.PatchDegradationRequestData;
import com.datadog.api.client.v2.model.PatchDegradationRequestDataAttributes;
import com.datadog.api.client.v2.model.PatchDegradationRequestDataType;
import java.util.UUID;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    StatusPagesApi apiInstance = new StatusPagesApi(defaultClient);

    // there is a valid "status_page" in the system
    UUID STATUS_PAGE_DATA_ID = null;
    try {
      STATUS_PAGE_DATA_ID = UUID.fromString(System.getenv("STATUS_PAGE_DATA_ID"));
    } catch (IllegalArgumentException e) {
      System.err.println("Error parsing UUID: " + e.getMessage());
    }

    // there is a valid "degradation" in the system
    UUID DEGRADATION_DATA_ID = null;
    try {
      DEGRADATION_DATA_ID = UUID.fromString(System.getenv("DEGRADATION_DATA_ID"));
    } catch (IllegalArgumentException e) {
      System.err.println("Error parsing UUID: " + e.getMessage());
    }

    PatchDegradationRequest body =
        new PatchDegradationRequest()
            .data(
                new PatchDegradationRequestData()
                    .attributes(
                        new PatchDegradationRequestDataAttributes()
                            .title("Elevated API Latency in US1"))
                    .id(DEGRADATION_DATA_ID)
                    .type(PatchDegradationRequestDataType.DEGRADATIONS));

    try {
      Degradation result =
          apiInstance.updateDegradation(STATUS_PAGE_DATA_ID, DEGRADATION_DATA_ID, body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling StatusPagesApi#updateDegradation");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Instructions

First install the library and its dependencies and then save the example to Example.java and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"
"""
Update degradation returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.status_pages_api import StatusPagesApi
from datadog_api_client.v2.model.patch_degradation_request import PatchDegradationRequest
from datadog_api_client.v2.model.patch_degradation_request_data import PatchDegradationRequestData
from datadog_api_client.v2.model.patch_degradation_request_data_attributes import PatchDegradationRequestDataAttributes
from datadog_api_client.v2.model.patch_degradation_request_data_type import PatchDegradationRequestDataType

# there is a valid "status_page" in the system
STATUS_PAGE_DATA_ID = environ["STATUS_PAGE_DATA_ID"]

# there is a valid "degradation" in the system
DEGRADATION_DATA_ID = environ["DEGRADATION_DATA_ID"]

body = PatchDegradationRequest(
    data=PatchDegradationRequestData(
        attributes=PatchDegradationRequestDataAttributes(
            title="Elevated API Latency in US1",
        ),
        id=DEGRADATION_DATA_ID,
        type=PatchDegradationRequestDataType.DEGRADATIONS,
    ),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
    api_instance = StatusPagesApi(api_client)
    response = api_instance.update_degradation(
        page_id=STATUS_PAGE_DATA_ID, degradation_id=DEGRADATION_DATA_ID, body=body
    )

    print(response)

Instructions

First install the library and its dependencies and then save the example to example.py and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"
# Update degradation returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::StatusPagesAPI.new

# there is a valid "status_page" in the system
STATUS_PAGE_DATA_ID = ENV["STATUS_PAGE_DATA_ID"]

# there is a valid "degradation" in the system
DEGRADATION_DATA_ID = ENV["DEGRADATION_DATA_ID"]

body = DatadogAPIClient::V2::PatchDegradationRequest.new({
  data: DatadogAPIClient::V2::PatchDegradationRequestData.new({
    attributes: DatadogAPIClient::V2::PatchDegradationRequestDataAttributes.new({
      title: "Elevated API Latency in US1",
    }),
    id: DEGRADATION_DATA_ID,
    type: DatadogAPIClient::V2::PatchDegradationRequestDataType::DEGRADATIONS,
  }),
})
p api_instance.update_degradation(STATUS_PAGE_DATA_ID, DEGRADATION_DATA_ID, body)

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
// Update degradation returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_status_pages::StatusPagesAPI;
use datadog_api_client::datadogV2::api_status_pages::UpdateDegradationOptionalParams;
use datadog_api_client::datadogV2::model::PatchDegradationRequest;
use datadog_api_client::datadogV2::model::PatchDegradationRequestData;
use datadog_api_client::datadogV2::model::PatchDegradationRequestDataAttributes;
use datadog_api_client::datadogV2::model::PatchDegradationRequestDataType;

#[tokio::main]
async fn main() {
    // there is a valid "status_page" in the system
    let status_page_data_id = uuid::Uuid::parse_str(&std::env::var("STATUS_PAGE_DATA_ID").unwrap())
        .expect("Invalid UUID");

    // there is a valid "degradation" in the system
    let degradation_data_id = uuid::Uuid::parse_str(&std::env::var("DEGRADATION_DATA_ID").unwrap())
        .expect("Invalid UUID");
    let body = PatchDegradationRequest::new().data(PatchDegradationRequestData::new(
        PatchDegradationRequestDataAttributes::new()
            .title("Elevated API Latency in US1".to_string()),
        degradation_data_id.clone(),
        PatchDegradationRequestDataType::DEGRADATIONS,
    ));
    let configuration = datadog::Configuration::new();
    let api = StatusPagesAPI::with_config(configuration);
    let resp = api
        .update_degradation(
            status_page_data_id.clone(),
            degradation_data_id.clone(),
            body,
            UpdateDegradationOptionalParams::default(),
        )
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

Instructions

First install the library and its dependencies and then save the example to src/main.rs and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
/**
 * Update degradation returns "OK" response
 */

import { client, v2 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
const apiInstance = new v2.StatusPagesApi(configuration);

// there is a valid "status_page" in the system
const STATUS_PAGE_DATA_ID = process.env.STATUS_PAGE_DATA_ID as string;

// there is a valid "degradation" in the system
const DEGRADATION_DATA_ID = process.env.DEGRADATION_DATA_ID as string;

const params: v2.StatusPagesApiUpdateDegradationRequest = {
  body: {
    data: {
      attributes: {
        title: "Elevated API Latency in US1",
      },
      id: DEGRADATION_DATA_ID,
      type: "degradations",
    },
  },
  pageId: STATUS_PAGE_DATA_ID,
  degradationId: DEGRADATION_DATA_ID,
};

apiInstance
  .updateDegradation(params)
  .then((data: v2.Degradation) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

Instructions

First install the library and its dependencies and then save the example to example.ts and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"