Skip to content

Add routes for managing On-Call user notification channels #3004

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
Dec 16, 2025
Merged

Add routes for managing On-Call user notification channels #3004

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
428 changes: 428 additions & 0 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

133 changes: 133 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 @@ -5268,6 +5268,13 @@ datadog\_api\_client.v2.model.create\_deployment\_rule\_params\_data\_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.create\_email\_notification\_channel\_config module
---------------------------------------------------------------------------------

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

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

Expand Down Expand Up @@ -5310,6 +5317,27 @@ datadog\_api\_client.v2.model.create\_jira\_issue\_request\_data\_relationships
:members:
:show-inheritance:

datadog\_api\_client.v2.model.create\_notification\_channel\_attributes module
------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.create\_notification\_channel\_config module
--------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.create\_notification\_channel\_data module
------------------------------------------------------------------------

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

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

Expand Down Expand Up @@ -5408,6 +5436,13 @@ datadog\_api\_client.v2.model.create\_page\_response\_data\_type module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.create\_phone\_notification\_channel\_config module
---------------------------------------------------------------------------------

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

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

Expand Down Expand Up @@ -5653,6 +5688,13 @@ datadog\_api\_client.v2.model.create\_upload\_response\_data\_type module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.create\_user\_notification\_channel\_request module
---------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.create\_workflow\_request module
--------------------------------------------------------------

Expand Down Expand Up @@ -13045,6 +13087,13 @@ datadog\_api\_client.v2.model.list\_kind\_catalog\_response module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.list\_notification\_channels\_response module
---------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.list\_pipelines\_response module
--------------------------------------------------------------

Expand Down Expand Up @@ -15075,6 +15124,90 @@ datadog\_api\_client.v2.model.notebook\_trigger\_wrapper module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.notification\_channel module
----------------------------------------------------------

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

datadog\_api\_client.v2.model.notification\_channel\_attributes module
----------------------------------------------------------------------

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

datadog\_api\_client.v2.model.notification\_channel\_config module
------------------------------------------------------------------

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

datadog\_api\_client.v2.model.notification\_channel\_data module
----------------------------------------------------------------

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

datadog\_api\_client.v2.model.notification\_channel\_email\_config module
-------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.notification\_channel\_email\_config\_type module
-------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.notification\_channel\_email\_format\_type module
-------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.notification\_channel\_phone\_config module
-------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.notification\_channel\_phone\_config\_type module
-------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.notification\_channel\_push\_config module
------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.notification\_channel\_push\_config\_type module
------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.notification\_channel\_type module
----------------------------------------------------------------

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

datadog\_api\_client.v2.model.notification\_rule module
-------------------------------------------------------

Expand Down
39 changes: 39 additions & 0 deletions examples/v2/on-call/CreateUserNotificationChannel.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
"""
Create an On-Call notification channel for a user returns "Created" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.on_call_api import OnCallApi
from datadog_api_client.v2.model.create_email_notification_channel_config import CreateEmailNotificationChannelConfig
from datadog_api_client.v2.model.create_notification_channel_attributes import CreateNotificationChannelAttributes
from datadog_api_client.v2.model.create_notification_channel_data import CreateNotificationChannelData
from datadog_api_client.v2.model.create_user_notification_channel_request import CreateUserNotificationChannelRequest
from datadog_api_client.v2.model.notification_channel_email_config_type import NotificationChannelEmailConfigType
from datadog_api_client.v2.model.notification_channel_email_format_type import NotificationChannelEmailFormatType
from datadog_api_client.v2.model.notification_channel_type import NotificationChannelType

# there is a valid "user" in the system
USER_DATA_ID = environ["USER_DATA_ID"]

body = CreateUserNotificationChannelRequest(
data=CreateNotificationChannelData(
attributes=CreateNotificationChannelAttributes(
config=CreateEmailNotificationChannelConfig(
address="foo@bar.com",
formats=[
NotificationChannelEmailFormatType.HTML,
],
type=NotificationChannelEmailConfigType.EMAIL,
),
),
type=NotificationChannelType.NOTIFICATION_CHANNELS,
),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = OnCallApi(api_client)
response = api_instance.create_user_notification_channel(user_id=USER_DATA_ID, body=body)

print(response)
21 changes: 21 additions & 0 deletions examples/v2/on-call/DeleteUserNotificationChannel.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
"""
Delete an On-Call notification channel for a user returns "No Content" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.on_call_api import OnCallApi

# there is a valid "user" in the system
USER_DATA_ID = environ["USER_DATA_ID"]

# there is a valid "oncall_email_notification_channel" in the system
ONCALL_EMAIL_NOTIFICATION_CHANNEL_DATA_ID = environ["ONCALL_EMAIL_NOTIFICATION_CHANNEL_DATA_ID"]

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = OnCallApi(api_client)
api_instance.delete_user_notification_channel(
user_id=USER_DATA_ID,
channel_id=ONCALL_EMAIL_NOTIFICATION_CHANNEL_DATA_ID,
)
23 changes: 23 additions & 0 deletions examples/v2/on-call/GetUserNotificationChannel.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
"""
Get an On-Call notification channel for a user returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.on_call_api import OnCallApi

# there is a valid "user" in the system
USER_DATA_ID = environ["USER_DATA_ID"]

# there is a valid "oncall_email_notification_channel" in the system
ONCALL_EMAIL_NOTIFICATION_CHANNEL_DATA_ID = environ["ONCALL_EMAIL_NOTIFICATION_CHANNEL_DATA_ID"]

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = OnCallApi(api_client)
response = api_instance.get_user_notification_channel(
user_id=USER_DATA_ID,
channel_id=ONCALL_EMAIL_NOTIFICATION_CHANNEL_DATA_ID,
)

print(response)
19 changes: 19 additions & 0 deletions examples/v2/on-call/ListUserNotificationChannels.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
"""
List On-Call notification channels for a user returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.on_call_api import OnCallApi

# there is a valid "user" in the system
USER_DATA_ID = environ["USER_DATA_ID"]

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = OnCallApi(api_client)
response = api_instance.list_user_notification_channels(
user_id=USER_DATA_ID,
)

print(response)
Loading