Skip to content

Add Incident Notification Rules Public Spec #3123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 10, 2025
Merged

Add Incident Notification Rules Public Spec #3123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
556 changes: 555 additions & 1 deletion .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

78 changes: 78 additions & 0 deletions examples/v2/incidents/CreateIncidentNotificationRule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
// Create an incident notification rule returns "Created" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.IncidentsApi;
import com.datadog.api.client.v2.model.CreateIncidentNotificationRuleRequest;
import com.datadog.api.client.v2.model.IncidentNotificationRule;
import com.datadog.api.client.v2.model.IncidentNotificationRuleConditionsItems;
import com.datadog.api.client.v2.model.IncidentNotificationRuleCreateAttributes;
import com.datadog.api.client.v2.model.IncidentNotificationRuleCreateAttributesVisibility;
import com.datadog.api.client.v2.model.IncidentNotificationRuleCreateData;
import com.datadog.api.client.v2.model.IncidentNotificationRuleCreateDataRelationships;
import com.datadog.api.client.v2.model.IncidentNotificationRuleType;
import com.datadog.api.client.v2.model.IncidentNotificationTemplateType;
import com.datadog.api.client.v2.model.IncidentTypeType;
import com.datadog.api.client.v2.model.RelationshipToIncidentNotificationTemplate;
import com.datadog.api.client.v2.model.RelationshipToIncidentNotificationTemplateData;
import com.datadog.api.client.v2.model.RelationshipToIncidentType;
import com.datadog.api.client.v2.model.RelationshipToIncidentTypeData;
import java.util.Arrays;
import java.util.Collections;
import java.util.UUID;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.createIncidentNotificationRule", true);
IncidentsApi apiInstance = new IncidentsApi(defaultClient);

CreateIncidentNotificationRuleRequest body =
new CreateIncidentNotificationRuleRequest()
.data(
new IncidentNotificationRuleCreateData()
.attributes(
new IncidentNotificationRuleCreateAttributes()
.conditions(
Collections.singletonList(
new IncidentNotificationRuleConditionsItems()
.field("severity")
.values(Arrays.asList("SEV-1", "SEV-2"))))
.enabled(true)
.handles(Arrays.asList("@team-email@company.com", "@slack-channel"))
.renotifyOn(Arrays.asList("status", "severity"))
.trigger("incident_created_trigger")
.visibility(
IncidentNotificationRuleCreateAttributesVisibility.ORGANIZATION))
.relationships(
new IncidentNotificationRuleCreateDataRelationships()
.incidentType(
new RelationshipToIncidentType()
.data(
new RelationshipToIncidentTypeData()
.id("00000000-0000-0000-0000-000000000000")
.type(IncidentTypeType.INCIDENT_TYPES)))
.notificationTemplate(
new RelationshipToIncidentNotificationTemplate()
.data(
new RelationshipToIncidentNotificationTemplateData()
.id(
UUID.fromString(
"00000000-0000-0000-0000-000000000001"))
.type(
IncidentNotificationTemplateType
.NOTIFICATION_TEMPLATES))))
.type(IncidentNotificationRuleType.INCIDENT_NOTIFICATION_RULES));

try {
IncidentNotificationRule result = apiInstance.createIncidentNotificationRule(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IncidentsApi#createIncidentNotificationRule");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
66 changes: 66 additions & 0 deletions examples/v2/incidents/CreateIncidentNotificationRule_3029800608.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
// Create incident notification rule returns "Created" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.IncidentsApi;
import com.datadog.api.client.v2.model.CreateIncidentNotificationRuleRequest;
import com.datadog.api.client.v2.model.IncidentNotificationRule;
import com.datadog.api.client.v2.model.IncidentNotificationRuleConditionsItems;
import com.datadog.api.client.v2.model.IncidentNotificationRuleCreateAttributes;
import com.datadog.api.client.v2.model.IncidentNotificationRuleCreateAttributesVisibility;
import com.datadog.api.client.v2.model.IncidentNotificationRuleCreateData;
import com.datadog.api.client.v2.model.IncidentNotificationRuleCreateDataRelationships;
import com.datadog.api.client.v2.model.IncidentNotificationRuleType;
import com.datadog.api.client.v2.model.IncidentTypeType;
import com.datadog.api.client.v2.model.RelationshipToIncidentType;
import com.datadog.api.client.v2.model.RelationshipToIncidentTypeData;
import java.util.Arrays;
import java.util.Collections;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.createIncidentNotificationRule", true);
IncidentsApi apiInstance = new IncidentsApi(defaultClient);

// there is a valid "incident_type" in the system
String INCIDENT_TYPE_DATA_ID = System.getenv("INCIDENT_TYPE_DATA_ID");

CreateIncidentNotificationRuleRequest body =
new CreateIncidentNotificationRuleRequest()
.data(
new IncidentNotificationRuleCreateData()
.attributes(
new IncidentNotificationRuleCreateAttributes()
.conditions(
Collections.singletonList(
new IncidentNotificationRuleConditionsItems()
.field("severity")
.values(Arrays.asList("SEV-1", "SEV-2"))))
.handles(Collections.singletonList("@test-email@company.com"))
.visibility(
IncidentNotificationRuleCreateAttributesVisibility.ORGANIZATION)
.trigger("incident_created_trigger")
.enabled(true))
.relationships(
new IncidentNotificationRuleCreateDataRelationships()
.incidentType(
new RelationshipToIncidentType()
.data(
new RelationshipToIncidentTypeData()
.id(INCIDENT_TYPE_DATA_ID)
.type(IncidentTypeType.INCIDENT_TYPES))))
.type(IncidentNotificationRuleType.INCIDENT_NOTIFICATION_RULES));

try {
IncidentNotificationRule result = apiInstance.createIncidentNotificationRule(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IncidentsApi#createIncidentNotificationRule");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
25 changes: 25 additions & 0 deletions examples/v2/incidents/DeleteIncidentNotificationRule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// Delete an incident notification rule returns "No Content" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.IncidentsApi;
import java.util.UUID;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.deleteIncidentNotificationRule", true);
IncidentsApi apiInstance = new IncidentsApi(defaultClient);

try {
apiInstance.deleteIncidentNotificationRule(
UUID.fromString("00000000-0000-0000-0000-000000000001"));
} catch (ApiException e) {
System.err.println("Exception when calling IncidentsApi#deleteIncidentNotificationRule");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
32 changes: 32 additions & 0 deletions examples/v2/incidents/DeleteIncidentNotificationRule_4148107167.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
// Delete incident notification rule returns "No Content" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.IncidentsApi;
import java.util.UUID;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.deleteIncidentNotificationRule", true);
IncidentsApi apiInstance = new IncidentsApi(defaultClient);

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

try {
apiInstance.deleteIncidentNotificationRule(NOTIFICATION_RULE_DATA_ID);
} catch (ApiException e) {
System.err.println("Exception when calling IncidentsApi#deleteIncidentNotificationRule");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
28 changes: 28 additions & 0 deletions examples/v2/incidents/GetIncidentNotificationRule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
// Get an incident notification rule returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.IncidentsApi;
import com.datadog.api.client.v2.model.IncidentNotificationRule;
import java.util.UUID;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.getIncidentNotificationRule", true);
IncidentsApi apiInstance = new IncidentsApi(defaultClient);

try {
IncidentNotificationRule result =
apiInstance.getIncidentNotificationRule(
UUID.fromString("00000000-0000-0000-0000-000000000001"));
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IncidentsApi#getIncidentNotificationRule");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
35 changes: 35 additions & 0 deletions examples/v2/incidents/GetIncidentNotificationRule_67441486.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
// Get incident notification rule returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.IncidentsApi;
import com.datadog.api.client.v2.model.IncidentNotificationRule;
import java.util.UUID;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.getIncidentNotificationRule", true);
IncidentsApi apiInstance = new IncidentsApi(defaultClient);

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

try {
IncidentNotificationRule result =
apiInstance.getIncidentNotificationRule(NOTIFICATION_RULE_DATA_ID);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IncidentsApi#getIncidentNotificationRule");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
25 changes: 25 additions & 0 deletions examples/v2/incidents/ListIncidentNotificationRules.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// List incident notification rules returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.IncidentsApi;
import com.datadog.api.client.v2.model.IncidentNotificationRuleArray;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.listIncidentNotificationRules", true);
IncidentsApi apiInstance = new IncidentsApi(defaultClient);

try {
IncidentNotificationRuleArray result = apiInstance.listIncidentNotificationRules();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IncidentsApi#listIncidentNotificationRules");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
81 changes: 81 additions & 0 deletions examples/v2/incidents/UpdateIncidentNotificationRule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
// Update an incident notification rule returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.IncidentsApi;
import com.datadog.api.client.v2.model.IncidentNotificationRule;
import com.datadog.api.client.v2.model.IncidentNotificationRuleConditionsItems;
import com.datadog.api.client.v2.model.IncidentNotificationRuleCreateAttributes;
import com.datadog.api.client.v2.model.IncidentNotificationRuleCreateAttributesVisibility;
import com.datadog.api.client.v2.model.IncidentNotificationRuleCreateDataRelationships;
import com.datadog.api.client.v2.model.IncidentNotificationRuleType;
import com.datadog.api.client.v2.model.IncidentNotificationRuleUpdateData;
import com.datadog.api.client.v2.model.IncidentNotificationTemplateType;
import com.datadog.api.client.v2.model.IncidentTypeType;
import com.datadog.api.client.v2.model.PutIncidentNotificationRuleRequest;
import com.datadog.api.client.v2.model.RelationshipToIncidentNotificationTemplate;
import com.datadog.api.client.v2.model.RelationshipToIncidentNotificationTemplateData;
import com.datadog.api.client.v2.model.RelationshipToIncidentType;
import com.datadog.api.client.v2.model.RelationshipToIncidentTypeData;
import java.util.Arrays;
import java.util.Collections;
import java.util.UUID;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.updateIncidentNotificationRule", true);
IncidentsApi apiInstance = new IncidentsApi(defaultClient);

PutIncidentNotificationRuleRequest body =
new PutIncidentNotificationRuleRequest()
.data(
new IncidentNotificationRuleUpdateData()
.attributes(
new IncidentNotificationRuleCreateAttributes()
.conditions(
Collections.singletonList(
new IncidentNotificationRuleConditionsItems()
.field("severity")
.values(Arrays.asList("SEV-1", "SEV-2"))))
.enabled(true)
.handles(Arrays.asList("@team-email@company.com", "@slack-channel"))
.renotifyOn(Arrays.asList("status", "severity"))
.trigger("incident_created_trigger")
.visibility(
IncidentNotificationRuleCreateAttributesVisibility.ORGANIZATION))
.id(UUID.fromString("00000000-0000-0000-0000-000000000001"))
.relationships(
new IncidentNotificationRuleCreateDataRelationships()
.incidentType(
new RelationshipToIncidentType()
.data(
new RelationshipToIncidentTypeData()
.id("00000000-0000-0000-0000-000000000000")
.type(IncidentTypeType.INCIDENT_TYPES)))
.notificationTemplate(
new RelationshipToIncidentNotificationTemplate()
.data(
new RelationshipToIncidentNotificationTemplateData()
.id(
UUID.fromString(
"00000000-0000-0000-0000-000000000001"))
.type(
IncidentNotificationTemplateType
.NOTIFICATION_TEMPLATES))))
.type(IncidentNotificationRuleType.INCIDENT_NOTIFICATION_RULES));

try {
IncidentNotificationRule result =
apiInstance.updateIncidentNotificationRule(
UUID.fromString("00000000-0000-0000-0000-000000000001"), body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IncidentsApi#updateIncidentNotificationRule");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Loading