Update degradation
PATCH
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}https://api.datadoghq.eu/api/v2/statuspages/{page_id}/degradations/{degradation_id}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.uk1.datadoghq.com/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}Descripción general
Updates an existing degradation's attributes.
OAuth apps require the status_pages_incident_write authorization scope to access this endpoint.
Argumentos
Parámetros de ruta
Nombre
Type
Descripción
page_id [required]string
The ID of the status page.
degradation_id [required]string
The ID of the degradation.
Cadenas de consulta
Nombre
Type
Descripción
notify_subscribersboolean
Whether to notify page subscribers of the degradation.
trueincludestring
Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page.
Solicitud
Body Data (required)
Campo
Type
Descripción
dataobject
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.
status [required]enum
The status of the component.
Allowed enum values:
operational, degraded, partial_outage, major_outage, maintenancedescriptionstring
The description of the degradation.
statusenum
The status of the degradation.
Allowed enum values:
investigating, identified, monitoring, resolvedtitlestring
The title of the degradation.
id [required]uuid
The ID of the degradation.
relationshipsobject
The supported relationships for updating a degradation.
templateobject
The template used to create the degradation.
data [required]object
The data object identifying the template used to create the degradation.
id [required]string
The ID of the degradation template.
type [required]enum
Degradation templates resource type.
degradation_templatesAllowed enum values:
degradation_templatestype [required]enum
Degradations resource type.
degradationsAllowed enum values:
degradationsmetaobject
The supported metadata for updating a degradation.
idempotency_keyuuid
A unique key used to ensure idempotent requests.
{
"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"
}
}Respuesta
OK
Response object for a single degradation.
Campo
Type
Descripción
dataobject
The data object for a degradation.
attributesobject
The attributes of a degradation.
components_affected[object]
Components affected by the degradation.
id [required]uuid
The ID of the component.
namestring
The name of the component.
status [required]enum
The status of the component.
Allowed enum values:
operational, degraded, partial_outage, major_outage, maintenancecreated_atdate-time
Timestamp of when the degradation was created.
descriptionstring
Description of the degradation.
is_backfilledboolean
Whether the degradation was backfilled.
modified_atdate-time
Timestamp of when the degradation was last modified.
sourceobject
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:
incidentstatusenum
The status of the degradation.
Allowed enum values:
investigating, identified, monitoring, resolvedtitlestring
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.
namestring
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, maintenancecreated_atdate-time
Timestamp of when the update was created.
deleted_atstring
The date and time the resource was deleted.
deleted_by_user_uuidstring
UUID of the user who deleted the resource.
descriptionstring
Description of the update.
iduuid
Identifier of the update.
last_modified_by_user_uuidstring
UUID of the user who last modified the resource.
modified_atdate-time
Timestamp of when the update was last modified.
started_atdate-time
Timestamp of when the update started.
statusenum
The status of the degradation.
Allowed enum values:
investigating, identified, monitoring, resolvediduuid
The ID of the degradation.
relationshipsobject
The relationships of a degradation.
created_by_userobject
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.
usersAllowed enum values:
userslast_modified_by_userobject
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.
usersAllowed enum values:
usersstatus_pageobject
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.
status_pagesAllowed enum values:
status_pagestemplateobject
The template the degradation was created from.
data [required]object
The data object identifying the template the degradation was created from.
id [required]string
The ID of the degradation template.
type [required]enum
Degradation templates resource type.
degradation_templatesAllowed enum values:
degradation_templatestype [required]enum
Degradations resource type.
degradationsAllowed enum values:
degradationsincluded[<oneOf>]
The included related resources of a degradation. Client must explicitly request these resources by name in the include query parameter.
<type=users>object
The included Datadog user resource.
attributesobject
Attributes of the Datadog user.
emailstring
The email of the Datadog user.
handlestring
The handle of the Datadog user.
iconstring
The icon of the Datadog user.
namestring
The name of the Datadog user.
uuidstring
The UUID of the Datadog user.
iduuid
The ID of the Datadog user.
type [required]enum
Users resource type.
usersAllowed enum values:
users<type=status_pages>object
The included status page resource.
attributesobject
The attributes of a status page.
company_logostring
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.
iduuid
The ID of the grouped component.
namestring
The name of the grouped component.
positionint64
The zero-indexed position of the grouped component. Relative to the other components in the group.
statusenum
The status of the component.
Allowed enum values:
operational, degraded, partial_outage, major_outage, maintenancetypeenum
The type of the component.
Allowed enum values:
componentiduuid
The ID of the component.
namestring
The name of the component.
positionint64
The zero-indexed position of the component.
statusenum
The status of the component.
Allowed enum values:
operational, degraded, partial_outage, major_outage, maintenancetypeenum
The type of the component.
Allowed enum values:
component, groupcreated_atdate-time
Timestamp of when the status page was created.
custom_domainstring
If configured, the url that the status page is accessible at.
custom_domain_enabledboolean
Whether the custom domain is configured.
domain_prefixstring
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_imagestring
Base64-encoded image data included in email notifications sent to status page subscribers.
enabledboolean
Whether the status page is enabled.
faviconstring
Base64-encoded image data displayed in the browser tab.
modified_atdate-time
Timestamp of when the status page was last modified.
namestring
The name of the status page.
page_urlstring
The url that the status page is accessible at.
slack_app_iconstring
The Slack app icon URL for the status page.
slack_subscriptions_enabledboolean
Whether Slack subscriptions are enabled for the status page.
subscriptions_enabledboolean
Whether users can subscribe to the status page.
typeenum
The type of the status page controlling how the status page is accessed.
Allowed enum values:
public, internalvisualization_typeenum
The visualization type of the status page.
Allowed enum values:
bars_and_uptime_percentage, bars_only, component_name_onlyiduuid
The ID of the status page.
relationshipsobject
The relationships of a status page.
created_by_userobject
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.
usersAllowed enum values:
userslast_modified_by_userobject
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.
usersAllowed enum values:
userstype [required]enum
Status pages resource type.
status_pagesAllowed enum values:
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",
"deleted_at": "string",
"deleted_by_user_uuid": "string",
"description": "string",
"id": "string",
"last_modified_by_user_uuid": "string",
"modified_at": "2019-09-19T10:00:00.000Z",
"started_at": "2019-09-19T10:00:00.000Z",
"status": "investigating"
}
]
},
"id": "string",
"relationships": {
"created_by_user": {
"data": {
"id": "",
"type": "users"
}
},
"last_modified_by_user": {
"data": {
"id": "",
"type": "users"
}
},
"status_page": {
"data": {
"id": "1234abcd-12ab-34cd-56ef-123456abcdef",
"type": "status_pages"
}
},
"template": {
"data": {
"id": "",
"type": "degradation_templates"
}
}
},
"type": "degradations"
},
"included": [
{
"attributes": {
"email": "string",
"handle": "string",
"icon": "string",
"name": "string",
"uuid": "string"
},
"id": "string",
"type": "users"
}
]
}Too many requests
API error response.
Campo
Type
Descripción
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Ejemplo de código
# Path parameters
export page_id="1234abcd-12ab-34cd-56ef-123456abcdef"
export degradation_id="1234abcd-12ab-34cd-56ef-123456abcdef"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/degradations/${degradation_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-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# Path parameters
export page_id="1234abcd-12ab-34cd-56ef-123456abcdef"
export degradation_id="1234abcd-12ab-34cd-56ef-123456abcdef"
# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/degradations/${degradation_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-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# Path parameters
export page_id="1234abcd-12ab-34cd-56ef-123456abcdef"
export degradation_id="1234abcd-12ab-34cd-56ef-123456abcdef"
# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/degradations/${degradation_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-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# Path parameters
export page_id="1234abcd-12ab-34cd-56ef-123456abcdef"
export degradation_id="1234abcd-12ab-34cd-56ef-123456abcdef"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/degradations/${degradation_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-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# Path parameters
export page_id="1234abcd-12ab-34cd-56ef-123456abcdef"
export degradation_id="1234abcd-12ab-34cd-56ef-123456abcdef"
# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/degradations/${degradation_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-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# Path parameters
export page_id="1234abcd-12ab-34cd-56ef-123456abcdef"
export degradation_id="1234abcd-12ab-34cd-56ef-123456abcdef"
# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/degradations/${degradation_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-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# Path parameters
export page_id="1234abcd-12ab-34cd-56ef-123456abcdef"
export degradation_id="1234abcd-12ab-34cd-56ef-123456abcdef"
# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/degradations/${degradation_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-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# Path parameters
export page_id="1234abcd-12ab-34cd-56ef-123456abcdef"
export degradation_id="1234abcd-12ab-34cd-56ef-123456abcdef"
# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/degradations/${degradation_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-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# Path parameters
export page_id="1234abcd-12ab-34cd-56ef-123456abcdef"
export degradation_id="1234abcd-12ab-34cd-56ef-123456abcdef"
# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X PATCH "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/degradations/${degradation_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-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())
ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
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.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" 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();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
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.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" 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()
configuration.access_token = environ["DD_BEARER_TOKEN"]
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.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"# Update degradation returns "OK" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.access_token = ENV["DD_BEARER_TOKEN"]
end
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.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" 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.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us3.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us5.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="datadoghq.eu" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap2.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="uk1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us2.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({
authMethods: {
AuthZ: {
accessToken: process.env.DD_BEARER_TOKEN as string,
},
},
});
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.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"