Skip to content

Add Incident Notification Rules Public Spec #2825

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
api-clients-generation-pipeline merged 1 commit into from
Sep 10, 2025
Merged

Add Incident Notification Rules Public Spec #2825

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.

147 changes: 147 additions & 0 deletions docs/datadog_api_client.v2.model.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4337,6 +4337,13 @@ datadog\_api\_client.v2.model.create\_data\_deletion\_response\_body module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.create\_incident\_notification\_rule\_request module
----------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.create_incident_notification_rule_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.create\_incident\_notification\_template\_request module
--------------------------------------------------------------------------------------

Expand Down Expand Up @@ -8516,6 +8523,118 @@ datadog\_api\_client.v2.model.incident\_notification\_handle module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.incident\_notification\_rule module
-----------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.incident_notification_rule
:members:
:show-inheritance:

datadog\_api\_client.v2.model.incident\_notification\_rule\_array module
------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.incident_notification_rule_array
:members:
:show-inheritance:

datadog\_api\_client.v2.model.incident\_notification\_rule\_array\_meta module
------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.incident_notification_rule_array_meta
:members:
:show-inheritance:

datadog\_api\_client.v2.model.incident\_notification\_rule\_array\_meta\_page module
------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.incident_notification_rule_array_meta_page
:members:
:show-inheritance:

datadog\_api\_client.v2.model.incident\_notification\_rule\_attributes module
-----------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.incident_notification_rule_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.incident\_notification\_rule\_attributes\_visibility module
-----------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.incident_notification_rule_attributes_visibility
:members:
:show-inheritance:

datadog\_api\_client.v2.model.incident\_notification\_rule\_conditions\_items module
------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.incident_notification_rule_conditions_items
:members:
:show-inheritance:

datadog\_api\_client.v2.model.incident\_notification\_rule\_create\_attributes module
-------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.incident_notification_rule_create_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.incident\_notification\_rule\_create\_attributes\_visibility module
-------------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.incident_notification_rule_create_attributes_visibility
:members:
:show-inheritance:

datadog\_api\_client.v2.model.incident\_notification\_rule\_create\_data module
-------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.incident_notification_rule_create_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.incident\_notification\_rule\_create\_data\_relationships module
----------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.incident_notification_rule_create_data_relationships
:members:
:show-inheritance:

datadog\_api\_client.v2.model.incident\_notification\_rule\_included\_items module
----------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.incident_notification_rule_included_items
:members:
:show-inheritance:

datadog\_api\_client.v2.model.incident\_notification\_rule\_relationships module
--------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.incident_notification_rule_relationships
:members:
:show-inheritance:

datadog\_api\_client.v2.model.incident\_notification\_rule\_response\_data module
---------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.incident_notification_rule_response_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.incident\_notification\_rule\_type module
-----------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.incident_notification_rule_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.incident\_notification\_rule\_update\_data module
-------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.incident_notification_rule_update_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.incident\_notification\_template module
---------------------------------------------------------------------

Expand Down Expand Up @@ -8579,6 +8698,13 @@ datadog\_api\_client.v2.model.incident\_notification\_template\_included\_items
:members:
:show-inheritance:

datadog\_api\_client.v2.model.incident\_notification\_template\_object module
-----------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.incident_notification_template_object
:members:
:show-inheritance:

datadog\_api\_client.v2.model.incident\_notification\_template\_relationships module
------------------------------------------------------------------------------------

Expand Down Expand Up @@ -14823,6 +14949,13 @@ datadog\_api\_client.v2.model.publish\_app\_response module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.put\_incident\_notification\_rule\_request module
-------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.put_incident_notification_rule_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.query module
------------------------------------------

Expand Down Expand Up @@ -15012,6 +15145,20 @@ datadog\_api\_client.v2.model.relationship\_to\_incident\_integration\_metadatas
:members:
:show-inheritance:

datadog\_api\_client.v2.model.relationship\_to\_incident\_notification\_template module
---------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.relationship_to_incident_notification_template
:members:
:show-inheritance:

datadog\_api\_client.v2.model.relationship\_to\_incident\_notification\_template\_data module
---------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.relationship_to_incident_notification_template_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.relationship\_to\_incident\_postmortem module
---------------------------------------------------------------------------

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

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.incidents_api import IncidentsApi
from datadog_api_client.v2.model.create_incident_notification_rule_request import CreateIncidentNotificationRuleRequest
from datadog_api_client.v2.model.incident_notification_rule_conditions_items import (
IncidentNotificationRuleConditionsItems,
)
from datadog_api_client.v2.model.incident_notification_rule_create_attributes import (
IncidentNotificationRuleCreateAttributes,
)
from datadog_api_client.v2.model.incident_notification_rule_create_attributes_visibility import (
IncidentNotificationRuleCreateAttributesVisibility,
)
from datadog_api_client.v2.model.incident_notification_rule_create_data import IncidentNotificationRuleCreateData
from datadog_api_client.v2.model.incident_notification_rule_create_data_relationships import (
IncidentNotificationRuleCreateDataRelationships,
)
from datadog_api_client.v2.model.incident_notification_rule_type import IncidentNotificationRuleType
from datadog_api_client.v2.model.incident_notification_template_type import IncidentNotificationTemplateType
from datadog_api_client.v2.model.incident_type_type import IncidentTypeType
from datadog_api_client.v2.model.relationship_to_incident_notification_template import (
RelationshipToIncidentNotificationTemplate,
)
from datadog_api_client.v2.model.relationship_to_incident_notification_template_data import (
RelationshipToIncidentNotificationTemplateData,
)
from datadog_api_client.v2.model.relationship_to_incident_type import RelationshipToIncidentType
from datadog_api_client.v2.model.relationship_to_incident_type_data import RelationshipToIncidentTypeData
from uuid import UUID

body = CreateIncidentNotificationRuleRequest(
data=IncidentNotificationRuleCreateData(
attributes=IncidentNotificationRuleCreateAttributes(
conditions=[
IncidentNotificationRuleConditionsItems(
field="severity",
values=[
"SEV-1",
"SEV-2",
],
),
],
enabled=True,
handles=[
"@team-email@company.com",
"@slack-channel",
],
renotify_on=[
"status",
"severity",
],
trigger="incident_created_trigger",
visibility=IncidentNotificationRuleCreateAttributesVisibility.ORGANIZATION,
),
relationships=IncidentNotificationRuleCreateDataRelationships(
incident_type=RelationshipToIncidentType(
data=RelationshipToIncidentTypeData(
id="00000000-0000-0000-0000-000000000000",
type=IncidentTypeType.INCIDENT_TYPES,
),
),
notification_template=RelationshipToIncidentNotificationTemplate(
data=RelationshipToIncidentNotificationTemplateData(
id=UUID("00000000-0000-0000-0000-000000000001"),
type=IncidentNotificationTemplateType.NOTIFICATION_TEMPLATES,
),
),
),
type=IncidentNotificationRuleType.INCIDENT_NOTIFICATION_RULES,
),
)

configuration = Configuration()
configuration.unstable_operations["create_incident_notification_rule"] = True
with ApiClient(configuration) as api_client:
api_instance = IncidentsApi(api_client)
response = api_instance.create_incident_notification_rule(body=body)

print(response)
67 changes: 67 additions & 0 deletions examples/v2/incidents/CreateIncidentNotificationRule_3029800608.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
"""
Create incident notification rule returns "Created" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.incidents_api import IncidentsApi
from datadog_api_client.v2.model.create_incident_notification_rule_request import CreateIncidentNotificationRuleRequest
from datadog_api_client.v2.model.incident_notification_rule_conditions_items import (
IncidentNotificationRuleConditionsItems,
)
from datadog_api_client.v2.model.incident_notification_rule_create_attributes import (
IncidentNotificationRuleCreateAttributes,
)
from datadog_api_client.v2.model.incident_notification_rule_create_attributes_visibility import (
IncidentNotificationRuleCreateAttributesVisibility,
)
from datadog_api_client.v2.model.incident_notification_rule_create_data import IncidentNotificationRuleCreateData
from datadog_api_client.v2.model.incident_notification_rule_create_data_relationships import (
IncidentNotificationRuleCreateDataRelationships,
)
from datadog_api_client.v2.model.incident_notification_rule_type import IncidentNotificationRuleType
from datadog_api_client.v2.model.incident_type_type import IncidentTypeType
from datadog_api_client.v2.model.relationship_to_incident_type import RelationshipToIncidentType
from datadog_api_client.v2.model.relationship_to_incident_type_data import RelationshipToIncidentTypeData

# there is a valid "incident_type" in the system
INCIDENT_TYPE_DATA_ID = environ["INCIDENT_TYPE_DATA_ID"]

body = CreateIncidentNotificationRuleRequest(
data=IncidentNotificationRuleCreateData(
attributes=IncidentNotificationRuleCreateAttributes(
conditions=[
IncidentNotificationRuleConditionsItems(
field="severity",
values=[
"SEV-1",
"SEV-2",
],
),
],
handles=[
"@test-email@company.com",
],
visibility=IncidentNotificationRuleCreateAttributesVisibility.ORGANIZATION,
trigger="incident_created_trigger",
enabled=True,
),
relationships=IncidentNotificationRuleCreateDataRelationships(
incident_type=RelationshipToIncidentType(
data=RelationshipToIncidentTypeData(
id=INCIDENT_TYPE_DATA_ID,
type=IncidentTypeType.INCIDENT_TYPES,
),
),
),
type=IncidentNotificationRuleType.INCIDENT_NOTIFICATION_RULES,
),
)

configuration = Configuration()
configuration.unstable_operations["create_incident_notification_rule"] = True
with ApiClient(configuration) as api_client:
api_instance = IncidentsApi(api_client)
response = api_instance.create_incident_notification_rule(body=body)

print(response)
15 changes: 15 additions & 0 deletions examples/v2/incidents/DeleteIncidentNotificationRule.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
"""
Delete an incident notification rule returns "No Content" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.incidents_api import IncidentsApi
from uuid import UUID

configuration = Configuration()
configuration.unstable_operations["delete_incident_notification_rule"] = True
with ApiClient(configuration) as api_client:
api_instance = IncidentsApi(api_client)
api_instance.delete_incident_notification_rule(
id=UUID("00000000-0000-0000-0000-000000000001"),
)
18 changes: 18 additions & 0 deletions examples/v2/incidents/DeleteIncidentNotificationRule_4148107167.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
"""
Delete incident notification rule returns "No Content" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.incidents_api import IncidentsApi

# there is a valid "notification_rule" in the system
NOTIFICATION_RULE_DATA_ID = environ["NOTIFICATION_RULE_DATA_ID"]

configuration = Configuration()
configuration.unstable_operations["delete_incident_notification_rule"] = True
with ApiClient(configuration) as api_client:
api_instance = IncidentsApi(api_client)
api_instance.delete_incident_notification_rule(
id=NOTIFICATION_RULE_DATA_ID,
)
17 changes: 17 additions & 0 deletions examples/v2/incidents/GetIncidentNotificationRule.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
"""
Get an incident notification rule returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.incidents_api import IncidentsApi
from uuid import UUID

configuration = Configuration()
configuration.unstable_operations["get_incident_notification_rule"] = True
with ApiClient(configuration) as api_client:
api_instance = IncidentsApi(api_client)
response = api_instance.get_incident_notification_rule(
id=UUID("00000000-0000-0000-0000-000000000001"),
)

print(response)
Loading