Create degradation
https://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}/degradationshttps://api.datadoghq.eu/api/v2/statuspages/{page_id}/degradationshttps://api.ap1.datadoghq.com/api/v2/statuspages/{page_id}/degradationshttps://api.ap2.datadoghq.com/api/v2/statuspages/{page_id}/degradationshttps://api.uk1.datadoghq.com/api/v2/statuspages/{page_id}/degradationshttps://api.ddog-gov.com/api/v2/statuspages/{page_id}/degradationshttps://api.us2.ddog-gov.com/api/v2/statuspages/{page_id}/degradations概要
Creates a new degradation.
OAuth apps require the status_pages_incident_write authorization scope to access this endpoint.
引数
パスパラメーター
page_id [required]The ID of the status page.
クエリ文字列
notify_subscribersWhether to notify page subscribers of the degradation.
trueincludeComma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page.
リクエスト
Body Data (required)
dataThe data object for creating a degradation.
attributes [required]The supported attributes for creating a degradation.
components_affected [required]The components affected by the degradation.
id [required]The ID of the component. Must be a component of type component.
status [required]The status of the component.
operational, degraded, partial_outage, major_outage, maintenancedescriptionThe description of the degradation.
status [required]The status of the degradation.
investigating, identified, monitoring, resolvedtitle [required]The title of the degradation.
relationshipsThe supported relationships for creating a degradation.
templateThe template used to create the degradation.
data [required]The data object identifying the template used to create the degradation.
id [required]The ID of the degradation template.
type [required]Degradation templates resource type.
degradation_templatesdegradation_templatestype [required]Degradations resource type.
degradationsdegradationsmetaThe supported metadata for creating a degradation.
idempotency_keyA unique key used to ensure idempotent requests.
{
"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"
}
}応答
Created
Response object for a single degradation.
dataThe data object for a degradation.
attributesThe attributes of a degradation.
components_affectedComponents affected by the degradation.
id [required]The ID of the component.
nameThe name of the component.
status [required]The status of the component.
operational, degraded, partial_outage, major_outage, maintenancecreated_atTimestamp of when the degradation was created.
descriptionDescription of the degradation.
is_backfilledWhether the degradation was backfilled.
modified_atTimestamp of when the degradation was last modified.
sourceThe source of the degradation.
created_at [required]Timestamp of when the source was created.
source_id [required]The ID of the source.
type [required]The type of the source.
incidentstatusThe status of the degradation.
investigating, identified, monitoring, resolvedtitleTitle of the degradation.
updatesPast updates made to the degradation.
components_affectedThe components affected at the time of the update.
id [required]Identifier of the component affected at the time of the update.
nameThe name of the component affected at the time of the update.
status [required]The status of the component affected at the time of the update.
operational, degraded, partial_outage, major_outage, maintenancecreated_atTimestamp of when the update was created.
deleted_atThe date and time the resource was deleted.
deleted_by_user_uuidUUID of the user who deleted the resource.
descriptionDescription of the update.
idIdentifier of the update.
last_modified_by_user_uuidUUID of the user who last modified the resource.
modified_atTimestamp of when the update was last modified.
started_atTimestamp of when the update started.
statusThe status of the degradation.
investigating, identified, monitoring, resolvedidThe ID of the degradation.
relationshipsThe relationships of a degradation.
created_by_userThe Datadog user who created the degradation.
data [required]The data object identifying the Datadog user who created the degradation.
id [required]The ID of the Datadog user who created the degradation.
type [required]Users resource type.
usersuserslast_modified_by_userThe Datadog user who last modified the degradation.
data [required]The data object identifying the Datadog user who last modified the degradation.
id [required]The ID of the Datadog user who last modified the degradation.
type [required]Users resource type.
usersusersstatus_pageThe status page the degradation belongs to.
data [required]The data object identifying the status page the degradation belongs to.
id [required]The ID of the status page.
type [required]Status pages resource type.
status_pagesstatus_pagestemplateThe template the degradation was created from.
data [required]The data object identifying the template the degradation was created from.
id [required]The ID of the degradation template.
type [required]Degradation templates resource type.
degradation_templatesdegradation_templatestype [required]Degradations resource type.
degradationsdegradationsincludedThe included related resources of a degradation. Client must explicitly request these resources by name in the include query parameter.
<type=users>The included Datadog user resource.
attributesAttributes of the Datadog user.
emailThe email of the Datadog user.
handleThe handle of the Datadog user.
iconThe icon of the Datadog user.
nameThe name of the Datadog user.
uuidThe UUID of the Datadog user.
idThe ID of the Datadog user.
type [required]Users resource type.
usersusers<type=status_pages>The included status page resource.
attributesThe attributes of a status page.
company_logoThe base64-encoded image data displayed in the company logo.
componentsComponents displayed on the status page.
componentsIf the component is of type group, the components within the group.
idThe ID of the grouped component.
nameThe name of the grouped component.
positionThe zero-indexed position of the grouped component. Relative to the other components in the group.
statusThe status of the component.
operational, degraded, partial_outage, major_outage, maintenancetypeThe type of the component.
componentidThe ID of the component.
nameThe name of the component.
positionThe zero-indexed position of the component.
statusThe status of the component.
operational, degraded, partial_outage, major_outage, maintenancetypeThe type of the component.
component, groupcreated_atTimestamp of when the status page was created.
custom_domainIf configured, the url that the status page is accessible at.
custom_domain_enabledWhether the custom domain is configured.
domain_prefixThe subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_imageBase64-encoded image data included in email notifications sent to status page subscribers.
enabledWhether the status page is enabled.
faviconBase64-encoded image data displayed in the browser tab.
modified_atTimestamp of when the status page was last modified.
nameThe name of the status page.
page_urlThe url that the status page is accessible at.
slack_app_iconThe Slack app icon URL for the status page.
slack_subscriptions_enabledWhether Slack subscriptions are enabled for the status page.
subscriptions_enabledWhether users can subscribe to the status page.
typeThe type of the status page controlling how the status page is accessed.
public, internalvisualization_typeThe visualization type of the status page.
bars_and_uptime_percentage, bars_only, component_name_onlyidThe ID of the status page.
relationshipsThe relationships of a status page.
created_by_userThe Datadog user who created the status page.
data [required]The data object identifying the Datadog user who created the status page.
id [required]The ID of the Datadog user who created the status page.
type [required]Users resource type.
usersuserslast_modified_by_userThe Datadog user who last modified the status page.
data [required]The data object identifying the Datadog user who last modified the status page.
id [required]The ID of the Datadog user who last modified the status page.
type [required]Users resource type.
usersuserstype [required]Status pages resource type.
status_pagesstatus_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.
errors [required]A list of errors.
{
"errors": [
"Bad Request"
]
}コード例
# Path parameters
export page_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 POST "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/degradations" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-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# Path parameters
export page_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 POST "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/degradations" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-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# Path parameters
export page_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 POST "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/degradations" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-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# Path parameters
export page_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 POST "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/degradations" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-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# Path parameters
export page_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 POST "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/degradations" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-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# Path parameters
export page_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 POST "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/degradations" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-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# Path parameters
export page_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 POST "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/degradations" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-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# Path parameters
export page_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 POST "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/degradations" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-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# Path parameters
export page_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 POST "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/degradations" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-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// Create degradation returns "Created" 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
StatusPageDataAttributesComponents0Components0ID := uuid.MustParse(os.Getenv("STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID"))
StatusPageDataID := uuid.MustParse(os.Getenv("STATUS_PAGE_DATA_ID"))
body := datadogV2.CreateDegradationRequest{
Data: &datadogV2.CreateDegradationRequestData{
Attributes: datadogV2.CreateDegradationRequestDataAttributes{
ComponentsAffected: []datadogV2.CreateDegradationRequestDataAttributesComponentsAffectedItems{
{
Id: StatusPageDataAttributesComponents0Components0ID,
Status: datadogV2.STATUSPAGESCOMPONENTDATAATTRIBUTESSTATUS_MAJOR_OUTAGE,
},
},
Description: datadog.PtrString("Our API is experiencing elevated latency. We are investigating the issue."),
Status: datadogV2.CREATEDEGRADATIONREQUESTDATAATTRIBUTESSTATUS_INVESTIGATING,
Title: "Elevated API Latency",
},
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.CreateDegradation(ctx, StatusPageDataID, body, *datadogV2.NewCreateDegradationOptionalParameters())
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `StatusPagesApi.CreateDegradation`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `StatusPagesApi.CreateDegradation`:\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"// Create degradation returns "Created" 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.CreateDegradationRequest;
import com.datadog.api.client.v2.model.CreateDegradationRequestData;
import com.datadog.api.client.v2.model.CreateDegradationRequestDataAttributes;
import com.datadog.api.client.v2.model.CreateDegradationRequestDataAttributesComponentsAffectedItems;
import com.datadog.api.client.v2.model.CreateDegradationRequestDataAttributesStatus;
import com.datadog.api.client.v2.model.Degradation;
import com.datadog.api.client.v2.model.PatchDegradationRequestDataType;
import com.datadog.api.client.v2.model.StatusPagesComponentDataAttributesStatus;
import java.util.Collections;
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_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID = null;
try {
STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID =
UUID.fromString(
System.getenv("STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID"));
} catch (IllegalArgumentException e) {
System.err.println("Error parsing UUID: " + e.getMessage());
}
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());
}
CreateDegradationRequest body =
new CreateDegradationRequest()
.data(
new CreateDegradationRequestData()
.attributes(
new CreateDegradationRequestDataAttributes()
.componentsAffected(
Collections.singletonList(
new CreateDegradationRequestDataAttributesComponentsAffectedItems()
.id(
STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID)
.status(
StatusPagesComponentDataAttributesStatus.MAJOR_OUTAGE)))
.description(
"Our API is experiencing elevated latency. We are investigating the"
+ " issue.")
.status(CreateDegradationRequestDataAttributesStatus.INVESTIGATING)
.title("Elevated API Latency"))
.type(PatchDegradationRequestDataType.DEGRADATIONS));
try {
Degradation result = apiInstance.createDegradation(STATUS_PAGE_DATA_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling StatusPagesApi#createDegradation");
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""""
Create degradation returns "Created" 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.create_degradation_request import CreateDegradationRequest
from datadog_api_client.v2.model.create_degradation_request_data import CreateDegradationRequestData
from datadog_api_client.v2.model.create_degradation_request_data_attributes import (
CreateDegradationRequestDataAttributes,
)
from datadog_api_client.v2.model.create_degradation_request_data_attributes_components_affected_items import (
CreateDegradationRequestDataAttributesComponentsAffectedItems,
)
from datadog_api_client.v2.model.create_degradation_request_data_attributes_status import (
CreateDegradationRequestDataAttributesStatus,
)
from datadog_api_client.v2.model.patch_degradation_request_data_type import PatchDegradationRequestDataType
from datadog_api_client.v2.model.status_pages_component_data_attributes_status import (
StatusPagesComponentDataAttributesStatus,
)
# there is a valid "status_page" in the system
STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID = environ[
"STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID"
]
STATUS_PAGE_DATA_ID = environ["STATUS_PAGE_DATA_ID"]
body = CreateDegradationRequest(
data=CreateDegradationRequestData(
attributes=CreateDegradationRequestDataAttributes(
components_affected=[
CreateDegradationRequestDataAttributesComponentsAffectedItems(
id=STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID,
status=StatusPagesComponentDataAttributesStatus.MAJOR_OUTAGE,
),
],
description="Our API is experiencing elevated latency. We are investigating the issue.",
status=CreateDegradationRequestDataAttributesStatus.INVESTIGATING,
title="Elevated API Latency",
),
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.create_degradation(page_id=STATUS_PAGE_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"# Create degradation returns "Created" 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_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID = ENV["STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID"]
STATUS_PAGE_DATA_ID = ENV["STATUS_PAGE_DATA_ID"]
body = DatadogAPIClient::V2::CreateDegradationRequest.new({
data: DatadogAPIClient::V2::CreateDegradationRequestData.new({
attributes: DatadogAPIClient::V2::CreateDegradationRequestDataAttributes.new({
components_affected: [
DatadogAPIClient::V2::CreateDegradationRequestDataAttributesComponentsAffectedItems.new({
id: STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID,
status: DatadogAPIClient::V2::StatusPagesComponentDataAttributesStatus::MAJOR_OUTAGE,
}),
],
description: "Our API is experiencing elevated latency. We are investigating the issue.",
status: DatadogAPIClient::V2::CreateDegradationRequestDataAttributesStatus::INVESTIGATING,
title: "Elevated API Latency",
}),
type: DatadogAPIClient::V2::PatchDegradationRequestDataType::DEGRADATIONS,
}),
})
p api_instance.create_degradation(STATUS_PAGE_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"// Create degradation returns "Created" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_status_pages::CreateDegradationOptionalParams;
use datadog_api_client::datadogV2::api_status_pages::StatusPagesAPI;
use datadog_api_client::datadogV2::model::CreateDegradationRequest;
use datadog_api_client::datadogV2::model::CreateDegradationRequestData;
use datadog_api_client::datadogV2::model::CreateDegradationRequestDataAttributes;
use datadog_api_client::datadogV2::model::CreateDegradationRequestDataAttributesComponentsAffectedItems;
use datadog_api_client::datadogV2::model::CreateDegradationRequestDataAttributesStatus;
use datadog_api_client::datadogV2::model::PatchDegradationRequestDataType;
use datadog_api_client::datadogV2::model::StatusPagesComponentDataAttributesStatus;
#[tokio::main]
async fn main() {
// there is a valid "status_page" in the system
let status_page_data_attributes_components_0_components_0_id = uuid::Uuid::parse_str(
&std::env::var("STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID").unwrap(),
)
.expect("Invalid UUID");
let status_page_data_id = uuid::Uuid::parse_str(&std::env::var("STATUS_PAGE_DATA_ID").unwrap())
.expect("Invalid UUID");
let body = CreateDegradationRequest::new().data(CreateDegradationRequestData::new(
CreateDegradationRequestDataAttributes::new(
vec![
CreateDegradationRequestDataAttributesComponentsAffectedItems::new(
status_page_data_attributes_components_0_components_0_id.clone(),
StatusPagesComponentDataAttributesStatus::MAJOR_OUTAGE,
),
],
CreateDegradationRequestDataAttributesStatus::INVESTIGATING,
"Elevated API Latency".to_string(),
)
.description(
"Our API is experiencing elevated latency. We are investigating the issue.".to_string(),
),
PatchDegradationRequestDataType::DEGRADATIONS,
));
let configuration = datadog::Configuration::new();
let api = StatusPagesAPI::with_config(configuration);
let resp = api
.create_degradation(
status_page_data_id.clone(),
body,
CreateDegradationOptionalParams::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/**
* Create degradation returns "Created" 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_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID = process.env
.STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID as string;
const STATUS_PAGE_DATA_ID = process.env.STATUS_PAGE_DATA_ID as string;
const params: v2.StatusPagesApiCreateDegradationRequest = {
body: {
data: {
attributes: {
componentsAffected: [
{
id: STATUS_PAGE_DATA_ATTRIBUTES_COMPONENTS_0_COMPONENTS_0_ID,
status: "major_outage",
},
],
description:
"Our API is experiencing elevated latency. We are investigating the issue.",
status: "investigating",
title: "Elevated API Latency",
},
type: "degradations",
},
},
pageId: STATUS_PAGE_DATA_ID,
};
apiInstance
.createDegradation(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"