Create degradation template
https://api.datadoghq.com/api/v2/statuspages/{page_id}/degradation_templateshttps://api.us3.datadoghq.com/api/v2/statuspages/{page_id}/degradation_templateshttps://api.us5.datadoghq.com/api/v2/statuspages/{page_id}/degradation_templateshttps://api.datadoghq.eu/api/v2/statuspages/{page_id}/degradation_templateshttps://api.ap1.datadoghq.com/api/v2/statuspages/{page_id}/degradation_templateshttps://api.ap2.datadoghq.com/api/v2/statuspages/{page_id}/degradation_templateshttps://api.uk1.datadoghq.com/api/v2/statuspages/{page_id}/degradation_templateshttps://api.ddog-gov.com/api/v2/statuspages/{page_id}/degradation_templateshttps://api.us2.ddog-gov.com/api/v2/statuspages/{page_id}/degradation_templates概要
Creates a new degradation template.
OAuth apps require the status_pages_settings_write authorization scope to access this endpoint.
引数
パスパラメーター
page_id [required]The ID of the status page.
クエリ文字列
includeComma-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 template.
attributesThe attributes for creating a degradation template.
components_affectedThe components affected by a degradation created from this template.
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_outagedegradation_titleThe title used for a degradation created from this template.
name [required]The name of the degradation template.
updatesThe pre-filled updates for a degradation created from this template.
messageThe message of the update.
status [required]The status of the degradation.
investigating, identified, monitoring, resolvedtype [required]Degradation templates resource type.
degradation_templatesdegradation_templates{
"data": {
"attributes": {
"components_affected": [
{
"id": "",
"status": "operational"
}
],
"degradation_title": "string",
"name": "",
"updates": [
{
"message": "string",
"status": "investigating"
}
]
},
"type": "degradation_templates"
}
}応答
Created
Response object for a single degradation template.
dataThe data object for a degradation template.
attributesThe attributes of a degradation template.
components_affectedThe components affected by a degradation created from this template.
id [required]The ID of the component.
nameThe name of the component.
status [required]The status of the component.
operational, degraded, partial_outage, major_outagecreated_atTimestamp of when the degradation template was created.
degradation_titleThe title used for a degradation created from this template.
modified_atTimestamp of when the degradation template was last modified.
nameThe name of the degradation template.
updatesThe pre-filled updates for a degradation created from this template.
messageThe message of the update.
status [required]The status of the degradation.
investigating, identified, monitoring, resolvedidThe ID of the degradation template.
relationshipsThe relationships of a degradation template.
created_by_userThe Datadog user who created the degradation template.
data [required]The data object identifying the Datadog user who created the degradation template.
id [required]The ID of the Datadog user who created the degradation template.
type [required]Users resource type.
usersuserslast_modified_by_userThe Datadog user who last modified the degradation template.
data [required]The data object identifying the Datadog user who last modified the degradation template.
id [required]The ID of the Datadog user who last modified the degradation template.
type [required]Users resource type.
usersusersstatus_pageThe status page the degradation template belongs to.
data [required]The data object identifying the status page associated with a degradation template.
id [required]The ID of the status page.
type [required]Status pages resource type.
status_pagesstatus_pagestype [required]Degradation templates resource type.
degradation_templatesdegradation_templatesincludedThe included related resources of a degradation template. 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": "",
"name": "string",
"status": "operational"
}
],
"created_at": "2019-09-19T10:00:00.000Z",
"degradation_title": "string",
"modified_at": "2019-09-19T10:00:00.000Z",
"name": "string",
"updates": [
{
"message": "string",
"status": "investigating"
}
]
},
"id": "string",
"relationships": {
"created_by_user": {
"data": {
"id": "",
"type": "users"
}
},
"last_modified_by_user": {
"data": {
"id": "",
"type": "users"
}
},
"status_page": {
"data": {
"id": "",
"type": "status_pages"
}
}
},
"type": "degradation_templates"
},
"included": [
{
"attributes": {
"email": "string",
"handle": "string",
"icon": "string",
"name": "string",
"uuid": "string"
},
"id": "string",
"type": "users"
}
]
}Too many requests
API error response.
errors [required]A list of errors.
{
"errors": [
"Bad Request"
]
}コード例
# Path parameters
export page_id="CHANGE_ME"
# 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}/degradation_templates" \
-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": "degraded"
}
],
"degradation_title": "Elevated API Latency",
"name": "Elevated API Latency",
"updates": [
{
"message": "We are investigating the issue.",
"status": "investigating"
}
]
},
"type": "degradation_templates"
}
}
EOF# Path parameters
export page_id="CHANGE_ME"
# 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}/degradation_templates" \
-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": "degraded"
}
],
"degradation_title": "Elevated API Latency",
"name": "Elevated API Latency",
"updates": [
{
"message": "We are investigating the issue.",
"status": "investigating"
}
]
},
"type": "degradation_templates"
}
}
EOF# Path parameters
export page_id="CHANGE_ME"
# 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}/degradation_templates" \
-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": "degraded"
}
],
"degradation_title": "Elevated API Latency",
"name": "Elevated API Latency",
"updates": [
{
"message": "We are investigating the issue.",
"status": "investigating"
}
]
},
"type": "degradation_templates"
}
}
EOF# Path parameters
export page_id="CHANGE_ME"
# 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}/degradation_templates" \
-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": "degraded"
}
],
"degradation_title": "Elevated API Latency",
"name": "Elevated API Latency",
"updates": [
{
"message": "We are investigating the issue.",
"status": "investigating"
}
]
},
"type": "degradation_templates"
}
}
EOF# Path parameters
export page_id="CHANGE_ME"
# 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}/degradation_templates" \
-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": "degraded"
}
],
"degradation_title": "Elevated API Latency",
"name": "Elevated API Latency",
"updates": [
{
"message": "We are investigating the issue.",
"status": "investigating"
}
]
},
"type": "degradation_templates"
}
}
EOF# Path parameters
export page_id="CHANGE_ME"
# 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}/degradation_templates" \
-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": "degraded"
}
],
"degradation_title": "Elevated API Latency",
"name": "Elevated API Latency",
"updates": [
{
"message": "We are investigating the issue.",
"status": "investigating"
}
]
},
"type": "degradation_templates"
}
}
EOF# Path parameters
export page_id="CHANGE_ME"
# 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}/degradation_templates" \
-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": "degraded"
}
],
"degradation_title": "Elevated API Latency",
"name": "Elevated API Latency",
"updates": [
{
"message": "We are investigating the issue.",
"status": "investigating"
}
]
},
"type": "degradation_templates"
}
}
EOF# Path parameters
export page_id="CHANGE_ME"
# 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}/degradation_templates" \
-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": "degraded"
}
],
"degradation_title": "Elevated API Latency",
"name": "Elevated API Latency",
"updates": [
{
"message": "We are investigating the issue.",
"status": "investigating"
}
]
},
"type": "degradation_templates"
}
}
EOF# Path parameters
export page_id="CHANGE_ME"
# 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}/degradation_templates" \
-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": "degraded"
}
],
"degradation_title": "Elevated API Latency",
"name": "Elevated API Latency",
"updates": [
{
"message": "We are investigating the issue.",
"status": "investigating"
}
]
},
"type": "degradation_templates"
}
}
EOF// Create degradation template 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() {
body := datadogV2.CreateDegradationTemplateRequest{
Data: &datadogV2.CreateDegradationTemplateRequestData{
Attributes: &datadogV2.CreateDegradationTemplateRequestDataAttributes{
ComponentsAffected: []datadogV2.CreateDegradationTemplateRequestDataAttributesComponentsAffectedItems{
{
Id: "",
Status: datadogV2.PATCHDEGRADATIONTEMPLATEREQUESTDATAATTRIBUTESCOMPONENTSAFFECTEDITEMSSTATUS_OPERATIONAL,
},
},
Name: "",
Updates: []datadogV2.CreateDegradationTemplateRequestDataAttributesUpdatesItems{
{
Status: datadogV2.CREATEDEGRADATIONREQUESTDATAATTRIBUTESSTATUS_INVESTIGATING,
},
},
},
Type: datadogV2.PATCHDEGRADATIONTEMPLATEREQUESTDATATYPE_DEGRADATION_TEMPLATES,
},
}
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.CreateDegradationTemplate(ctx, uuid.MustParse("9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"), body, *datadogV2.NewCreateDegradationTemplateOptionalParameters())
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `StatusPagesApi.CreateDegradationTemplate`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `StatusPagesApi.CreateDegradationTemplate`:\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 template 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.CreateDegradationRequestDataAttributesStatus;
import com.datadog.api.client.v2.model.CreateDegradationTemplateRequest;
import com.datadog.api.client.v2.model.CreateDegradationTemplateRequestData;
import com.datadog.api.client.v2.model.CreateDegradationTemplateRequestDataAttributes;
import com.datadog.api.client.v2.model.CreateDegradationTemplateRequestDataAttributesComponentsAffectedItems;
import com.datadog.api.client.v2.model.CreateDegradationTemplateRequestDataAttributesUpdatesItems;
import com.datadog.api.client.v2.model.DegradationTemplate;
import com.datadog.api.client.v2.model.PatchDegradationTemplateRequestDataAttributesComponentsAffectedItemsStatus;
import com.datadog.api.client.v2.model.PatchDegradationTemplateRequestDataType;
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);
CreateDegradationTemplateRequest body =
new CreateDegradationTemplateRequest()
.data(
new CreateDegradationTemplateRequestData()
.attributes(
new CreateDegradationTemplateRequestDataAttributes()
.componentsAffected(
Collections.singletonList(
new CreateDegradationTemplateRequestDataAttributesComponentsAffectedItems()
.id("")
.status(
PatchDegradationTemplateRequestDataAttributesComponentsAffectedItemsStatus
.OPERATIONAL)))
.name("")
.updates(
Collections.singletonList(
new CreateDegradationTemplateRequestDataAttributesUpdatesItems()
.status(
CreateDegradationRequestDataAttributesStatus
.INVESTIGATING))))
.type(PatchDegradationTemplateRequestDataType.DEGRADATION_TEMPLATES));
try {
DegradationTemplate result =
apiInstance.createDegradationTemplate(
UUID.fromString("9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"), body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling StatusPagesApi#createDegradationTemplate");
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 template 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_data_attributes_status import (
CreateDegradationRequestDataAttributesStatus,
)
from datadog_api_client.v2.model.create_degradation_template_request import CreateDegradationTemplateRequest
from datadog_api_client.v2.model.create_degradation_template_request_data import CreateDegradationTemplateRequestData
from datadog_api_client.v2.model.create_degradation_template_request_data_attributes import (
CreateDegradationTemplateRequestDataAttributes,
)
from datadog_api_client.v2.model.create_degradation_template_request_data_attributes_components_affected_items import (
CreateDegradationTemplateRequestDataAttributesComponentsAffectedItems,
)
from datadog_api_client.v2.model.create_degradation_template_request_data_attributes_updates_items import (
CreateDegradationTemplateRequestDataAttributesUpdatesItems,
)
from datadog_api_client.v2.model.patch_degradation_template_request_data_attributes_components_affected_items_status import (
PatchDegradationTemplateRequestDataAttributesComponentsAffectedItemsStatus,
)
from datadog_api_client.v2.model.patch_degradation_template_request_data_type import (
PatchDegradationTemplateRequestDataType,
)
from uuid import UUID
body = CreateDegradationTemplateRequest(
data=CreateDegradationTemplateRequestData(
attributes=CreateDegradationTemplateRequestDataAttributes(
components_affected=[
CreateDegradationTemplateRequestDataAttributesComponentsAffectedItems(
id="",
status=PatchDegradationTemplateRequestDataAttributesComponentsAffectedItemsStatus.OPERATIONAL,
),
],
name="",
updates=[
CreateDegradationTemplateRequestDataAttributesUpdatesItems(
status=CreateDegradationRequestDataAttributesStatus.INVESTIGATING,
),
],
),
type=PatchDegradationTemplateRequestDataType.DEGRADATION_TEMPLATES,
),
)
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_template(page_id=UUID("9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"), 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 template 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
body = DatadogAPIClient::V2::CreateDegradationTemplateRequest.new({
data: DatadogAPIClient::V2::CreateDegradationTemplateRequestData.new({
attributes: DatadogAPIClient::V2::CreateDegradationTemplateRequestDataAttributes.new({
components_affected: [
DatadogAPIClient::V2::CreateDegradationTemplateRequestDataAttributesComponentsAffectedItems.new({
id: "",
status: DatadogAPIClient::V2::PatchDegradationTemplateRequestDataAttributesComponentsAffectedItemsStatus::OPERATIONAL,
}),
],
name: "",
updates: [
DatadogAPIClient::V2::CreateDegradationTemplateRequestDataAttributesUpdatesItems.new({
status: DatadogAPIClient::V2::CreateDegradationRequestDataAttributesStatus::INVESTIGATING,
}),
],
}),
type: DatadogAPIClient::V2::PatchDegradationTemplateRequestDataType::DEGRADATION_TEMPLATES,
}),
})
p api_instance.create_degradation_template("9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d", 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 template returns "Created" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_status_pages::CreateDegradationTemplateOptionalParams;
use datadog_api_client::datadogV2::api_status_pages::StatusPagesAPI;
use datadog_api_client::datadogV2::model::CreateDegradationRequestDataAttributesStatus;
use datadog_api_client::datadogV2::model::CreateDegradationTemplateRequest;
use datadog_api_client::datadogV2::model::CreateDegradationTemplateRequestData;
use datadog_api_client::datadogV2::model::CreateDegradationTemplateRequestDataAttributes;
use datadog_api_client::datadogV2::model::CreateDegradationTemplateRequestDataAttributesComponentsAffectedItems;
use datadog_api_client::datadogV2::model::CreateDegradationTemplateRequestDataAttributesUpdatesItems;
use datadog_api_client::datadogV2::model::PatchDegradationTemplateRequestDataAttributesComponentsAffectedItemsStatus;
use datadog_api_client::datadogV2::model::PatchDegradationTemplateRequestDataType;
use uuid::Uuid;
#[tokio::main]
async fn main() {
let body =
CreateDegradationTemplateRequest
::new().data(
CreateDegradationTemplateRequestData::new(
PatchDegradationTemplateRequestDataType::DEGRADATION_TEMPLATES,
).attributes(
CreateDegradationTemplateRequestDataAttributes::new("".to_string())
.components_affected(
vec![
CreateDegradationTemplateRequestDataAttributesComponentsAffectedItems::new(
"".to_string(),
PatchDegradationTemplateRequestDataAttributesComponentsAffectedItemsStatus
::OPERATIONAL,
)
],
)
.updates(
vec![
CreateDegradationTemplateRequestDataAttributesUpdatesItems::new(
CreateDegradationRequestDataAttributesStatus::INVESTIGATING,
)
],
),
),
);
let configuration = datadog::Configuration::new();
let api = StatusPagesAPI::with_config(configuration);
let resp = api
.create_degradation_template(
Uuid::parse_str("00000000-0000-0000-0000-000000000000").expect("invalid UUID"),
body,
CreateDegradationTemplateOptionalParams::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 template 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);
const params: v2.StatusPagesApiCreateDegradationTemplateRequest = {
body: {
data: {
attributes: {
componentsAffected: [
{
id: "",
status: "operational",
},
],
name: "",
updates: [
{
status: "investigating",
},
],
},
type: "degradation_templates",
},
},
pageId: "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
};
apiInstance
.createDegradationTemplate(params)
.then((data: v2.DegradationTemplate) => {
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"